See the API's various operations for details on their request parameters and response data.
Operation | Method | Endpoint |
---|---|---|
Email enrollments | ||
Send enrollment email | POST | /email-enrollments |
Users | ||
List users | GET | /users |
Add a user | POST | /users |
Delete a user | DELETE | /users/{userId} |
Get a user | GET | /users/{userId} |
Update a user | PUT | /users/{userId} |
Add an alias to a user | POST | /users/{userId}/aliases |
Delete an alias assigned to a user | DELETE | /users/{userId}/aliases/{userAliasId} |
Assign groups | POST | /users/{userId}/assign-groups |
Assign policies | POST | /users/{userId}/assign-policies |
List bypass codes | GET | /users/{userId}/bypass-codes |
Create a bypass code | POST | /users/{userId}/bypass-codes |
Get a bypass code | GET | /users/{userId}/bypass-codes/{bypassCodeId} |
List the user's devices | GET | /users/{userId}/devices |
Assign a hardware token | POST | /users/{userId}/devices/assign-hardware-token |
Disable a device | POST | /users/{userId}/devices/{deviceId}/disable |
Enable a device | POST | /users/{userId}/devices/{deviceId}/enable |
Groups | ||
List groups | GET | /groups |
Add a group | POST | /groups |
Delete a group | DELETE | /groups/{groupId} |
Get a group | GET | /groups/{groupId} |
Remove a user from a group | DELETE | /groups/{groupId}/users/{userId} |
Add a user to a group | POST | /groups/{groupId}/users/{userId} |