Skip to content

SaveSsoConnection

PUT
/api/v1/t/{tenant}/identity/sso
curl --request PUT \
--url https://example.com/api/v1/t/example/identity/sso \
--header 'Content-Type: application/json' \
--data '{ "provider": "EntraId", "domain": "example", "defaultRoleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "clientId": "example", "clientSecret": "example", "directoryId": "example", "discoveryUrl": "example", "metadataUrl": "example", "version": 1 }'
tenant
required
string

Tenant slug

Media typeapplication/json
object
provider
required
Allowed values: EntraId Google Oidc Saml
domain
required
string
defaultRoleId
required
string format: uuid
clientId
null | string
clientSecret
null | string
directoryId
null | string
discoveryUrl
null | string
metadataUrl
null | string
version
null | integer format: uint32

OK

Media typeapplication/json
object
id
required
string format: uuid
provider
required
Allowed values: EntraId Google Oidc Saml
domain
required
string
domainState
required
Allowed values: Unverified Verified Lost
verifiedAt
required
null | string format: date-time
lastCheckedAt
required
null | string format: date-time
verificationRecordHost
required
string
verificationRecordValue
required
string
redirectUri
required
string
clientId
required
null | string
directoryId
required
null | string
discoveryUrl
required
null | string
metadataUrl
required
null | string
hasClientSecret
required
boolean
defaultRoleId
required
string format: uuid
enforced
required
boolean
breakGlassUserId
required
null | string format: uuid
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
version
required
integer format: uint32
Example
{
"provider": "EntraId",
"domainState": "Unverified"
}

Bad Request

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
errors
object
key
additional properties
Array<string>
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example",
"errors": {
"additionalProperty": [
"example"
]
}
}

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Conflict

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}