SSOプロバイダ作成

インストールされたSSOプロバイダの設定を新たに登録します。作成された設定は無効化状態で保存されるため、有効化APIを呼び出してから実際のログインで使用できます。

必要な権限

ADMIN以上のロールが必要です。同じSSOプロバイダの設定が既に存在する場合は作成できず、システムに登録されたSSOプロバイダ設定の総数が制限値を超える場合は拒否されます。

HTTPリクエスト

cURL例

curl -H "Authorization: Bearer <API_KEY>" \
     -H "Content-Type: application/json" \
     -X POST \
     -d '{
           "description": "本社SAML IdP連携",
           "configs": {
             "idp_url": "https://idp.example.com/saml",
             "client_secret": "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 already exists: saml"
}

登録可能なSSOプロバイダ数を超えた場合

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

{
  "error_code": "illegal-state",
  "error_msg": "sso provider count exceeds N limit"
}

必須設定項目が指定されていない場合

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

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

権限がない場合

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

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