Previous Topic: Authentication Header ElementsNext Topic: SOAP Header Namespace


Authorization Header Elements

The following table lists the elements that you must pass in the call header for authorization.

Element

Mandatory

Description

authToken

Yes

The authentication token that is returned after successful user verification. This token indicates that the user is already authenticated, and thereby eliminates the need for user credentials for successive authentication attempts.

By default, the authentication token is valid for one day, after which you need to authenticate again.

Note: You can set any one of the following elements.

targetorg

No

The organization to which your calling application must authorize before performing any operation.

Note: If you want to enable authorization for more than one organization, then repeat this entry for every organization.

targetAllOrgs

No

Indicates whether authorization is required before operations on all organizations can be performed. Set the value of this element to TRUE to enable authorization for all organizations.

globalEntity

No

Indicates whether authorization is required for performing global configurations. Set this value to TRUE if you want to enable authorization for the global configuration operations, such as fetching attributes for users and fetching UDS attributes.