Class AccessManagementClient

Index

Constructors

Methods

checkPolicy deleteWorkspacePermissionAssignment getObjectPermissions getRuleSet getRuleSetProxy listAssignableRolesForResource listAssignableRolesForResourceProxy listPermissionLevels listWorkspacePermissionAssignments listWorkspacePermissions setObjectPermissions updateObjectPermissions updateRuleSet updateRuleSetProxy updateWorkspacePermissionAssignment

Constructors

constructor

new AccessManagementClient(options: ClientOptions): AccessManagementClient
Parameters
- options: ClientOptions
Returns AccessManagementClient
- Defined in client.ts:80

Methods

checkPolicy

checkPolicy(
req: CheckPolicyRequest,
options?: CallOptions,
): Promise<CheckPolicyResponse>
Check access policy to a resource.
Parameters
- req: CheckPolicyRequest
- Optionaloptions: CallOptions
Returns Promise<CheckPolicyResponse>
- Defined in client.ts:552

deleteWorkspacePermissionAssignment

deleteWorkspacePermissionAssignment(
req: DeleteWorkspacePermissionAssignmentRequest,
options?: CallOptions,
): Promise<DeleteWorkspacePermissionAssignmentResponse>
Deletes the workspace permissions assignment in a given account and workspace for the specified principal.
Parameters
- req: DeleteWorkspacePermissionAssignmentRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteWorkspacePermissionAssignmentResponse>
- Defined in client.ts:96

getObjectPermissions

getObjectPermissions(
req: GetObjectPermissionsRequest,
options?: CallOptions,
): Promise<PermissionsResponse>
Gets the permissions of an object. Objects can inherit permissions from their parent objects or root object.
Parameters
- req: GetObjectPermissionsRequest
- Optionaloptions: CallOptions
Returns Promise<PermissionsResponse>
- Defined in client.ts:428

getRuleSet

getRuleSet(req: GetRuleSetRequest, options?: CallOptions): Promise<RuleSet>
Get a rule set by its name. A rule set is always attached to a resource and contains a list of access rules on the said resource. Currently only a default rule set for each resource is supported.
Parameters
- req: GetRuleSetRequest
- Optionaloptions: CallOptions
Returns Promise<RuleSet>
- Defined in client.ts:219

getRuleSetProxy

getRuleSetProxy(req: GetRuleSetRequest, options?: CallOptions): Promise<RuleSet>
Get a rule set by its name. A rule set is always attached to a resource and contains a list of access rules on the said resource. Currently only a default rule set for each resource is supported.
Parameters
- req: GetRuleSetRequest
- Optionaloptions: CallOptions
Returns Promise<RuleSet>
- Defined in client.ts:257

listAssignableRolesForResource

listAssignableRolesForResource(
req: ListAssignableRolesForResourceRequest,
options?: CallOptions,
): Promise<ListAssignableRolesForResourceResponse>
Gets all the roles that can be granted on an account level resource. A role is grantable if the rule set on the resource can contain an access rule of the role.
Parameters
- req: ListAssignableRolesForResourceRequest
- Optionaloptions: CallOptions
Returns Promise<ListAssignableRolesForResourceResponse>
- Defined in client.ts:295

listAssignableRolesForResourceProxy

listAssignableRolesForResourceProxy(
req: ListAssignableRolesForResourceRequest,
options?: CallOptions,
): Promise<ListAssignableRolesForResourceResponse>
Gets all the roles that can be granted on an account level resource. A role is grantable if the rule set on the resource can contain an access rule of the role.
Parameters
- req: ListAssignableRolesForResourceRequest
- Optionaloptions: CallOptions
Returns Promise<ListAssignableRolesForResourceResponse>
- Defined in client.ts:333

listPermissionLevels

listPermissionLevels(
req: ListPermissionLevelsRequest,
options?: CallOptions,
): Promise<ListPermissionLevelsResponse>
Gets the permission levels that a user can have on an object.
Parameters
- req: ListPermissionLevelsRequest
- Optionaloptions: CallOptions
Returns Promise<ListPermissionLevelsResponse>
- Defined in client.ts:457

listWorkspacePermissionAssignments

listWorkspacePermissionAssignments(
req: ListWorkspacePermissionAssignmentsRequest,
options?: CallOptions,
): Promise<ListWorkspacePermissionAssignmentsResponse>
Get the permission assignments for the specified and .
Parameters
- req: ListWorkspacePermissionAssignmentsRequest
- Optionaloptions: CallOptions
Returns Promise<ListWorkspacePermissionAssignmentsResponse>
- Defined in client.ts:125

listWorkspacePermissions

listWorkspacePermissions(
req: ListWorkspacePermissionsRequest,
options?: CallOptions,
): Promise<ListWorkspacePermissionsResponse>
Get an array of workspace permissions for the specified account and workspace.
Parameters
- req: ListWorkspacePermissionsRequest
- Optionaloptions: CallOptions
Returns Promise<ListWorkspacePermissionsResponse>
- Defined in client.ts:154

setObjectPermissions

setObjectPermissions(
req: SetObjectPermissionsRequest,
options?: CallOptions,
): Promise<PermissionsResponse>
Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their parent objects or root object.
Parameters
- req: SetObjectPermissionsRequest
- Optionaloptions: CallOptions
Returns Promise<PermissionsResponse>
- Defined in client.ts:489

updateObjectPermissions

updateObjectPermissions(
req: UpdateObjectPermissionsRequest,
options?: CallOptions,
): Promise<PermissionsResponse>
Updates the permissions on an object. Objects can inherit permissions from their parent objects or root object.
Parameters
- req: UpdateObjectPermissionsRequest
- Optionaloptions: CallOptions
Returns Promise<PermissionsResponse>
- Defined in client.ts:519

updateRuleSet

updateRuleSet(
req: UpdateRuleSetRequest,
options?: CallOptions,
): Promise<RuleSet>
Replace the rules of a rule set. First, use get to read the current version of the rule set before modifying it. This pattern helps prevent conflicts between concurrent updates.
Parameters
- req: UpdateRuleSetRequest
- Optionaloptions: CallOptions
Returns Promise<RuleSet>
- Defined in client.ts:371

updateRuleSetProxy

updateRuleSetProxy(
req: UpdateRuleSetRequest,
options?: CallOptions,
): Promise<RuleSet>
Replace the rules of a rule set. First, use get to read the current version of the rule set before modifying it. This pattern helps prevent conflicts between concurrent updates.
Parameters
- req: UpdateRuleSetRequest
- Optionaloptions: CallOptions
Returns Promise<RuleSet>
- Defined in client.ts:401

updateWorkspacePermissionAssignment

updateWorkspacePermissionAssignment(
req: UpdateWorkspacePermissionAssignmentRequest,
options?: CallOptions,
): Promise<WorkspacePermissionAssignmentOutput>
Creates or updates the workspace permissions assignment in a given account and workspace for the specified principal.
Parameters
- req: UpdateWorkspacePermissionAssignmentRequest
- Optionaloptions: CallOptions
Returns Promise<WorkspacePermissionAssignmentOutput>
- Defined in client.ts:183

Class AccessManagementClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AccessManagementClient

Methods

checkPolicy

Parameters

Returns Promise<CheckPolicyResponse>

deleteWorkspacePermissionAssignment

Parameters

Returns Promise<DeleteWorkspacePermissionAssignmentResponse>

getObjectPermissions

Parameters

Returns Promise<PermissionsResponse>

getRuleSet

Parameters

Returns Promise<RuleSet>

getRuleSetProxy

Parameters

Returns Promise<RuleSet>

listAssignableRolesForResource

Parameters

Returns Promise<ListAssignableRolesForResourceResponse>

listAssignableRolesForResourceProxy

Parameters

Returns Promise<ListAssignableRolesForResourceResponse>

listPermissionLevels

Parameters

Returns Promise<ListPermissionLevelsResponse>

listWorkspacePermissionAssignments

Parameters

Returns Promise<ListWorkspacePermissionAssignmentsResponse>

listWorkspacePermissions

Parameters

Returns Promise<ListWorkspacePermissionsResponse>

setObjectPermissions

Parameters

Returns Promise<PermissionsResponse>

updateObjectPermissions

Parameters

Returns Promise<PermissionsResponse>

updateRuleSet

Parameters

Returns Promise<RuleSet>

updateRuleSetProxy

Parameters

Returns Promise<RuleSet>

updateWorkspacePermissionAssignment

Parameters

Returns Promise<WorkspacePermissionAssignmentOutput>

Settings

On This Page