Standard libraryhttpclasses

ListenerFileUserStoreBasicAuthHandler

Class: ListenerFileUserStoreBasicAuthHandler

Isolated

Defines the file store Basic Auth handler for listener authentication.

Constructor

Initializes the http:ListenerFileUserStoreBasicAuthHandler object.

init (FileUserStoreConfig config)

Methods

authenticate

Authenticates with the relevant authentication requirements.

authorize

Authorizes with the relevant authorization requirements.

authenticate 

function authenticate(Request | Headers | string data) returns UserDetails | Unauthorized
Isolated Function

Authenticates with the relevant authentication requirements.

Parameters

  • data Request | Headers | string

    • The http:Request instance or http:Headers instance or string Authorization header

Return Type

(UserDetails | Unauthorized)

The auth:UserDetails instance or else Unauthorized type in case of an error

authorize 

function authorize(UserDetails userDetails, string | string[ ] expectedScopes) returns Forbidden?
Isolated Function

Authorizes with the relevant authorization requirements.

Parameters

  • userDetails UserDetails

    • The auth:UserDetails instance which is received from authentication results

  • expectedScopes string | string[ ]

    • The expected scopes as string or string[]

Return Type

(Forbidden?)

(), if it is successful or else Forbidden type in case of an error