User Management v3 APIs

• Overview
• Types of User Management v3 APIs
• Permission Keys
• Error Codes

Overview

The User Management v3 APIs allow you to manage users, user groups, domains, permissions, and account policies in the system. These APIs support operations such as:

• Retrieving user profiles
• Locking or unlocking users
• Deleting users or groups
• Managing domains
• Configuring permissions and account policies

Example API Request:

https://apm-prod-server:8443/api/v3/users

Types of User Management v3 APIs

Browse through the following topics to perform user management operations to required endpoints:

• Users
• User Groups
• User Domains

Following are the consolidated list of categories and their corresponding v3 APIs supported for User Management in Applications Manager.

Permission Keys

Following are the list of permission keys used in various response parameters of User Management v3 APIs based on their user roles:

• Administrator
• Delegated Administrator
• Operator
• User

Administrator role permissions

Delegated Administrator role permissions

Operator role permissions

User role permissions

Error Codes

Following are the list of permission keys used in various response parameters of User Management v3 APIs. All error responses follow this standard format:

{
  "message": "failure",
  "data": [
    {
      "errorCode": "ERROR_CODE_NAME",
      "errorMessage": "Human-readable error description"
    }
  ],
  "meta": {}
}