Class MembersClient

Index

Constructors

Methods

Properties

Constructors

constructor

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

Methods

list

list(
    id: string,
    role_id: string,
    request?: ListOrganizationRoleMembersRequestParameters,
    requestOptions?: MembersClient.RequestOptions,
): Promise<Page<RoleMember, ListOrganizationRoleMembersResponseContent>>
List the organization members assigned a specific role within the context of an organization.
- Note: Returns only members with direct role assignments. For groups assigned to this role within the organization, use GET /api/v2/organizations/{organization_id}/roles/{role_id}/groups.
Parameters
- id: string
  ID of the organization.
- role_id: string
  ID of the role to retrieve the assigned members for.
- request: ListOrganizationRoleMembersRequestParameters = {}
- OptionalrequestOptions: MembersClient.RequestOptions
  Request-specific configuration.
Returns Promise<Page<RoleMember, ListOrganizationRoleMembersResponseContent>>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.roles.members.list("id", "role_id", {
        from: "from",
        take: 1,
        fields: "fields",
        include_fields: true
    })
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>