Authentication

Quick Navigation

POST Auth/SignAppin

Purpose

Authenticates the provided credentials and creates a user session.

Required Permissions

A user group to which the user belongs must be granted access to the API key given in authorization header. Must be running script from a valid source address as configured in API registration for the given API key.

Request Body

None.

Response Body

Content-Type: application/json

{
    UserId: int,
    SID: string,
    EmailAddress: string,
    UserName: string,
    Name: string
}

Response Codes

  • 200 – Request successful. User model in the response body.
  • 403 – Access forbidden. Returned if the Password Safe license is not valid.
  • 410 – API version has been disabled.

For more information, please see Common Response Codes.

POST Auth/Signout

Purpose

Terminates the current user session.

Required Permissions

None.

Request Body

None.

Response Body

None.

Response Codes

  • 200 – Request successful.

For more information, please see Common Response Codes.