Class ClientsClient

Index

Constructors

constructor

new ClientsClient(options: BaseClientOptions): ClientsClient
Parameters
- options: BaseClientOptions
Returns ClientsClient

Methods

list

list(
    id: string,
    request?: ListOrganizationClientsRequestParameters,
    requestOptions?: ClientsClient.RequestOptions,
): Promise<Page<OrganizationClient, ListOrganizationClientsResponseContent>>
List all clients associated with an organization, using checkpoint pagination.
- 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 organization.
- request: ListOrganizationClientsRequestParameters = {}
- OptionalrequestOptions: ClientsClient.RequestOptions
  Request-specific configuration.
Returns Promise<Page<OrganizationClient, ListOrganizationClientsResponseContent>>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.clients.list("id", {
        from: "from",
        take: 1
    })
```

create

create(
    id: string,
    request: CreateOrganizationClientsRequestContent,
    requestOptions?: ClientsClient.RequestOptions,
): HttpResponsePromise<CreateOrganizationClientsResponseContent>
Associate one or more clients with an organization.
Parameters
- id: string
  ID of the organization.
- request: CreateOrganizationClientsRequestContent
- OptionalrequestOptions: ClientsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<CreateOrganizationClientsResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.clients.create("id", {
        clients: [{
                client_id: "client_id",
                use_for_member_access: true
            }]
    })
```

delete

delete(
    id: string,
    request: DeleteOrganizationClientsRequestContent,
    requestOptions?: ClientsClient.RequestOptions,
): HttpResponsePromise<void>
Remove one or more client associations from an organization.
Parameters
- id: string
  ID of the organization.
- request: DeleteOrganizationClientsRequestContent
- OptionalrequestOptions: ClientsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.clients.delete("id", {
        clients: ["clients"]
    })
```

get

get(
    id: string,
    client_id: string,
    requestOptions?: ClientsClient.RequestOptions,
): HttpResponsePromise<GetOrganizationClientResponseContent>
Get a specific client association for an organization.
Parameters
- id: string
  ID of the organization.
- client_id: string
  ID of the client association to retrieve.
- OptionalrequestOptions: ClientsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetOrganizationClientResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.clients.get("id", "client_id")
```

update

update(
    id: string,
    client_id: string,
    request?: UpdateOrganizationClientRequestContent,
    requestOptions?: ClientsClient.RequestOptions,
): HttpResponsePromise<UpdateOrganizationClientResponseContent>
Update an organization client association.
Parameters
- id: string
  ID of the organization.
- client_id: string
  ID of the client association to update.
- request: UpdateOrganizationClientRequestContent = {}
- OptionalrequestOptions: ClientsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<UpdateOrganizationClientResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.clients.update("id", "client_id")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Class ClientsClient

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns ClientsClient

Methods

list

Parameters

Returns Promise<Page<OrganizationClient, ListOrganizationClientsResponseContent>>

Throws

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateOrganizationClientsResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetOrganizationClientResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateOrganizationClientResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

Properties

Protected Readonly_options

Settings

On This Page

`Protected` `Readonly`_options