authenticationInfo Object

Purpose

Describes authentication information for 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 only 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 system object is used as the authUserName and the authServiceId specifies the ID of the internal authentication service (1).

Syntax

{
        "authUsers": [
            {
                "authUserName": "string",
                "authServiceId": integer
            },
            ...
        ]
}