opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-29 01:42:29 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
grafana/docs/sources/developers/http_api/sso-settings.md
Mihai Doarna df4eba4654 Add documentation for the SSO settings delete API method (#78521) 
add documentation for the sso settings delete API method
2023-11-29 17:57:29 +02:00

1.5 KiB
Raw Blame History

aliases canonical description keywords labels title
../../http_api/sso-settings/
../../http_api/ssosettings/
/docs/grafana/latest/developers/http_api/sso-settings/ Grafana SSO Settings API
grafana
http
documentation
api
sso
sso-settings
products
enterprise
oss
SSO Settings API

SSO Settings API

If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information.

The API can be used to create, update, delete, get, and list SSO Settings.

Delete SSO Settings

DELETE /api/v1/sso-settings/:provider

Deletes an existing SSO Settings entry for a provider.

Required permissions

See note in the [introduction]({{< ref "#sso-settings" >}}) for an explanation.

Action Scope
settings:write settings:auth.{provider}:*

Example Request:

DELETE /api/v1/sso-settings/azuread HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Example Response:

HTTP/1.1 204
Content-Type: application/json

Status Codes:

  • 204 – SSO Settings deleted
  • 400 – Bad Request
  • 401 – Unauthorized
  • 403 – Access Denied
  • 404 – SSO Settings not found