Skip to content

SDK API Reference / PolicySDK

Class: PolicySDK ​

Policy API - manage access control policies

Methods ​

getMyPermissions() ​

getMyPermissions(): Promise<UserAccessControlResponse>

Get current user's assigned policies and effective permissions

Returns ​

Promise<UserAccessControlResponse>


getPolicy() ​

getPolicy(idOrName): Promise<Policy>

Get a specific policy by ID or name

Parameters ​

idOrName ​

string

Returns ​

Promise<Policy>


getPolicyPermissions() ​

getPolicyPermissions(policyId): Promise<PolicyPermissions>

Get permissions for a specific policy

Parameters ​

policyId ​

number

Returns ​

Promise<PolicyPermissions>


getPolicyUsers() ​

getPolicyUsers(policyId): Promise<PolicyUser[]>

Get users assigned to a specific policy

Parameters ​

policyId ​

number

Returns ​

Promise<PolicyUser[]>


getUserPolicies() ​

getUserPolicies(userId): Promise<Policy[]>

Get policies assigned to a specific user

Returns a bare array from the API.

Parameters ​

userId ​

number

Returns ​

Promise<Policy[]>


listPolicies() ​

listPolicies(): Promise<Policy[]>

List all policies in the account

Returns ​

Promise<Policy[]>