Purpose

Retrieves information on a user account

URL

https://<myserver>:<port>/api/admin/users/{id}

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

https://<myserver>:<port>/api/admin/users/{id}?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.

The URL parameter "id" described in the following table is required.
Parameter 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.

Response Definition

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

{
   "id": user_account_id,
   "userName": "user_account_name",
   "tenantId": tenant_id,
   "tenantName": "tenant_name",
   "statusInfo": {status_information},
   "passwordInfo": {password_information},
   "permissions": {permissions},
   "authenticationInfo": {authentication_info},
   "tenantsAdministered": {tenant_id,tenant_id,...}
}
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. 1 | x

1 is the ID for the system tenant.

x is the ID for a tenant created by an administrator. The ID is auto-generated when the tenant is created and cannot be changed.
"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. See permissions Object for details.
"authenticationInfo" Authentication information associated with the user account as defined by the authUserName and authServiceId properties. The authenticationInfo object does not need to be included in a request payload when the default internal authentication service is being used. When an external authentication service is being used, authenticationInfo must be included in the request payload. If authenticationInfo is not passed, a default authenticationInfo object is created where the userName of the account object is used as the authUserName and the authServiceId specifies the ID of the internal authentication service (1). See authenticationInfo Object for details.
"tenantsAdministered" The ID or IDs of the tenants that the user administers.
Note: Included when the details query parameter is set to true (?details=true).
 A valid tenant ID or comma-separated list of valid tenant IDs.

Sample Server 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
            
{
    "id": 3,
    "userName": "testuser",
    "tenantId": 1,
    "statusInfo": {
        "status": 1,
        "accountLocked": false
    },
    "passwordInfo": {
        "passwordStatus": 1,
        "passwordExpiration": null
    },
    "permissions": {
        "roles": [
            2
        ]
    },
    "authenticationInfo": {
        "authUsers": [
            {
                "authUserName": "testuser",
                "authServiceId": 1
            }
        ]
    }
}

Sample Server Failure Response 

{
   "error":{
      "code":222207916,
      "message":{
         "lang":"en-US",
         "value":"There is no User with that id: 123."
      }
   }
}

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.