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