Class GroupsClient

Index

Accessors

Constructors

Methods

list get delete

Properties

_options _members _roles

Accessors

members

get members(): MembersClient

Returns MembersClient

roles

get roles(): RolesClient

Returns RolesClient

Constructors

constructor

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

Methods

list

list(
request?: ListGroupsRequestParameters,
requestOptions?: GroupsClient.RequestOptions,
): Promise<Page<Group, ListGroupsPaginatedResponseContent>>
List all groups in your tenant.
Parameters
- request: ListGroupsRequestParameters = {}
- OptionalrequestOptions: GroupsClient.RequestOptions
  Request-specific configuration.
Returns Promise<Page<Group, ListGroupsPaginatedResponseContent>>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.groups.list({
        connection_id: "connection_id",
        name: "name",
        external_id: "external_id",
        search: "search",
        fields: "fields",
        include_fields: true,
        include_totals: true,
        from: "from",
        take: 1
    })
```

get

get(
id: string,
requestOptions?: GroupsClient.RequestOptions,
): HttpResponsePromise<GetGroupResponseContent>
Retrieve a group by its ID.
Parameters
- id: string
  Unique identifier for the group (service-generated).
- OptionalrequestOptions: GroupsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetGroupResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.groups.get("id")
```

delete

delete(
id: string,
requestOptions?: GroupsClient.RequestOptions,
): HttpResponsePromise<void>
Delete a group by its ID.
Parameters
- id: string
  Unique identifier for the group (service-generated).
- OptionalrequestOptions: GroupsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.groups.delete("id")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

`Protected`_members

_members: MembersClient | undefined

`Protected`_roles

_roles: RolesClient | undefined