Invite Users

Invite Users

Invite users with given user groups and permissions.

Request
URI
POST
https://{api_host}/api/v2/user/invite
COPY
Request Body

Example Body: 

[
{
  "emailAddress": "[email protected]",
  "groups": [
    "user_management"
  ],
  "userGroups": [
    "8b23136b-ecd2-4cb5-8c92-62477dcc4090"
  ],
  "roles": [
    "Role"
  ],
}
]
UserToCreateArray of type(s) application/json
Optional 
[
    {
        "emailAddress": "string",
        "groups": [
            "string"
        ],
        "userGroups": [
            "string"
        ],
        "roles": [
            "string"
        ]
    }
]
Authentication
This operation uses the following authentication methods.
Responses
200

successful operation

Returns UserModel of type(s) application/json 
"UserModel Object"
string
identifier
Required

The unique identifier of this user, which must be their valid email address

string
customer
Required

The id of the customer to which this user belongs

string
ssoId
Optional

ssoId

integer As int64 As int64
lastSuccessfulLogin
Optional

lastSuccessfulLogin

array of string
groups
Required

The permissions granted to this user

array of object
userGroups
Required

The list of user groups the user belongs to

array of object
roles
Optional

roles


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/api/v2/user/invite
On This Page
User Operations
GET
Get All Users
POST
Create User
POST
Delete Multiple Users
POST
Grant Permission To Users
POST
Invite Users
POST
Revoke Permission From Users
POST
Validate Users
GET
Get User
PUT
Update User
DELETE
Delete User
POST
Add User To User Groups
GET
Get User Business Functions
POST
Grant User Permission
POST
Remove User From User Groups
POST
Revoke User Permission