docs/classes/management.SDK.GroupsClient.html
get members(): MembersClient
new GroupsClient(options: BaseClientOptions): GroupsClient
list(
request?: ListGroupsRequestParameters,
requestOptions?: GroupsClient.RequestOptions,
): Promise<Page<Group, ListGroupsPaginatedResponseContent>>
List all groups in your tenant.
OptionalrequestOptions: GroupsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.groups.list({ connection_id: "connection_id", name: "name", external_id: "external_id", search: "search", fields: "fields", include_fields: true, from: "from", take: 1 })Copy
get(
id: string,
requestOptions?: GroupsClient.RequestOptions,
): HttpResponsePromise<GetGroupResponseContent>
Retrieve a group by its ID.
Unique identifier for the group (service-generated).
OptionalrequestOptions: GroupsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.groups.get("id")Copy
delete(
id: string,
requestOptions?: GroupsClient.RequestOptions,
): HttpResponsePromise<void>
Delete a group by its ID.
Unique identifier for the group (service-generated).
OptionalrequestOptions: GroupsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.groups.delete("id")Copy
Protected Readonly_options_options: NormalizedClientOptionsWithAuth<BaseClientOptions>
Protected_members_members: MembersClient | undefined
Member Visibility
ThemeOSLightDark
Accessors members Constructors constructor Methods listgetdelete Properties _options_members