Skip to main content
POST
/
user
/
invite
User Invite
curl --request POST \
  --url https://apigw.bienport.com/api/user/invite \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'OrganizationId: <organizationid>' \
  --data '
{
  "emailAddress": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "orgIds": [
    123
  ],
  "roleIds": [
    123
  ],
  "screenName": "<string>",
  "userPrivilegeGroupAndAuthResources": {
    "userId": 20199,
    "authorizedResourceIds": [
      170174
    ],
    "privilegeGroups": [
      {
        "privilegeGroupId": 1,
        "authorized": true
      }
    ],
    "organizationId": 31547,
    "expirationTime": 1644466338000,
    "period": [
      {
        "dayOfWeek": 1,
        "start": 125,
        "end": 126
      }
    ],
    "validityStart": 1645466338000
  }
}
'
import requests

url = "https://apigw.bienport.com/api/user/invite"

payload = {
"emailAddress": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"orgIds": [123],
"roleIds": [123],
"screenName": "<string>",
"userPrivilegeGroupAndAuthResources": {
"userId": 20199,
"authorizedResourceIds": [170174],
"privilegeGroups": [
{
"privilegeGroupId": 1,
"authorized": True
}
],
"organizationId": 31547,
"expirationTime": 1644466338000,
"period": [
{
"dayOfWeek": 1,
"start": 125,
"end": 126
}
],
"validityStart": 1645466338000
}
}
headers = {
"Authorization": "<authorization>",
"OrganizationId": "<organizationid>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {
Authorization: '<authorization>',
OrganizationId: '<organizationid>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
emailAddress: '<string>',
firstName: '<string>',
lastName: '<string>',
orgIds: [123],
roleIds: [123],
screenName: '<string>',
userPrivilegeGroupAndAuthResources: {
userId: 20199,
authorizedResourceIds: [170174],
privilegeGroups: [{privilegeGroupId: 1, authorized: true}],
organizationId: 31547,
expirationTime: 1644466338000,
period: [{dayOfWeek: 1, start: 125, end: 126}],
validityStart: 1645466338000
}
})
};

fetch('https://apigw.bienport.com/api/user/invite', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://apigw.bienport.com/api/user/invite",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'emailAddress' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'orgIds' => [
123
],
'roleIds' => [
123
],
'screenName' => '<string>',
'userPrivilegeGroupAndAuthResources' => [
'userId' => 20199,
'authorizedResourceIds' => [
170174
],
'privilegeGroups' => [
[
'privilegeGroupId' => 1,
'authorized' => true
]
],
'organizationId' => 31547,
'expirationTime' => 1644466338000,
'period' => [
[
'dayOfWeek' => 1,
'start' => 125,
'end' => 126
]
],
'validityStart' => 1645466338000
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json",
"OrganizationId: <organizationid>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://apigw.bienport.com/api/user/invite"

payload := strings.NewReader("{\n \"emailAddress\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"orgIds\": [\n 123\n ],\n \"roleIds\": [\n 123\n ],\n \"screenName\": \"<string>\",\n \"userPrivilegeGroupAndAuthResources\": {\n \"userId\": 20199,\n \"authorizedResourceIds\": [\n 170174\n ],\n \"privilegeGroups\": [\n {\n \"privilegeGroupId\": 1,\n \"authorized\": true\n }\n ],\n \"organizationId\": 31547,\n \"expirationTime\": 1644466338000,\n \"period\": [\n {\n \"dayOfWeek\": 1,\n \"start\": 125,\n \"end\": 126\n }\n ],\n \"validityStart\": 1645466338000\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "<authorization>")
req.Header.Add("OrganizationId", "<organizationid>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://apigw.bienport.com/api/user/invite")
.header("Authorization", "<authorization>")
.header("OrganizationId", "<organizationid>")
.header("Content-Type", "application/json")
.body("{\n \"emailAddress\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"orgIds\": [\n 123\n ],\n \"roleIds\": [\n 123\n ],\n \"screenName\": \"<string>\",\n \"userPrivilegeGroupAndAuthResources\": {\n \"userId\": 20199,\n \"authorizedResourceIds\": [\n 170174\n ],\n \"privilegeGroups\": [\n {\n \"privilegeGroupId\": 1,\n \"authorized\": true\n }\n ],\n \"organizationId\": 31547,\n \"expirationTime\": 1644466338000,\n \"period\": [\n {\n \"dayOfWeek\": 1,\n \"start\": 125,\n \"end\": 126\n }\n ],\n \"validityStart\": 1645466338000\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://apigw.bienport.com/api/user/invite")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["OrganizationId"] = '<organizationid>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"emailAddress\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"orgIds\": [\n 123\n ],\n \"roleIds\": [\n 123\n ],\n \"screenName\": \"<string>\",\n \"userPrivilegeGroupAndAuthResources\": {\n \"userId\": 20199,\n \"authorizedResourceIds\": [\n 170174\n ],\n \"privilegeGroups\": [\n {\n \"privilegeGroupId\": 1,\n \"authorized\": true\n }\n ],\n \"organizationId\": 31547,\n \"expirationTime\": 1644466338000,\n \"period\": [\n {\n \"dayOfWeek\": 1,\n \"start\": 125,\n \"end\": 126\n }\n ],\n \"validityStart\": 1645466338000\n }\n}"

response = http.request(request)
puts response.read_body
{
  "email": "example@mail.com",
  "status": false,
  "message": "SMS sent. / SMS not sent.",
  "userId": 20199
}
This response has no body data.
{
"statusCode": 123,
"error": "***Exception",
"message": "Message about the error",
"path": "/api/example/path"
}
{
"statusCode": 123,
"error": "***Exception",
"message": "Message about the error",
"path": "/api/example/path"
}
This response has no body data.
{
"statusCode": 123,
"error": "***Exception",
"message": "Message about the error",
"path": "/api/example/path"
}
{
"statusCode": 123,
"error": "***Exception",
"message": "Message about the error",
"path": "/api/example/path"
}

Headers

Authorization
string
required

Access Token

OrganizationId
string
required

Organization ID

Body

application/json

userInviteRequest

emailAddress
string
firstName
string
lastName
string
orgIds
integer<int64>[]
roleIds
integer<int64>[]
screenName
string
userPrivilegeGroupAndAuthResources
AddOrUpdateUserPrivilegeGroupRequest · object

Response

Created User and sent invite.

email
string

Email to send invite message.

Example:

"example@mail.com"

status
boolean

The sending status of the SMS.

Example:

false

message
string

The sending message of the SMS.

Example:

"SMS sent. / SMS not sent."

userId
integer<int64>

User ID to send SMS.

Example:

20199