See the API's various operations for details on their request parameters and response data.
You can also run this API with a Postman collection.
| Operation | Method | Endpoint |
|---|---|---|
| Groups | ||
| List groups | GET | /user-admin/groups |
| Move a group | POST | /user-admin/groups/move |
| List users affected by moving a group | GET | /user-admin/groups/move/{sourceGroupId}/{destinationGroupId}/affected-users |
| 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} |
| Properties | ||
| List properties or includes | GET | /user-admin/properties |
| Get a property or include | GET | /user-admin/properties/{assetId} |
| Move a property or include | PUT | /user-admin/properties/{assetId} |
| Get asset's resources | GET | /user-admin/properties/{assetId}/resources |
| List users for property or include | GET | /user-admin/properties/{assetId}/users |
| Block users from a property or include | PUT | /user-admin/properties/{assetId}/users/block |
| Roles | ||
| List roles | GET | /user-admin/roles |
| Create a role | POST | /user-admin/roles |
| List grantable roles | GET | /user-admin/roles/grantable-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} |
| 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} |
| Set a user's multi-factor authentication | PUT | /user-admin/ui-identities/{uiIdentityId}/additionalAuthentication |
| Reset a user's multi-factor authentication | PUT | /user-admin/ui-identities/{uiIdentityId}/additionalAuthentication/reset |
| Modify a user's group and role assignments | PUT | /user-admin/ui-identities/{uiIdentityId}/auth-grants |
| Update a user | PUT | /user-admin/ui-identities/{uiIdentityId}/basic-info |
| List blocked properties and includes | GET | /user-admin/ui-identities/{uiIdentityId}/groups/{groupId}/blocked-properties |
| Update blocked properties and includes | PUT | /user-admin/ui-identities/{uiIdentityId}/groups/{groupId}/blocked-properties |
| Lock a user's account | POST | /user-admin/ui-identities/{uiIdentityId}/lock |
| Update a user's notifications | PUT | /user-admin/ui-identities/{uiIdentityId}/notifications |
| 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 |
| Unlock a user's account | POST | /user-admin/ui-identities/{uiIdentityId}/unlock |
| Your user profile | ||
| View your profile | GET | /user-profile |
| Set multi-factor authentication for your user profile | PUT | /user-profile/additionalAuthentication |
| Reset multi-factor authentication for your user profile | PUT | /user-profile/additionalAuthentication/reset |
| Edit your profile | PUT | /user-profile/basic-info |
| Rotate your password | POST | /user-profile/change-password |
| Update your 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 products | GET | /user-admin/common/notification-products |
| View password policy | GET | /user-admin/common/password-policy |
| View languages | GET | /user-admin/common/supported-languages |
| View timeout policies | GET | /user-admin/common/timeout-policies |
| View time zones | GET | /user-admin/common/timezones |
| 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 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 languages for a user profile | GET | /user-profile/common/supported-languages |
| View timeout policies for a user profile | GET | /user-profile/common/timeout-policies |
| View time zones for a user profile | GET | /user-profile/common/timezones |
| IP access control lists | ||
| List CIDR blocks | GET | /user-admin/ip-acl/allowlist |
| Create a CIDR block | POST | /user-admin/ip-acl/allowlist |
| 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 |
| Validate CIDR blocks | GET | /user-admin/ip-acl/allowlist/validate |
| Delete a CIDR block | DELETE | /user-admin/ip-acl/allowlist/{cidrBlockId} |
| Get a CIDR block | GET | /user-admin/ip-acl/allowlist/{cidrBlockId} |
| Modify a CIDR block | PUT | /user-admin/ip-acl/allowlist/{cidrBlockId} |
| API clients administration | ||
| List API clients | GET | /api-clients |
| Create an API client | POST | /api-clients |
| Delete your API client | DELETE | /api-clients/self |
| Get your API client | GET | /api-clients/self |
| Update your API client | PUT | /api-clients/self |
| List your account switch keys | GET | /api-clients/self/account-switch-keys |
| Lock your API client | PUT | /api-clients/self/lock |
| Delete an API client | DELETE | /api-clients/{clientId} |
| Get an API client | GET | /api-clients/{clientId} |
| Update an API client | PUT | /api-clients/{clientId} |
| List account switch keys | GET | /api-clients/{clientId}/account-switch-keys |
| Lock an API client | PUT | /api-clients/{clientId}/lock |
| Unlock an API client | PUT | /api-clients/{clientId}/unlock |
| List authorized users | GET | /users |
| List allowed APIs | GET | /users/{username}/allowed-apis |
| List allowed CP codes | POST | /users/{username}/allowed-cpcodes |
| List accessible groups | GET | /users/{username}/group-access |
| 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 |