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. |
URL
|
Resource information
HTTP method |
Content type |
---|---|
POST |
application/x-www-form-urlencoded |
Body parameters
concurrentSession=true&apiUse=true&SAMLResponse=PHNhb...
|
All body parameters should be encoded in key-value pairs, separated by an ampersand (&). Each key and value should be separated by an equals symbol (=). |
Parameter |
Description |
---|---|
SAMLResponse |
The SAML response from the ldP Type: String Mandatory: Yes |
apiUse |
Always send with value Type: Boolean Mandatory: Yes Valid values: True |
concurrentSession |
Set this parameter to Type: Boolean Mandatory: No Valid values: True/False Default: False |
Result
|
This method returns the session token.
Return codes
For a complete list of return codes, see Return Codes.