SAML logon

This method authenticates a user to the Vault using SAML authentication and returns a token that can be used in subsequent web services calls.

 

To make this API available, you need to enable the SAML IdP initiated SSO flow. For details, see Configure the IdP.

URL

 
https://<IIS_Server_Ip>/PasswordVault/API/auth/SAML/Logon

Resource information

HTTP method

POST

Content type

application/x-www-form-urlencoded

Body parameters

  concurrentSession=true&apiUse=true&SAMLResponse=PHNhb...
 

All body parameters should be encoded in key-value tuples separated by &.

Each key and value should be separated by =.

Parameter

Description

SAMLResponse

The SAML response from the ldP

Type: string

Mandatory: yes

apiUse

Always send with value true.

Type: boolean

Mandatory: yes

Valid values: true

concurrentSession

Set this parameter to true to enable the user to open multiple connection sessions simultaneously. Up to 300 concurrent sessions are supported.

Type: boolean

Mandatory: no

Valid values: true/false

Default: false

Result

 
{ 

"<session token>"

}

This method returns the session token.

Return codes

For a complete list of return codes, see Return Codes.