Class default

Index

Constructors

Accessors

isAdmin isAgency isBrand isCreator isService isUser

Methods

authenticate canManageUser canManageUserByEmail canUseAgency canUseBrand getActionerId getUserEmail getUserId

Constructors

constructor

new default(
    permissions: AuthorizerPermissions,
    config: AuthorizerConfig,
    creds?: AuthorizerCredentials,
): default
Constructs an instance of the Authorizer class with the provided permissions, configuration, and credentials.
Parameters
- permissions: AuthorizerPermissions
  The permissions object defining access levels and ACLs.
- config: AuthorizerConfig
  The configuration object for the authorizer.
- Optionalcreds: AuthorizerCredentials
  The credentials object for authentication.
Returns default
- Defined in src/server/Authorizer.ts:41

Accessors

isAdmin

get isAdmin(): boolean
Returns boolean
- Defined in src/server/Authorizer.ts:166

isAgency

get isAgency(): boolean
Returns boolean
- Defined in src/server/Authorizer.ts:178

isBrand

get isBrand(): boolean
Returns boolean
- Defined in src/server/Authorizer.ts:154

isCreator

get isCreator(): boolean
Returns boolean
- Defined in src/server/Authorizer.ts:160

isService

get isService(): boolean
Returns boolean
- Defined in src/server/Authorizer.ts:184

isUser

get isUser(): boolean
Returns boolean
- Defined in src/server/Authorizer.ts:172

Methods

authenticate

authenticate(): Promise<true | ResponseErrorType>
Asynchronously authenticates the user based on permissions and access levels.

Returns Promise<true | ResponseErrorType>
A promise that resolves to true if authentication is successful, or a ResponseErrorType object if there is an error.
- Defined in src/server/Authorizer.ts:76

canManageUser

canManageUser(userId: string, onlySelf?: boolean): boolean
Parameters
- userId: string
- OptionalonlySelf: boolean
Returns boolean
- Defined in src/server/Authorizer.ts:124

canManageUserByEmail

canManageUserByEmail(userEmail: string, onlySelf?: boolean): boolean
Parameters
- userEmail: string
- OptionalonlySelf: boolean
Returns boolean
- Defined in src/server/Authorizer.ts:131

canUseAgency

canUseAgency(agencyId: string): Promise<boolean>
Parameters
- agencyId: string
Returns Promise<boolean>
- Defined in src/server/Authorizer.ts:145

canUseBrand

canUseBrand(brandId: string): Promise<boolean>
Parameters
- brandId: string
Returns Promise<boolean>
- Defined in src/server/Authorizer.ts:137

getActionerId

getActionerId(): string
Returns string
- Defined in src/server/Authorizer.ts:206

getUserEmail

getUserEmail(): null | string
Returns null | string
- Defined in src/server/Authorizer.ts:200

getUserId

getUserId(raw?: boolean): null | string
Parameters
- Optionalraw: boolean
Returns null | string
- Defined in src/server/Authorizer.ts:190