Back to Node Auth0

Class GroupsClient

docs/classes/management.SDK.GroupsClient-3.html

5.11.05.4 KB
Original Source

Class GroupsClient

Index

Constructors

constructor

Methods

getcreatedelete

Properties

_options

Constructors

constructor

new GroupsClient(options: BaseClientOptions): GroupsClient

Parameters

Returns GroupsClient

Methods

get

get(
id: string,
request?: ListRoleGroupsParameters,
requestOptions?: GroupsClient.RequestOptions,
): Promise<Page<Group, ListRoleGroupsResponseContent>>

Lists the groups to which the specified role is assigned.

Parameters

  • id: string

Unique identifier for the role (service-generated).

Request-specific configuration.

Returns Promise<Page<Group, ListRoleGroupsResponseContent>>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.roles.groups.get("id", { from: "from", take: 1 })Copy

create

create(
id: string,
request: AssignRoleGroupsRequestContent,
requestOptions?: GroupsClient.RequestOptions,
): HttpResponsePromise<void>

Assign one or more groups to a specified role.

Parameters

  • id: string

Unique identifier for the role (service-generated).

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.roles.groups.create("id", { groups: ["groups"] })Copy

delete

delete(
id: string,
request: DeleteRoleGroupsRequestContent,
requestOptions?: GroupsClient.RequestOptions,
): HttpResponsePromise<void>

Unassign one or more groups from a specified role.

Parameters

  • id: string

Unique identifier for the role (service-generated).

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.roles.groups.delete("id", { groups: ["groups"] })Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods getcreatedelete Properties _options