Single Sign-On

Update SSO Connection

patch/api/v1/sso

Request body

clientIDstring required

Client ID for the connection

clientSecretstring required

Client Secret for the connection

namestring

Name/identifier for the connection

labelstring

An internal label to identify the connection

descriptionstring

A short description for the connection not more than 100 characters

encodedRawMetadatastring

Base64 encoding of the XML metadata

rawMetadatastring

Raw XML metadata

metadataUrlstring

URL containing raw XML metadata

oidcDiscoveryUrlstring

well-known URL where the OpenID Provider configuration is exposed

oidcMetadatastring

metadata (JSON) for the OpenID Provider in the absence of discoveryUrl

oidcClientIdstring

clientId of the application set up on the OpenID Provider

oidcClientSecretstring

clientSecret of the application set up on the OpenID Provider

defaultRedirectUrlstring

The redirect URL to use in the IdP login flow

redirectUrlstring[]

JSON encoded array containing a list of allowed redirect URLs

tenantstring required

Tenant

productstring required

Product

deactivatedboolean

Connection status

sortOrdernumber

Indicate the position of the connection in the IdP selection screen

acsUrlOverridestring

Override the global ACS URL on a per connection basis

samlAudienceOverridestring

Override the global SAML Audience on a per connection basis

forceAuthnboolean

Require a new authentication instead of reusing an existing session.

Response

Success

Changes