• management
• SDK
• GroupsClient

Class GroupsClient

Index

Constructors

constructor

Methods

list

Properties

_options

Constructors

constructor

new GroupsClient(options: BaseClientOptions): GroupsClient

Parameters

• options: BaseClientOptions

Returns GroupsClient

Methods

list

list(
id: string,
request: ListUserRoleSourceGroupsRequestParameters,
requestOptions?: GroupsClient.RequestOptions,
): Promise<Page<Group, ListUserRoleSourceGroupsResponseContent>>

Lists the groups that grant a user a specific role.

Parameters

• id: string

ID of the user to list role source groups for.

• request: ListUserRoleSourceGroupsRequestParameters
• OptionalrequestOptions: GroupsClient.RequestOptions

Request-specific configuration.

Returns Promise<Page<Group, ListUserRoleSourceGroupsResponseContent>>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.users.effectiveRoles.sources.groups.list("id", { role_id: "role_id", from: "from", take: 1 })Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods list Properties _options