Class GroupsClient

Index

Constructors

constructor

new GroupsClient(options: BaseClientOptions): GroupsClient
Parameters
- options: BaseClientOptions
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: ListRoleGroupsParameters = {}
- OptionalrequestOptions: GroupsClient.RequestOptions
  Request-specific configuration.
Returns Promise<Page<Group, ListRoleGroupsResponseContent>>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

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

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: AssignRoleGroupsRequestContent
- OptionalrequestOptions: GroupsClient.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.roles.groups.create("id", {
        groups: ["groups"]
    })
```

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: DeleteRoleGroupsRequestContent
- OptionalrequestOptions: GroupsClient.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.roles.groups.delete("id", {
        groups: ["groups"]
    })
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Class GroupsClient

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns GroupsClient

Methods

get

Parameters

Returns Promise<Page<Group, ListRoleGroupsResponseContent>>

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