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

Try Now

Users API

The Users API can be used to provision and manage Hybrid Data Pipeline user accounts. Administrators can also use the Users API to set permissions on user accounts, assign roles to user accounts, and configure authentication for user accounts.
When working with Hybrid Data Pipeline user accounts, it is important to note that two types of authentication services are supported. First, an end user may use the default internal authentication service. In this case, the end user authenticates directly with Hybrid Data Pipeline by passing the username and password associated with a user account. Alternatively, a Hybrid Data Pipeline user account can be associated with an external authentication service. In this case, multiple end users can be associated with a single Hybrid Data Pipeline user account through the external authentication service. These end users inherit the permissions attached to the Hybrid Data Pipeline user account. (See Authentication and Authentication API for details.)
Any user with the Administrator (12) permission is in effect a system administrator and has permission to perform any operation available in Hybrid Data Pipeline. They are in effect a super user. It is strongly recommended that these accounts be secured. Other administrator accounts should be created with only the permissions they need. System administrators can create, view, modify, and delete user accounts in all tenants across the system. In contrast, administrator users who do not have the Administrator permission must be granted permissions for specific operations and administrative access to the tenant which they are administering.
Note: Users in the default system tenant can be promoted to administer multiple tenants across the system. However, users in non-system tenants can only be promoted to administer users within their own tenant. They cannot administer users in other tenants.
The following table summarizes Users API operations.
Operation
Request
URL
GET
https://<myserver>:<port>/api/admin/users
POST
https://<myserver>:<port>/api/admin/users
GET
https://<myserver>:<port>/api/admin/users/{id}
PUT
https://<myserver>:<port>/api/admin/users/{id}
DELETE
https://<myserver>:<port>/api/admin/users/{id}
GET
https://<myserver>:<port>/api/admin/users/{id}/statusinfo
PUT
https://<myserver>:<port>/api/admin/users/{id}/statusinfo
GET
https://<myserver>:<port>/api/admin/users/{id}/passwordinfo
PUT
https://<myserver>:<port>/api/admin/users/{id}/passwordinfo
PUT
https://<myserver>:<port>/api/admin/users/{id}/resetpassword
GET
https://<myserver>:<port>/api/admin/users/{id}/permissions
PUT
https://<myserver>:<port>/api/admin/users/{id}/permissions
GET
https://<myserver>:<port>/api/admin/users/{id}/authinfo
PUT
https://<myserver>:<port>/api/admin/users/{id}/authinfo
GET
https://<myserver>:<port>/api/admin/users/authUserName/{auth_user_name}
GET
https://<myserver>:<port>/api/admin/users/{userid}/datasources
GET
https://<myserver>:<port>/api/admin/users/{id}/tenantsadministered
PUT
https://<myserver>:<port>/api/admin/users/{id}/tenantsadministered
* Get user accounts
* Create a user account
* Get a user account
* Update a user account
* Delete a user account
* Get status info on a user account
* Update status info on a user account
* Get password info on a user account
* Update password info on a user account
* Reset the password on a user account
* Get permissions on a user account
* Update permissions on a user account
* Get authentication information
* Update authentication information
* Get information on the authentication user
* Get data sources for a user account
* Get tenants administered
* Update tenants administered