sso-connections

Update SSO connection

Updates an enterprise single sign-on connection. clientSecret is optional: when provided, it replaces the stored secret; when omitted, the existing secret is left unchanged.

Notes.

  • Changing emailDomains, issuer or clientId clears domainsVerifiedAt (the DNS proof vouches for the IdP too; publish the new challenge and verify again). Changing issuer, clientId, clientSecret or emailDomains clears provenAt.
patch/v1/sso-connections/{id}

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/sso-connections/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

SSO connection id.

Request body

displayNamestring
vendorstring

Free text, e.g. okta, entra.

issuerstring

Must start with https://. A trailing slash is removed.

clientIdstring
clientSecretstring

Replaces the stored secret. Omitted or empty keeps it.

emailDomainsstring

Comma-separated email domains, e.g. acme.com,acme.org.

jitProvisioningboolean

Default true.

enabledboolean

Default true.

defaultRoleIdstring nullable

You must be able to grant this role for the whole workspace.

extraScopesstring nullable

Space- or comma-separated scope tokens (at most 20). Null or empty clears them.

Response

Success.

Changes

No recorded changes to this operation across all 2 revisions of this API.