Class Auth.AuthBase

Base class for server-side implementations of Auth

Inheritance

System.Object

Auth.AuthBase

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Etcdserverpb

Assembly: cs.temp.dll.dll

Syntax

public abstract class AuthBase

Methods

AuthDisable(AuthDisableRequest, grpc.ServerCallContext)

AuthDisable disables authentication.

Declaration

public virtual Task<AuthDisableResponse> AuthDisable(AuthDisableRequest request, grpc.ServerCallContext context)

Parameters

Type	Name	Description
AuthDisableRequest	request	The request received from the client.
grpc.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
System.Threading.Tasks.Task<AuthDisableResponse>	The response to send back to the client (wrapped by a task).

AuthEnable(AuthEnableRequest, grpc.ServerCallContext)

AuthEnable enables authentication.

Declaration

public virtual Task<AuthEnableResponse> AuthEnable(AuthEnableRequest request, grpc.ServerCallContext context)

Parameters

Type	Name	Description
AuthEnableRequest	request	The request received from the client.
grpc.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
System.Threading.Tasks.Task<AuthEnableResponse>	The response to send back to the client (wrapped by a task).

Authenticate(AuthenticateRequest, grpc.ServerCallContext)

Authenticate processes an authenticate request.

Declaration

public virtual Task<AuthenticateResponse> Authenticate(AuthenticateRequest request, grpc.ServerCallContext context)

Parameters

Type	Name	Description
AuthenticateRequest	request	The request received from the client.
grpc.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
System.Threading.Tasks.Task<AuthenticateResponse>	The response to send back to the client (wrapped by a task).

RoleAdd(AuthRoleAddRequest, grpc.ServerCallContext)

RoleAdd adds a new role.

Declaration

public virtual Task<AuthRoleAddResponse> RoleAdd(AuthRoleAddRequest request, grpc.ServerCallContext context)

Parameters

Type	Name	Description
AuthRoleAddRequest	request	The request received from the client.
grpc.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
System.Threading.Tasks.Task<AuthRoleAddResponse>	The response to send back to the client (wrapped by a task).

RoleDelete(AuthRoleDeleteRequest, grpc.ServerCallContext)

RoleDelete deletes a specified role.

Declaration

public virtual Task<AuthRoleDeleteResponse> RoleDelete(AuthRoleDeleteRequest request, grpc.ServerCallContext context)

Parameters

Type	Name	Description
AuthRoleDeleteRequest	request	The request received from the client.
grpc.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
System.Threading.Tasks.Task<AuthRoleDeleteResponse>	The response to send back to the client (wrapped by a task).

RoleGet(AuthRoleGetRequest, grpc.ServerCallContext)

RoleGet gets detailed role information.

Declaration

public virtual Task<AuthRoleGetResponse> RoleGet(AuthRoleGetRequest request, grpc.ServerCallContext context)

Parameters

Type	Name	Description
AuthRoleGetRequest	request	The request received from the client.
grpc.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
System.Threading.Tasks.Task<AuthRoleGetResponse>	The response to send back to the client (wrapped by a task).

RoleGrantPermission(AuthRoleGrantPermissionRequest, grpc.ServerCallContext)

RoleGrantPermission grants a permission of a specified key or range to a specified role.

Declaration

public virtual Task<AuthRoleGrantPermissionResponse> RoleGrantPermission(AuthRoleGrantPermissionRequest request, grpc.ServerCallContext context)

Parameters

Type	Name	Description
AuthRoleGrantPermissionRequest	request	The request received from the client.
grpc.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
System.Threading.Tasks.Task<AuthRoleGrantPermissionResponse>	The response to send back to the client (wrapped by a task).

RoleList(AuthRoleListRequest, grpc.ServerCallContext)

RoleList gets lists of all roles.

Declaration

public virtual Task<AuthRoleListResponse> RoleList(AuthRoleListRequest request, grpc.ServerCallContext context)

Parameters

Type	Name	Description
AuthRoleListRequest	request	The request received from the client.
grpc.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
System.Threading.Tasks.Task<AuthRoleListResponse>	The response to send back to the client (wrapped by a task).

RoleRevokePermission(AuthRoleRevokePermissionRequest, grpc.ServerCallContext)

RoleRevokePermission revokes a key or range permission of a specified role.

Declaration

public virtual Task<AuthRoleRevokePermissionResponse> RoleRevokePermission(AuthRoleRevokePermissionRequest request, grpc.ServerCallContext context)

Parameters

Type	Name	Description
AuthRoleRevokePermissionRequest	request	The request received from the client.
grpc.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
System.Threading.Tasks.Task<AuthRoleRevokePermissionResponse>	The response to send back to the client (wrapped by a task).

UserAdd(AuthUserAddRequest, grpc.ServerCallContext)

UserAdd adds a new user.

Declaration

public virtual Task<AuthUserAddResponse> UserAdd(AuthUserAddRequest request, grpc.ServerCallContext context)

Parameters

Type	Name	Description
AuthUserAddRequest	request	The request received from the client.
grpc.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
System.Threading.Tasks.Task<AuthUserAddResponse>	The response to send back to the client (wrapped by a task).

UserChangePassword(AuthUserChangePasswordRequest, grpc.ServerCallContext)

UserChangePassword changes the password of a specified user.

Declaration

public virtual Task<AuthUserChangePasswordResponse> UserChangePassword(AuthUserChangePasswordRequest request, grpc.ServerCallContext context)

Parameters

Type	Name	Description
AuthUserChangePasswordRequest	request	The request received from the client.
grpc.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
System.Threading.Tasks.Task<AuthUserChangePasswordResponse>	The response to send back to the client (wrapped by a task).

UserDelete(AuthUserDeleteRequest, grpc.ServerCallContext)

UserDelete deletes a specified user.

Declaration

public virtual Task<AuthUserDeleteResponse> UserDelete(AuthUserDeleteRequest request, grpc.ServerCallContext context)

Parameters

Type	Name	Description
AuthUserDeleteRequest	request	The request received from the client.
grpc.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
System.Threading.Tasks.Task<AuthUserDeleteResponse>	The response to send back to the client (wrapped by a task).

UserGet(AuthUserGetRequest, grpc.ServerCallContext)

UserGet gets detailed user information.

Declaration

public virtual Task<AuthUserGetResponse> UserGet(AuthUserGetRequest request, grpc.ServerCallContext context)

Parameters

Type	Name	Description
AuthUserGetRequest	request	The request received from the client.
grpc.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
System.Threading.Tasks.Task<AuthUserGetResponse>	The response to send back to the client (wrapped by a task).

UserGrantRole(AuthUserGrantRoleRequest, grpc.ServerCallContext)

UserGrant grants a role to a specified user.

Declaration

public virtual Task<AuthUserGrantRoleResponse> UserGrantRole(AuthUserGrantRoleRequest request, grpc.ServerCallContext context)

Parameters

Type	Name	Description
AuthUserGrantRoleRequest	request	The request received from the client.
grpc.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
System.Threading.Tasks.Task<AuthUserGrantRoleResponse>	The response to send back to the client (wrapped by a task).

UserList(AuthUserListRequest, grpc.ServerCallContext)

UserList gets a list of all users.

Declaration

public virtual Task<AuthUserListResponse> UserList(AuthUserListRequest request, grpc.ServerCallContext context)

Parameters

Type	Name	Description
AuthUserListRequest	request	The request received from the client.
grpc.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
System.Threading.Tasks.Task<AuthUserListResponse>	The response to send back to the client (wrapped by a task).

UserRevokeRole(AuthUserRevokeRoleRequest, grpc.ServerCallContext)

UserRevokeRole revokes a role of specified user.

Declaration

public virtual Task<AuthUserRevokeRoleResponse> UserRevokeRole(AuthUserRevokeRoleRequest request, grpc.ServerCallContext context)

Parameters

Type	Name	Description
AuthUserRevokeRoleRequest	request	The request received from the client.
grpc.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
System.Threading.Tasks.Task<AuthUserRevokeRoleResponse>	The response to send back to the client (wrapped by a task).