Interface IDeprecatedPermitApi

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

IDeprecatedReadApis
IDeprecatedWriteApis
- IDeprecatedPermitApi
  - IPermitApi

Implemented by

DeprecatedApiClient

Methods

assignConditionSetRule

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

assignRole

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

createConditionSet

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

createResource

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

createRole

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

createTenant

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

createUser

createUser(user): Promise<UserRead>
Parameters
- user: UserCreate
Returns Promise<UserRead>
Inherited from IDeprecatedWriteApis.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 IDeprecatedWriteApis.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 IDeprecatedWriteApis.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 IDeprecatedWriteApis.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 IDeprecatedWriteApis.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 IDeprecatedWriteApis.deleteUser
- Defined in src/api/deprecated.ts:68

getAssignedRoles

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

getRole

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

getTenant

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

getUser

getUser(userId): Promise<UserRead>
Parameters
- userId: string
Returns Promise<UserRead>
Inherited from IDeprecatedReadApis.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 IDeprecatedReadApis.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 IDeprecatedReadApis.listConditionSetsRules
- Defined in src/api/deprecated.ts:55

listRoles

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

listTenants

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

listUsers

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

syncUser

syncUser(user): Promise<UserRead>
Parameters
- user: UserCreate
Returns Promise<UserRead>
Inherited from IDeprecatedWriteApis.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 IDeprecatedWriteApis.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 IDeprecatedWriteApis.unassignRole
- Defined in src/api/deprecated.ts:77

updateConditionSet

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

updateResource

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

updateRole

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

updateTenant

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

updateUser

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

Generated using TypeDoc