• management
• SDK
• EffectiveRolesClient

Class EffectiveRolesClient

Index

Accessors

sources

Constructors

constructor

Methods

list

Properties

_options_sources

Accessors

sources

get sources(): SourcesClient

Returns SourcesClient

Constructors

constructor

new EffectiveRolesClient(options: BaseClientOptions): EffectiveRolesClient

Parameters

• options: BaseClientOptions

Returns EffectiveRolesClient

Methods

list

list(
id: string,
user_id: string,
request?: ListOrganizationMemberEffectiveRolesRequestParameters,
requestOptions?: EffectiveRolesClient.RequestOptions,
): Promise<
Page<
OrganizationMemberEffectiveRole,
ListOrganizationMemberEffectiveRolesResponseContent,
>,
>

Lists the roles assigned to an organization member directly or through group membership.

Parameters

• id: string

Organization identifier.

• user_id: string

ID of the user to list effective roles for.

• request: ListOrganizationMemberEffectiveRolesRequestParameters = {}
• OptionalrequestOptions: EffectiveRolesClient.RequestOptions

Request-specific configuration.

Returns Promise< Page< OrganizationMemberEffectiveRole, ListOrganizationMemberEffectiveRolesResponseContent, >, >

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.organizations.members.effectiveRoles.list("id", "user_id", { from: "from", take: 1 })Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Protected_sources

_sources: SourcesClient | undefined

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Accessors sources Constructors constructor Methods list Properties _options_sources