Class EffectiveRolesClient

Index

Accessors

Constructors

Methods

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.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.members.effectiveRoles.list("id", "user_id", {
        from: "from",
        take: 1
    })
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

`Protected`_sources

_sources: SourcesClient | undefined