Off-boarding Users

When off-boarding Sift users it is recommended to deactivate the users account. Account deactivation will implicitly deactivate API keys created by that user.

Sift accounts can be deactivated through the UI or via the API. Both workflows require that the user performing the deactivation be a Sift admin.

UI

1. Click on your Sift account icon and select Manage.

2. Ensure you are on the User tab

3. Select deactivate on the desired user

API

Admins can use the sift User Service to get user information and deactivate users.

ListActiveUsers

The ListUsers API can be used to get user information

• https://docs.siftstack.com/api-docs/rest#tag/UserService/operation/UserService_ListActiveUsers

GET Request

/api/v2/users/{userId}

UpdateUserOrganizationActive

The UpdateUserOrganizationActive API can be used to deactivate users.

• https://docs.siftstack.com/api-docs/rest#tag/UserService/operation/UserService_GetUser

POST Request

/api/v2/users/{userId}/active

Payload

{
    "organizationId": "string",
    "active": false
}