Disable Identity Provider

Disables an enabled Identity provider, removing it from the sign-in entry points. The configuration values are preserved, so calling the enable endpoint again restores the same configuration.

Required Permissions

Requires the ADMIN role or higher.

HTTP Request

PUT /api/sonar/sso-providers/:code/disable
cURL Example
curl -H "Authorization: Bearer <API_KEY>" \
     -X PUT \
     https://HOSTNAME/api/sonar/id-providers/saml/disable
Request Parameters
Path Parameters
KeyTypeDescriptionNotes
idStringIdentity provider identifier

Success Response

{}

Error Responses

id is missing

HTTP status code 400

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

HTTP status code 500

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

HTTP status code 500

{
  "error_code": "illegal-state",
  "error_msg": "Identity provider config not found: saml"
}
Permission denied

HTTP status code 500

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