skip to main content
Hybrid Data Pipeline API reference : Administrators API : Users API : Update authentication information
  

Try Now
Update authentication information

Purpose

Updates authentication information on a user account. Allows an administrator to modify the authentication user(s) and service(s) that belong to the user account.

URL

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

Method

PUT

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a standalone installation, or the machine hosting the load balancer for a load balancer installation. For a standalone installation, <port> is the port number specified as the Server Access Port during installation. For a load balancer installation, <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 Payload Definition

The request takes the following format. The properties of the request are described in the table that follows.
{
"authUsers": [
{
"authUserName": "string",
"authServiceId": integer
},
...
]
}
Property
Description
Usage
Valid Values
"authUserName"
The name of the authentication user.
Required
A string where the string specifies a user name persisted by the authentication service. The maximum length is 128 characters.
"authServiceId"
The ID of the authentication service against which the user is authenticating.
Required
1 | x
1 is the ID for the default internal authentication service.
x is an auto-generated ID for an external authentication service implemented by an administrator.

Sample Payload Request

{
"authUsers": [
{
"authUserName": "user_1",
"authServiceId": 43
},
{
"authUserName": "user_2",
"authServiceId": 43
}
]
}

Sample Server Response


Status code: 200
Successful response
{
"authUsers": [
{
"authUserName": "user_1",
"authServiceId": 43
},
{
"authUserName": "user_2",
"authServiceId": 43
}
]
}

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.