Project: Grafana (Observability and Analysis / Observability)
File: sso-settings.md

aliases: ../../http_api/sso-settings/ ../../http_api/ssosettings/ canonical: /docs/grafana/latest/developers/http_api/sso-settings/ description: Grafana SSO Settings API keywords: grafana http documentation api sso sso-settings labels: products: enterprise oss title: SSO Settings API If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to for more information. {{% admonition type="note" %}} Available in Public Preview in Grafana 10.4 and on Grafana Cloud behind the `ssoSettingsApi` feature toggle. {{% /admonition %}} The API can be used to create, update, delete, get, and list SSO Settings. `GET /api/v1/sso-settings` Lists the SSO Settings for all providers. Required permissions See note in the for an explanation. | Action | Scope | | | - | | `settings:read` | `settings:auth.{provider}:*` | Example Request: ```http GET /api/v1/sso-settings HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ``` Example Response: ```http HTTP/1.1 200 Content-Type: application/json [ { "id": "1", "provider": "github", "settings": { "apiUrl": "https://api.github.com/user", "clientId": "mygithubclient", "clientSecret": "*", "enabled": true, "scopes": "user:email,read:org" // rest of the settings }, "source": "system", }, { "id": "2", "provider": "azuread", "settings": { "authUrl": "https://login.microsoftonline.com/00000000-0000-0000-0000-000000000000/oauth2/v2.0/authorize", "clientId": "myazureadclient", "clientSecret": "*", "enabled": true, "scopes": "openid,email,profile" // rest of the settings }, "source": "system", } ] ``` Status Codes: 200 SSO Settings found 400 Bad Request 401 Unauthorized 403 Access Denied `GET /api/v1/sso-settings/:provider` Gets the SSO Settings for a provider. Required permissions See note in the for an explanation. | Action | Scope | | | - | | `settings:read` | `settings:auth.{provider}:*` | Example Request: ```http GET /api/v1/sso-settings/github HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ``` Example Response: ```http HTTP/1.1 200 Content-Type: application/json ETag: db87f729761898ee { "id": "1", "provider": "github", "settings": { "apiUrl": "https://api.github.com/user", "clientId": "mygithubclient", "clientSecret": "*", "enabled": true, "scopes": "user:email,read:org" // rest of the settings }, "source": "system", } ``` Status Codes: 200 SSO Settings found 400 Bad Request 401 Unauthorized 403 Access Denied 404 SSO Settings not found `PUT /api/v1/sso-settings/:provider` Updates the SSO Settings for a provider. Required permissions See note in the for an explanation. | Action | Scope | | - | - | | `settings:write` | `settings:auth.{provider}:*` | Example Request: ```http PUT /api/v1/sso-settings/github HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk { "settings": { "apiUrl": "https://api.github.com/user", "clientId": "mygithubclient", "clientSecret": "mygithubsecret", "enabled": true, "scopes": "user:email,read:org" } } ``` Example Response: ```http HTTP/1.1 204 Content-Type: application/json ``` Status Codes: 204 SSO Settings updated 400 Bad Request 401 Unauthorized 403 Access Denied `DELETE /api/v1/sso-settings/:provider` Deletes an existing SSO Settings entry for a provider. Required permissions See note in the for an explanation. | Action | Scope | | - | - | | `settings:write` | `settings:auth.{provider}:*` | Example Request: ```http DELETE /api/v1/sso-settings/azuread HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ``` Example Response: ```http 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