sso.updateSsoConnection

PATCH

/v1/organization/sso_connections/{connectionId}

curl --request PATCH \
  --url https://example.com/v1/organization/sso_connections/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expectedVersion": 1, "name": "example", "issuer": "example", "clientId": "example", "clientSecret": "example", "domains": [ "example" ], "enforce": true }'

Authorizations

• token
• session

Parameters

Path Parameters

connectionId

required

string

Request Body^required

Media typeapplication/json

object

expectedVersion

required

integer

<= 9007199254740991

name

string

>= 1 characters <= 120 characters

issuer

string

>= 1 characters

clientId

string

>= 1 characters <= 512 characters

clientSecret

Any of:

string

string

>= 1 characters <= 4096 characters

null

null

domains

Array<string>

>= 1 items <= 50 items

enforce

boolean

Example ^generated

{
  "expectedVersion": 1,
  "name": "example",
  "issuer": "example",
  "clientId": "example",
  "clientSecret": "example",
  "domains": [
    "example"
  ],
  "enforce": true
}

Responses

200

Success

Media typeapplication/json

object

id

required

string

name

required

string

issuer

required

string

clientId

required

string

clientSecret

required

object

set

required

boolean

hint

required

Any of:

string

string

null

null

domains

required

Array<string>

enforce

required

boolean

redirectUri

required

string

version

required

integer

<= 9007199254740991

createdAt

required

string

updatedAt

required

string

Example ^generated

{
  "id": "example",
  "name": "example",
  "issuer": "example",
  "clientId": "example",
  "clientSecret": {
    "set": true,
    "hint": "example"
  },
  "domains": [
    "example"
  ],
  "enforce": true,
  "redirectUri": "example",
  "version": 1,
  "createdAt": "example",
  "updatedAt": "example"
}

400

SsoConnectionInvalid | OrganizationRequired

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: SsoConnectionInvalid

message

required

string

object

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "SsoConnectionInvalid"
}

401

AuthenticationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "Forbidden"
}

404

DomainNotFound | SsoConnectionNotFound

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: DomainNotFound

domain

required

string

object

object

_tag

required

string

Allowed values: SsoConnectionNotFound

connectionId

required

string

Example

{
  "_tag": "DomainNotFound"
}

409

@nmnmcc/ability/Authorizer/Pending | DomainTaken | DomainNotVerified | DomainInUse | SsoConnectionConflict

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

object

object

_tag

required

string

Allowed values: DomainTaken

domain

required

string

object

object

_tag

required

string

Allowed values: DomainNotVerified

domain

required

string

object

object

_tag

required

string

Allowed values: DomainInUse

domain

required

string

object

object

_tag

required

string

Allowed values: SsoConnectionConflict

version

required

integer

<= 9007199254740991

Example

{
  "_tag": "Pending"
}

429

RateLimited

Media typeapplication/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

SsoUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: PolicyUnavailable

object

object

_tag

required

string

Allowed values: SsoUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

object

object

_tag

required

string

Allowed values: RequestFailed

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "PolicyUnavailable"
}