External module security

Index

Classes

Server

Interfaces

Variables

Functions

Variables

ANONYMOUS_AUTHORIZATION

ANONYMOUS_AUTHORIZATION: Authorization

immutable Authorization representing the anonymous user.

type: {Authorization}

ROLE_ADMIN

ROLE_ADMIN: string

Administrator's role name. Users in this role should have full access to all services in the system.

ROLE_AUTHENTICATED

ROLE_AUTHENTICATED: string

Virtual role for all authenticated users.

USER_ANYONE

USER_ANYONE: string

The name of the predefined role, user.anyone, that all users and groups belong to.

Functions

cloneCredentials

cloneCredentials<CredentialsT>(credentials: CredentialsT): CredentialsT

- Defined in security/auth.ts:45
Type parameters
- CredentialsT: Credentials
Parameters
- credentials: CredentialsT
Returns CredentialsT

freezeAuthorization

freezeAuthorization(authorization: Authorization): Authorization

- Defined in security/auth.ts:78
turns the object deeply immutable.

internal

for library use only.

Parameters
- authorization: Authorization
  
  to freeze.
Returns Authorization

authorization for convenience.

freezeCredentials

freezeCredentials<CredentialsT>(credentials: CredentialsT): CredentialsT

- Defined in security/auth.ts:49
Type parameters
- CredentialsT: Credentials
Parameters
- credentials: CredentialsT
Returns CredentialsT

freezeOrganization

freezeOrganization(organization: Organization): Organization

- Defined in security/roles.ts:55
turns the object deeply immutable.

internal

for library use only.

Parameters
- organization: Organization
  
  to freeze.
Returns Organization

organization for convenience.

freezeUser

freezeUser(user: User): User

- Defined in security/roles.ts:96
turns the object deeply immutable.

internal

for library use only.

Parameters
- user: User
  
  to freeze.
Returns User

user for convenience.

getCurrentAuthorization

getCurrentAuthorization(): Authorization

- Defined in security/server.ts:196
gets the Authorization in effect.

Returns Authorization

in effect, may be null.

getCurrentOrganization

getCurrentOrganization(...fields: string[]): Organization

- Defined in security/server.ts:206
gets the Organization in effect.

Parameters
- Rest ...fields: string[]
  
  of interest.
Returns Organization

in effect, may be null.

getCurrentServer

getCurrentServer(): Server

- Defined in security/server.ts:172
gets the current Server.

internal

for library use only.

Returns Server

state parameter.

getCurrentUser

getCurrentUser(...fields: string[]): User

- Defined in security/server.ts:225
gets the User in effect.

Parameters
- Rest ...fields: string[]
  
  of interest.
Returns User

in effect, may be null.

setCurrentOrganization

setCurrentOrganization(organization: Organization): void

- Defined in security/server.ts:214
sets the Organization.

Parameters
- organization: Organization
  
  to set.
Returns void

setCurrentServer

setCurrentServer(server: Server): void

- Defined in security/server.ts:182
sets the current Server.

internal

for library use only.

Parameters
- server: Server
  
  to set state of.
Returns void

Generated using TypeDoc