/saml
v1 Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| POST /saml/authn_request/{idp_name} | Make a SAML authentication request for a specified IdP Authentication Domain. | Available | |
| POST /saml/authn_request_gps | Make a SAML authentication request to Polaris for Federated Login. Federated login enables the inheritance of user roles and privileges from Polaris to CDM clusters registered on Polaris. | Available | |
| GET /saml/encryption_certificate | Gets the encryption certificate ID if a custom certificate has been set. If a custom encryption certificate has not been set (the default certificate is being used) this api retuns an empty string. | Available | |
| PUT /saml/encryption_certificate | Sets encryption certificate for SSO. | Available | |
| DELETE /saml/encryption_certificate | Unsets any previously set encryption certificate. As a result, SSO relies on the default certificate. | Available | |
| PUT /saml/gps_metadata | Provide GPS SAML metadata and generate the SAML metadata for this Rubrik cluster, and return it. | Restricted | |
| DELETE /saml/gps_metadata | Remove GPS SAML metadata registration, and disable federated login with GPS. | Restricted | |
| POST /saml/rubrik_metadata | Configure and generate the SAML metadata for this Rubrik cluster. The call returns the download URL for the metadata. | Available | |
| GET /saml/signing_certificate | Gets the signing certificate ID if a custom certificate has been set. If a custom signing certificate has not been set (the default certificate is being used) this api retuns an empty string. | Available | |
| PUT /saml/signing_certificate | Sets the signing certificate for SSO. | Available | |
| DELETE /saml/signing_certificate | Unsets any previously set signing certificate. As a result, SSO relies on the default certificate. | Available | |
| GET /saml/sso_status | An object that contains two values. A Boolean value that determines whether or not SSO is enabled and an optional String value that indicates the name of the default IdP authentication domain for SSO login. When the boolean value is 'true', SAML SSO is enabled. When the Boolean value is 'false', SAML SSO is disabled. | Available |