Skip to main content
PATCH
/
v1
/
sso_connections
/
{connectionId}
Update an SSO Connection
curl --request PATCH \
  --url https://api.us.lexful.app/v1/sso_connections/{connectionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-ID: <api-key>' \
  --data '
{
  "name": "<string>",
  "saml_config": {
    "acs_url": "<string>",
    "audience_uri": "<string>",
    "idp_entity_id": "<string>",
    "idp_sso_url": "<string>",
    "x509_certificate": "<string>",
    "attribute_mapping": {}
  },
  "oidc_config": {
    "redirect_url": "<string>",
    "client_id": "<string>",
    "client_secret": "<string>",
    "issuer": "<string>"
  }
}
'
{
  "connection_id": "<string>",
  "type": "saml",
  "status": "active",
  "name": "<string>",
  "saml_config": {
    "acs_url": "<string>",
    "audience_uri": "<string>",
    "idp_entity_id": "<string>",
    "idp_sso_url": "<string>",
    "x509_certificate": "<string>",
    "attribute_mapping": {}
  },
  "oidc_config": {
    "redirect_url": "<string>",
    "client_id": "<string>",
    "client_secret": "<string>",
    "issuer": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer token

X-Account-ID
string
header
required

Account ID

Path Parameters

connectionId
string
required

SSO connection ID

Body

application/json
name
string

Display name for the SSO connection

Required string length: 1 - 255
saml_config
object
oidc_config
object

Response

Default Response

connection_id
string
required

SSO connection unique identifier

type
enum<string>
required

SSO connection type (SAML or OIDC)

Available options:
saml,
oidc
status
enum<string>
required

SSO connection status

Available options:
active,
inactive,
pending
name
string

Name for the SSO connection

saml_config
object
oidc_config
object