Click or drag to resize

UserApiClient Class

A client for interacting with ArangoDB User Management endpoints, implementing IUserApiClient.
Inheritance Hierarchy

Namespace:  ArangoDBNetStandard.UserApi
Assembly:  ArangoDBNetStandard (in ArangoDBNetStandard.dll) Version: 1.1.0
Syntax
public class UserApiClient : ApiClientBase, 
	IUserApiClient

The UserApiClient type exposes the following members.

Constructors
  NameDescription
Public methodUserApiClient(IApiClientTransport)
Creates an instance of UserApiClient using the provided transport layer and the default JSON serialization.
Public methodUserApiClient(IApiClientTransport, IApiClientSerialization)
Creates an instance of UserApiClient using the provided transport and serialization layers.
Top
Methods
  NameDescription
Public methodDeleteCollectionAccessLevelAsync
Clears the collection access levels of a user for a given database. As consequence the default collection access level is used. If there is no defined default database access level, it defaults to 'No access'. You need permission to the '_system' database in order to execute this REST call.
Public methodDeleteDatabaseAccessLevelAsync
Clears the database access levels of a user for a given database. As consequence the default database access level is used. If there is no defined default database access level, it defaults to 'No access'. You need permission to the '_system' database in order to execute this REST call.
Public methodDeleteUserAsync
Delete a user permanently. You need Administrate for the server access level in order to execute this REST call.
Protected methodDeserializeJsonFromStreamT (Inherited from ApiClientBase.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetAccessibleDatabasesAsync
Fetch the list of databases available to the specified user. You need Administrate for the server access level in order to execute this REST call.
Protected methodGetApiErrorException
Gets an ApiErrorException from the provided error response.
(Inherited from ApiClientBase.)
Public methodGetCollectionAccessLevelAsync
Gets specific collection access level of a user for a given database.
Protected methodGetContentT (Inherited from ApiClientBase.)
Protected methodGetContentStringT (Inherited from ApiClientBase.)
Public methodGetDatabaseAccessLevelAsync
Gets specific database access level for a user.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUserAsync
Fetches data about the specified user. You can fetch information about yourself or you need the Administrate server access level in order to execute this REST call.
Public methodGetUsersAsync
Fetches data about all users. You need the Administrate server access level in order to execute this REST call. Otherwise, you will only get information about yourself.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPatchUserAsync
Partially update an existing user. You need server access level Administrate in order to execute this REST call. Additionally, a user can change his/her own data.
Public methodPostUserAsync
Create a new user. You need server access level Administrate in order to execute this REST call.
Public methodPutCollectionAccessLevelAsync
Sets the collection access levels of a user for a given database. You need the Administrate server access level in order to execute this REST call.
Public methodPutDatabaseAccessLevelAsync
Sets the database access levels of a user for a given database. You need the Administrate server access level in order to execute this REST call.
Public methodPutUserAsync
Replace an existing user. You need server access level Administrate in order to execute this REST call. Additionally, a user can change his/her own data.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodValidateDocumentId
Checks whether the provided document ID is in the correct form of "{collection}/{key}".
(Inherited from ApiClientBase.)
Top
Fields
  NameDescription
Protected field_client
The transport client used to communicate with the ArangoDB host.
Protected field_userApiPath
The root path of the API.
Top
See Also