• management
• SDK
• ConnectionsClient

Class ConnectionsClient

Index

Constructors

constructor

Methods

get

Properties

_options

Constructors

constructor

new ConnectionsClient(options: BaseClientOptions): ConnectionsClient

Parameters

• options: BaseClientOptions

Returns ConnectionsClient

Methods

get

get(
id: string,
request?: ConnectionsGetRequest,
requestOptions?: ConnectionsClient.RequestOptions,
): Promise<Page<ConnectionForList, ListClientConnectionsResponseContent>>

Retrieve all connections that are enabled for the specified Application, using checkpoint pagination. A list of fields to include or exclude for each connection may also be specified.

• This endpoint requires the read:connections scope and any one of read:clients or read:client_summary.
• Note : The first time you call this endpoint, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no further results are remaining.

Parameters

• id: string

ID of the client for which to retrieve enabled connections.

• request: ConnectionsGetRequest = {}
• OptionalrequestOptions: ConnectionsClient.RequestOptions

Request-specific configuration.

Returns Promise<Page<ConnectionForList, ListClientConnectionsResponseContent>>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.clients.connections.get("id", { strategy: ["ad"], from: "from", take: 1, fields: "fields", include_fields: true })Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods get Properties _options