Click or drag to resize

IUserApiClient Methods

The IUserApiClient type exposes the following members.

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.
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.
Public methodGetCollectionAccessLevelAsync
Gets specific collection access level of a user for a given database.
Public methodGetDatabaseAccessLevelAsync
Gets specific database access level for a user.
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.
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.
Top
See Also