PUT
/
v2.01
/
{ClientId}
/
clients
/
ssos
/
{SsoId}
{
    "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
}
This call may be used to deactivate an SSO access by updating the Active parameter to false.

​
Path parameters

​
SsoId
string
The unique identifier of the SSO object.

​
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.
​
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.
​
Active
boolean
Whether or not the SSO is active.

​
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"
}