Class UserSecurityIdentityBuilder

Build a security identity of type USER.

Typically used in conjunction with DocumentBuilder.withAllowedPermissions or DocumentBuilder.withDeniedPermissions.

See SecurityIdentity.

Hierarchy

UserSecurityIdentityBuilder

Implements

SecurityIdentityBuilder

Index

Constructors

constructor

Methods

build

Constructors

constructor

new UserSecurityIdentityBuilder(user: string | string[], securityProvider?: string): UserSecurityIdentityBuilder

- Defined in src/securityIdentityBuilder.ts:54
Pass either a single user, or an array of user to create multiple identities.

Parameters
- user: string | string[]
- securityProvider: string = 'Email Security Provider'
Returns UserSecurityIdentityBuilder

Methods

build

build(): SecurityIdentity | SecurityIdentity[]

Implementation of SecurityIdentityBuilder.build
- Defined in src/securityIdentityBuilder.ts:69
Build and return the security identity or identities.

Returns SecurityIdentity | SecurityIdentity[]

Generated using TypeDoc