Sign in

v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB
SSO Connections

Update SSO connection

Update the status or metadata of an existing SSO identity provider connection.

patch/auth/sso/connections/{connectionId}

Path parameters

connectionIdstring uuid required

Unique identifier of the SSO connection.

Headers

x-idempotency-keystring uuid required

Idempotency key to be used. Sending again the same key would return the same result without re-executing the update.

Content-Typestring required

Content Type key to indicate the original media type of the resource.

Request body

OR
OR

Response

Success.

idstring uuid required

Unique identifier of the SSO connection.

referencestring required

Identifier assigned by the downstream identity provider.

type'SAML' required

Identity provider connection type.

status'enabled' | 'disabled' required

Lifecycle status of the connection.

namestring required

Internal name assigned to the connection.

displayNamestring required

Display label returned to clients initiating SSO.

provider'auth0' | 'jumpcloud' | 'microsoft' | 'okta' required

Allowed/Supported SSO providers.

createdAtstring date-time required

ISO-8601 timestamp when the connection was created.

updatedAtstring date-time required

ISO-8601 timestamp when the connection was last updated.