SSOプロバイダ修正

登録済みSSOプロバイダの説明と設定値を更新します。有効化中のプロバイダ設定を変更すると、必須項目の検証も併せて実行されます。

必要な権限

ADMIN以上のロールが必要です。

HTTPリクエスト

cURL例

curl -H "Authorization: Bearer <API_KEY>" \
     -H "Content-Type: application/json" \
     -X PUT \
     -d '{
           "description": "本社SAML IdP連携 (更新)",
           "configs": {
             "idp_url": "https://idp.example.com/saml",
             "client_secret": "new-secret-value"
           }
         }' \
     https://HOSTNAME/api/sonar/sso-providers/saml

リクエストパラメータ

パスパラメータ

リクエスト本文パラメータ

正常応答

{}

エラー応答

idまたはconfigsが指定されていない場合

HTTPステータスコード 400 応答

{
  "error_code": "null-argument",
  "error_msg": "id should be not null"
}

プロバイダが存在しない場合

HTTPステータスコード 500 応答

{
  "error_code": "illegal-argument",
  "error_msg": "provider not found: saml"
}

登録された設定がない場合

HTTPステータスコード 500 応答

{
  "error_code": "illegal-state",
  "error_msg": "SSO provider config not found: saml"
}

有効化中のプロバイダで必須設定が指定されていない場合

HTTPステータスコード 400 応答

{
  "error_code": "invalid-argument",
  "error_msg": "idp_url is required"
}

権限がない場合

HTTPステータスコード 500 応答

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}