Class GroupsClient

Index

Constructors

Methods

Properties

Constructors

constructor

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

Methods

get

get(
    id: string,
    request?: GetUserGroupsRequestParameters,
    requestOptions?: GroupsClient.RequestOptions,
): Promise<
    Page<UserGroupsResponseSchema, GetUserGroupsPaginatedResponseContent>,
>
List all groups to which this user belongs.
Parameters
- id: string
  ID of the user to list groups for.
- request: GetUserGroupsRequestParameters = {}
- OptionalrequestOptions: GroupsClient.RequestOptions
  Request-specific configuration.
Returns Promise<Page<UserGroupsResponseSchema, GetUserGroupsPaginatedResponseContent>>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.users.groups.get("id", {
        fields: "fields",
        include_fields: true,
        from: "from",
        take: 1
    })
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>