v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-291317322.2 KB
Users

Create admin user

Allows you to create an admin user by providing an email (mandatory) and name (optional). The email must be in a valid format. The success response will contain the generated userId for that user.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

ProductCategoryResource
License ManagerServices access controlSave user

You can create a custom role with that resource or use one of the following predefined roles:

RoleResource
User Administrator - RESTRICTEDSave user

❗ Assigning a predefined role to users or application keys usually grants permission to multiple License Manager resources. If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see Best practices for using application keys.

To learn more about machine authentication at VTEX, see Authentication overview.

post/api/license-manager/users

Request body

namestring

Name of the user.

emailstring required

Email of the user.

Example request

{
  "name": "John",
  "email": "john@mail.com"
}

Response

Success

idstring

ID of the user.

emailstring

Email of the user.

namestring

Name of the user.