Security methods

showCurrentSession()

Retrieves information about the current session.

Input

NONE

Response

Session (D)

Availability

Engage 7.3.3

Errors returned

No non-standard errors

listAccessibleOrgs(User user)

Retrieves the organizations that this user has access to.

Input

user: externalId of user

Response

Org[] (D)

Availability

Future

Errors returned

RESULT_TOO_LARGE – Result returned would be too large

Notes

• If authenticated at the account level this entry point returns an array containing a single org which is the current Account.
• If authenticated at the enterprise level this entry point currently returns an array containing a single org which is the current Enterprise.
• The maximum number of items returned using this method is 1,000.

createSecurityToken(SecurityToken securityToken)

Creates security token with given userid and time-to-live, in milliseconds.

Input

securityToken: timeToLive & attribute userId

Response

SecurityToken[] (D)

Availability

11.9

Errors returned

• OBJECT_NOT_EXISTS – if non existing userid is provided
• ARG_NULL – if null input is given
• ATTRIBUTE_NULL- if null required input is given
• NO_SESSION- if logged in user is not found

validateSecurityToken(SecurityToken securityToken)

Validates the security token with the given attributes.

Input

securityToken: attribute url or token signature , expires , attributes (used to generate token)

Response

NONE or errors

Availability

11.9

Errors returned

• ARG_NULL – if null input is given
• ATTRIBUTE_NULL- if null required input is given
• INVALID_MAC – error in validating MAC

invalidateSecurityToken(SecurityToken securityToken)

Invalidates the given security token.

Input

securityToken: signature

Response

NONE

Availability

11.9

Errors returned

• OBJECT_NOT_EXISTS – If non existing MAC is provided.
• ARG_NULL – if null input is given
• ATTRIBUTE_NULL- if null required input is given