<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.
Request Payload Properties
The request takes the following format. The properties of the request are described in the table that follows.
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. A user account may only be assigned roles in their tenant.
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).
Example 1 payload request The following example shows a payload request to create a user account that uses the internal authentication service. In this scenario, the end user would authenticate with the username associated with the user account (testuser).
Example 2 payload request The following example shows a payload request to create a user account using an external authentication service. Here the end user (user_external) authenticates via an external authentication service ("authServiceId": 2). This end user inherits all the attributes associated with the testuser account.
Example 3 payload request The following payload request creates a user account that supports both the internal authentication service or an external authentication service. The end user testuser may authenticate through the internal authentication service. Alternatively, the end user user_external can, with a distinct set of credentials, authenticate via the external authentication service "authServiceId": 2.
