getSamlConnectionList(), Deprecated

This method is deprecated. Use getEnterpriseConnectionList() instead.

Gets the list of SAML connections for an instance. Returns a PaginatedResourceResponse object with a data property that contains an array of SamlConnection objects, and a totalCount property that indicates the total number of SAML connections for the instance.

function getSamlConnectionList(params: SamlConnectionListParams = {}): Promise<SamlConnection[]> {
}

SamlConnectionListParams

• Name: limit?
  Type: number
  Description: The number of results to return. Must be an integer greater than zero and less than 501. Default: 10

• Name: offset?
  Type: number
  Description: The number of results to skip. Default: 0

Usage

Note: Using clerkClient varies based on the SDK you're using. Refer to the overview for usage details, including guidance on how to access the userId and other properties.

Basic

const response = await clerkClient.samlConnections.getSamlConnectionList()

Limit the number of results

Gets the list of SAML connections, limited to the specified number of results.

const { data, totalCount } = await clerkClient.samlConnections.getSamlConnectionList({
  // returns the first 10 results
  limit: 10,
})

Skip results

Gets the list of SAML connections, skipping the specified number of results.

const { data, totalCount } = await clerkClient.samlConnections.getSamlConnectionList({
  // skips the first 10 results
  offset: 10,
})

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint GET/saml_connections. See the BAPI reference for more information.