PUT /orgs/{orgId}/sso

PUT

/api/v1/orgs/{orgId}/sso

curl --request PUT \
  --url https://api.pitch2sale.com/api/v1/orgs/example/sso \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "protocol": "saml", "enabled": true, "enforced": true, "email_domains": [ "example" ], "saml": { "idp_entity_id": "example", "idp_sso_url": "https://example.com", "idp_x509_cert": "example", "sp_entity_id": "example", "acs_url": "https://example.com" }, "oidc": { "issuer": "https://example.com", "client_id": "example", "client_secret": "example", "scopes": [ "example" ], "jwks_uri": "https://example.com" }, "attribute_map": { "email": "example", "first_name": "example", "last_name": "example", "groups": "example" }, "role_mapping": [ { "idp_group": "example", "role_id": "example" } ], "default_role_id": "example" }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Parameters

Path Parameters

orgId

required

string

Request Body^required

Media typeapplication/json

object

protocol

required

string

Allowed values: saml oidc

enabled

boolean

enforced

boolean

email_domains

Array<string>

<= 50 items

saml

object

idp_entity_id

Any of:

string

string

<= 2048 characters

null

null

idp_sso_url

Any of:

string

string format: uri

<= 2048 characters

null

null

idp_x509_cert

Any of:

string

string

<= 20000 characters

null

null

sp_entity_id

Any of:

string

string

<= 2048 characters

null

null

acs_url

Any of:

string

string format: uri

<= 2048 characters

null

null

oidc

object

issuer

Any of:

string

string format: uri

<= 2048 characters

null

null

client_id

Any of:

string

string

<= 2048 characters

null

null

client_secret

string

>= 1 characters <= 4096 characters

scopes

Array<string>

<= 50 items

jwks_uri

Any of:

string

string format: uri

<= 2048 characters

null

null

attribute_map

object

email

string

>= 1 characters <= 128 characters

first_name

string

>= 1 characters <= 128 characters

last_name

string

>= 1 characters <= 128 characters

groups

string

>= 1 characters <= 128 characters

role_mapping

Array<object>

<= 200 items

object

idp_group

required

string

>= 1 characters <= 256 characters

role_id

required

string

default_role_id

Any of:

string

string

null

null

Responses

200

OK

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}