Back to Node Auth0

Class RolesClient

docs/classes/management.SDK.RolesClient-1.html

5.11.06.0 KB
Original Source

Class RolesClient

Index

Constructors

constructor

Methods

listcreatedelete

Properties

_options

Constructors

constructor

new RolesClient(options: BaseClientOptions): RolesClient

Parameters

Returns RolesClient

Methods

list

list(
organization_id: string,
group_id: string,
request?: ListOrganizationGroupRolesRequestParameters,
requestOptions?: RolesClient.RequestOptions,
): Promise<Page<Role, ListOrganizationGroupRolesResponseContent>>

Lists the roles assigned to the specified group in the context of an organization.

Parameters

  • organization_id: string

ID of the organization

  • group_id: string

ID of the group

Request-specific configuration.

Returns Promise<Page<Role, ListOrganizationGroupRolesResponseContent>>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

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

create

create(
organization_id: string,
group_id: string,
request: CreateOrganizationGroupRolesRequestContent,
requestOptions?: RolesClient.RequestOptions,
): HttpResponsePromise<void>

Assign one or more roles to a specified group in the context of an organization.

Parameters

  • organization_id: string

ID of the organization

  • group_id: string

ID of the group

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.ConflictError

Throws

Management.TooManyRequestsError

Example

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

delete

delete(
organization_id: string,
group_id: string,
request: DeleteOrganizationGroupRolesRequestContent,
requestOptions?: RolesClient.RequestOptions,
): HttpResponsePromise<void>

Unassign one or more roles from a specified group in the context of an organization.

Parameters

  • organization_id: string

ID of the organization

  • group_id: string

ID of the group

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

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

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods listcreatedelete Properties _options