Clerk.SAMLConnection (Clerk SDK v1.0.1)

A SAML Connection holds configuration data required for facilitating a SAML flow between your Clerk Instance (SP) and a particular SAML IdP.

Summary

Functions

Deletes the SAML Connection whose ID matches the provided id in the path.

Fetches the SAML Connection whose ID matches the provided saml_connection_id in the path.

Returns the list of SAML Connections for an instance. Results can be paginated using the optional limit and offset query parameters. The SAML Connections are ordered by descending creation date and the most recent will be returned first. Refer to https://clerk.com/docs/authentication/saml-at-clerk#saml-at-clerk-beta for more information.

Updates the SAML Connection whose ID matches the provided id in the path.

Functions

Link to this function

create(params, opts \\ [])

Refer to https://clerk.com/docs/authentication/saml-at-clerk#saml-at-clerk-beta for more information.

REQUEST BODY SCHEMA: application/json

name

required string The name to use as a label for this SAML Connection

domain

required string The domain of your organization. Sign in flows using an email with this domain, will use this SAML Connection.

idp_entity_id

string or null The Entity ID as provided by the IdP

idp_sso_url

string or null The Single-Sign On URL as provided by the IdP

idp_certificate

string or null The X.509 certificate as provided by the IdP

Link to this function

delete(id, opts \\ [])

Deletes the SAML Connection whose ID matches the provided id in the path.

Link to this function

get(id, opts \\ [])

Fetches the SAML Connection whose ID matches the provided saml_connection_id in the path.

Link to this function

list(opts \\ [])

Returns the list of SAML Connections for an instance. Results can be paginated using the optional limit and offset query parameters. The SAML Connections are ordered by descending creation date and the most recent will be returned first. Refer to https://clerk.com/docs/authentication/saml-at-clerk#saml-at-clerk-beta for more information.

QUERY PARAMETERS

limit

number [ 1 .. 500 ] Default: 10 Applies a limit to the number of results returned. Can be used for paginating the results together with offset. Must be an integer greater than zero and less than 500. By default, if not supplied, a limit of 10 is used.

offset

number >= 0 Default: 0 Skip the first offset results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with limit.

Link to this function

update(id, params, opts \\ [])

Updates the SAML Connection whose ID matches the provided id in the path.

REQUEST BODY SCHEMA: application/json

name

string or null The name of the new SAML Connection

domain

string or null The domain to use for the new SAML Connection

idp_entity_id

string or null The entity id as provided by the IdP

idp_sso_url

string or null The SSO url as provided by the IdP

idp_certificate

string or null The x509 certificated as provided by the IdP

active

boolean or null Activate or de-activate the SAML Connection

sync_user_attributes

boolean or null Controls whether to update the user's attributes in each sign-in