From df4eba4654fc8d6c732134579e389735673eaca9 Mon Sep 17 00:00:00 2001 From: Mihai Doarna Date: Wed, 29 Nov 2023 17:57:29 +0200 Subject: [PATCH] Add documentation for the SSO settings delete API method (#78521) add documentation for the sso settings delete API method --- .../developers/http_api/sso-settings.md | 63 +++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 docs/sources/developers/http_api/sso-settings.md diff --git a/docs/sources/developers/http_api/sso-settings.md b/docs/sources/developers/http_api/sso-settings.md new file mode 100644 index 00000000000..25d337104a8 --- /dev/null +++ b/docs/sources/developers/http_api/sso-settings.md @@ -0,0 +1,63 @@ +--- +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 +--- + +# 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**: + +```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