Interface Security

Returns SystemAuthenticationScriptBuilder

a script builder

Parameters

• principal: string

• credentials: string

Returns Result<void>

a Result

Example:

session.security.changePrincipal('foo', 'password');

Returns Result<GlobalPermission[]>

the set of global permissions. This may be empty indicating that the role has no global permissions assigned.

Parameters

• path: string

Returns Result<PathPermission[]>

a Result which completes when the response is received from the server.

If the request was successful, the Result will complete successfully with a list of PathPermission.

Returns string

the session's principal

Returns Result<SecurityConfiguration>

a Result that completes with the security configuration

Returns Result<SystemAuthenticationConfiguration>

a Result that completes with the server's authentication store

Returns SecurityScriptBuilder

a script builder

Parameters

• handlerName: string

• authenticator: Authenticator

Returns Result<Registration>

a Result that completes when the authentication handler has been registered, returning a Registration which can be used to unregister the authentication handler.

Otherwise, the Result will resolve with an error. Common reasons for failure include:

• the session is closed;
• the session does not have REGISTER_HANDLER or AUTHENTICATE permission;
• the server configuration does not contain a control-authentication-handler element with the given name.
• NullValueError – if any of the arguments are null or undefined

Parameters

• script: string

Returns Result<void>

a Result

Parameters

• script: string

Returns Result<void>

a Result