1. Docs
  2. API Reference
  3. Import the identity provider's SAML metadata

Import the identity provider's SAML metadata

POST/api/v1/organizations/{id}/sso-connection/import-metadata

Reads the identity provider's SAML metadata from an HTTPS URL or a pasted XML document and fills the connection's issuer, sign-in URL and signing certificate from it. The URL must resolve to a public host and must not redirect; paste the document when it does not. SAML connections only.

Authentication

Bearer TokenAuthorization Option A

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Path Parameters

idstring Required

Request body

application/json

metadata_urlstring Optional

HTTPS URL the identity provider publishes its SAML metadata at.

metadata_xmlstring Optional

The identity provider's SAML metadata XML, pasted in.

Responses

application/json

  • dataOrganizationSsoConnectionDetailResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

OrganizationSsoConnectionDetailResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/api/v1/organizations/value/sso-connection/import-metadata" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "metadata_url": "string",
    "metadata_xml": "string"
  }'
Response
{
  "data": {
    "connection": {
      "id": "string",
      "account_id": "string",
      "scope": "admin",
      "type": "saml",
      "name": "string",
      "status": "configuring",
      "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",
      "last_login_failure_at": "2026-04-20T12:00:00.000Z",
      "consecutive_failures": 0,
      "auto_disabled_at": "2026-04-20T12:00:00.000Z",
      "created_at": "2026-04-20T12:00:00.000Z",
      "updated_at": "2026-04-20T12:00:00.000Z"
    },
    "default_role": {
      "id": "string",
      "name": "string"
    },
    "owned_by_organization": false,
    "service_provider": {
      "protocol": "saml",
      "acs_url": "string",
      "entity_id": "string",
      "metadata_url": "string",
      "redirect_uri": "string"
    }
  }
}
 Related endpoints
GETList organizations
POSTCreate an organization
DELETEDelete every organization
GETGet an organization
PATCHUpdate an organization
DELETEDelete an organization
GETGet an organization's authentication policy
PATCHUpdate an organization's authentication policy
POSTRegenerate the organization's SSO recovery codes
POSTStart a test sign-in on the organization's connection
GETRead the organization's test sign-in
GETList the organization's domain claims
POSTClaim a domain for the organization
POSTVerify one of the organization's domains
DELETERemove one of the organization's domain claims
GETList an organization's SSO connections
POSTBind an SSO connection to an organization
DELETEUnbind an SSO connection from an organization
GETList an organization's members
POSTAdd a member to an organization
PATCHChange a member's role
DELETERemove a member from an organization
GETList an organization's invitations
POSTInvite a member into an organization
GETList the roles an organization may assign
DELETERevoke an organization invitation
GETGet an organization's SSO connection
POSTSet up an organization's SSO connection
PATCHChange an organization's SSO connection
DELETERemove an organization's SSO connection
POSTActivate an organization's SSO connection
POSTDisable an organization's SSO connection
GETGet the service-provider values for an organization's SSO connection
 Was this page helpful?

Tell us how we can improve this guide.

Canopy