Class GrantsClient

Index

Constructors

Methods

getEffectivePermissions getPermissions listEffectivePrivilegeAssignments listEffectivePrivilegeAssignmentsIter listPrivilegeAssignments listPrivilegeAssignmentsIter updatePermissions

Constructors

constructor

new GrantsClient(options: ClientOptions): GrantsClient
Parameters
- options: ClientOptions
Returns GrantsClient
- Defined in client.ts:60

Methods

getEffectivePermissions

getEffectivePermissions(
req: GetEffectivePermissionsRequest,
options?: CallOptions,
): Promise<GetEffectivePermissionsResponse>
Gets the effective permissions for a securable. Includes inherited permissions from any parent securables.

NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.

PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.
Parameters
- req: GetEffectivePermissionsRequest
- Optionaloptions: CallOptions
Returns Promise<GetEffectivePermissionsResponse>
- Defined in client.ts:83

getPermissions

getPermissions(
req: GetPermissionsRequest,
options?: CallOptions,
): Promise<GetPermissionsResponse>
Gets the permissions for a securable. Does not include inherited permissions.

NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.

PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.
Parameters
- req: GetPermissionsRequest
- Optionaloptions: CallOptions
Returns Promise<GetPermissionsResponse>
- Defined in client.ts:134

listEffectivePrivilegeAssignments

listEffectivePrivilegeAssignments(
req: ListEffectivePrivilegeAssignmentsRequest,
options?: CallOptions,
): Promise<ListEffectivePrivilegeAssignmentsResponse>
Lists the effective privilege assignments for a securable. Includes inherited privileges. Paginated version of Get Effective Permissions API.
Parameters
- req: ListEffectivePrivilegeAssignmentsRequest
- Optionaloptions: CallOptions
Returns Promise<ListEffectivePrivilegeAssignmentsResponse>
- Defined in client.ts:178

listEffectivePrivilegeAssignmentsIter

listEffectivePrivilegeAssignmentsIter(
req: ListEffectivePrivilegeAssignmentsRequest,
options?: CallOptions,
): AsyncGenerator<EffectivePrivilegeAssignment>
Parameters
- req: ListEffectivePrivilegeAssignmentsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<EffectivePrivilegeAssignment>
- Defined in client.ts:221

listPrivilegeAssignments

listPrivilegeAssignments(
req: ListPrivilegeAssignmentsRequest,
options?: CallOptions,
): Promise<ListPrivilegeAssignmentsResponse>
Lists the privilege assignments for a securable. Does not include inherited privileges. Paginated version of Get Permissions API.
Parameters
- req: ListPrivilegeAssignmentsRequest
- Optionaloptions: CallOptions
Returns Promise<ListPrivilegeAssignmentsResponse>
- Defined in client.ts:245

listPrivilegeAssignmentsIter

listPrivilegeAssignmentsIter(
req: ListPrivilegeAssignmentsRequest,
options?: CallOptions,
): AsyncGenerator<PrivilegeAssignment>
Parameters
- req: ListPrivilegeAssignmentsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<PrivilegeAssignment>
- Defined in client.ts:288

updatePermissions

updatePermissions(
req: UpdatePermissionsRequest,
options?: CallOptions,
): Promise<UpdatePermissionsResponse>
Updates the permissions for a securable.
Parameters
- req: UpdatePermissionsRequest
- Optionaloptions: CallOptions
Returns Promise<UpdatePermissionsResponse>
- Defined in client.ts:306