Class AuthExtensions

Inheritance

System.Object

AuthExtensions

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: ETCD.V3

Assembly: cs.temp.dll.dll

Syntax

public static class AuthExtensions

Methods

AuthDisable(Client)

AuthDisable disables authentication.

Declaration

public static AuthDisableResponse AuthDisable(this Client client)

Parameters

Type	Name	Description
Client	client

Returns

Type	Description
AuthDisableResponse	The response received from the server.

AuthDisableAsync(Client)

AuthDisable disables authentication.

Declaration

public static AsyncUnaryCall<AuthDisableResponse> AuthDisableAsync(this Client client)

Parameters

Type	Name	Description
Client	client

Returns

Type	Description
AsyncUnaryCall<AuthDisableResponse>	The call object.

Authebtucate(Client, String, String)

Authenticate processes an authenticate request.

Declaration

public static AuthenticateResponse Authebtucate(this Client client, string name, string password)

Parameters

Type	Name	Description
Client	client
System.String	name	User Name.
System.String	password	User Password.

Returns

Type	Description
AuthenticateResponse	The response received from the server.

AuthEnable(Client)

AuthEnable enables authentication.

Declaration

public static AuthEnableResponse AuthEnable(this Client client)

Parameters

Type	Name	Description
Client	client

Returns

Type	Description
AuthEnableResponse	The response received from the server.

AuthEnableAsync(Client)

AuthEnable enables authentication.

Declaration

public static AsyncUnaryCall<AuthEnableResponse> AuthEnableAsync(this Client client)

Parameters

Type	Name	Description
Client	client

Returns

Type	Description
AsyncUnaryCall<AuthEnableResponse>	The call object.

AuthenticateAsync(Client, String, String)

Authenticate processes an authenticate request.

Declaration

public static AsyncUnaryCall<AuthenticateResponse> AuthenticateAsync(this Client client, string name, string password)

Parameters

Type	Name	Description
Client	client
System.String	name	User Name.
System.String	password	User Password.

Returns

Type	Description
AsyncUnaryCall<AuthenticateResponse>	The call object.

CreateAuthenticateRequest(Client, String, String)

Authenticate processes an authenticate request.

Declaration

public static AuthenticateRequest CreateAuthenticateRequest(this Client client, string name, string password)

Parameters

Type	Name	Description
Client	client
System.String	name	User Name.
System.String	password	User Password.

Returns

Type	Description
AuthenticateRequest	The response received from the server.

CreateAuthUserAddRequest(Client, String, String)

Create AuthUserAddRequest.

Declaration

public static AuthUserAddRequest CreateAuthUserAddRequest(this Client client, string name, string password)

Parameters

Type	Name	Description
Client	client
System.String	name	User Name.
System.String	password	User Password.

Returns

Type	Description
AuthUserAddRequest	AuthUserAddRequest.

CreateAuthUserChangePasswordRequest(Client, String, String)

Create AuthUserChangePasswordRequest

Declaration

public static AuthUserChangePasswordRequest CreateAuthUserChangePasswordRequest(this Client client, string name, string password)

Parameters

Type	Name	Description
Client	client
System.String	name	User Name.
System.String	password	User Password.

Returns

Type	Description
AuthUserChangePasswordRequest	AuthUserChangePasswordRequest.

CreateAuthUserDeleteRequest(Client, String)

Create AuthUserDeleteRequest.

Declaration

public static AuthUserDeleteRequest CreateAuthUserDeleteRequest(this Client client, string name)

Parameters

Type	Name	Description
Client	client
System.String	name	User Name.

Returns

Type	Description
AuthUserDeleteRequest	AuthUserDeleteRequest.

CreateAuthUserGetRequest(Client, String)

Create AuthUserGetRequest.

Declaration

public static AuthUserGetRequest CreateAuthUserGetRequest(this Client client, string name)

Parameters

Type	Name	Description
Client	client
System.String	name	User Name.

Returns

Type	Description
AuthUserGetRequest	AuthUserGetRequest.

CreateRoleAddRequest(Client, String)

Create RoleGetRequest.

Declaration

public static AuthRoleAddRequest CreateRoleAddRequest(this Client client, string role)

Parameters

Type	Name	Description
Client	client
System.String	role	name is the name of the role to add to the authentication system.

Returns

Type	Description
AuthRoleAddRequest	AuthRoleGetRequest.

CreateRoleDeleteRequest(Client, String)

Create RoleDeleteRequest.

Declaration

public static AuthRoleDeleteRequest CreateRoleDeleteRequest(this Client client, string role)

Parameters

Type	Name	Description
Client	client
System.String	role	The role name.

Returns

Type	Description
AuthRoleDeleteRequest	AuthRoleDeleteRequest.

CreateRoleGetRequest(Client, String)

Create RoleGetRequest.

Declaration

public static AuthRoleGetRequest CreateRoleGetRequest(this Client client, string role)

Parameters

Type	Name	Description
Client	client
System.String	role	The role name.

Returns

Type	Description
AuthRoleGetRequest	AuthRoleGetRequest.

CreateRoleGrantPermissionRequest(Client, String, ByteString, ByteString, Permission.Types.Type)

Create RoleGrantPermissionRequest.

Declaration

public static AuthRoleGrantPermissionRequest CreateRoleGrantPermissionRequest(this Client client, string name, ByteString key, ByteString rangeEnd, Permission.Types.Type permType = null)

Parameters

Type	Name	Description
Client	client
System.String	name	name is the name of the role which will be granted the permission.
ByteString	key	key is the first key to RoleGrantPermission.
ByteString	rangeEnd	range_end is the key following the last key to delete for the range [key, range_end). If range_end is not given, the range is defined to contain only the key argument. If range_end is one bit larger than the given key, then the range is all the keys with the prefix (the given key). If range_end is '\0', the range is all keys greater than or equal to the key argument.
Permission.Types.Type	permType	Permission message type.

Returns

Type	Description
AuthRoleGrantPermissionRequest	AuthRoleGrantPermissionRequest.

CreateRoleRevokePermissionRequest(Client, String, String, String)

Create RoleRevokePermissionRequest.

Declaration

public static AuthRoleRevokePermissionRequest CreateRoleRevokePermissionRequest(this Client client, string role, string key, string rangeEnd)

Parameters

Type	Name	Description
Client	client
System.String	role	The role name.
System.String	key	key is the first key to RoleGrantPermission.
System.String	rangeEnd	range_end is the key following the last key to delete for the range [key, range_end). If range_end is not given, the range is defined to contain only the key argument. If range_end is one bit larger than the given key, then the range is all the keys with the prefix (the given key). If range_end is '\0', the range is all keys greater than or equal to the key argument.

Returns

Type	Description
AuthRoleRevokePermissionRequest	AuthRoleRevokePermissionRequest.

CreateUserGrantRoleRequest(Client, String, String)

Create UserGrantRoleRequest.

Declaration

public static AuthUserGrantRoleRequest CreateUserGrantRoleRequest(this Client client, string user, string role)

Parameters

Type	Name	Description
Client	client
System.String	user	user is the name of the user which should be granted a given role.
System.String	role	role is the name of the role to grant to the user.

Returns

Type	Description
AuthUserGrantRoleRequest	AuthUserGrantRoleRequest.

CreateUserRevokeRoleRequest(Client, String, String)

Create UserRevokeRoleRequest.

Declaration

public static AuthUserRevokeRoleRequest CreateUserRevokeRoleRequest(this Client client, string user, string role)

Parameters

Type	Name	Description
Client	client
System.String	user	user is the name of the user which should be Revoked a given role.
System.String	role	role is the name of the role to Revoked to the user.

Returns

Type	Description
AuthUserRevokeRoleRequest	AuthUserRevokeRoleRequest.

RoleAdd(Client, String)

RoleAdd adds a new role.

Declaration

public static AuthRoleAddResponse RoleAdd(this Client client, string role)

Parameters

Type	Name	Description
Client	client
System.String	role	name is the name of the role to add to the authentication system.

Returns

Type	Description
AuthRoleAddResponse	The response received from the server.

RoleAddAsync(Client, String)

RoleAdd adds a new role.

Declaration

public static AsyncUnaryCall<AuthRoleAddResponse> RoleAddAsync(this Client client, string role)

Parameters

Type	Name	Description
Client	client
System.String	role	name is the name of the role to add to the authentication system.

Returns

Type	Description
AsyncUnaryCall<AuthRoleAddResponse>	The call object.

RoleDelete(Client, String)

RoleDelete deletes a specified role.

Declaration

public static AuthRoleDeleteResponse RoleDelete(this Client client, string role)

Parameters

Type	Name	Description
Client	client
System.String	role	The role name.

Returns

Type	Description
AuthRoleDeleteResponse	The response received from the server.

RoleDeleteAsync(Client, String)

RoleDelete deletes a specified role.

Declaration

public static AsyncUnaryCall<AuthRoleDeleteResponse> RoleDeleteAsync(this Client client, string role)

Parameters

Type	Name	Description
Client	client
System.String	role	The role name.

Returns

Type	Description
AsyncUnaryCall<AuthRoleDeleteResponse>	The call object.

RoleGet(Client, String)

RoleGet gets detailed role information.

Declaration

public static AuthRoleGetResponse RoleGet(this Client client, string role)

Parameters

Type	Name	Description
Client	client
System.String	role	The role name.

Returns

Type	Description
AuthRoleGetResponse	The response received from the server.

RoleGetAsync(Client, String)

RoleGet gets detailed role information.

Declaration

public static AsyncUnaryCall<AuthRoleGetResponse> RoleGetAsync(this Client client, string role)

Parameters

Type	Name	Description
Client	client
System.String	role	The role name.

Returns

Type	Description
AsyncUnaryCall<AuthRoleGetResponse>	The call object.

RoleGrantPermission(Client, String, ByteString, ByteString, Permission.Types.Type)

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

Declaration

public static AuthRoleGrantPermissionResponse RoleGrantPermission(this Client client, string name, ByteString key, ByteString rangeEnd, Permission.Types.Type permType = null)

Parameters

Type	Name	Description
Client	client
System.String	name	name is the name of the role which will be granted the permission.
ByteString	key	key is the first key to RoleGrantPermission.
ByteString	rangeEnd	range_end is the key following the last key to delete for the range [key, range_end). If range_end is not given, the range is defined to contain only the key argument. If range_end is one bit larger than the given key, then the range is all the keys with the prefix (the given key). If range_end is '\0', the range is all keys greater than or equal to the key argument.
Permission.Types.Type	permType	Permission message type.

Returns

Type	Description
AuthRoleGrantPermissionResponse	The response received from the server.

RoleGrantPermission(Client, String, String, String, Permission.Types.Type)

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

Declaration

public static AuthRoleGrantPermissionResponse RoleGrantPermission(this Client client, string name, string key, string rangeEnd, Permission.Types.Type permType = null)

Parameters

Type	Name	Description
Client	client
System.String	name	name is the name of the role which will be granted the permission.
System.String	key	key is the first key to RoleGrantPermission.
System.String	rangeEnd	range_end is the key following the last key to delete for the range [key, range_end). If range_end is not given, the range is defined to contain only the key argument. If range_end is one bit larger than the given key, then the range is all the keys with the prefix (the given key). If range_end is '\0', the range is all keys greater than or equal to the key argument.
Permission.Types.Type	permType	Permission message type.

Returns

Type	Description
AuthRoleGrantPermissionResponse	The response received from the server.

RoleGrantPermissionAsync(Client, String, ByteString, ByteString, Permission.Types.Type)

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

Declaration

public static AsyncUnaryCall<AuthRoleGrantPermissionResponse> RoleGrantPermissionAsync(this Client client, string name, ByteString key, ByteString rangeEnd, Permission.Types.Type permType = null)

Parameters

Type	Name	Description
Client	client
System.String	name	name is the name of the role which will be granted the permission.
ByteString	key	key is the first key to RoleGrantPermission.
ByteString	rangeEnd	range_end is the key following the last key to delete for the range [key, range_end). If range_end is not given, the range is defined to contain only the key argument. If range_end is one bit larger than the given key, then the range is all the keys with the prefix (the given key). If range_end is '\0', the range is all keys greater than or equal to the key argument.
Permission.Types.Type	permType	Permission message type.

Returns

Type	Description
AsyncUnaryCall<AuthRoleGrantPermissionResponse>	The call object.

RoleGrantPermissionAsync(Client, String, String, String, Permission.Types.Type)

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

Declaration

public static AsyncUnaryCall<AuthRoleGrantPermissionResponse> RoleGrantPermissionAsync(this Client client, string name, string key, string rangeEnd, Permission.Types.Type permType = null)

Parameters

Type	Name	Description
Client	client
System.String	name	name is the name of the role which will be granted the permission.
System.String	key	key is the first key to RoleGrantPermission.
System.String	rangeEnd	range_end is the key following the last key to delete for the range [key, range_end). If range_end is not given, the range is defined to contain only the key argument. If range_end is one bit larger than the given key, then the range is all the keys with the prefix (the given key). If range_end is '\0', the range is all keys greater than or equal to the key argument.
Permission.Types.Type	permType	Permission message type.

Returns

Type	Description
AsyncUnaryCall<AuthRoleGrantPermissionResponse>	The call object.

RoleList(Client)

RoleList gets lists of all roles.

Declaration

public static AuthRoleListResponse RoleList(this Client client)

Parameters

Type	Name	Description
Client	client

Returns

Type	Description
AuthRoleListResponse	The response received from the server.

RoleListAsync(Client)

RoleList gets lists of all roles.

Declaration

public static AsyncUnaryCall<AuthRoleListResponse> RoleListAsync(this Client client)

Parameters

Type	Name	Description
Client	client

Returns

Type	Description
AsyncUnaryCall<AuthRoleListResponse>	The call object.

RoleRevokePermission(Client, String, String, String)

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

Declaration

public static AuthRoleRevokePermissionResponse RoleRevokePermission(this Client client, string role, string key, string rangeEnd)

Parameters

Type	Name	Description
Client	client
System.String	role	The role name.
System.String	key	key is the first key to RoleGrantPermission.
System.String	rangeEnd	range_end is the key following the last key to delete for the range [key, range_end). If range_end is not given, the range is defined to contain only the key argument. If range_end is one bit larger than the given key, then the range is all the keys with the prefix (the given key). If range_end is '\0', the range is all keys greater than or equal to the key argument.

Returns

Type	Description
AuthRoleRevokePermissionResponse	The response received from the server.

RoleRevokePermissionAsync(Client, String, String, String)

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

Declaration

public static AsyncUnaryCall<AuthRoleRevokePermissionResponse> RoleRevokePermissionAsync(this Client client, string role, string key, string rangeEnd)

Parameters

Type	Name	Description
Client	client
System.String	role	The role name.
System.String	key	key is the first key to RoleGrantPermission.
System.String	rangeEnd	range_end is the key following the last key to delete for the range [key, range_end). If range_end is not given, the range is defined to contain only the key argument. If range_end is one bit larger than the given key, then the range is all the keys with the prefix (the given key). If range_end is '\0', the range is all keys greater than or equal to the key argument.

Returns

Type	Description
AsyncUnaryCall<AuthRoleRevokePermissionResponse>	The call object.

UserAdd(Client, String, String)

UserAdd adds a new user.

Declaration

public static AuthUserAddResponse UserAdd(this Client client, string name, string password)

Parameters

Type	Name	Description
Client	client
System.String	name	User Name.
System.String	password	User Password.

Returns

Type	Description
AuthUserAddResponse	The response received from the server.

UserAddAsync(Client, String, String)

UserAdd adds a new user.

Declaration

public static AsyncUnaryCall<AuthUserAddResponse> UserAddAsync(this Client client, string name, string password)

Parameters

Type	Name	Description
Client	client
System.String	name	User Name.
System.String	password	User Password.

Returns

Type	Description
AsyncUnaryCall<AuthUserAddResponse>	The call object.

UserChangePassword(Client, String, String)

UserChangePassword changes the password of a specified user.

Declaration

public static AuthUserChangePasswordResponse UserChangePassword(this Client client, string name, string password)

Parameters

Type	Name	Description
Client	client
System.String	name	User Name.
System.String	password	User Password.

Returns

Type	Description
AuthUserChangePasswordResponse	The response received from the server.

UserChangePasswordAsync(Client, String, String)

UserChangePassword changes the password of a specified user.

Declaration

public static AsyncUnaryCall<AuthUserChangePasswordResponse> UserChangePasswordAsync(this Client client, string name, string password)

Parameters

Type	Name	Description
Client	client
System.String	name	User Name.
System.String	password	User Password.

Returns

Type	Description
AsyncUnaryCall<AuthUserChangePasswordResponse>	The call object.

UserDelete(Client, String)

UserDelete deletes a specified user.

Declaration

public static AuthUserDeleteResponse UserDelete(this Client client, string name)

Parameters

Type	Name	Description
Client	client
System.String	name	User Name.

Returns

Type	Description
AuthUserDeleteResponse	The response received from the server.

UserDeleteAsync(Client, String)

UserDelete deletes a specified user.

Declaration

public static AsyncUnaryCall<AuthUserDeleteResponse> UserDeleteAsync(this Client client, string name)

Parameters

Type	Name	Description
Client	client
System.String	name	User Name.

Returns

Type	Description
AsyncUnaryCall<AuthUserDeleteResponse>	The call object.

UserGet(Client, String)

UserGet gets detailed user information.

Declaration

public static AuthUserGetResponse UserGet(this Client client, string name)

Parameters

Type	Name	Description
Client	client
System.String	name	User Name.

Returns

Type	Description
AuthUserGetResponse	The response received from the server.

UserGetAsync(Client, String)

UserGet gets detailed user information.

Declaration

public static AsyncUnaryCall<AuthUserGetResponse> UserGetAsync(this Client client, string name)

Parameters

Type	Name	Description
Client	client
System.String	name	User Name.

Returns

Type	Description
AsyncUnaryCall<AuthUserGetResponse>	The call object.

UserGrantRole(Client, String, String)

UserGrant grants a role to a specified user.

Declaration

public static AuthUserGrantRoleResponse UserGrantRole(this Client client, string user, string role)

Parameters

Type	Name	Description
Client	client
System.String	user	user is the name of the user which should be granted a given role.
System.String	role	role is the name of the role to grant to the user.

Returns

Type	Description
AuthUserGrantRoleResponse	The response received from the server.

UserGrantRoleAsync(Client, String, String)

UserGrant grants a role to a specified user.

Declaration

public static AsyncUnaryCall<AuthUserGrantRoleResponse> UserGrantRoleAsync(this Client client, string user, string role)

Parameters

Type	Name	Description
Client	client
System.String	user	user is the name of the user which should be granted a given role.
System.String	role	role is the name of the role to grant to the user.

Returns

Type	Description
AsyncUnaryCall<AuthUserGrantRoleResponse>	The call object.

UserList(Client)

UserList gets a list of all users.

Declaration

public static AuthUserListResponse UserList(this Client client)

Parameters

Type	Name	Description
Client	client

Returns

Type	Description
AuthUserListResponse	The response received from the server.

UserListAsync(Client)

UserList gets a list of all users.

Declaration

public static AsyncUnaryCall<AuthUserListResponse> UserListAsync(this Client client)

Parameters

Type	Name	Description
Client	client

Returns

Type	Description
AsyncUnaryCall<AuthUserListResponse>	The call object.

UserRevokeRole(Client, String, String)

UserRevokeRole revokes a role of specified user.

Declaration

public static AuthUserRevokeRoleResponse UserRevokeRole(this Client client, string user, string role)

Parameters

Type	Name	Description
Client	client
System.String	user	user is the name of the user which should be Revoked a given role.
System.String	role	role is the name of the role to Revoked to the user.

Returns

Type	Description
AuthUserRevokeRoleResponse	The response received from the server.

UserRevokeRoleAsync(Client, String, String)

UserRevokeRole revokes a role of specified user.

Declaration

public static AsyncUnaryCall<AuthUserRevokeRoleResponse> UserRevokeRoleAsync(this Client client, string user, string role)

Parameters

Type	Name	Description
Client	client
System.String	user	user is the name of the user which should be Revoked a given role.
System.String	role	role is the name of the role to Revoked to the user.

Returns

Type	Description
AsyncUnaryCall<AuthUserRevokeRoleResponse>	The call object.