--- title: "Users" slug: "users-2" updated: 2023-05-25T01:59:59Z published: 2023-05-25T01:59:59Z canonical: "docs.visualvault.com/users-2" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.visualvault.com/llms.txt > Use this file to discover all available pages before exploring further. # Users #### **GET **/Users**** --- > **Retreive a list of database users.** ##### ****Query Parameters**** | Parameter | Type | Description | | --- | --- | --- | | enabled | String | Search for users with the specified enabled status. - enabled - all - disabled | | isVaultAccess | Bool | Search for only VaultAccess users? | | acctInfo | Bool | Include account information? | | q | String | A VisualVault REST API Data Query. | | UserExtendedProperties | Bool | Include user extended properties? | ##### ****Response Codes**** | Code | Description | | --- | --- | | 400 | Bad Request | | 404 | Not Found | #### **GET **/Users/{id}**** --- > **Get the properties for a user.** ##### ****Route Parameters**** | Parameter | Type | Description | | --- | --- | --- | | id* | Guid | The user id. | ##### ****Query Parameters**** | Parameter | Type | Description | | --- | --- | --- | | UserExtendedProperties | Bool | Include user extended properties? | ##### ****Response Codes**** | Code | Description | | --- | --- | | 404 | Not Found | #### **GET **/Users/AccountOwner**** --- > **Get the account owner.** No Parameters. ##### ****Response Codes**** | Code | Description | | --- | --- | | 400 | Bad Request | | 404 | Not Found | #### **POST **/Users**** --- > **Create a new user.** ##### ****Query Parameters**** | Parameter | Type | Description | | --- | --- | --- | | siteid* | Guid | Site ID to include the user. | ##### ****Body Parameters**** | Parameter | Type | Description | | --- | --- | --- | | siteId* | Guid | ID of the site to associate the group. | | firstName | String | First Name. | | middleInitial | String | User's middle initial. | | lastName | String | Last Name. | | emailAddress | String | Account owner email address. | | userId* | Guid | The unique user ID. | | password | String | Password for the user. | | mustChangePassword | Bool | Requires the user to change their password upon next login. | | sendEmail | Bool | Sends a confirmation email upon user creation. | | passwordNeverExpires | Bool | Set the password to never expire. | | passwordExpires | datetime | The date of password expiration if set to expire. | | getPasswordResetToken | Bool | Return a password reset token? | | userExtendedProperties | String | A list of custom extended properties. | ##### ****Response Codes**** | Code | Description | | --- | --- | | 400 | Bad Request | #### **PUT **/Users/{id}**** --- > **Update a user's properties.** ##### ****Route Parameters**** | Parameter | Type | Description | | --- | --- | --- | | id* | Guid | The user id. | ##### ****Body Parameters**** | Parameter | Type | Description | | --- | --- | --- | | newpassword | String | The new password. | | oldpassword | String | The old password. | | emailaddress | String | The user email address. | | firstName | String | First name. | | lastName | String | Last name. | ##### ****Response Codes**** | Code | Description | | --- | --- | | 400 | Bad Request | #### **PUT **/Users/{id}/extendedProperty**** --- > **Update the extended properties of an authentication user.** ##### ****Route Parameters**** | Parameter | Type | Description | | --- | --- | --- | | id* | Guid | The user id. | | extendedProperty* | Object | A list of extended properties. | #### **PUT **/Users/{id}/userExtendedProperty**** --- > **Update the extended properties of a user.** ##### ****Route Parameters**** | Parameter | Type | Description | | --- | --- | --- | | id* | Guid | The user id. | | extendedProperties* | Array | A list of extended properties. | ##### ****Response Codes**** | Code | Description | | --- | --- | | 400 | Bad Request | | 500 | Internal Server Error | #### **PUT **/Users/{id}/password**** --- > **Reset a user password.** ##### ****Route Parameters**** | Parameter | Type | Description | | --- | --- | --- | | id* | Guid | The user id. | ##### ****Body Parameters**** | Parameter | Type | Description | | --- | --- | --- | | resetPassword | Bool | Reset the user password? | | forceEmailLink | Bool | Force a password reset email to be sent? | | sendEmail | Bool | Send an email with a reset token to the user? | | newPassword | String | The new password. | | oldPassword | String | The old password. | ##### ****Response Codes**** | Code | Description | | --- | --- | | 400 | Bad Request | #### **PUT **api/v1/Users/password***** --- > **Reset an authentication user password.** ##### ****Body Parameters**** | Parameter | Type | Description | | --- | --- | --- | | userId* | Guid | The unique user ID. | | baseUrl* | String | Base URL. | ##### ****Response Codes**** | Code | Description | | --- | --- | | 400 | Bad Request | #### **GET **api/v1/Users/reset/{token}***** --- > **Get the password reset status from a token.** ##### ****Route Parameters**** | Parameter | Type | Description | | --- | --- | --- | | token* | string | The reset token. | ##### ****Response Codes**** | Code | Description | | --- | --- | | 400 | Bad Request | | 401 | Unauthorized | #### **PUT **api/v1/Users/reset/{token}***** --- > **Set a new password from a token.** ##### ****Route Parameters**** | Parameter | Type | Description | | --- | --- | --- | | token* | string | The reset token. | ##### ****Body Parameters**** | Parameter | Type | Description | | --- | --- | --- | | newPassword | String | The new password. | ##### ****Response Codes**** | Code | Description | | --- | --- | | 200 | OK | | 400 | Bad Request | | 401 | Unauthorized | #### **GET **/Users/{id}/webToken**** --- > **Get a web token for a user by ID.** ##### ****Route Parameters**** | Parameter | Type | Description | | --- | --- | --- | | id* | Guid | The user id. | ##### ****Query Parameters**** | Parameter | Type | Description | | --- | --- | --- | | expiration | String | A timespan to expire the web token upon creation. | | u | String | The user name. | | p | String | The user password. | ##### ****Response Codes**** | Code | Description | | --- | --- | | 403 | Forbidden | #### **GET **api/v1/Users***** --- > **Get a user's JWT properties.** No Parameters. #### **GET **api/v1/Users/Security***** --- > **Get a user's security properties.** No Parameters. #### **GET **api/v1/Users/Properties***** --- > **Get a user's configuration properties.** No Parameters. #### **GET **/Users/getJWT**** --- > **Receive a JWT for an authenticated user.** No Parameters. #### **GET **/Users/getPublicJWT**** --- > **Receive a JWT for public user.** ##### ****Query Parameters**** | Parameter | Type | Description | | --- | --- | --- | | audience | String | The audience ID for external applications. | ##### ****Response Codes**** | Code | Description | | --- | --- | | 400 | Bad Request | | 403 | Forbidden | #### **PUT **api/v1/SetAuthCookie***** --- > **Set the authentication cookie.** ##### ****Body Parameters**** | Parameter | Type | Description | | --- | --- | --- | | u | String | The user name. | | p | String | The user password. | #### **GET **api/v1/UpdateAuthCookie***** --- > **Update the authentication cookie.** ##### ****Query Parameters**** | Parameter | Type | Description | | --- | --- | --- | | xcid | Guid | The unique customer ID. | | xcdid | Guid | The unique customer database ID. | #### **GET **/Users/{id}/annotations/privileges**** --- > **Get a user's annotation privileges.** ##### ****Route Parameters**** | Parameter | Type | Description | | --- | --- | --- | | id* | Guid | The user id. | ##### ****Query Parameters**** | Parameter | Type | Description | | --- | --- | --- | | layerName | String | The name of the annotation layer. | #### **GET **/Users/{id}/approvals**** --- > **Returns a list of document approvals.** ##### ****Route Parameters**** | Parameter | Type | Description | | --- | --- | --- | | id* | Guid | The user id. | #### **GET **/Users/{id}/sentapprovals**** --- > **Returns a list of document approvals sent for approval.** ##### ****Route Parameters**** | Parameter | Type | Description | | --- | --- | --- | | id* | Guid | The user id. | #### **GET **/Users/{id}/approvalhistory**** --- > **Returns a list of document approval history.** ##### ****Route Parameters**** | Parameter | Type | Description | | --- | --- | --- | | id* | Guid | The user id. | ##### ****Query Parameters**** | Parameter | Type | Description | | --- | --- | --- | | sort | String | The name of a data column to sort by. | | sortDir | String | Sort direction. - asc: Ascending order - desc: Descending order | | q | String | A VisualVault REST API Data Query. | ##### ****Response Codes**** | Code | Description | | --- | --- | | 400 | Bad Request | #### **GET **api/v1/Users/DefaultCustomer***** --- > **Get the user default customer and database.** No Parameters. #### **POST **api/v1/Users/DefaultCustomerDatabase***** --- > **Update the customer default database.** ##### ****Body Parameters**** | Parameter | Type | Description | | --- | --- | --- | | userId* | Guid | The unique user ID. | | customerDatabaseId** | Guid | The customer database ID to set to default. | ##### ****Response Codes**** | Code | Description | | --- | --- | | 400 | Bad Request | #### **GET **/Users/signatures**** --- > **Retrieve the user signature image.** ##### ****Query Parameters**** | Parameter | Type | Description | | --- | --- | --- | | z | String | The timezone offset. | | userName | String | Name of the user to remove from the group. | | password | String | The user password. | #### **PUT **/Users/signatures**** --- > **Update the user's signature image.** ##### ****Body Parameters**** | Parameter | Type | Description | | --- | --- | --- | | clearSignature | Bool | Clear the user signature? | | signature* | String | User signature image as a base64 string. | ##### ****Response Codes**** | Code | Description | | --- | --- | | 200 | OK | | 404 | Not Found | #### **GET **/Users/formSignature**** --- > **Retrieve the user signature image.** ##### ****Query Parameters**** | Parameter | Type | Description | | --- | --- | --- | | userName | String | Name of the user to remove from the group. | | password | String | The user password. | | displayType | String | Username format type. - UserId (0) - PrincipalName (1) - FirstNameLastName (2) - EmailAddress (3) | #### **GET **/Users/{id}/Groups**** --- > **Get the list of groups a user is assigned to.** ##### ****Route Parameters**** | Parameter | Type | Description | | --- | --- | --- | | id* | Guid | The user id. | #### **GET **/Users/{id}/Supervisors**** --- > **Get the user's supervisor properties.** ##### ****Route Parameters**** | Parameter | Type | Description | | --- | --- | --- | | id* | Guid | The user id. | #### **GET **/Users/{id}/Supervisees**** --- > **Get the user's supervisee properties.** ##### ****Route Parameters**** | Parameter | Type | Description | | --- | --- | --- | | id* | Guid | The user id. | #### **GET **/Users/{id}/workflowtask**** --- > **Check if a user can complete a workflow task.** ##### ****Route Parameters**** | Parameter | Type | Description | | --- | --- | --- | | id* | Guid | The user id. | ##### ****Query Parameters**** | Parameter | Type | Description | | --- | --- | --- | | taskId | Guid | The ID of the workflow task. | | formId | Guid | Id of the form requesting the index fields if called from a form. | ##### ****Response Codes**** | Code | Description | | --- | --- | | 400 | Bad Request | | 404 | Not Found | | 500 | Internal Server Error |