Purpose

Updates information on a user account

URL

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

Method

PUT

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.

Request Definition

{
    "userName": "user_name",
    "tenantId": tenant_id,
    "statusInfo": {status_information},
    "passwordInfo": {password_information},
    "permissions": {permissions},
    "authenticationInfo": {authentication_information}
    }
Property Description Usage Valid Values
"userName" The name of the user account Required The maximum length is 128 characters.
"tenantId" The ID of the tenant to which the user belongs Optional 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.
"statusInfo" The status of the user account defined by the status property and additional properties associated with an account lockout policy. Required See statusInfo Object for details.
"passwordInfo" Password information associated with the user account defined by the password, passwordStatus, and passwordExpiration properties. Optional 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. Optional 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). Optional See authenticationInfo Object for details.

Sample Payload Request

Note: Optional properties not included in the payload request will be removed from the object.
{
    "userName": "testuser",
    "tenantId": 1,
    "statusInfo": {
        "status": 1,
        "accountLocked": false
    },
    "passwordInfo": {
        "passwordStatus": 1,
        "passwordExpiration": "2025-01-01 00:00:00"
    },
    "permissions": {
        "roles": [
            1
        ]
    }
}

Sample Server Success Response 


      Status code: 200
      Successful response
            
{
    "userName": "testuser",
    "tenantId": 1,
    "statusInfo": {
        "status": 1,
        "accountLocked": false
    },
    "passwordInfo": {
        "passwordStatus": 1,
        "passwordExpiration": "2025-01-01 00:00:00"
    },
    "permissions": {
        "roles": [
            1
        ]
    },
    "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 ModifyUsers (15) permission and administrative access on the tenant.

Note: Administrator users cannot grant permissions they do not have to other user accounts.