AuthClient | etcd3

Hierarchy

AuthClient

Index

Constructors

constructor

Methods

Constructors

constructor

new AuthClient(client: ICallable<unknown>): AuthClient

- Defined in src/rpc.ts:302
Parameters
- client: ICallable<unknown>
Returns AuthClient

Methods

authDisable

authDisable(options?: grpc.CallOptions): Promise<IAuthDisableResponse>

- Defined in src/rpc.ts:313
AuthDisable disables authentication.

Parameters
- Optional options: grpc.CallOptions
Returns Promise<IAuthDisableResponse>

authEnable

authEnable(options?: grpc.CallOptions): Promise<IAuthEnableResponse>

- Defined in src/rpc.ts:307
AuthEnable enables authentication.

Parameters
- Optional options: grpc.CallOptions
Returns Promise<IAuthEnableResponse>

authStatus

authStatus(options?: grpc.CallOptions): Promise<IAuthStatusResponse>

- Defined in src/rpc.ts:319
AuthStatus displays authentication status.

Parameters
- Optional options: grpc.CallOptions
Returns Promise<IAuthStatusResponse>

authenticate

authenticate(req: IAuthenticateRequest, options?: grpc.CallOptions): Promise<IAuthenticateResponse>

- Defined in src/rpc.ts:325
Authenticate processes an authenticate request.

Parameters
- req: IAuthenticateRequest
- Optional options: grpc.CallOptions
Returns Promise<IAuthenticateResponse>

roleAdd

roleAdd(req: IAuthRoleAddRequest, options?: grpc.CallOptions): Promise<IAuthRoleAddResponse>

- Defined in src/rpc.ts:394
RoleAdd adds a new role. Role name cannot be empty.

Parameters
- req: IAuthRoleAddRequest
- Optional options: grpc.CallOptions
Returns Promise<IAuthRoleAddResponse>

roleDelete

roleDelete(req: IAuthRoleDeleteRequest, options?: grpc.CallOptions): Promise<IAuthRoleDeleteResponse>

- Defined in src/rpc.ts:418
RoleDelete deletes a specified role.

Parameters
- req: IAuthRoleDeleteRequest
- Optional options: grpc.CallOptions
Returns Promise<IAuthRoleDeleteResponse>

roleGet

roleGet(req: IAuthRoleGetRequest, options?: grpc.CallOptions): Promise<IAuthRoleGetResponse>

- Defined in src/rpc.ts:403
RoleGet gets detailed role information.

Parameters
- req: IAuthRoleGetRequest
- Optional options: grpc.CallOptions
Returns Promise<IAuthRoleGetResponse>

roleGrantPermission

roleGrantPermission(req: IAuthRoleGrantPermissionRequest, options?: grpc.CallOptions): Promise<IAuthRoleGrantPermissionResponse>

- Defined in src/rpc.ts:427
RoleGrantPermission grants a permission of a specified key or range to a specified role.

Parameters
- req: IAuthRoleGrantPermissionRequest
- Optional options: grpc.CallOptions
Returns Promise<IAuthRoleGrantPermissionResponse>

roleList

roleList(options?: grpc.CallOptions): Promise<IAuthRoleListResponse>

- Defined in src/rpc.ts:412
RoleList gets lists of all roles.

Parameters
- Optional options: grpc.CallOptions
Returns Promise<IAuthRoleListResponse>

roleRevokePermission

roleRevokePermission(req: IAuthRoleRevokePermissionRequest, options?: grpc.CallOptions): Promise<IAuthRoleRevokePermissionResponse>

- Defined in src/rpc.ts:436
RoleRevokePermission revokes a key or range permission of a specified role.

Parameters
- req: IAuthRoleRevokePermissionRequest
- Optional options: grpc.CallOptions
Returns Promise<IAuthRoleRevokePermissionResponse>

userAdd

userAdd(req: IAuthUserAddRequest, options?: grpc.CallOptions): Promise<IAuthUserAddResponse>

- Defined in src/rpc.ts:334
UserAdd adds a new user. User name cannot be empty.

Parameters
- req: IAuthUserAddRequest
- Optional options: grpc.CallOptions
Returns Promise<IAuthUserAddResponse>

userChangePassword

userChangePassword(req: IAuthUserChangePasswordRequest, options?: grpc.CallOptions): Promise<IAuthUserChangePasswordResponse>

- Defined in src/rpc.ts:367
UserChangePassword changes the password of a specified user.

Parameters
- req: IAuthUserChangePasswordRequest
- Optional options: grpc.CallOptions
Returns Promise<IAuthUserChangePasswordResponse>

userDelete

userDelete(req: IAuthUserDeleteRequest, options?: grpc.CallOptions): Promise<IAuthUserDeleteResponse>

- Defined in src/rpc.ts:358
UserDelete deletes a specified user.

Parameters
- req: IAuthUserDeleteRequest
- Optional options: grpc.CallOptions
Returns Promise<IAuthUserDeleteResponse>

userGet

userGet(req: IAuthUserGetRequest, options?: grpc.CallOptions): Promise<IAuthUserGetResponse>

- Defined in src/rpc.ts:343
UserGet gets detailed user information.

Parameters
- req: IAuthUserGetRequest
- Optional options: grpc.CallOptions
Returns Promise<IAuthUserGetResponse>

userGrantRole

userGrantRole(req: IAuthUserGrantRoleRequest, options?: grpc.CallOptions): Promise<IAuthUserGrantRoleResponse>

- Defined in src/rpc.ts:376
UserGrant grants a role to a specified user.

Parameters
- req: IAuthUserGrantRoleRequest
- Optional options: grpc.CallOptions
Returns Promise<IAuthUserGrantRoleResponse>

userList

userList(options?: grpc.CallOptions): Promise<IAuthUserListResponse>

- Defined in src/rpc.ts:352
UserList gets a list of all users.

Parameters
- Optional options: grpc.CallOptions
Returns Promise<IAuthUserListResponse>

userRevokeRole

userRevokeRole(req: IAuthUserRevokeRoleRequest, options?: grpc.CallOptions): Promise<IAuthUserRevokeRoleResponse>

- Defined in src/rpc.ts:385
UserRevokeRole revokes a role of specified user.

Parameters
- req: IAuthUserRevokeRoleRequest
- Optional options: grpc.CallOptions
Returns Promise<IAuthUserRevokeRoleResponse>

Generated using TypeDoc