メインコンテンツまでスキップ

SAML認証の公開鍵証明書を更新する

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

SAML認証の公開鍵証明書を更新する


同時に2つ以上の証明書は利用できません

DeployGateとご利用の認証プロバイダ(IdP: Identity Provider)の両方で証明書の変更が完了するまで、認証に関してダウンタイムが発生することをご留意の上で本APIを利用してください。

Path Params

NameTypeRequiredDescription
WORKSPACE_NAMEstringtrueワークスペース名

Body

NameTypeRequiredDescription
idp_certfiletrue新しい証明書ファイル。公開鍵証明書はX.509形式である必要があります。

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",
// 新しい公開鍵証明書の内容
"idp_cert": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
// 公開鍵証明書のSHA256フィンガープリント
"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
}
}