API summary

See the API's various operations for details on their request parameters and response data:

OperationMethodEndpoint
Groups
List groupsGET/user-admin/​groups
Delete a groupDELETE/user-admin/​groups/​{groupId}
Get a groupGET/user-admin/​groups/​{groupId}
Create a new groupPOST/user-admin/​groups/​{groupId}
Modify a group's namePUT/user-admin/​groups/​{groupId}
Move a groupPOST/user-admin/​groups/​move
List users affected by moving a groupGET/user-admin/​groups/​move/​{sourceGroupId}/​{destinationGroupId}/​affected-users
Properties
List propertiesGET/user-admin/​properties
Get a propertyGET/user-admin/​properties/​{propertyId}
Move a propertyPUT/user-admin/​properties/​{propertyId}
Get a property's resourcesGET/user-admin/​properties/​{propertyId}/​resources
List users for propertyGET/user-admin/​properties/​{propertyId}/​users
Block usersPUT/user-admin/​properties/​{propertyId}/​users/​block
Roles
List rolesGET/user-admin/​roles
Create a rolePOST/user-admin/​roles
Delete a roleDELETE/user-admin/​roles/​{roleId}
Get a roleGET/user-admin/​roles/​{roleId}
Edit a rolePUT/user-admin/​roles/​{roleId}
List grantable rolesGET/user-admin/​roles/​grantable-roles
Users, for administrators
List usersGET/user-admin/​ui-identities
Create a userPOST/user-admin/​ui-identities
Remove a userDELETE/user-admin/​ui-identities/​{uiIdentityId}
Get a userGET/user-admin/​ui-identities/​{uiIdentityId}
Update a userPUT/user-admin/​ui-identities/​{uiIdentityId}/​basic-info
Modify a user's group and role assignmentsPUT/user-admin/​ui-identities/​{uiIdentityId}/​auth-grants
List blocked propertiesGET/user-admin/​ui-identities/​{uiIdentityId}/​groups/​{groupId}/​blocked-properties
Update blocked propertiesPUT/user-admin/​ui-identities/​{uiIdentityId}/​groups/​{groupId}/​blocked-properties
Lock a user's accountPOST/user-admin/​ui-identities/​{uiIdentityId}/​lock
Reset a user's passwordPOST/user-admin/​ui-identities/​{uiIdentityId}/​reset-password
Set a user's passwordPOST/user-admin/​ui-identities/​{uiIdentityId}/​set-password
Set a user's two-factor authenticationPUTuser-admin/ui-identities/{uiIdentityId}/additionalAuthentication
Unlock a user's accountPOST/user-admin/​ui-identities/​{uiIdentityId}/​unlock
Update a user's notificationsPUT/user-admin/​ui-identities/​{uiIdentityId}/​notifications
Your user profile
View your profileGET/user-profile
Edit your profilePUT/user-profile/​basic-info
Rotate your passwordPOST/user-profile/​change-password
Set two-factor authenticationPUT/user-profile/additionalAuthentication
Update notificationsPUT/user-profile/​notifications
Common resources, for administrators
View contact typesGET/user-admin/​common/​contact-types
View countriesGET/user-admin/​common/​countries
View statesGET/user-admin/​common/​countries/​{country}/​states
View languagesGET/user-admin/​common/​supported-languages
View time zonesGET/user-admin/​common/​timezones
View productsGET/user-admin/​common/​notification-products
View password policyGET/user-admin/​common/​password-policy
View timeout policiesGET/user-admin/​common/​timeout-policies
Common resources, for users
View contact types for a user profileGET/user-profile/​common/​contact-types
View supported countries for a user profileGET/user-profile/​common/​countries
View states for a user profileGET/user-profile/​common/​countries/​{country}/​states
View languages for a user profileGET/user-profile/​common/​supported-languages
View time zones for a user profileGET/user-profile/​common/​timezones
View products for a user profileGET/user-profile/​common/​notification-products
View password policy for a user profileGET/user-profile/​common/​password-policy
View timeout policies for a user profileGET/user-profile/​common/​timeout-policies
IP allowlists
List CIDR blocksGET/user-admin/​ip-acl/​allowlist
Create a CIDR blockPOST/user-admin/​ip-acl/​allowlist
Validate CIDR blocksGET/user-admin/​ip-acl/​allowlist/​validate
Delete a CIDR blockDELETE/user-admin/​ip-acl/​allowlist/​{cidrBlockId}
View CIDR block detailsGET/user-admin/​ip-acl/​allowlist/​{cidrBlockId}
Modify a CIDR blockPUT/user-admin/​ip-acl/​allowlist/​{cidrBlockId}
Disable IP allowlistPOST/user-admin/​ip-acl/​allowlist/​disable
Enable IP allowlistPOST/user-admin/​ip-acl/​allowlist/​enable
View IP allowlist statusGET/user-admin/​ip-acl/​allowlist/​status
API clients administration
List authorized usersGET/users
List accessible groupsGET/users/{username}/group-access
List allowed APIsGET/users/{username}/allowed-apis
List allowed CP codesGET/users/{username}/allowed-cpcodes
Get your API clientGET/api-clients/self
Update your API clientPUT/api-clients/self
Delete your API clientDELETE/api-clients/self
Lock your API clientPUT/api-clients/self/lock
List your account switch keysGET/api-clients/self/account-switch-keys
List API clientsGET/api-clients
Create an API clientPOST/api-clients
Get an API clientGET/api-clients/{clientId}
Update an API clientPUT/api-clients/{clientId}
Delete an API clientDELETE/api-clients/{clientId}
Lock an API clientPUT/api-clients/{clientId}/lock
Unlock an API clientPUT/api-clients/{clientId}/unlock
List account switch keysGET/api-clients/{clientId}/account-switch-keys
API client credentials
List your credentialsGET/api-clients/​self/​credentials
Create your credentialPOST/api-clients/​self/​credentials
Deactivate your credentialsPOST/api-clients/​self/​credentials/​deactivate
Remove your credentialDELETE/api-clients/​self/​credentials/​{credentialId}
Get your credentialGET/api-clients/​self/​credentials/​{credentialId}
Update your credentialPUT/api-clients/​self/​credentials/​{credentialId}
Deactivate your credentialPOST/api-clients/​self/​credentials/​{credentialId}/​deactivate
List credentialsGET/api-clients/​{clientId}/​credentials
Create a credentialPOST/api-clients/​{clientId}/​credentials
Deactivate credentialsPOST/api-clients/​{clientId}/​credentials/​deactivate
Remove a credentialDELETE/api-clients/​{clientId}/​credentials/​{credentialId}
Get a credentialGET/api-clients/​{clientId}/​credentials/​{credentialId}
Update a credentialPUT/api-clients/​{clientId}/​credentials/​{credentialId}
Deactivate a credentialPOST/api-clients/​{clientId}/​credentials/​{credentialId}/​deactivate