- URL:https://<root>/security/saml
- Operations:Update
- Required Capability:Default administrator role | Security and infrastructure
- Version Introduced:10.9
Description
The saml resource returns information about the SAML configuration for an organization. If SAML is configured, the enabled property will return as true and identityCertificateName will show the name of the imported identity certificate. For more information about setting up SAML logins, see Configure security settings. You can modify the properties returned by this resource using the update operation.
Note:
To configure SAML logins, the imported SAML identity certificate must be named samlcert.
Request parameters
Parameter | Details |
---|---|
f | The response format. The default format is html. Values: html | json | pjson |
Example usage
The following is a sample request URL used to access the saml resource:
https://organization.domain.com/context/admin/security/saml?f=pjson
JSON Response example
{
"enabled": true
"identityCertificateName": "samlcert"
}