Type parameters
Properties
requireAudited
• requireAudited:string extends keyof D["types"] ? (request: ModelAccessRequest<D>) => Promise<GoverningResult> : D extends { audit: true } ? (request: ModelAccessRequest<D>) => Promise<GoverningResult> : never
Methods
renew
▸ renew(input, options?): Promise<GenericId<string>>
Parameters
Returns
Promise<GenericId<string>>
revoke
▸ revoke(input): Promise<void>
Parameters
Returns
Promise<void>
reviewDue
▸ reviewDue(input): Promise<Assignment | null>
Parameters
Returns
Promise<Assignment | null>
inspect
▸ inspect():AccessInspector
Returns
AccessInspector
requestable
▸ requestable(resource): Promise<{ role: string ; maxDuration: number | null ; reasonRequired: boolean }[]>
Parameters
Returns
Promise<{ role: string ; maxDuration: number | null ; reasonRequired: boolean }[]>
readVisible
▸ readVisible(type, ids, options): Promise<VisibleRead[]>
Parameters
Returns
Promise<VisibleRead[]>
check
▸ check(request): Promise<AccessDecision>
Parameters
Returns
Promise<AccessDecision>
checkMany
▸ checkMany(requests): Promise<AccessDecision[]>
Parameters
Returns
Promise<AccessDecision[]>
require
▸ require(request): Promise<GoverningResult>
Parameters
Returns
Promise<GoverningResult>
requirePrincipal
▸ requirePrincipal(request): Promise<GoverningResult>
Parameters
Returns
Promise<GoverningResult>
isInitialOwner
▸ isInitialOwner():Promise<boolean>
Returns
Promise<boolean>
principal
▸ principal():Promise<AccessPrincipal<PrincipalKey<D, EndpointContext<S>>, string> | null>
Returns
Promise<AccessPrincipal<PrincipalKey<D, EndpointContext<S>>, string> | null>
grant
▸ grant(input, options?): Promise<GenericId<string>>
Parameters
Returns
Promise<GenericId<string>>
permissionsOn
▸ permissionsOn(resource): Promise<AccessPermission<D>[]>
Parameters
Returns
Promise<AccessPermission<D>[]>
candidateKeys
▸ candidateKeys<T>(input): Promise<ResourceKey<D, T>[]>
Type parameters
Parameters
Returns
Promise<ResourceKey<D, T>[]>
holders
▸ holders<Target>(resource): Promise<AccessHolders<Target>>
Type parameters
Parameters
Returns
Promise<AccessHolders<Target>>
revokeAll
▸ revokeAll(resource): Promise<number>
Parameters
Returns
Promise<number>
release
▸ release(input): Promise<ExternalCallId>
Parameters
Returns
Promise<ExternalCallId>
sharedPage
▸ sharedPage<T, Fields>(input): Promise<SharedPage<SelectedDocument<SharedDocument<D, T, EndpointContext<S>>, Fields>>>
Type parameters
Parameters
Returns
Promise<SharedPage<SelectedDocument<SharedDocument<D, T, EndpointContext<S>>, Fields>>>
▸ sharedPage<T>(input): Promise<SharedPage<SharedDocument<D, T, EndpointContext<S>>>>
Type parameters
Parameters
Returns
Promise<SharedPage<SharedDocument<D, T, EndpointContext<S>>>>