1. Docs
  2. API Reference
  3. SsoConnectionResponseDto

SsoConnectionResponseDto

Example

JSON
{
  "id": "string",
  "account_id": "string",
  "scope": "admin",
  "type": "saml",
  "name": "string",
  "status": "configuring",
  "owner_organization_node_id": "string",
  "owned_by_organization": false,
  "saml_metadata_url": "string",
  "last_test_sign_in": {
    "test_id": "string",
    "outcome": "success",
    "reason": "string",
    "email": "string",
    "domain_outcome": "accepted",
    "completed_at": "2026-04-20T12:00:00.000Z"
  },
  "saml_entity_id": "string",
  "saml_sso_url": "string",
  "saml_slo_url": "string",
  "saml_signing_cert": "string",
  "saml_signature_algorithm": "string",
  "saml_want_assertions_signed": false,
  "saml_name_id_format": "string",
  "force_authn": false,
  "oidc_discovery_url": "string",
  "oidc_client_id": "string",
  "oidc_scopes": [
    "string"
  ],
  "has_oidc_client_secret": false,
  "jit_provisioning_enabled": false,
  "attribute_mapping": {},
  "last_login_at": "2026-04-20T12:00:00.000Z",
  "created_at": "2026-04-20T12:00:00.000Z",
  "updated_at": "2026-04-20T12:00:00.000Z"
}

Properties

27 properties 17 required

id string Required
account_id string Required
scope enum Required
Enumadminend_user
type enum Required
Enumsamloidc
name string Required
status enum Required
Enumconfiguringactivedisabled
owner_organization_node_id string Optional

The organization that owns the connection, when its administrator set it up from the organization portal; null for a connection the developer created. An owned connection cannot be moved to another organization or Environment, and its administrators are emailed when the developer changes its provider settings, disables or deletes it.

nullable
owned_by_organization boolean Required

True when an organization's administrator set the connection up from the organization portal.

saml_metadata_url string Optional

The HTTPS address the identity provider's SAML metadata was last imported from. `null` when the metadata was pasted as a document or never imported.

nullable
last_test_sign_in object Optional

The last test sign-in run against the connection. Cleared when its provider settings change, since a test no longer proves them.

nullable
saml_entity_id string Optional
nullable
saml_sso_url string Optional
nullable
saml_slo_url string Optional
nullable
saml_signing_cert string Optional
nullable
saml_signature_algorithm string Required
saml_want_assertions_signed boolean Required
saml_name_id_format string Required
force_authn boolean Required
oidc_discovery_url string Optional
nullable
oidc_client_id string Optional
nullable
oidc_scopes array of string Required
has_oidc_client_secret boolean Required

Whether an OIDC client secret is stored (never the value).

jit_provisioning_enabled boolean Required
attribute_mapping object Required
last_login_at string Optional
format: date-timenullable
created_at string Required
format: date-time
updated_at string Required
format: date-time
Was this page helpful?

Tell us how we can improve this guide.

Canopy