Purpose

Retrieves a list of user accounts

URL

https://<myserver>:<port>/api/admin/users

When the details query parameter is set to true, the response payload will include the tenantName property.

https://<myserver>:<port>/api/admin/users?details=true

Method

GET

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a non-load balancer deployment, or the machine hosting the load balancer for a load balancer deployment. For a non-load balancer deployment, <port> is the port number specified as the Server Access Port during deployment. For a load balancer deployment, <port> must be either 80 for http or 443 for https. Whenever port 80 or 443 are used, it is not necessary to include the port number in the URL.

Response Definition

The response takes the following format. The properties of the response are described in the table that follows.

{
  "users": [
    {
      "id": user_account_id,
      "userName": "user_account_name",
      "tenantId": tenant_id,
      "tenantName": "tenant_name",
      "statusInfo": {status_information},
      "passwordInfo": {password_information},
      "permissions": {permissions}
    },
    ...
  ]
}
Property Description Valid Values
"id" The ID of the user account. The ID is auto-generated when the user account is created and cannot be changed.
"userName" The name of the user account. The maximum length is 128 characters.
"tenantId" The ID of the tenant to which the user belongs. A valid tenant ID.
"tenantName" The name of the tenant to which the user belongs.
Note: Included when the details query parameter is set to true (?details=true).
 A string that specifies the name of the tenant.
"statusInfo" The status of the user account defined by the status property and additional properties associated with an account lockout policy. See statusInfo Object for details.
"passwordInfo" Password information associated with the user account defined by the password, passwordStatus, and passwordExpiration properties. See passwordInfo Object for details.
"permissions" Permissions associated with the user account in terms of the role(s) and permissions set explicitly on the account. User account permissions are the sum of the permissions on associated role(s) and permissions set explicitly on the account. Roles must belong to the tenant in which the user is being created. See permissions Object for details.

Sample Server Success Response

Note: The response will not return settings for optional properties that were not set in a previous POST or PUT request.

      Status code: 200
      Successful response
            
{
    "users": [
        {
            "id": 1,
            "userName": "d2cadmin",
            "tenantId": 1,
            "statusInfo": {
                "status": 1,
                "accountLocked": false
            },
            "permissions": {
                "roles": [
                    1
                ]
            }
        },
        {
            "id": 62,
            "userName": "OrgA_Admin",
            "tenantId": 26,
            "statusInfo": {
                "status": 1,
                "accountLocked": false
            },
            "permissions": {
                "roles": [
                    86
                ]
            }
        },
        {
            "id": 73,
            "userName": "OrgB_Admin",
            "tenantId": 29,
            "statusInfo": {
                "status": 1,
                "accountLocked": false
            },
            "permissions": {
                "roles": [
                    94
                ]
            }
        }
    ]
}

Sample Server Failure Response 

{
   "error":{
      "code":222206007,
      "message":{
         "lang":"en-US",
         "value":"Invalid user ID or password."
      }
   }
}

Authentication

Basic Authentication using Login ID and Password

Authorization

The user must have the Administrator (12) permission, or the ViewUsers (14) permission and administrative access on the tenant.