UserApiClient Class |
Namespace: ArangoDBNetStandard.UserApi
The UserApiClient type exposes the following members.
Name | Description | |
---|---|---|
![]() | UserApiClient(IApiClientTransport) |
Creates an instance of UserApiClient
using the provided transport layer and the default JSON serialization.
|
![]() | UserApiClient(IApiClientTransport, IApiClientSerialization) |
Creates an instance of UserApiClient
using the provided transport and serialization layers.
|
Name | Description | |
---|---|---|
![]() | DeleteCollectionAccessLevelAsync |
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.
|
![]() | DeleteDatabaseAccessLevelAsync |
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.
|
![]() | DeleteUserAsync |
Delete a user permanently.
You need Administrate for the server access level in order to execute this REST call.
|
![]() | DeserializeJsonFromStreamT | (Inherited from ApiClientBase.) |
![]() | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetAccessibleDatabasesAsync |
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.
|
![]() | GetApiErrorException |
Gets an ApiErrorException from the provided error response.
(Inherited from ApiClientBase.) |
![]() | GetCollectionAccessLevelAsync |
Gets specific collection access level of a user for a given database.
|
![]() | GetContentT | (Inherited from ApiClientBase.) |
![]() | GetContentStringT | (Inherited from ApiClientBase.) |
![]() | GetDatabaseAccessLevelAsync |
Gets specific database access level for a user.
|
![]() | GetHashCode | Serves as the default hash function. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | GetUserAsync |
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.
|
![]() | GetUsersAsync |
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.
|
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | PatchUserAsync |
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.
|
![]() | PostUserAsync |
Create a new user. You need server access level Administrate
in order to execute this REST call.
|
![]() | PutCollectionAccessLevelAsync |
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.
|
![]() | PutDatabaseAccessLevelAsync |
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.
|
![]() | PutUserAsync |
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.
|
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | ValidateDocumentId |
Checks whether the provided document ID is in the correct form
of "{collection}/{key}".
(Inherited from ApiClientBase.) |
Name | Description | |
---|---|---|
![]() | _client |
The transport client used to communicate with the ArangoDB host.
|
![]() | _userApiPath |
The root path of the API.
|