Update SSO connection

PATCH /sso-connection/{id}

Path Parameters

idstring · uuid

required·

The ID of the SSO connection you want to update.

Example: 1ba1f401-7183-47c5-9e39-e8e257e3c795

Request Body

client_secretstring

The OIDC relying-party client secret. Write-only — encrypted at rest and never returned.

Example: rp-secret-value

configobject

Non-secret protocol settings. Deep-merged onto the existing config.

allow_idp_initiatedboolean

SAML only — accept unsolicited (IdP-initiated) responses at the ACS. Defaults to false (unsolicited responses rejected) when omitted.

Example: false

client_idstring

OIDC relying-party client ID.

Example: truto-client

discovery_urlstring

OIDC discovery document URL.

Example: https://accounts.example.com/.well-known/openid-configuration

idp_entity_idstring

SAML IdP entity ID.

Example: https://idp.example.com/metadata

idp_metadata_xmlstring

SAML only — IdP metadata XML. When provided, the server parses it to populate idp_entity_id, idp_sso_url, and idp_x509_cert, then discards the raw XML (never stored or returned).

idp_sso_urlstring

SAML IdP single sign-on URL.

Example: https://idp.example.com/sso

idp_x509_certstring

SAML IdP X.509 signing certificate (PEM).

issuerstring

OIDC issuer URL.

Example: https://accounts.example.com

sign_authn_requestsboolean

SAML only — sign SP-initiated AuthnRequests with the SP key (HTTP-Redirect binding).

Example: false

default_environment_idsstring[]

Environment IDs that provisioned users are granted access to by default.

default_rolestring

The role assigned to users provisioned through this connection.

Example: member

enforcedboolean

Whether SSO login is enforced for the connection's verified domains.

Example: false

is_activeboolean

Whether the connection is active.

Example: true

is_defaultboolean

Whether this is the team's default SSO connection.

Example: false

protocolstring

The SSO protocol for this connection.

Example: saml

Possible values:

samloidc

Response Body

configobject

Non-secret protocol settings. Secret values (the OIDC client secret and SAML SP keys) are never returned.

allow_idp_initiatedboolean

SAML only — accept unsolicited (IdP-initiated) responses at the ACS. Defaults to false (unsolicited responses rejected) when omitted.

Example: false

client_idstring

OIDC relying-party client ID.

Example: truto-client

discovery_urlstring

OIDC discovery document URL.

Example: https://accounts.example.com/.well-known/openid-configuration

idp_entity_idstring

SAML IdP entity ID.

Example: https://idp.example.com/metadata

idp_sso_urlstring

SAML IdP single sign-on URL.

Example: https://idp.example.com/sso

idp_x509_certstring

SAML IdP X.509 signing certificate (PEM).

issuerstring

OIDC issuer URL.

Example: https://accounts.example.com

sign_authn_requestsboolean

SAML only — sign SP-initiated AuthnRequests with the SP key (HTTP-Redirect binding).

Example: false

created_atstring · date-time

The date and time when the SSO connection was created.

Example: 2021-08-10T10:00:00.000Z

default_environment_idsstring[]

Environment IDs that provisioned users are granted access to by default.

default_rolestring

The role assigned to users provisioned through this connection.

Example: member

enforcedboolean

Whether SSO login is enforced for users on the connection's verified domains.

Example: false

idstring · uuid

The ID of the SSO connection.

Example: 1ba1f401-7183-47c5-9e39-e8e257e3c795

is_activeboolean

Whether this SSO connection is active.

Example: true

is_defaultboolean

Whether this is the team's default SSO connection.

Example: false

protocolstring

The SSO protocol used by this connection.

Example: saml

Possible values:

samloidc

team_idstring · uuid

The ID of the team that owns this SSO connection.

Example: 05daecaf-4365-42e8-8370-8127de5dd717

updated_atstring · date-time

The date and time when the SSO connection was last updated.

Example: 2021-08-10T10:30:00.000Z

curl -X PATCH 'https://api.truto.one/sso-connection/{id}' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "protocol": "saml",
  "is_active": true,
  "enforced": false,
  "is_default": false,
  "config": {},
  "client_secret": "rp-secret-value",
  "default_role": "member",
  "default_environment_ids": []
}'

const body = {
  "protocol": "saml",
  "is_active": true,
  "enforced": false,
  "is_default": false,
  "config": {},
  "client_secret": "rp-secret-value",
  "default_role": "member",
  "default_environment_ids": []
};

const response = await fetch('https://api.truto.one/sso-connection/{id}', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

const data = await response.json();
console.log(data);

import requests

url = "https://api.truto.one/sso-connection/{id}"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
}
payload = {
    "protocol": "saml",
    "is_active": True,
    "enforced": False,
    "is_default": False,
    "config": {},
    "client_secret": "rp-secret-value",
    "default_role": "member",
    "default_environment_ids": []
}

response = requests.patch(url, headers=headers, params=params, json=payload)
print(response.json())