Skip to main content
Version: 57.2.0

AccessOptions

Type Parameters​

S​

S extends Statements

Properties​

auditSink?​

optional auditSink?: RbacAuditSink | RbacAuditSink[]

Extra destinations for RoleManager audit records (e.g. a consuming-app audit log). The built-in RbacAudit collection is still written unless persistAudit is false.

cacheTtlMs?​

optional cacheTtlMs?: number

connection​

connection: Connection

defaultRoles?​

optional defaultRoles?: RoleDefinition[]

fieldViews?​

optional fieldViews?: ResourceFieldViews<S>

persistAudit?​

optional persistAudit?: boolean

When false, skip the built-in RbacAudit collection. At least one auditSink is then required so role mutations cannot go unaudited.

readActions?​

optional readActions?: readonly string[]

resolvePermissions?​

optional resolvePermissions?: (args) => Promise<PermissionSet | null>

Parameters​

args​
user​

User

Returns​

Promise<PermissionSet | null>

scopes?​

optional scopes?: ResourceScopes<S>

sources?​

optional sources?: PermissionSource[]

statementDescriptions?​

optional statementDescriptions?: Record<string, Record<string, string>>

statements​

statements: S

userModel?​

optional userModel?: UserModel