SSOプロバイダ無効化

有効化中のSSOプロバイダを無効化してログイン画面の入口から外します。設定値はそのまま保持され、再び有効化APIを呼び出すと同じ設定で再度有効化されます。

必要な権限

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

HTTPリクエスト

cURL例

curl -H "Authorization: Bearer <API_KEY>" \
     -X PUT \
     https://HOSTNAME/api/sonar/id-providers/saml/disable

リクエストパラメータ

パスパラメータ

正常応答

{}

エラー応答

idが指定されていない場合

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": "ID provider config not found: saml"
}

権限がない場合

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

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