Skip to main content
POST
Link Open Id Connect

Authorizations

X-Authorization
string
header
required

This API requires a client session ticket, available from any Client Login function.

Body

application/json
ConnectionId
string
required

A name that identifies which configured OpenID Connect provider relationship to use. Maximum 100 characters.

IdToken
string
required

The JSON Web token (JWT) returned by the identity provider after login. Represented as the id_token field in the identity provider's response. Used to validate the request and find the user ID (OpenID Connect subject) to link with.

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

If another user is already linked to a specific OpenId Connect user, unlink the other user and re-link.

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Last modified on October 1, 2026