IUserApiClient Interface |
Defines a client to access the ArangoDB User API.
Namespace: ArangoDBNetStandard.UserApi
Assembly: ArangoDBNetStandard (in ArangoDBNetStandard.dll) Version: 1.1.0
SyntaxThe IUserApiClient type exposes the following members.
Methods| 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.
|
| 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.
|
| GetCollectionAccessLevelAsync |
Gets specific collection access level of a user for a given database.
|
| GetDatabaseAccessLevelAsync |
Gets specific database access level for a user.
|
| 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.
|
| 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.
|
See Also