docs/classes/management.SDK.ClientsClient-1.html
new ClientsClient(options: BaseClientOptions): ClientsClient
get(
id: string,
request?: GetConnectionEnabledClientsRequestParameters,
requestOptions?: ClientsClient.RequestOptions,
): Promise<
Page<
ConnectionEnabledClient,
GetConnectionEnabledClientsResponseContent,
>,
>
Retrieve all clients that have the specified connection enabled.
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.
The id of the connection for which enabled clients are to be retrieved
OptionalrequestOptions: ClientsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.connections.clients.get("id", { take: 1, from: "from" })Copy
update(
id: string,
request: UpdateEnabledClientConnectionsRequestContent,
requestOptions?: ClientsClient.RequestOptions,
): HttpResponsePromise<void>
The id of the connection to modify
OptionalrequestOptions: ClientsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.connections.clients.update("id", [{ client_id: "client_id", status: true }])Copy
Protected Readonly_options_options: NormalizedClientOptionsWithAuth<BaseClientOptions>
Member Visibility
ThemeOSLightDark
Constructors constructor Methods getupdate Properties _options