Class AuthClient

Constructors

constructor

new AuthClient(client: ICallable<unknown>): AuthClient
Parameters
- client: ICallable<unknown>
Returns AuthClient
- Defined in src/rpc.ts:331

Methods

authDisable

authDisable(options?: CallOptions): Promise<IAuthDisableResponse>
AuthDisable disables authentication.
Parameters
- Optionaloptions: CallOptions
Returns Promise<IAuthDisableResponse>
- Defined in src/rpc.ts:341

authEnable

authEnable(options?: CallOptions): Promise<IAuthEnableResponse>
AuthEnable enables authentication.
Parameters
- Optionaloptions: CallOptions
Returns Promise<IAuthEnableResponse>
- Defined in src/rpc.ts:335

authenticate

authenticate(
req: IAuthenticateRequest,
options?: CallOptions,
): Promise<IAuthenticateResponse>
Authenticate processes an authenticate request.
Parameters
- req: IAuthenticateRequest
- Optionaloptions: CallOptions
Returns Promise<IAuthenticateResponse>
- Defined in src/rpc.ts:353

authStatus

authStatus(options?: CallOptions): Promise<IAuthStatusResponse>
AuthStatus displays authentication status.
Parameters
- Optionaloptions: CallOptions
Returns Promise<IAuthStatusResponse>
- Defined in src/rpc.ts:347

roleAdd

roleAdd(
req: IAuthRoleAddRequest,
options?: CallOptions,
): Promise<IAuthRoleAddResponse>
RoleAdd adds a new role. Role name cannot be empty.
Parameters
- req: IAuthRoleAddRequest
- Optionaloptions: CallOptions
Returns Promise<IAuthRoleAddResponse>
- Defined in src/rpc.ts:422

roleDelete

roleDelete(
req: IAuthRoleDeleteRequest,
options?: CallOptions,
): Promise<IAuthRoleDeleteResponse>
RoleDelete deletes a specified role.
Parameters
- req: IAuthRoleDeleteRequest
- Optionaloptions: CallOptions
Returns Promise<IAuthRoleDeleteResponse>
- Defined in src/rpc.ts:446

roleGet

roleGet(
req: IAuthRoleGetRequest,
options?: CallOptions,
): Promise<IAuthRoleGetResponse>
RoleGet gets detailed role information.
Parameters
- req: IAuthRoleGetRequest
- Optionaloptions: CallOptions
Returns Promise<IAuthRoleGetResponse>
- Defined in src/rpc.ts:431

roleGrantPermission

roleGrantPermission(
req: IAuthRoleGrantPermissionRequest,
options?: CallOptions,
): Promise<IAuthRoleGrantPermissionResponse>
RoleGrantPermission grants a permission of a specified key or range to a specified role.
Parameters
- req: IAuthRoleGrantPermissionRequest
- Optionaloptions: CallOptions
Returns Promise<IAuthRoleGrantPermissionResponse>
- Defined in src/rpc.ts:455

roleList

roleList(options?: CallOptions): Promise<IAuthRoleListResponse>
RoleList gets lists of all roles.
Parameters
- Optionaloptions: CallOptions
Returns Promise<IAuthRoleListResponse>
- Defined in src/rpc.ts:440

roleRevokePermission

roleRevokePermission(
req: IAuthRoleRevokePermissionRequest,
options?: CallOptions,
): Promise<IAuthRoleRevokePermissionResponse>
RoleRevokePermission revokes a key or range permission of a specified role.
Parameters
- req: IAuthRoleRevokePermissionRequest
- Optionaloptions: CallOptions
Returns Promise<IAuthRoleRevokePermissionResponse>
- Defined in src/rpc.ts:464

userAdd

userAdd(
req: IAuthUserAddRequest,
options?: CallOptions,
): Promise<IAuthUserAddResponse>
UserAdd adds a new user. User name cannot be empty.
Parameters
- req: IAuthUserAddRequest
- Optionaloptions: CallOptions
Returns Promise<IAuthUserAddResponse>
- Defined in src/rpc.ts:362

userChangePassword

userChangePassword(
req: IAuthUserChangePasswordRequest,
options?: CallOptions,
): Promise<IAuthUserChangePasswordResponse>
UserChangePassword changes the password of a specified user.
Parameters
- req: IAuthUserChangePasswordRequest
- Optionaloptions: CallOptions
Returns Promise<IAuthUserChangePasswordResponse>
- Defined in src/rpc.ts:395

userDelete

userDelete(
req: IAuthUserDeleteRequest,
options?: CallOptions,
): Promise<IAuthUserDeleteResponse>
UserDelete deletes a specified user.
Parameters
- req: IAuthUserDeleteRequest
- Optionaloptions: CallOptions
Returns Promise<IAuthUserDeleteResponse>
- Defined in src/rpc.ts:386

userGet

userGet(
req: IAuthUserGetRequest,
options?: CallOptions,
): Promise<IAuthUserGetResponse>
UserGet gets detailed user information.
Parameters
- req: IAuthUserGetRequest
- Optionaloptions: CallOptions
Returns Promise<IAuthUserGetResponse>
- Defined in src/rpc.ts:371

userGrantRole

userGrantRole(
req: IAuthUserGrantRoleRequest,
options?: CallOptions,
): Promise<IAuthUserGrantRoleResponse>
UserGrantRole grants a role to a specified user.
Parameters
- req: IAuthUserGrantRoleRequest
- Optionaloptions: CallOptions
Returns Promise<IAuthUserGrantRoleResponse>
- Defined in src/rpc.ts:404

userList

userList(options?: CallOptions): Promise<IAuthUserListResponse>
UserList gets a list of all users.
Parameters
- Optionaloptions: CallOptions
Returns Promise<IAuthUserListResponse>
- Defined in src/rpc.ts:380

userRevokeRole

userRevokeRole(
req: IAuthUserRevokeRoleRequest,
options?: CallOptions,
): Promise<IAuthUserRevokeRoleResponse>
UserRevokeRole revokes a role of specified user.
Parameters
- req: IAuthUserRevokeRoleRequest
- Optionaloptions: CallOptions
Returns Promise<IAuthUserRevokeRoleResponse>
- Defined in src/rpc.ts:413