Hierarchy
-
AccessPolicies↳GenericAccessDefinition
Properties
role
• role: (key: string) => Extract<RoleRef, { kind: "declared" }>
Type declaration
▸ (key): Extract<RoleRef, { kind: "declared" }>
A declared role, by its stable key.
Parameters
Returns
Extract<RoleRef, { kind: "declared" }>
person
• person: (key: string) => Extract<Holder, { kind: "person" }>
Type declaration
▸ (key): Extract<Holder, { kind: "person" }>
Parameters
Returns
Extract<Holder, { kind: "person" }>
service
• service: (name: string) => Extract<Holder, { kind: "service" }>
Type declaration
▸ (name): Extract<Holder, { kind: "service" }>
Parameters
Returns
Extract<Holder, { kind: "service" }>
group
• group: (resource: AccessResourceRef, memberPermission: string) => Extract<Holder, { kind: "group" }>
Type declaration
▸ (resource, memberPermission): Extract<Holder, { kind: "group" }>
The holders of memberPermission on a group resource.
Parameters
Returns
Extract<Holder, { kind: "group" }>
delegate
• delegate: (client: DelegationClient, input: DelegationInput) => Promise<DelegationGrant>
Type declaration
▸ (client, input): Promise<DelegationGrant>
Parameters
Returns
Promise<DelegationGrant>
roles
•Readonly roles: Pick<{ tenant: (id: GenericId<string>) => Extract<RoleRef, { kind: "tenant" }> ; create: (ctx: AccessMutationCtx, input: { scope: { type: string ; key: string } ; resourceType: string ; name: string ; permissions: string[] ; assignment?: { maxDuration?: number ; reasonRequired?: boolean ; guests?: boolean } }) => Promise<Extract<RoleRef, { kind: "tenant" }>> ; update: (ctx: AccessMutationCtx, role: Extract<RoleRef, { kind: "tenant" }>, changes: Partial<Pick<RoleDefinitionDocument, "name" | "permissions" | "maxDuration" | "reasonRequired" | "guests">>) => Promise<void> ; remove: (ctx: AccessMutationCtx, role: Extract<RoleRef, { kind: "tenant" }>) => Promise<void> }, "tenant">
Methods
inputs
▸ inputs():string[]
Returns
string[]
Inherited from
AccessPolicies.inputspolicy
▸ policy(type, options?): SchemaAccessPolicy
Parameters
Returns
SchemaAccessPolicy
Inherited from
AccessPolicies.policyassignmentsPolicy
▸ assignmentsPolicy(options?): SchemaAccessPolicy
Parameters
Returns
SchemaAccessPolicy
Inherited from
AccessPolicies.assignmentsPolicyrequestsPolicy
▸ requestsPolicy():SchemaAccessPolicy
Returns
SchemaAccessPolicy
Inherited from
AccessPolicies.requestsPolicyroleDefinitionsPolicy
▸ roleDefinitionsPolicy():SchemaAccessPolicy
Returns
SchemaAccessPolicy
Inherited from
AccessPolicies.roleDefinitionsPolicyassignments
▸ assignments(policy?): ReturnType<typeof assignmentsTable>
Parameters
Returns
ReturnType<typeof assignmentsTable>
Inherited from
AccessPolicies.assignmentsrequests
▸ requests():ReturnType<typeof requestsTable>
Returns
ReturnType<typeof requestsTable>
Inherited from
AccessPolicies.requestsroleDefinitions
▸ roleDefinitions():ReturnType<typeof roleDefinitionsTable>
Returns
ReturnType<typeof roleDefinitionsTable>
Inherited from
AccessPolicies.roleDefinitionsresource
▸ resource(type, key): AccessResourceRef
Parameters
Returns
AccessResourceRef
describe
▸ describe():AccessDescription
Returns
AccessDescription