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
  }
}'
{
  "email": "example@mail.com",
  "status": false,
  "message": "SMS sent. / SMS not sent.",
  "userId": 20199
}

Headers

Authorization
string
required

Access Token

OrganizationId
string
required

Organization ID

Body

application/json

userInviteRequest

emailAddress
string
firstName
string
lastName
string
orgIds
integer[]
roleIds
integer[]
screenName
string
userPrivilegeGroupAndAuthResources
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

User ID to send SMS.

Example:

20199