Set OIDC settings

POST 
<your-unleash-url>/api/admin/auth/oidc/settings

Configure OpenID Connect as a login provider for Unleash.

Request

Responses

200

oidcSettingsResponseSchema

400

The request data does not match what we expect.

401

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

415

The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L '<your-unleash-url>/api/admin/auth/oidc/settings' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>' \
-d '{
  "enabled": true,
  "discoverUrl": "https://myoidchost.azure.com/.well-known/openid-configuration",
  "clientId": "FB87266D-CDDB-4BCF-BB1F-8392FD0EDC1B",
  "secret": "qjcVfeFjEfoYAF3AEsX2IMUWYuUzAbXO",
  "autoCreate": true,
  "enableSingleSignOut": true,
  "defaultRootRole": "Viewer",
  "defaultRootRoleId": 2,
  "emailDomains": "getunleash.io,getunleash.ai",
  "acrValues": "urn:okta:loa:2fa:any phr",
  "idTokenSigningAlgorithm": "RS256",
  "enableGroupSyncing": false,
  "groupJsonPath": "groups",
  "addGroupsScope": false
}'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Body required

{
  "enabled": true,
  "discoverUrl": "https://myoidchost.azure.com/.well-known/openid-configuration",
  "clientId": "FB87266D-CDDB-4BCF-BB1F-8392FD0EDC1B",
  "secret": "qjcVfeFjEfoYAF3AEsX2IMUWYuUzAbXO",
  "autoCreate": true,
  "enableSingleSignOut": true,
  "defaultRootRole": "Viewer",
  "defaultRootRoleId": 2,
  "emailDomains": "getunleash.io,getunleash.ai",
  "acrValues": "urn:okta:loa:2fa:any phr",
  "idTokenSigningAlgorithm": "RS256",
  "enableGroupSyncing": false,
  "groupJsonPath": "groups",
  "addGroupsScope": false
}

ResponseClear

Click the Send API Request button above and see the response here!