• management
• SDK
• MembersClient

Class MembersClient

Index

Constructors

constructor

Methods

list

Properties

_options

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.

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 })Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods list Properties _options