Interface IPermitApi

This interface contains read actions that goes outside of your local network and queries permit.io cloud api. You should be aware that these actions incur some cross-cloud latency.

See

DeprecatedApiClient for implementation and docs.

Hierarchy

IDeprecatedPermitApi
- IPermitApi

Implemented by

ApiClient

Properties

actionGroups

actionGroups: IResourceActionGroupsApi

API for managing resource action groups.

See

https://api.permit.io/v2/redoc#tag/Resource-Action-Groups

conditionSetRules

conditionSetRules: IConditionSetRulesApi

API for managing condition set rules.

See

https://api.permit.io/v2/redoc#tag/Condition-Set-Rules

conditionSets

conditionSets: IConditionSetsApi

API for managing condition sets.

See

https://api.permit.io/v2/redoc#tag/Condition-Sets

environments

environments: IEnvironmentsApi

API for managing environments.

See

https://api.permit.io/v2/redoc#tag/Environments

projects

projects: IProjectsApi

API for managing projects.

See

https://api.permit.io/v2/redoc#tag/Projects

relationshipTuples

relationshipTuples: IRelationshipTuplesApi

API for managing relationship tuples.

See

https://api.permit.io/v2/redoc#tag/Relationship-Tuples

resourceActions

resourceActions: IResourceActionsApi

API for managing resource actions.

See

https://api.permit.io/v2/redoc#tag/Resource-Actions

resourceAttributes

resourceAttributes: IResourceAttributesApi

API for managing resource attributes.

See

https://api.permit.io/v2/redoc#tag/Resource-Attributes

resourceInstances

resourceInstances: IResourceInstancesApi

API for managing resource instances.

See

https://api.permit.io/v2/redoc#tag/Resource-Instances

resourceRelations

resourceRelations: IResourceRelationsApi

API for managing resource relations.

See

https://api.permit.io/v2/redoc#tag/Resource-Relations

resourceRoles

resourceRoles: IResourceRolesApi

API for managing resource roles.

See

https://api.permit.io/v2/redoc#tag/Resource-Roles

resources

resources: IResourcesApi

API for managing resources.

See

https://api.permit.io/v2/redoc#tag/Resources

roleAssignments

roleAssignments: IRoleAssignmentsApi

API for managing role assignments.

See

https://api.permit.io/v2/redoc#tag/Role-Assignments

roles

roles: IRolesApi

API for managing roles.

See

https://api.permit.io/v2/redoc#tag/Roles

tenants

tenants: ITenantsApi

API for managing tenants.

See

https://api.permit.io/v2/redoc#tag/Tenants

users

users: IUsersApi

API for managing users.

See

https://api.permit.io/v2/redoc#tag/Users

Methods

assignConditionSetRule

assignConditionSetRule(conditionSetRule): Promise<ConditionSetRuleRead[]>
Parameters
- conditionSetRule: ConditionSetRuleCreate
Returns Promise<ConditionSetRuleRead[]>
Inherited from IDeprecatedPermitApi.assignConditionSetRule
- Defined in src/api/deprecated.ts:87

assignRole

assignRole(assignedRole): Promise<RoleAssignmentRead>
Parameters
- assignedRole: RoleAssignmentCreate
Returns Promise<RoleAssignmentRead>
Inherited from IDeprecatedPermitApi.assignRole
- Defined in src/api/deprecated.ts:76

createConditionSet

createConditionSet(conditionSet): Promise<ConditionSetRead>
Parameters
- conditionSet: ConditionSetCreate
Returns Promise<ConditionSetRead>
Inherited from IDeprecatedPermitApi.createConditionSet
- Defined in src/api/deprecated.ts:81

createResource

createResource(resource): Promise<ResourceRead>
Parameters
- resource: ResourceCreate
Returns Promise<ResourceRead>
Inherited from IDeprecatedPermitApi.createResource
- Defined in src/api/deprecated.ts:78

createRole

createRole(role): Promise<RoleRead>
Parameters
- role: RoleCreate
Returns Promise<RoleRead>
Inherited from IDeprecatedPermitApi.createRole
- Defined in src/api/deprecated.ts:73

createTenant

createTenant(tenant): Promise<TenantRead>
Parameters
- tenant: TenantCreate
Returns Promise<TenantRead>
Inherited from IDeprecatedPermitApi.createTenant
- Defined in src/api/deprecated.ts:69

createUser

createUser(user): Promise<UserRead>
Parameters
- user: UserCreate
Returns Promise<UserRead>
Inherited from IDeprecatedPermitApi.createUser
- Defined in src/api/deprecated.ts:65

deleteConditionSet

deleteConditionSet(conditionSetId): Promise<AxiosResponse<void, any>>
Parameters
- conditionSetId: string
Returns Promise<AxiosResponse<void, any>>
Inherited from IDeprecatedPermitApi.deleteConditionSet
- Defined in src/api/deprecated.ts:86

deleteResource

deleteResource(resourceId): Promise<AxiosResponse<void, any>>
Parameters
- resourceId: string
Returns Promise<AxiosResponse<void, any>>
Inherited from IDeprecatedPermitApi.deleteResource
- Defined in src/api/deprecated.ts:80

deleteRole

deleteRole(roleId): Promise<AxiosResponse<void, any>>
Parameters
- roleId: string
Returns Promise<AxiosResponse<void, any>>
Inherited from IDeprecatedPermitApi.deleteRole
- Defined in src/api/deprecated.ts:75

deleteTenant

deleteTenant(tenantId): Promise<AxiosResponse<void, any>>
Parameters
- tenantId: string
Returns Promise<AxiosResponse<void, any>>
Inherited from IDeprecatedPermitApi.deleteTenant
- Defined in src/api/deprecated.ts:71

deleteUser

deleteUser(userId): Promise<AxiosResponse<void, any>>
Parameters
- userId: string
Returns Promise<AxiosResponse<void, any>>
Inherited from IDeprecatedPermitApi.deleteUser
- Defined in src/api/deprecated.ts:68

ensureAccessLevel

ensureAccessLevel(requiredAccessLevel): Promise<void>
Ensure that the API Key has the necessary permissions to successfully call the API endpoint. Note that this check is not foolproof, and the API may still throw 401.
Parameters
- requiredAccessLevel: ApiKeyLevel
  
  The required API Key Access level for the endpoint.
Returns Promise<void>

Throws
PermitContextError If the currently set API key access level does not match the required access level.
- Defined in src/api/api-client.ts:127

ensureContext

ensureContext(requiredContext): Promise<void>
Ensure that the API context matches the required endpoint context.
Parameters
- requiredContext: ApiContextLevel
  
  The required API context level for the endpoint.
Returns Promise<void>

Throws
PermitContextError If the currently set API context level does not match the required context level.
- Defined in src/api/api-client.ts:134

getAssignedRoles

getAssignedRoles(user, tenant?): Promise<RoleAssignmentRead[]>
Parameters
- user: string
- Optional tenant: string
Returns Promise<RoleAssignmentRead[]>
Inherited from IDeprecatedPermitApi.getAssignedRoles
- Defined in src/api/deprecated.ts:53

getRole

getRole(roleId): Promise<RoleRead>
Parameters
- roleId: string
Returns Promise<RoleRead>
Inherited from IDeprecatedPermitApi.getRole
- Defined in src/api/deprecated.ts:52

getTenant

getTenant(tenantId): Promise<TenantRead>
Parameters
- tenantId: string
Returns Promise<TenantRead>
Inherited from IDeprecatedPermitApi.getTenant
- Defined in src/api/deprecated.ts:51

getUser

getUser(userId): Promise<UserRead>
Parameters
- userId: string
Returns Promise<UserRead>
Inherited from IDeprecatedPermitApi.getUser
- Defined in src/api/deprecated.ts:50

listConditionSets

listConditionSets(type, page, per_page): Promise<ConditionSetRead[]>
Parameters
- type: string
- page: number
- per_page: number
Returns Promise<ConditionSetRead[]>
Inherited from IDeprecatedPermitApi.listConditionSets
- Defined in src/api/deprecated.ts:54

listConditionSetsRules

listConditionSetsRules(page, per_page): Promise<ConditionSetRuleRead[]>
Parameters
- page: number
- per_page: number
Returns Promise<ConditionSetRuleRead[]>
Inherited from IDeprecatedPermitApi.listConditionSetsRules
- Defined in src/api/deprecated.ts:55

listRoles

listRoles(): Promise<RoleRead[]>
Returns Promise<RoleRead[]>
Inherited from IDeprecatedPermitApi.listRoles
- Defined in src/api/deprecated.ts:49

listTenants

listTenants(page?): Promise<TenantRead[]>
Parameters
- Optional page: number
Returns Promise<TenantRead[]>
Inherited from IDeprecatedPermitApi.listTenants
- Defined in src/api/deprecated.ts:72

listUsers

listUsers(): Promise<UserRead[]>
Returns Promise<UserRead[]>
Inherited from IDeprecatedPermitApi.listUsers
- Defined in src/api/deprecated.ts:48

syncUser

syncUser(user): Promise<UserRead>
Parameters
- user: UserCreate
Returns Promise<UserRead>
Inherited from IDeprecatedPermitApi.syncUser
- Defined in src/api/deprecated.ts:67

unassignConditionSetRule

unassignConditionSetRule(conditionSetRule): Promise<AxiosResponse<void, any>>
Parameters
- conditionSetRule: ConditionSetRuleRemove
Returns Promise<AxiosResponse<void, any>>
Inherited from IDeprecatedPermitApi.unassignConditionSetRule
- Defined in src/api/deprecated.ts:88

unassignRole

unassignRole(removedRole): Promise<AxiosResponse<void, any>>
Parameters
- removedRole: RoleAssignmentRemove
Returns Promise<AxiosResponse<void, any>>
Inherited from IDeprecatedPermitApi.unassignRole
- Defined in src/api/deprecated.ts:77

updateConditionSet

updateConditionSet(conditionSetId, conditionSet): Promise<ConditionSetRead>
Parameters
- conditionSetId: string
- conditionSet: ConditionSetUpdate
Returns Promise<ConditionSetRead>
Inherited from IDeprecatedPermitApi.updateConditionSet
- Defined in src/api/deprecated.ts:82

updateResource

updateResource(resourceId, resource): Promise<ResourceRead>
Parameters
- resourceId: string
- resource: ResourceUpdate
Returns Promise<ResourceRead>
Inherited from IDeprecatedPermitApi.updateResource
- Defined in src/api/deprecated.ts:79

updateRole

updateRole(roleId, role): Promise<RoleRead>
Parameters
- roleId: string
- role: RoleUpdate
Returns Promise<RoleRead>
Inherited from IDeprecatedPermitApi.updateRole
- Defined in src/api/deprecated.ts:74

updateTenant

updateTenant(tenantId, tenant): Promise<TenantRead>
Parameters
- tenantId: string
- tenant: TenantUpdate
Returns Promise<TenantRead>
Inherited from IDeprecatedPermitApi.updateTenant
- Defined in src/api/deprecated.ts:70

updateUser

updateUser(userId, user): Promise<UserRead>
Parameters
- userId: string
- user: UserUpdate
Returns Promise<UserRead>
Inherited from IDeprecatedPermitApi.updateUser
- Defined in src/api/deprecated.ts:66

Interface IPermitApi

See

Hierarchy

Implemented by

Index

Properties

Methods

Properties

actionGroups

See

conditionSetRules

See

conditionSets

See

environments

See

projects

See

relationshipTuples

See

resourceActions

See

resourceAttributes

See

resourceInstances

See

resourceRelations

See

resourceRoles

See

resources

See

roleAssignments

See

roles

See

tenants

See

users

See

Methods

assignConditionSetRule

Parameters

conditionSetRule: ConditionSetRuleCreate

Returns Promise<ConditionSetRuleRead[]>

assignRole

Parameters

assignedRole: RoleAssignmentCreate

Returns Promise<RoleAssignmentRead>

createConditionSet

Parameters

conditionSet: ConditionSetCreate

Returns Promise<ConditionSetRead>

createResource

Parameters

resource: ResourceCreate

Returns Promise<ResourceRead>

createRole

Parameters

role: RoleCreate

Returns Promise<RoleRead>

createTenant

Parameters

tenant: TenantCreate

Returns Promise<TenantRead>

createUser

Parameters

user: UserCreate

Returns Promise<UserRead>

deleteConditionSet

Parameters

conditionSetId: string

Returns Promise<AxiosResponse<void, any>>

deleteResource

Parameters

resourceId: string

Returns Promise<AxiosResponse<void, any>>

deleteRole

Parameters

roleId: string

`Optional` tenant: string

`Optional` page: number