Save OIDC settings

PUT

/api/v1/instance/oidc

curl --request PUT \
  --url https://example.com/api/v1/instance/oidc \
  --header 'Content-Type: application/json' \
  --header 'X-CSRF-Token: <X-CSRF-Token>' \
  --cookie ttx_access_token=<ttx_access_token> \
  --data '{ "allow_jit": false, "client_id": "example", "client_secret": "example", "display_name": "example", "enabled": true, "entra_tenant_id": "example", "issuer_url": "example", "provider_kind": "entra", "trust_provider_mfa": true }'

Recorded (without the secret), with step-up: whoever chooses the provider chooses who can sign in.

Authorizations

• csrfToken
• sessionCookie

Request Body^required

Media typeapplication/json

OidcSettingsUpdateRequest

object

allow_jit

Allow Jit

boolean

client_id

required

Client Id

string

>= 1 characters <= 255 characters

client_secret

Any of:

string

string

<= 2000 characters

null

null

display_name

Any of:

string

string

<= 60 characters

null

null

enabled

Enabled

boolean

default: true

entra_tenant_id

Any of:

string

string

<= 36 characters

null

null

issuer_url

Any of:

string

string

<= 500 characters

null

null

provider_kind

Provider Kind

string

default: entra

Allowed values: entra generic

trust_provider_mfa

Trust Provider Mfa

boolean

default: true

Responses

200

Successful Response

Media typeapplication/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

string

null

null

client_secret_readable

Client Secret Readable

boolean

default: true

configured

required

Configured

boolean

display_name

Any of:

string

string

null

null

enabled

Enabled

boolean

entra_tenant_id

Any of:

string

string

null

null

has_client_secret

Has Client Secret

boolean

issuer_url

Any of:

string

string

null

null

linked_accounts

Linked Accounts

integer

0

pinned_by_env

required

Pinned By Env

boolean

provider_kind

Any of:

string

string

Allowed values: entra generic

null

null

redirect_uri

required

Any of:

string

string

null

null

trust_provider_mfa

Trust Provider Mfa

boolean

default: true

updated_at

Any of:

string

string format: date-time

null

null

Example

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

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example ^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}