Create Multiple Users
POST https://{{vaultDNS}}/api/{{version}}/objects/users
https://developer.veevavault.com/api/22.3/#Bulk_Users_API
Note: Beginning in v18.1, Admins create and manage users with user_sys
object records. Unless you are creating cross-domain users or adding users to a domain without assigning Vault membership, we strongly recommend using the <a href="https://developer.veevavault.com/api/22.3#CreateUserObjectRecord">Create Object Records endpoint to create new users.
Create new users and assign them to Vaults in bulk. You can also add multiple existing users as cross-domain users.
- The maximum input file size is 1GB.
- The values in the input must be UTF-8 encoded.
- CSVs must follow the standard format.
- The maximum batch size is 500.
- If you want to add profile pictures, you must upload these to the file staging server.
Headers
Name | Description |
---|---|
Content-Type | application/json or text/csv |
Accept | application/json (default) or text/csv |
Body Parameters
Prepare a JSON or CSV input file. You may add values to any other editable user field, unless you are are adding a cross-domain user. See Retrieve Users for all possible values. Using only the required fields will add users to your domain but will not assign them to individual Vaults within your domain. See Vault Membership below.
Name | Description |
---|---|
user_name__v | The user’s Vault username (login credential). For example, ewoodhouse@veepharm.com |
user_first_name__v | The user's first name. |
user_last_name__v | The user's last name. |
user_email__v | The user's email address. |
user_timezone__v | The user's time zone. Retrieve values from Retrieve Users. |
user_locale__v | The user's location. Retrieve values from Retrieve Users. |
security_policy_id__v | The user's security policy. Retrieve values from Retrieve All Security Policies. |
user_language__v | The user's preferred language. Retrieve values from Retrieve Users. |
file | Optional: The file path of a profile picture from the file staging server. Must be JPG, PNG, or GIF, and less than 10MB in size. Vault automatically resizes images to 64 x 64 pixels and removes the animations from GIFs. Note that when you upload or change a user's profile image, the change applies across the entire domain and will be visible in all Vaults where user has membership. |
domain | Optional: If you set this to true , the user will not be assigned to a Vault. |
security_profile__v | Optional: The user’s security profile. If omitted, default value is document_user__v . |
license_type__v | Optional: The user’s license type. If omitted, default value is full__v . |
vault_membership | Optional: Use this field to assign a user to individual Vaults within your domain. This is required to create cross-domain users. See below for how to configure. |
app_licensing | Optional: Use this field to assign a user to individual applications within your Vault. See below for how to configure. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string | ||
Content-Type | string | ||
Accept | string |