Get OIDC settings

GET

/api/v1/instance/oidc

const url = 'https://example.com/api/v1/instance/oidc';
const options = {method: 'GET', headers: {cookie: 'ttx_access_token=<ttx_access_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/instance/oidc \
  --cookie ttx_access_token=<ttx_access_token>

The single sign-on settings.

Authorizations

sessionCookie

Responses

200

Successful Response

application/json

OidcSettingsRead

Platform -> Single sign-on. Never carries the client secret: has_client_secret says whether one is stored, client_secret_readable whether the current key still decrypts it.

object

active

required

Active

boolean

allow_jit

Allow Jit

boolean

client_id

Any of:

string
null

string

client_secret_readable

Client Secret Readable

boolean

default: true

configured

required

Configured

boolean

display_name

Any of:

string
null

string

enabled

Enabled

boolean

entra_tenant_id

Any of:

string
null

string

has_client_secret

Has Client Secret

boolean

issuer_url

Any of:

string
null

string

linked_accounts

Linked Accounts

integer

pinned_by_env

required

Pinned By Env

boolean

provider_kind

Any of:

string
null

string

Allowed values: entra generic

redirect_uri

required

Any of:

string
null

string

trust_provider_mfa

Trust Provider Mfa

boolean

default: true

updated_at

Any of:

string
null

string format: date-time

Example

{
  "allow_jit": false,
  "client_secret_readable": true,
  "enabled": false,
  "has_client_secret": false,
  "linked_accounts": 0,
  "provider_kind": "entra",
  "trust_provider_mfa": true
}