Class RolesClient

Index

Constructors

constructor

new RolesClient(options: BaseClientOptions): RolesClient
Parameters
- options: BaseClientOptions
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: ListOrganizationGroupRolesRequestParameters = {}
- OptionalrequestOptions: RolesClient.RequestOptions
  Request-specific configuration.
Returns Promise<Page<Role, ListOrganizationGroupRolesResponseContent>>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

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

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: CreateOrganizationGroupRolesRequestContent
- OptionalrequestOptions: RolesClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.ConflictError

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

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: DeleteOrganizationGroupRolesRequestContent
- 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.organizations.groups.roles.delete("organization_id", "group_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, ListOrganizationGroupRolesResponseContent>>

Throws

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<void>

Throws

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