POST
/
v2.01
/
{ClientId}
/
clients
/
ssos
{
    "FirstName": "Alex",
    "LastName": "Smith",
    "Tag": "Custom meta",
    "Email": "alex.smith@example.com",
    "PermissionGroupId": "WRITE"
}  
{
    "Id": "14446007",
    "FirstName": "Alex",
    "LastName": "Smith",
    "Tag": "Custom meta",
    "Active": true,
    "Email": "alex.smith@example.com",
    "ClientId": "sandboxalex",
    "InvitationStatus": "SENT",
    "PermissionGroupId": "WRITE",
    "LastLoginDate": null,
    "CreationDate": 1646232844
}
  

Body parameters

FirstName
string
required
Max. length: 100 charactersThe first name of the Dashboard user.
LastName
string
required
Max. length: 100 charactersThe last name of the Dashboard user.
Tag
string
Max. length: 255 charactersCustom data that you can add to this object.
Email
boolean
required
Max. length: 255 charactersThe email address of the Dashboard user. Must be a valid email that is not already used for another SSO. Once the SSO is created, this email address cannot be changed.
Note: A maximum of 12 consecutive digits are allowed.
PermissionGroupId
string
required
The Id of the Permission Group object associated with the Dashboard user. Identifiers for default permission groups are ADMIN, WRITE, and READ.

Responses

{
    "Id": "14446007",
    "FirstName": "Alex",
    "LastName": "Smith",
    "Tag": "Custom meta",
    "Active": true,
    "Email": "alex.smith@example.com",
    "ClientId": "sandboxalex",
    "InvitationStatus": "SENT",
    "PermissionGroupId": "WRITE",
    "LastLoginDate": null,
    "CreationDate": 1646232844
}
  

{
    "FirstName": "Alex",
    "LastName": "Smith",
    "Tag": "Custom meta",
    "Email": "alex.smith@example.com",
    "PermissionGroupId": "WRITE"
}