Class RolesClient

Index

Constructors

constructor

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

Methods

list

list(
    id: string,
    request?: ListGroupRolesRequestParameters,
    requestOptions?: RolesClient.RequestOptions,
): Promise<Page<Role, ListGroupRolesResponseContent>>
Lists the roles assigned to a group.
Parameters
- id: string
  Unique identifier for the group (service-generated).
- request: ListGroupRolesRequestParameters = {}
- OptionalrequestOptions: RolesClient.RequestOptions
  Request-specific configuration.
Returns Promise<Page<Role, ListGroupRolesResponseContent>>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.groups.roles.list("id", {
        from: "from",
        take: 1
    })
```

create

create(
    id: string,
    request: CreateGroupRolesRequestParameters,
    requestOptions?: RolesClient.RequestOptions,
): HttpResponsePromise<void>
Assign one or more roles to a specified group.
Parameters
- id: string
  Unique identifier for the group (service-generated).
- request: CreateGroupRolesRequestParameters
- OptionalrequestOptions: RolesClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.groups.roles.create("id", {
        roles: ["roles"]
    })
```

delete

delete(
    id: string,
    request: DeleteGroupRolesRequestContent,
    requestOptions?: RolesClient.RequestOptions,
): HttpResponsePromise<void>
Unassign one or more roles from a specified group.
Parameters
- id: string
  Unique identifier for the group (service-generated).
- request: DeleteGroupRolesRequestContent
- OptionalrequestOptions: RolesClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.groups.roles.delete("id", {
        roles: ["roles"]
    })
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Class RolesClient

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns RolesClient

Methods

list

Parameters

Returns Promise<Page<Role, ListGroupRolesResponseContent>>

Throws

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Throws

Example

Properties

Protected Readonly_options

Settings

On This Page

`Protected` `Readonly`_options