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.

The following table summarizes Users API operations.