Clerk · Capability
Clerk Backend Api — SAML Connections
Clerk SAML Connections capability. 5 operations. Lead operation: Get a List of SAML Connections for an Instance.
Capability Spec
naftiko: 1.0.0-alpha2
info:
label: Clerk Backend Api — SAML Connections
description: 'Clerk SAML Connections capability. 5 operations. Lead operation: Get a List of SAML Connections for an Instance.'
tags:
- Clerk
- SAML Connections
created: '2026-05-22'
modified: '2026-05-22'
binds:
- namespace: env
keys:
CLERK_SECRET_KEY: CLERK_SECRET_KEY
capability:
consumes:
- type: http
namespace: clerk-backend-api-saml-connections
baseUri: https://api.clerk.com/v1
description: Clerk clerk-backend-api SAML Connections business capability.
resources:
- name: saml-connections
path: /saml_connections
operations:
- name: ListSAMLConnections
method: GET
description: Get a List of SAML Connections for an Instance
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: query
in: query
type: string
description: Returns SAML connections that have a name that matches the given query, via case-insensitive partial match.
required: false
- name: order_by
in: query
type: string
description: 'Sorts organizations memberships by phone_number, email_address, created_at, first_name, last_name or username.
By prepending one of those values with + or -,
we can choose to sort in ascending (ASC) o'
required: false
- name: organization_id
in: query
type: array
description: 'Returns SAML connections that have an associated organization ID to the
given organizations.
For each organization ID, the `+` and `-` can be
prepended to the ID, which denote whether the
respective o'
required: false
- name: CreateSAMLConnection
method: POST
description: Create a SAML Connection
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: saml-connections-saml-connection-id
path: /saml_connections/{saml_connection_id}
operations:
- name: GetSAMLConnection
method: GET
description: Retrieve a SAML Connection by ID
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: saml_connection_id
in: path
type: string
description: The ID of the SAML Connection
required: true
- name: UpdateSAMLConnection
method: PATCH
description: Update a SAML Connection
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: saml_connection_id
in: path
type: string
description: The ID of the SAML Connection to update
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: DeleteSAMLConnection
method: DELETE
description: Delete a SAML Connection
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: saml_connection_id
in: path
type: string
description: The ID of the SAML Connection to delete
required: true