See the API's various operations for details on their request parameters and response data:
Operation | Method | Endpoint |
---|---|---|
Groups | ||
List groups | GET | /user-admin/groups |
Delete a group | DELETE | /user-admin/groups/{groupId} |
Get a group | GET | /user-admin/groups/{groupId} |
Create a new group | POST | /user-admin/groups/{groupId} |
Modify a group's name | PUT | /user-admin/groups/{groupId} |
Move a group | POST | /user-admin/groups/move |
List users affected by moving a group | GET | /user-admin/groups/move/{sourceGroupId}/{destinationGroupId}/affected-users |
Properties | ||
List properties | GET | /user-admin/properties |
Get a property | GET | /user-admin/properties/{propertyId} |
Move a property | PUT | /user-admin/properties/{propertyId} |
Get a property's resources | GET | /user-admin/properties/{propertyId}/resources |
List users for property | GET | /user-admin/properties/{propertyId}/users |
Block users | PUT | /user-admin/properties/{propertyId}/users/block |
Roles | ||
List roles | GET | /user-admin/roles |
Create a role | POST | /user-admin/roles |
Delete a role | DELETE | /user-admin/roles/{roleId} |
Get a role | GET | /user-admin/roles/{roleId} |
Edit a role | PUT | /user-admin/roles/{roleId} |
List grantable roles | GET | /user-admin/roles/grantable-roles |
Users, for administrators | ||
List users | GET | /user-admin/ui-identities |
Create a user | POST | /user-admin/ui-identities |
Remove a user | DELETE | /user-admin/ui-identities/{uiIdentityId} |
Get a user | GET | /user-admin/ui-identities/{uiIdentityId} |
Update a user | PUT | /user-admin/ui-identities/{uiIdentityId}/basic-info |
Modify a user's group and role assignments | PUT | /user-admin/ui-identities/{uiIdentityId}/auth-grants |
List blocked properties | GET | /user-admin/ui-identities/{uiIdentityId}/groups/{groupId}/blocked-properties |
Update blocked properties | PUT | /user-admin/ui-identities/{uiIdentityId}/groups/{groupId}/blocked-properties |
Lock a user's account | POST | /user-admin/ui-identities/{uiIdentityId}/lock |
Reset a user's password | POST | /user-admin/ui-identities/{uiIdentityId}/reset-password |
Set a user's password | POST | /user-admin/ui-identities/{uiIdentityId}/set-password |
Set a user's two-factor authentication | PUT | user-admin/ui-identities/{uiIdentityId}/additionalAuthentication |
Unlock a user's account | POST | /user-admin/ui-identities/{uiIdentityId}/unlock |
Update a user's notifications | PUT | /user-admin/ui-identities/{uiIdentityId}/notifications |
Your user profile | ||
View your profile | GET | /user-profile |
Edit your profile | PUT | /user-profile/basic-info |
Rotate your password | POST | /user-profile/change-password |
Set two-factor authentication | PUT | /user-profile/additionalAuthentication |
Update notifications | PUT | /user-profile/notifications |
Common resources, for administrators | ||
View contact types | GET | /user-admin/common/contact-types |
View countries | GET | /user-admin/common/countries |
View states | GET | /user-admin/common/countries/{country}/states |
View languages | GET | /user-admin/common/supported-languages |
View time zones | GET | /user-admin/common/timezones |
View products | GET | /user-admin/common/notification-products |
View password policy | GET | /user-admin/common/password-policy |
View timeout policies | GET | /user-admin/common/timeout-policies |
Common resources, for users | ||
View contact types for a user profile | GET | /user-profile/common/contact-types |
View supported countries for a user profile | GET | /user-profile/common/countries |
View states for a user profile | GET | /user-profile/common/countries/{country}/states |
View languages for a user profile | GET | /user-profile/common/supported-languages |
View time zones for a user profile | GET | /user-profile/common/timezones |
View products for a user profile | GET | /user-profile/common/notification-products |
View password policy for a user profile | GET | /user-profile/common/password-policy |
View timeout policies for a user profile | GET | /user-profile/common/timeout-policies |
IP allowlists | ||
List CIDR blocks | GET | /user-admin/ip-acl/allowlist |
Create a CIDR block | POST | /user-admin/ip-acl/allowlist |
Validate CIDR blocks | GET | /user-admin/ip-acl/allowlist/validate |
Delete a CIDR block | DELETE | /user-admin/ip-acl/allowlist/{cidrBlockId} |
View CIDR block details | GET | /user-admin/ip-acl/allowlist/{cidrBlockId} |
Modify a CIDR block | PUT | /user-admin/ip-acl/allowlist/{cidrBlockId} |
Disable IP allowlist | POST | /user-admin/ip-acl/allowlist/disable |
Enable IP allowlist | POST | /user-admin/ip-acl/allowlist/enable |
View IP allowlist status | GET | /user-admin/ip-acl/allowlist/status |
API clients administration | ||
List authorized users | GET | /users |
List accessible groups | GET | /users/{username}/group-access |
List allowed APIs | GET | /users/{username}/allowed-apis |
List allowed CP codes | GET | /users/{username}/allowed-cpcodes |
Get your API client | GET | /api-clients/self |
Update your API client | PUT | /api-clients/self |
Delete your API client | DELETE | /api-clients/self |
Lock your API client | PUT | /api-clients/self/lock |
List your account switch keys | GET | /api-clients/self/account-switch-keys |
List API clients | GET | /api-clients |
Create an API client | POST | /api-clients |
Get an API client | GET | /api-clients/{clientId} |
Update an API client | PUT | /api-clients/{clientId} |
Delete an API client | DELETE | /api-clients/{clientId} |
Lock an API client | PUT | /api-clients/{clientId}/lock |
Unlock an API client | PUT | /api-clients/{clientId}/unlock |
List account switch keys | GET | /api-clients/{clientId}/account-switch-keys |
API client credentials | ||
List your credentials | GET | /api-clients/self/credentials |
Create your credential | POST | /api-clients/self/credentials |
Deactivate your credentials | POST | /api-clients/self/credentials/deactivate |
Remove your credential | DELETE | /api-clients/self/credentials/{credentialId} |
Get your credential | GET | /api-clients/self/credentials/{credentialId} |
Update your credential | PUT | /api-clients/self/credentials/{credentialId} |
Deactivate your credential | POST | /api-clients/self/credentials/{credentialId}/deactivate |
List credentials | GET | /api-clients/{clientId}/credentials |
Create a credential | POST | /api-clients/{clientId}/credentials |
Deactivate credentials | POST | /api-clients/{clientId}/credentials/deactivate |
Remove a credential | DELETE | /api-clients/{clientId}/credentials/{credentialId} |
Get a credential | GET | /api-clients/{clientId}/credentials/{credentialId} |
Update a credential | PUT | /api-clients/{clientId}/credentials/{credentialId} |
Deactivate a credential | POST | /api-clients/{clientId}/credentials/{credentialId}/deactivate |