Skip to main content
PUT
/
api
/
v1
/
org
/
sso
/
azuread
Error
A valid request URL is required to generate request examples
{
  "results": {
    "oauth2ClientId": "<string>",
    "oauth2TenantId": "<string>",
    "allowPassword": true,
    "emailDomains": [
      "<string>"
    ],
    "overrideEmailDomains": true,
    "enabled": true,
    "hasClientSecret": true
  },
  "status": "ok"
}

Documentation Index

Fetch the complete documentation index at: https://docs.lightdash.com/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json

Make all properties in T optional

ā€‹
oauth2TenantId
string
required
ā€‹
oauth2ClientId
string
required
ā€‹
oauth2ClientSecret
string

When omitted on update, the stored secret is preserved. Required on create.

ā€‹
enabled
boolean

When false the method is hidden from precheck even if discovery would match.

ā€‹
overrideEmailDomains
boolean

When true, the method's own emailDomains list governs discovery. When false, the org's allowed_email_domains is used instead.

ā€‹
emailDomains
string[]

Strict whitelist (only consulted when overrideEmailDomains is true).

ā€‹
allowPassword
boolean

Controls whether email+password sign-in is shown alongside this method when it matches a user. When multiple matching SSO methods disagree, lenient rule applies (ANY method that allows ā†’ show password).

Response

Ok

ā€‹
results
object
required

Per-row flags shared by every SSO method configured at the org level. Stored as plain columns alongside the encrypted provider-specific config.

ā€‹
status
enum<string>
required
Available options:
ok