Skip to main content

Update the certificate for SAML authentication

PUT https://deploygate.com/api/enterprises/{WORKSPACE_NAME}/saml_settings/update_certificate

Update the certificate for SAML authentication.


Our SAML SSO only supports one certificate at a time.

Please note that you may experience some authentication downtime while DeployGate and your Identity Provider (IdP) complete the certificate rotation.

Path Params

NameTypeRequiredDescription
WORKSPACE_NAMEstringtrueName of Workspace

Body

NameTypeRequiredDescription
idp_certfiletrueNew certificate file. It must be an X.509 format file.

Example

curl \
-X PUT \
--url "https://deploygate.com/api/enterprises/${WORKSPACE_NAME}/saml_settings/update_certificate" \
-H "Authorization: Bearer ${API_TOKEN}" \
-F "idp_cert=@/path/to/certificate"

Result 200

{
"results": {
"idp_display_name": "Example IdP",
"idp_entity_id": "https://example.com/idp/unique_id",
// New certificate’s content
"idp_cert": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
// SHA256 fingerprint of a new certificate
"idp_cert_fingerprint_sha256": "A0:.........:Z9",
"idp_sso_target_url": "https://example.com/idp/saml/sso",
"idp_slo_target_url": "https://example.com/idp/saml/slo",
"make_enable": true
}
}