• management
• SDK
• GroupsClient

Class GroupsClient

Index

Accessors

roles

Constructors

constructor

Methods

list

Properties

_options_roles

Accessors

roles

get roles(): RolesClient

Returns RolesClient

Constructors

constructor

new GroupsClient(options: BaseClientOptions): GroupsClient

Parameters

• options: BaseClientOptions

Returns GroupsClient

Methods

list

list(
organization_id: string,
request?: ListOrganizationGroupsRequestParameters,
requestOptions?: GroupsClient.RequestOptions,
): Promise<Page<Group, ListOrganizationGroupsResponseContent>>

Lists the groups that are assigned to the specified organization.

Parameters

• organization_id: string

ID of the organization

• request: ListOrganizationGroupsRequestParameters = {}
• OptionalrequestOptions: GroupsClient.RequestOptions

Request-specific configuration.

Returns Promise<Page<Group, ListOrganizationGroupsResponseContent>>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.organizations.groups.list("organization_id", { from: "from", take: 1 })Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Protected_roles

_roles: RolesClient | undefined

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Accessors roles Constructors constructor Methods list Properties _options_roles