Users

Prev Next
This content is currently unavailable in Spanish. You are viewing the default (English) version.


 GET   /Users


Retreive a list of database users.

Query Parameters
ParameterTypeDescription
enabledStringSearch for users with the specified enabled status.
  • enabled
  • all
  • disabled
isVaultAccessBoolSearch for only VaultAccess users?
acctInfoBoolInclude account information?
qStringA VisualVault REST API Data Query.
UserExtendedPropertiesBoolInclude user extended properties?
Response Codes
CodeDescription
400Bad Request
404Not Found


 GET   /Users/{id}


Get the properties for a user.

Route Parameters
ParameterTypeDescription
id*GuidThe user id.
Query Parameters
ParameterTypeDescription
UserExtendedPropertiesBoolInclude user extended properties?
Response Codes
CodeDescription
404Not Found


 GET   /Users/AccountOwner


Get the account owner.

No Parameters.

Response Codes
CodeDescription
400Bad Request
404Not Found


 POST   /Users


Create a new user.

Query Parameters
ParameterTypeDescription
siteid*GuidSite ID to include the user.
Body Parameters
ParameterTypeDescription
siteId*GuidID of the site to associate the group.
firstNameStringFirst Name.
middleInitialStringUser's middle initial.
lastNameStringLast Name.
emailAddressStringAccount owner email address.
userId*GuidThe unique user ID.
passwordStringPassword for the user.
mustChangePasswordBoolRequires the user to change their password upon next login.
sendEmailBoolSends a confirmation email upon user creation.
passwordNeverExpiresBoolSet the password to never expire.
passwordExpiresdatetimeThe date of password expiration if set to expire.
getPasswordResetTokenBoolReturn a password reset token?
userExtendedPropertiesStringA list of custom extended properties.
Response Codes
CodeDescription
400Bad Request


 PUT   /Users/{id}


Update a user's properties.

Route Parameters
ParameterTypeDescription
id*GuidThe user id.
Body Parameters
ParameterTypeDescription
newpasswordStringThe new password.
oldpasswordStringThe old password.
emailaddressStringThe user email address.
firstNameStringFirst name.
lastNameStringLast name.
Response Codes
CodeDescription
400Bad Request


 PUT   /Users/{id}/extendedProperty


Update the extended properties of an authentication user.

Route Parameters
ParameterTypeDescription
id*GuidThe user id.
extendedProperty*ObjectA list of extended properties.


 PUT   /Users/{id}/userExtendedProperty


Update the extended properties of a user.

Route Parameters
ParameterTypeDescription
id*GuidThe user id.
extendedProperties*ArrayA list of extended properties.
Response Codes
CodeDescription
400Bad Request
500Internal Server Error


 PUT   /Users/{id}/password


Reset a user password.

Route Parameters
ParameterTypeDescription
id*GuidThe user id.
Body Parameters
ParameterTypeDescription
resetPasswordBoolReset the user password?
forceEmailLinkBoolForce a password reset email to be sent?
sendEmailBoolSend an email with a reset token to the user?
newPasswordStringThe new password.
oldPasswordStringThe old password.
Response Codes
CodeDescription
400Bad Request


 PUT   api/v1/Users/password*


Reset an authentication user password.

Body Parameters
ParameterTypeDescription
userId*GuidThe unique user ID.
baseUrl*StringBase URL.
Response Codes
CodeDescription
400Bad Request


 GET   api/v1/Users/reset/{token}*


Get the password reset status from a token.

Route Parameters
ParameterTypeDescription
token*stringThe reset token.
Response Codes
CodeDescription
400Bad Request
401Unauthorized


 PUT   api/v1/Users/reset/{token}*


Set a new password from a token.

Route Parameters
ParameterTypeDescription
token*stringThe reset token.
Body Parameters
ParameterTypeDescription
newPasswordStringThe new password.
Response Codes
CodeDescription
200OK
400Bad Request
401Unauthorized


 GET   /Users/{id}/webToken


Get a web token for a user by ID.

Route Parameters
ParameterTypeDescription
id*GuidThe user id.
Query Parameters
ParameterTypeDescription
expirationStringA timespan to expire the web token upon creation.
uStringThe user name.
pStringThe user password.
Response Codes
CodeDescription
403Forbidden


 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
ParameterTypeDescription
audienceStringThe audience ID for external applications.
Response Codes
CodeDescription
400Bad Request
403Forbidden


 PUT   api/v1/SetAuthCookie*


Set the authentication cookie.

Body Parameters
ParameterTypeDescription
uStringThe user name.
pStringThe user password.


 GET   api/v1/UpdateAuthCookie*


Update the authentication cookie.

Query Parameters
ParameterTypeDescription
xcidGuidThe unique customer ID.
xcdidGuidThe unique customer database ID.


 GET   /Users/{id}/annotations/privileges


Get a user's annotation privileges.

Route Parameters
ParameterTypeDescription
id*GuidThe user id.
Query Parameters
ParameterTypeDescription
layerNameStringThe name of the annotation layer.


 GET   /Users/{id}/approvals


Returns a list of document approvals.

Route Parameters
ParameterTypeDescription
id*GuidThe user id.


 GET   /Users/{id}/sentapprovals


Returns a list of document approvals sent for approval.

Route Parameters
ParameterTypeDescription
id*GuidThe user id.


 GET   /Users/{id}/approvalhistory


Returns a list of document approval history.

Route Parameters
ParameterTypeDescription
id*GuidThe user id.
Query Parameters
ParameterTypeDescription
sortStringThe name of a data column to sort by.
sortDirStringSort direction.
  • asc: Ascending order
  • desc: Descending order
qStringA VisualVault REST API Data Query.
Response Codes
CodeDescription
400Bad 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
ParameterTypeDescription
userId*GuidThe unique user ID.
customerDatabaseId**GuidThe customer database ID to set to default.
Response Codes
CodeDescription
400Bad Request


 GET   /Users/signatures


Retrieve the user signature image. 

Query Parameters
ParameterTypeDescription
zStringThe timezone offset.
userNameStringName of the user to remove from the group.
passwordStringThe user password.


 PUT   /Users/signatures


Update the user's signature image.

Body Parameters
ParameterTypeDescription
clearSignatureBoolClear the user signature?
signature*StringUser signature image as a base64 string.
Response Codes
CodeDescription
200OK
404Not Found


 GET   /Users/formSignature


Retrieve the user signature image. 

Query Parameters
ParameterTypeDescription
userNameStringName of the user to remove from the group.
passwordStringThe user password.
displayTypeStringUsername 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
ParameterTypeDescription
id*GuidThe user id.


 GET   /Users/{id}/Supervisors


Get the user's supervisor properties.

Route Parameters
ParameterTypeDescription
id*GuidThe user id.


 GET   /Users/{id}/Supervisees


Get the user's supervisee properties.

Route Parameters
ParameterTypeDescription
id*GuidThe user id.


 GET   /Users/{id}/workflowtask


Check if a user can complete a workflow task.

Route Parameters
ParameterTypeDescription
id*GuidThe user id.
Query Parameters
ParameterTypeDescription
taskIdGuidThe ID of the workflow task.
formIdGuidId of the form requesting the index fields if called from a form.
Response Codes
CodeDescription
400Bad Request
404Not Found
500Internal Server Error