getSamlConnectionList()
Retrieves 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[]>- 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
const response = await clerkClient.samlConnections.getSamlConnectionList()Limit the number of results
Retrieves organization list that is filtered by the number of results.
const { data, totalCount } = await clerkClient.samlConnections.getSamlConnectionList({
// returns the first 10 results
limit: 10,
})Skip results
Retrieves organization list that is filtered by the number of results to skip.
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.
Feedback
Last updated on