openapi: 3.0.0
info:
  title: VTex License Manager API
  description: "The License Manager API allows you to create users, modify their names and emails, add and remove [roles](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) from users, and create and manage [appKeys](https://help.vtex.com/en/tutorial/application-keys--2iffYzlvvz4BDMr6WGUtet).\r\n\r\n## Common parameters\r\n\r\n|Attribute name | Description |\r\n|:------------|--------------|\r\n|`accountName` | Account name in VTEX License Manager. |\r\n|`environment` | Environment on which you want to run the query, e.g. `vtexcommercestable`. |\r\n|`userId`      | Unique user identification string. |\r\n|`roleId`      | Integer that represents a role, can be obtained from the [Get List of Roles](https://developers.vtex.com/docs/api-reference/license-manager-api#get-/api/license-manager/site/pvt/roles/list/paged) endpoint. |\r\n\r\n## Index\r\n\r\n### User\r\n\r\n- `GET` [Get user](https://developers.vtex.com/docs/api-reference/license-manager-api#get-/api/license-manager/users/-userId-)\r\n- `DELETE` [Delete user](https://developers.vtex.com/docs/api-reference/license-manager-api#delete-/api/license-manager/users/-userId-)\r\n- `POST` [Create user](https://developers.vtex.com/docs/api-reference/license-manager-api#post-/api/license-manager/users)\r\n- `GET` [Get list of users](https://developers.vtex.com/docs/api-reference/license-manager-api#get-/api/license-manager/site/pvt/logins/list/paged)\r\n\r\n### Roles\r\n\r\n- `PUT` [Add roles to user or appKey](https://developers.vtex.com/docs/api-reference/license-manager-api#put-/api/license-manager/users/-userId-/roles)\r\n- `GET` [Get roles by user or appKey](https://developers.vtex.com/docs/api-reference/license-manager-api#get-/api/license-manager/users/-userId-/roles)\r\n- `DELETE` [Remove role from user or appKey](https://developers.vtex.com/docs/api-reference/license-manager-api#delete-/api/license-manager/users/-userId-/roles/-roleId-)\r\n- `GET` [Get list of roles](https://developers.vtex.com/docs/api-reference/license-manager-api#get-/api/license-manager/site/pvt/roles/list/paged)\r\n\r\n### App Keys\r\n\r\n- `POST` [Create new appkey](https://developers.vtex.com/docs/api-reference/license-manager-api#post-/api/vlm/appkeys)\r\n- `GET` [Get appKeys from account](https://developers.vtex.com/docs/api-reference/license-manager-api#get-/api/vlm/appkeys)\r\n- `PUT` [Update appKey](https://developers.vtex.com/docs/api-reference/license-manager-api#put-/api/vlm/appkeys/-id-)\r\n\r\n### Store\r\n\r\n- `GET` [Get stores](https://developers.vtex.com/docs/api-reference/license-manager-api#get-/api/vlm/account/stores)\r\n\r\n### Account\r\n\r\n- `GET` [Get information about account](https://developers.vtex.com/docs/api-reference/license-manager-api#get-/api/vlm/account)"
  version: '1.0'
servers:
  - url: https://{accountName}.{environment}.com.br
    description: VTEX server URL.
    variables:
      accountName:
        description: Name of the VTEX account. Used as part of the URL
        default: apiexamples
      environment:
        description: Environment to use. Used as part of the URL.
        enum:
          - vtexcommercestable
        default: vtexcommercestable
paths:
  /api/license-manager/users/{userId}:
    get:
      tags:
        - Users
      summary: VTex Get user
      description: "Allows you to get a user from the database, using the `userId` as the identifier. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **Remove user** |\r\n| License Manager | Services access control | **Save user** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| User Administrator - RESTRICTED | Save user |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication)."
      operationId: GetUser
      parameters:
        - $ref: '#/components/parameters/Content-Type'
        - $ref: '#/components/parameters/Accept'
        - name: userId
          in: path
          description: ID from queried user.
          required: true
          style: simple
          schema:
            type: string
            example: e845b52a40e24654a2c70766adb5762b
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    description: ID of the user.
                    type: string
                  name:
                    description: Name of the user.
                    type: string
                  email:
                    description: Email of the user.
                    type: string
              example:
                id: e845b52a40e24654a2c70766adb5762b
                name: Jane
                email: jane@mail.com
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  Message:
                    description: Error message.
                    type: string
              example:
                Message: Invalid UserId
        '405':
          description: Method Not Allowed - A null `userId` sends the request to a path that is not allowed.
      deprecated: false
    delete:
      tags:
        - Users
      summary: VTex Delete user
      description: "Allows you to delete a user from the database, using the `userId` as the identifier. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **Save user** |\r\n| License Manager | Services access control | **Remove user** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| User Administrator - RESTRICTED | Save user |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication)."
      parameters:
        - $ref: '#/components/parameters/Content-Type'
        - $ref: '#/components/parameters/Accept'
        - name: userId
          in: path
          description: ID from queried user.
          required: true
          style: simple
          schema:
            type: string
            example: e845b52a40e24654a2c70766adb5762b
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  Message:
                    description: Error message.
                    type: string
              example:
                Message: Invalid UserId
      deprecated: false
  /api/license-manager/users:
    post:
      tags:
        - Users
      summary: VTex Create user
      description: "Allows you to create a 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. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **Save user** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| User Administrator - RESTRICTED | Save user |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication)."
      operationId: CreateUser
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUserRequest'
            example:
              name: Jane
              email: jane@mail.com
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    description: ID of the user.
                    type: string
                  email:
                    description: Email of the user.
                    type: string
                  name:
                    description: Name of the user.
                    type: string
              example:
                id: a404870467d24533a085a6b3c6a5a320
                email: jane@mail.com
                name: Jane
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  Message:
                    type: string
                    description: Error message.
              example:
                Message: Invalid email
      deprecated: false
  /api/license-manager/site/pvt/logins/list/paged:
    get:
      tags:
        - Users
      summary: VTex Get list of users
      description: "Returns a list of registered users. The response is divided in pages. The query parameter `numItems` defines the number of items in each page, and consequently the amount of pages for the whole list. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **Get paged users** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: GetListUsers
      parameters:
        - $ref: '#/components/parameters/Content-Type'
        - $ref: '#/components/parameters/Accept'
        - name: numItems
          in: query
          description: Number of items in the returned page.
          required: false
          style: form
          schema:
            type: integer
            example: 10
        - name: pageNumber
          in: query
          description: Which page from the whole list will be returned.
          required: false
          style: form
          schema:
            type: integer
            example: 1
        - name: sort
          in: query
          description: Chooses the field that the list will be sorted by.
          required: false
          style: form
          schema:
            type: string
            example: name
        - name: sortType
          in: query
          description: Defines the sorting order. `ASC` is used for ascendant order. `DSC` is used for descendant order.
          required: false
          style: form
          schema:
            type: string
            example: ASC
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListUsersResponse'
              example:
                items:
                  - id: a404870467d24533a085a6b3c6a5a320
                    email: mynewuser@mydomain.com
                    isAdmin: false
                    isReliable: false
                    isBlocked: false
                    roles: []
                    accountNames: []
                    name: testuser
                paging:
                  page: 1
                  perPage: 1
                  total: 1
                  pages: 1
  /api/license-manager/users/{userId}/roles:
    put:
      tags:
        - Roles
      summary: VTex Add roles to user or appKey
      description: "Allows you to add License Manager [roles](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) to a particular user or application key by specifying the list of role IDs on the request body. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **Save user** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| User Administrator - RESTRICTED | Save user |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication)."
      operationId: PutRolesinUser
      parameters:
        - name: userId
          in: path
          description: ID of the user.
          required: true
          style: simple
          schema:
            type: string
            example: a404870467d24533a085a6b3c6a5a320
      requestBody:
        description: List of role IDs to add to the user or application key.
        content:
          application/json:
            schema:
              type: array
              description: Array containing role IDs.
              items:
                type: integer
                format: int32
                description: Role ID, which can be obtained from the [Get List of Roles](https://developers.vtex.com/docs/api-reference/license-manager-api#get-/api/license-manager/site/pvt/roles/list/paged) endpoint.
                example: 9000
            example:
              - 9000
              - 9111
              - 9333
              - 9444
        required: true
      responses:
        '204':
          description: Success - A no-content response, but the roles were added successfully.
        '400':
          description: Bad Request - A userId or role list with invalid format. The message on the body of the response will contain further information.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Message:
                    description: Error message.
                    type: string
              example:
                Message: Roles list contains roles that do not exist in this account
        '500':
          description: Unexpected error - One possible reason is that the userId is not present on the database.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Message:
                    type: string
                    description: Error message.
              example:
                Message: Unexpected error
      deprecated: false
    get:
      tags:
        - Roles
      summary: VTex Get roles by user or appKey
      description: "Retrieves License Manager [roles](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) of a particular user or application key. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **Save user** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| User Administrator - RESTRICTED | Save user |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication)."
      operationId: GetRolesbyUser
      parameters:
        - $ref: '#/components/parameters/Content-Type'
        - $ref: '#/components/parameters/Accept'
        - name: userId
          in: path
          description: ID of the user.
          required: true
          style: simple
          schema:
            type: string
            example: e845b52a40e24654a2c70766adb5762b
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                description: Array of role objects.
                items:
                  type: object
                  description: Object with information about each role.
                  properties:
                    id:
                      description: ID of role.
                      type: integer
                      format: int32
                    name:
                      description: Name of the role.
                      type: string
              example:
                - id: 957
                  name: Call center operator
                - id: 1
                  name: Owner (Admin Super)
      deprecated: false
  /api/license-manager/users/{userId}/roles/{roleId}:
    delete:
      tags:
        - Roles
      summary: VTex Remove role from user or appKey
      description: "Allows you to remove a License Manager [role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) from a specific user or application key. This method only allows the removal of one role per request. The role's ID must be specified on the request path, not on the request body.\n\r\n\r> Note that a successful response returns a `204` response with an empty body. A deletion on a role or user that does not exist will also return a `204`. Thus, this method should not be used to verify the existence of a specific user or role. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **Save user** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| User Administrator - RESTRICTED | Save user |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication)."
      operationId: RemoveRolefromUser
      parameters:
        - $ref: '#/components/parameters/Content-Type'
        - $ref: '#/components/parameters/Accept'
        - name: userId
          in: path
          description: ID of the user.
          required: true
          style: simple
          schema:
            type: string
            example: e845b52a40e24654a2c70766adb5762b
        - name: roleId
          in: path
          description: ID of the role which will be removed from the user.
          required: true
          style: simple
          schema:
            type: string
            example: '1'
      responses:
        '204':
          description: Success - A no-content response, but the role deletion was performed successfully.
        '400':
          description: Bad Request - A userId or role list with invalid format. The message on the body of the response will contain further information.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Message:
                    type: string
                    description: Error message.
              example:
                Message: Invalid UserId
        '405':
          description: Method Not Allowed
      deprecated: false
  /api/license-manager/site/pvt/roles/list/paged:
    get:
      tags:
        - Roles
      summary: VTex Get list of roles
      description: "Returns a list of License Manager [roles](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc). The response is divided in pages. The query parameter `numItems` defines the number of items in each page, and consequently the amount of pages for the whole list. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **Get paged roles** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: GetListRoles
      parameters:
        - $ref: '#/components/parameters/Content-Type'
        - $ref: '#/components/parameters/Accept'
        - name: numItems
          in: query
          description: Number of items in the returned page.
          required: false
          style: form
          schema:
            type: integer
            example: 10
        - name: pageNumber
          in: query
          description: Which page from the whole list will be returned.
          required: false
          style: form
          schema:
            type: integer
            example: 1
        - name: sort
          in: query
          description: Chooses the field that the list will be sorted by.
          required: false
          style: form
          schema:
            type: string
            example: id
        - name: sortType
          in: query
          description: Defines the sorting order. `ASC` is used for ascendant order. `DSC` is used for descendant order.
          required: false
          style: form
          schema:
            type: string
            example: ASC
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRolesResponse'
              example:
                items:
                  - id: 957
                    isAdmin: false
                    roleType: 0
                    products:
                      - id:
                        categoryId:
                        categoryName:
                        description:
                        consoleUrlMask:
                        urlConfiguration:
                        webApiUrlMask:
                        url:
                        productResources:
                        name: Catalog
                      - id:
                        categoryId:
                        categoryName:
                        description:
                        consoleUrlMask:
                        urlConfiguration:
                        webApiUrlMask:
                        url:
                        productResources:
                        name: OMS
                    resources:
                    logins:
                    name: Call center operator
                paging:
                  page: 1
                  perPage: 1
                  total: 1
                  pages: 1
  /api/vlm/appkeys:
    post:
      tags:
        - App Keys
      summary: VTex Create new appKey
      description: "Creates a new pair of `appKey` and `appToken`. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **Save user** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| User Administrator - RESTRICTED | Save user |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication)."
      operationId: Createnewappkey
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatenewappkeyRequest'
            example:
              label: my new appkey
        required: true
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatenewappkeyResponse'
              example:
                id: a2555e95-9db8-48be-94f8-2a28577c0b4a
                appKey: vtexappkey-myaccount-ORYNWX
                appToken: WNVUJKYFKJFLTPXHQGAZDHPBHSDQVJJWSFZUBOGCKPEXAIFHTPANKJTOXUKRIIJAAJSOPCFBAXOODRABMUXFJVLJLKWGEOUCFDXRPRRQKYNNUFLGTIEOKERFXJCFFYXL
                label: my new appkey
                createdIn: '2018-07-04T14:09:08.2718405Z'
                isActive: true
      deprecated: false
    get:
      tags:
        - App Keys
      summary: VTex Get appKeys from account
      description: "Retrieves all application keys from an account. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **Save user** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| User Administrator - RESTRICTED | Save user |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication)."
      operationId: Getappkeysfromaccount
      parameters:
        - $ref: '#/components/parameters/Content-Type'
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                type: array
                description: Array of AppKeys object
                items:
                  $ref: '#/components/schemas/Getappkeysfromaccount'
              example:
                - id: a2555e95-9db8-48be-94f8-2a28577c0b4a
                  appKey: vtexappkey-myaccount-ORYNWX
                  label: my new appkey
                  createdIn: '2018-07-04T14:09:08.2718405Z'
                  isActive: true
                - id: a2555e95-9db8-48be-94f8-2a28577c0b4a
                  appKey: vtexappkey-myaccount-ORKPDC
                  label: my other appkey
                  createdIn: '2018-07-04T14:09:08.2718405Z'
                  isActive: true
      deprecated: false
  /api/vlm/appkeys/{id}:
    put:
      tags:
        - App Keys
      summary: VTex Update appKey
      description: "Activates or deactivates an `appKey` by its ID. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **Save user** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| User Administrator - RESTRICTED | Save user |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication)."
      operationId: Updateappkey
      parameters:
        - name: id
          in: path
          description: ID from the appKey which will be updated
          required: true
          style: simple
          schema:
            type: string
      requestBody:
        description: Request body for updating AppKeys
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateappkeyRequest'
            example:
              isActive: false
        required: true
      responses:
        '200':
          description: Success
          headers: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VLMError'
              example:
                Details:
                HttpStatusCode: 400
                VLMErrorCode: 17
                Message: Token not exists for this account
      deprecated: false
  /api/vlm/account/stores:
    get:
      tags:
        - Stores
      summary: VTex Get stores
      description: "Retrieves the stores of the account and their respective hosts. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **Save account** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Finance - Full access | Save account |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). \r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication)."
      operationId: GetByAccount
      parameters: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                description: Array of store objects.
                items:
                  $ref: '#/components/schemas/StoreItems'
              example:
                - id: 1213
                  name: ambientecrm
                  hosts:
                    - loja.ambientecrm.com.br
                    - www.ambientecrm.com.br
                - id: 213
                  name: ambienteqa
                  hosts:
                    - loja.blackbox.com.br
                    - www.blackbox.com.br
      deprecated: false
  /api/vlm/account:
    get:
      tags:
        - Account
      summary: VTex Get information about account
      description: "Retrieves information from an account, such as company and sponsor user details, stores, and appTokens.\n\r\n\rThis endpoint only accepts requests from the host list designated for that store. If you want to try this request from this portal, be sure to add it to the list. Learn how to add hosts to the list in [How to manage accounts](https://help.vtex.com/en/tutorial/how-to-manage-accounts--tutorials_6285#). \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **Save account** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Finance - Full access | Save account |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\n To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication)."
      operationId: GetAccount
      parameters: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountResponse'
              example:
                isActive: true
                id: 71fe5fdabc4940ad81c226d43b754ba8
                name: UNISUPER, SOCIEDAD ANONIMA
                accountName: apiexamples
                lv:
                isOperating: false
                defaultUrl:
                district:
                country:
                complement:
                companyName: UNISUPER, SOCIEDAD ANONIMA
                cnpj:
                haveParentAccount: false
                parentAccountId:
                parentAccountName:
                city:
                address:
                logo:
                hasLogo: false
                number:
                postalCode:
                state:
                telephone: '+219999999'
                tradingName: UNISUPER, SOCIEDAD ANONIMA
                licenses:
                  - expiration:
                    id: 24
                    isPurchased: false
                    products:
                      - id: 1
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: License Manager
                      - id: 9
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Logistics
                      - id: 14
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Log
                      - id: 23
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Message Center
                      - id: 43
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Billing
                      - id: 55
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Audit
                      - id: 64
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Vtex ID
                      - id: 66
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX IO
                      - id: 73
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Seller Register
                      - id: 75
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Time Series
                      - id: 91
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Releases
                    name: Carrier
                  - expiration:
                    id: 10
                    isPurchased: false
                    products:
                      - id: 1
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: License Manager
                      - id: 3
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Master Data
                      - id: 14
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Log
                      - id: 17
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX DWT
                      - id: 18
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Unikey
                      - id: 23
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Message Center
                      - id: 25
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Dynamic Storage
                      - id: 30
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Key Store
                      - id: 48
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX Bridge
                      - id: 51
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Vtex My Account
                      - id: 55
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Audit
                      - id: 64
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Vtex ID
                      - id: 67
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTable
                      - id: 68
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Zendesk
                      - id: 73
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Seller Register
                      - id: 75
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Time Series
                      - id: 91
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Releases
                    name: CRM
                  - expiration:
                    id: 8
                    isPurchased: false
                    products:
                      - id: 1
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: License Manager
                      - id: 2
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Catalog
                      - id: 3
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Master Data
                      - id: 4
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Request Capture
                      - id: 5
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Checkout
                      - id: 6
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: PCI Gateway
                      - id: 9
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Logistics
                      - id: 13
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Channels
                      - id: 14
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Log
                      - id: 16
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Rates and Benefits
                      - id: 17
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX DWT
                      - id: 18
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Unikey
                      - id: 19
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: OMS
                      - id: 20
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Conversation Tracker
                      - id: 23
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Message Center
                      - id: 25
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Dynamic Storage
                      - id: 27
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Portal
                      - id: 38
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: CMS
                      - id: 43
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Billing
                      - id: 48
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX Bridge
                      - id: 50
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Suggestion
                      - id: 51
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Vtex My Account
                      - id: 53
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Network
                      - id: 55
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Audit
                      - id: 57
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Insights
                      - id: 58
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Credit Control
                      - id: 61
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: WebService
                      - id: 64
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Vtex ID
                      - id: 65
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Pricing
                      - id: 66
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX IO
                      - id: 67
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTable
                      - id: 69
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Conditions Evaluator
                      - id: 70
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: GiftCard
                      - id: 73
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Seller Register
                      - id: 74
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Order Authorization
                      - id: 75
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Time Series
                      - id: 76
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Search
                      - id: 81
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Application Logs Stream
                      - id: 83
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Subscriptions
                      - id: 84
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: CDN Service
                      - id: 85
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Dandelion
                      - id: 88
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Tenant Switcher
                      - id: 89
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Promotions Policy Engine
                      - id: 91
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Releases
                    name: E-Commerce Professional
                  - expiration:
                    id: 6
                    isPurchased: false
                    products:
                      - id: 1
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: License Manager
                      - id: 2
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Catalog
                      - id: 3
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Master Data
                      - id: 4
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Request Capture
                      - id: 5
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Checkout
                      - id: 6
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: PCI Gateway
                      - id: 7
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Buscapé Connect
                      - id: 9
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Logistics
                      - id: 13
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Channels
                      - id: 14
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Log
                      - id: 16
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Rates and Benefits
                      - id: 17
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX DWT
                      - id: 18
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Unikey
                      - id: 19
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: OMS
                      - id: 20
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Conversation Tracker
                      - id: 23
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Message Center
                      - id: 25
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Dynamic Storage
                      - id: 27
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Portal
                      - id: 38
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: CMS
                      - id: 43
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Billing
                      - id: 48
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX Bridge
                      - id: 50
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Suggestion
                      - id: 51
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Vtex My Account
                      - id: 53
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Network
                      - id: 55
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Audit
                      - id: 57
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Insights
                      - id: 58
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Credit Control
                      - id: 61
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: WebService
                      - id: 64
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Vtex ID
                      - id: 65
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Pricing
                      - id: 66
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX IO
                      - id: 67
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTable
                      - id: 68
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Zendesk
                      - id: 69
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Conditions Evaluator
                      - id: 70
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: GiftCard
                      - id: 73
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Seller Register
                      - id: 74
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Order Authorization
                      - id: 75
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Time Series
                      - id: 76
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Search
                      - id: 81
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Application Logs Stream
                      - id: 83
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Subscriptions
                      - id: 84
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: CDN Service
                      - id: 85
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Dandelion
                      - id: 88
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Tenant Switcher
                      - id: 89
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Promotions Policy Engine
                      - id: 91
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Releases
                    name: E-Commerce Starter
                  - expiration:
                    id: 7
                    isPurchased: true
                    products:
                      - id: 1
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: License Manager
                      - id: 2
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Catalog
                      - id: 3
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Master Data
                      - id: 4
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Request Capture
                      - id: 5
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Checkout
                      - id: 6
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: PCI Gateway
                      - id: 7
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Buscapé Connect
                      - id: 8
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX Events
                      - id: 9
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Logistics
                      - id: 10
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Shipping Notification
                      - id: 13
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Channels
                      - id: 14
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Log
                      - id: 15
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX Fulfilment
                      - id: 16
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Rates and Benefits
                      - id: 17
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX DWT
                      - id: 18
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Unikey
                      - id: 19
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: OMS
                      - id: 20
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Conversation Tracker
                      - id: 22
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VtexID
                      - id: 23
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Message Center
                      - id: 25
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Dynamic Storage
                      - id: 27
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Portal
                      - id: 28
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Dumbo
                      - id: 30
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Key Store
                      - id: 31
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Dashboard
                      - id: 37
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Vtex PAI
                      - id: 38
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: CMS
                      - id: 39
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Availability
                      - id: 41
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Big Data
                      - id: 43
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Billing
                      - id: 45
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Healthcheck
                      - id: 46
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX Home
                      - id: 48
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX Bridge
                      - id: 50
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Suggestion
                      - id: 51
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Vtex My Account
                      - id: 53
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Network
                      - id: 55
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Audit
                      - id: 57
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Insights
                      - id: 58
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Credit Control
                      - id: 60
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Extension Store
                      - id: 61
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: WebService
                      - id: 64
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Vtex ID
                      - id: 65
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Pricing
                      - id: 66
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX IO
                      - id: 67
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTable
                      - id: 68
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Zendesk
                      - id: 69
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Conditions Evaluator
                      - id: 70
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: GiftCard
                      - id: 73
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Seller Register
                      - id: 74
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Order Authorization
                      - id: 75
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Time Series
                      - id: 76
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Search
                      - id: 81
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Application Logs Stream
                      - id: 83
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Subscriptions
                      - id: 84
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: CDN Service
                      - id: 85
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Dandelion
                      - id: 88
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Tenant Switcher
                      - id: 89
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Promotions Policy Engine
                      - id: 91
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Releases
                    name: E-Commerce Unlimited
                  - expiration:
                    id: 28
                    isPurchased: false
                    products:
                      - id: 1
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: License Manager
                      - id: 2
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Catalog
                      - id: 3
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Master Data
                      - id: 4
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Request Capture
                      - id: 5
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Checkout
                      - id: 6
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: PCI Gateway
                      - id: 7
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Buscapé Connect
                      - id: 8
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX Events
                      - id: 9
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Logistics
                      - id: 10
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Shipping Notification
                      - id: 13
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Channels
                      - id: 14
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Log
                      - id: 15
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX Fulfilment
                      - id: 16
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Rates and Benefits
                      - id: 17
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX DWT
                      - id: 18
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Unikey
                      - id: 19
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: OMS
                      - id: 20
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Conversation Tracker
                      - id: 22
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VtexID
                      - id: 23
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Message Center
                      - id: 25
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Dynamic Storage
                      - id: 27
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Portal
                      - id: 28
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Dumbo
                      - id: 30
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Key Store
                      - id: 31
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Dashboard
                      - id: 37
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Vtex PAI
                      - id: 38
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: CMS
                      - id: 39
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Availability
                      - id: 41
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Big Data
                      - id: 45
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Healthcheck
                      - id: 46
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX Home
                      - id: 48
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX Bridge
                      - id: 50
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Suggestion
                      - id: 51
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Vtex My Account
                      - id: 53
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Network
                      - id: 55
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Audit
                      - id: 57
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Insights
                      - id: 58
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Credit Control
                      - id: 60
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Extension Store
                      - id: 61
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: WebService
                      - id: 64
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Vtex ID
                      - id: 65
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Pricing
                      - id: 66
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX IO
                      - id: 67
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTable
                      - id: 68
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Zendesk
                      - id: 69
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Conditions Evaluator
                      - id: 70
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: GiftCard
                      - id: 73
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Seller Register
                      - id: 74
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Order Authorization
                      - id: 75
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Time Series
                      - id: 76
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Search
                      - id: 81
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Application Logs Stream
                      - id: 83
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Subscriptions
                      - id: 84
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: CDN Service
                      - id: 88
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Tenant Switcher
                      - id: 89
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Promotions Policy Engine
                      - id: 91
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Releases
                    name: E-Commerce Unlimited No Billing
                  - expiration:
                    id: 11
                    isPurchased: false
                    products:
                      - id: 1
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: License Manager
                      - id: 6
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: PCI Gateway
                      - id: 8
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX Events
                      - id: 14
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Log
                      - id: 16
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Rates and Benefits
                      - id: 17
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX DWT
                      - id: 18
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Unikey
                      - id: 22
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VtexID
                      - id: 48
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX Bridge
                      - id: 55
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Audit
                      - id: 64
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Vtex ID
                      - id: 66
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX IO
                      - id: 73
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Seller Register
                      - id: 75
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Time Series
                      - id: 89
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Promotions Policy Engine
                      - id: 91
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Releases
                    name: Gateway
                  - expiration:
                    id: 15
                    isPurchased: false
                    products:
                      - id: 1
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: License Manager
                      - id: 6
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: PCI Gateway
                      - id: 8
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX Events
                      - id: 14
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Log
                      - id: 16
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Rates and Benefits
                      - id: 17
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX DWT
                      - id: 18
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Unikey
                      - id: 22
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VtexID
                      - id: 43
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Billing
                      - id: 48
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX Bridge
                      - id: 55
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Audit
                      - id: 64
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Vtex ID
                      - id: 66
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX IO
                      - id: 73
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Seller Register
                      - id: 75
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Time Series
                      - id: 89
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Promotions Policy Engine
                      - id: 91
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Releases
                    name: Gateway Seller Nao VTEX
                  - expiration:
                    id: 29
                    isPurchased: false
                    products:
                      - id: 1
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: License Manager
                      - id: 23
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Message Center
                      - id: 55
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Audit
                      - id: 64
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Vtex ID
                      - id: 91
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Releases
                    name: Indeva
                  - expiration:
                    id: 30
                    isPurchased: false
                    products:
                      - id: 1
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: License Manager
                      - id: 2
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Catalog
                      - id: 5
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Checkout
                      - id: 6
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: PCI Gateway
                      - id: 9
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Logistics
                      - id: 13
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Channels
                      - id: 16
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Rates and Benefits
                      - id: 19
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: OMS
                      - id: 20
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Conversation Tracker
                      - id: 23
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Message Center
                      - id: 43
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Billing
                      - id: 46
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX Home
                      - id: 55
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Audit
                      - id: 64
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Vtex ID
                      - id: 65
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Pricing
                      - id: 66
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX IO
                      - id: 74
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Order Authorization
                      - id: 86
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: CatalogV2
                      - id: 89
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Promotions Policy Engine
                      - id: 91
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Releases
                    name: Marketplace Seller
                  - expiration:
                    id: 23
                    isPurchased: false
                    products:
                      - id: 1
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: License Manager
                      - id: 14
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Log
                      - id: 55
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Audit
                      - id: 64
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Vtex ID
                      - id: 73
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Seller Register
                      - id: 75
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Time Series
                      - id: 84
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: CDN Service
                      - id: 88
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Tenant Switcher
                      - id: 90
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Payments' Provider Manager
                      - id: 91
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Releases
                    name: VTEX Backoffice
                  - expiration:
                    id: 26
                    isPurchased: false
                    products:
                      - id: 55
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Audit
                      - id: 64
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Vtex ID
                      - id: 82
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Banking Service
                    name: VTEX Bank
                  - expiration:
                    id: 22
                    isPurchased: false
                    products:
                      - id: 1
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: License Manager
                      - id: 14
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Log
                      - id: 43
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Billing
                      - id: 55
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Audit
                      - id: 64
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Vtex ID
                      - id: 66
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX IO
                      - id: 73
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Seller Register
                      - id: 75
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Time Series
                    name: VTEX Billing
                  - expiration:
                    id: 27
                    isPurchased: false
                    products:
                      - id: 43
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Billing
                      - id: 55
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Audit
                      - id: 88
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Tenant Switcher
                    name: VTEX Partner
                  - expiration:
                    id: 25
                    isPurchased: false
                    products:
                      - id: 14
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Log
                      - id: 43
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Billing
                      - id: 55
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Audit
                      - id: 64
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Vtex ID
                      - id: 72
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX Payment
                      - id: 73
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Seller Register
                      - id: 75
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Time Series
                    name: VTEX Payment
                  - expiration:
                    id: 19
                    isPurchased: false
                    products:
                      - id: 1
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: License Manager
                      - id: 2
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Catalog
                      - id: 3
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Master Data
                      - id: 5
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Checkout
                      - id: 6
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: PCI Gateway
                      - id: 9
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Logistics
                      - id: 14
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Log
                      - id: 16
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Rates and Benefits
                      - id: 19
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: OMS
                      - id: 23
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Message Center
                      - id: 25
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Dynamic Storage
                      - id: 27
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Portal
                      - id: 39
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Availability
                      - id: 43
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Billing
                      - id: 55
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Audit
                      - id: 57
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Insights
                      - id: 64
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Vtex ID
                      - id: 65
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Pricing
                      - id: 66
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX IO
                      - id: 67
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTable
                      - id: 68
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Zendesk
                      - id: 73
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Seller Register
                      - id: 74
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Order Authorization
                      - id: 75
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Time Series
                      - id: 76
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Search
                      - id: 81
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Application Logs Stream
                      - id: 89
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Promotions Policy Engine
                      - id: 91
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Releases
                    name: WhiteLabel
                  - expiration:
                    id: 21
                    isPurchased: false
                    products:
                      - id: 2
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Catalog
                      - id: 14
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Log
                      - id: 55
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Audit
                      - id: 64
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Vtex ID
                      - id: 66
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX IO
                      - id: 73
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Seller Register
                      - id: 75
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Time Series
                    name: Whitelabel Instore
                  - expiration:
                    id: 31
                    isPurchased: false
                    products:
                      - id: 1
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: License Manager
                      - id: 2
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Catalog
                      - id: 5
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Checkout
                      - id: 6
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: PCI Gateway
                      - id: 9
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Logistics
                      - id: 16
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Rates and Benefits
                      - id: 19
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: OMS
                      - id: 20
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Conversation Tracker
                      - id: 23
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Message Center
                      - id: 43
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Billing
                      - id: 46
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX Home
                      - id: 55
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Audit
                      - id: 64
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Vtex ID
                      - id: 65
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Pricing
                      - id: 66
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: VTEX IO
                      - id: 74
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Order Authorization
                      - id: 86
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: CatalogV2
                      - id: 89
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Promotions Policy Engine
                      - id: 91
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Releases
                    name: Marketplace Seller Whitelabel
                  - expiration:
                    id: 33
                    isPurchased: false
                    products:
                      - id: 1
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: License Manager
                      - id: 55
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Audit
                      - id: 64
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Vtex ID
                      - id: 91
                        domains: []
                        endpoints:
                          webApiUrl:
                          consoleUrl:
                        name: Releases
                    name: Buyer Organization
                sponsor:
                  name: John Doe
                  email: john.doe@vtex.com.br
                  phone: '+219999999'
                contact:
                  name: John Doe
                  email: john.doe@vtex.com.br
                  phone: '+219999999'
                operationDate:
                inactivationDate:
                creationDate: '2019-12-11T17:02:34'
                hosts: []
                sites:
                  - id: 23117
                    name: apiexamples
                    tradingName: UNISUPER, SOCIEDAD ANONIMA
                    LV:
                    logo:
                    monetaryUnitId: 1
                    domains:
                    hosts: []
                    aliases: []
                appKey:
                  token:
                  name:
                appKeys:
                  - id: 03ccde55547d43b09bbb2e1e6f7d455e
                    appKey: vtexappkey-apiexamples-YSTRGZ
                    appToken:
                    label: apiexamples
                    createdIn: '2019-12-11T21:06:33'
                    isActive: true
                    isBlocked: false
                  - id: d585d6d94fd5415fb36c574a4c22986f
                    appKey: vtexappkey-apiexamples-LVQVVA
                    appToken:
                    label: tadashi-test
                    createdIn: '2021-10-21T20:00:21.308679'
                    isActive: true
                    isBlocked: false
      deprecated: false
security:
  - appKey: []
    appToken: []
  - VtexIdclientAutCookie: []
components:
  securitySchemes:
    appKey:
      type: apiKey
      in: header
      name: X-VTEX-API-AppKey
      description: Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys).
    appToken:
      type: apiKey
      in: header
      name: X-VTEX-API-AppToken
      description: Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys).
    VtexIdclientAutCookie:
      type: apiKey
      in: header
      name: VtexIdclientAutCookie
      description: '[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.'
  schemas:
    AccountResponse:
      description: Successful response for `/api/vlm/account`.
      type: object
      properties:
        isActive:
          description: Defines if the account is active (`true`) or not (`false`).
          type: boolean
        id:
          description: ID of the account.
          type: string
        name:
          description: Trading name.
          type: string
        accountName:
          description: Account name.
          type: string
        lv:
          type: string
          description: Level.
          nullable: true
          deprecated: true
        isOperating:
          description: Defines if the account is in production (`true`) or not (`false`).
          type: boolean
        defaultUrl:
          deprecated: true
          description: Default URL.
          type: string
          nullable: true
        district:
          description: Neighborhood of the person assigned as main contact of the store.
          type: string
          nullable: true
        country:
          description: Country of the person assigned as main contact of the store.
          type: string
          nullable: true
        complement:
          description: Additional address of the person assigned as main contact of the store.
          type: string
          nullable: true
        companyName:
          description: Company name.
          type: string
        cnpj:
          description: CNPJ (Corporate Tax ID) of account.
          type: string
          nullable: true
        haveParentAccount:
          description: Defines if the account has a parent account (`true`) or not (`false`).
          type: boolean
        parentAccountId:
          description: ID of the parent account.
          type: string
          nullable: true
        parentAccountName:
          description: Name of the parent account.
          type: string
          nullable: true
        city:
          description: City of the person assigned as main contact of the store.
          type: string
          nullable: true
        address:
          description: Address of the person assigned as main contact of the store.
          type: string
          nullable: true
        logo:
          description: Filename of the account's logotype.
          type: string
          nullable: true
        hasLogo:
          description: Defines if the store's logotype has been uploaded (`true`) or not (`false`).
          type: boolean
        number:
          description: Number of the address of the person assigned as main contact of the store.
          type: string
          nullable: true
        postalCode:
          description: Zip code of the person assigned as main contact of the store.
          type: string
          nullable: true
        state:
          description: State or province of the person assigned as main contact of the store.
          type: string
          nullable: true
        telephone:
          description: Telephone number of the person assigned as main contact of the store.
          type: string
        tradingName:
          description: Trading name.
          type: string
        licenses:
          description: Licenses of the account.
          type: array
          items:
            $ref: '#/components/schemas/LicenseItems'
        sponsor:
          description: Object with information about the sponsor user.
          type: object
          properties:
            name:
              description: Name of the sponsor user.
              type: string
            email:
              description: Email of the sponsor user.
              type: string
            phone:
              description: Phone of the sponsor user.
              type: string
        contact:
          type: object
          description: Information about the person assigned as main contact of the store.
          properties:
            name:
              description: Name of the person assigned as main contact of the store.
              type: string
            email:
              description: Email of the person assigned as main contact of the store.
              type: string
            phone:
              description: Telephone number of the person assigned as main contact of the store.
              type: string
        operationDate:
          description: Date when the account went into production.
          type: string
          nullable: true
          format: date-time
        inactivationDate:
          description: Date when the account was deactivated.
          type: string
          nullable: true
          format: date-time
        creationDate:
          description: Date when the account was created.
          type: string
          format: date-time
        hosts:
          description: Hosts of all stores.
          type: array
          items:
            type: string
            description: Host address.
        sites:
          description: Array of objects representing each store.
          type: array
          items:
            $ref: '#/components/schemas/SiteItems'
        appKey:
          description: Deprecated. Check the `appKeys` object for all appKeys.
          type: object
          properties:
            token:
              type: string
              description: Token.
              nullable: true
              deprecated: true
            name:
              type: string
              description: Token name.
              nullable: true
              deprecated: true
          deprecated: true
        appKeys:
          description: Array of application keys.
          type: array
          items:
            $ref: '#/components/schemas/AppKeyItems'
    LicenseItems:
      description: Object representing licenses.
      type: object
      properties:
        expiration:
          type: string
          format: date-time
          nullable: true
          deprecated: true
          description: Expiration date.
        id:
          description: ID of the category of the license.
          type: number
        isPurchased:
          description: Defines if the license is purchased (`true`) or not (`false`).
          type: boolean
        products:
          description: Array of products.
          type: array
          items:
            description: Object representing products of licenses.
            type: object
            properties:
              id:
                description: ID of the product.
                type: number
              name:
                description: Name of the product.
                type: string
              domains:
                description: List of domains of the product.
                type: array
                items:
                  type: string
                  description: Domain of the product.
                deprecated: true
              endpoints:
                type: object
                description: Endpoints.
                properties:
                  webApiUrl:
                    type: string
                    description: Web API URL.
                    nullable: true
                    deprecated: true
                  consoleUrl:
                    type: string
                    description: Console URL.
                    nullable: true
                    deprecated: true
                deprecated: true
        name:
          description: Name of the category of the license.
          type: string
    SiteItems:
      description: Object containing complete information from a store.
      type: object
      properties:
        id:
          description: ID of the store.
          type: number
        name:
          description: Store name.
          type: string
        tradingName:
          description: Trading name of the store.
          type: string
        LV:
          type: string
          description: Level.
          nullable: true
          deprecated: true
        logo:
          type: string
          description: Logo.
          nullable: true
          deprecated: true
        monetaryUnitId:
          type: number
          description: Monetary unit ID.
          deprecated: true
        domains:
          type: array
          description: List of domains.
          items:
            type: string
            description: Domain.
            deprecated: true
          nullable: true
          deprecated: true
        hosts:
          description: Hosts associated to the store.
          type: array
          items:
            type: string
            description: Host address.
        aliases:
          type: array
          description: Aliases.
          items:
            type: string
            description: Alias.
            deprecated: true
          deprecated: true
    AppKeyItems:
      description: Object representing application keys.
      type: object
      properties:
        id:
          description: ID of the application key.
          type: string
        appKey:
          description: AppKey.
          type: string
        appToken:
          description: AppToken. For security reasons, it should always be null.
          type: string
          nullable: true
        label:
          description: Label of the application key.
          type: string
        createdIn:
          description: Creation date of the application key.
          type: string
          format: date-time
        isActive:
          description: Defines if the application key is active (`true`) or not (`false`).
          type: boolean
        isBlocked:
          description: Defines if the application key is blocked (`true`) or not (`false`).
          type: boolean
    CreateUserRequest:
      description: Request body for creating users.
      required:
        - email
      type: object
      properties:
        name:
          description: Name of the user.
          type: string
          example: John
        email:
          description: Email of the user.
          type: string
          example: john@mail.com
    CreatenewappkeyRequest:
      description: Request body for creating new application key (/api/vlm/appkeys)
      required:
        - label
      type: object
      properties:
        label:
          description: Label of the application key.
          type: string
          example: appkey-test
    CreatenewappkeyResponse:
      description: Response body of sucessful call to /api/vlm/appkeys.
      required:
        - id
        - appKey
        - appToken
        - label
        - createdIn
        - isActive
      type: object
      properties:
        id:
          description: ID of the application key.
          type: string
        appKey:
          description: AppKey.
          type: string
        appToken:
          description: AppToken. For security reasons, it should always be null.
          type: string
          nullable: true
        label:
          description: Label of the application key.
          type: string
        createdIn:
          description: Creation date of the application key.
          type: string
          format: date-time
        isActive:
          description: Defines if the application key is active (`true`) or not (`false`).
          type: boolean
    UpdateappkeyRequest:
      description: Request body for activating or deactivating application keys.
      required:
        - isActive
      type: object
      properties:
        isActive:
          description: Defines if the application key is active (`true`) or not (`false`).
          type: boolean
          example: true
    Getappkeysfromaccount:
      description: Response body for getting all application keys from the account.
      required:
        - id
        - appKey
        - label
        - createdIn
        - isActive
      type: object
      properties:
        id:
          description: ID of the application key.
          type: string
        appKey:
          description: AppKey.
          type: string
        label:
          description: Label of the application key.
          type: string
        createdIn:
          description: Creation date of the application key.
          type: string
          format: date-time
        isActive:
          description: Defines if the application key is active (`true`) or not (`false`).
          type: boolean
    ListUsersResponse:
      description: Response body for listing all users.
      type: object
      properties:
        items:
          description: Array of user objects.
          type: array
          items:
            $ref: '#/components/schemas/UserItems'
        paging:
          $ref: '#/components/schemas/Paging'
    ListRolesResponse:
      description: Response body for listing all roles.
      type: object
      properties:
        items:
          description: Array of role objects.
          type: array
          items:
            $ref: '#/components/schemas/RoleItems'
        paging:
          $ref: '#/components/schemas/Paging'
    Paging:
      description: Paging object.
      required:
        - page
        - perPage
        - total
        - pages
      type: object
      properties:
        page:
          description: Current page number.
          type: integer
        perPage:
          description: Items per page.
          type: integer
        total:
          description: Total of items.
          type: integer
        pages:
          description: Total of pages.
          type: integer
    UserItems:
      description: Object with information about an user.
      type: object
      properties:
        id:
          description: ID of the user.
          type: string
        email:
          description: Email of the user.
          type: string
        isAdmin:
          description: Defines if the user has administrative access (`true`) or not (`false`).
          type: boolean
        isReliable:
          description: For internal use only.
          type: boolean
        isBlocked:
          description: Defines if the user is blocked (`true`) or not (`false`).
          type: boolean
        roles:
          type: array
          description: Array of user roles.
          items:
            type: string
            description: Role ID.
        accountNames:
          type: array
          description: Array of account names.
          items:
            type: string
            description: Account names.
        name:
          description: Name of the user.
          type: string
    RoleItems:
      description: Object with information about a role.
      type: object
      properties:
        id:
          description: ID of the role.
          type: integer
        isAdmin:
          description: Defines if the role has administrative access (`true`) or not (`false`).
          type: boolean
        roleType:
          description: Returns `1` for custom roles, and `0` for predefined roles.
          type: integer
        products:
          type: array
          description: Array of License Manager product objects.
          items:
            $ref: '#/components/schemas/ProductItems'
        resources:
          type: string
          description: Resources.
          nullable: true
          deprecated: true
        logins:
          type: string
          description: Logins.
          nullable: true
          deprecated: true
        name:
          description: Name of the role.
          type: string
    ProductItems:
      description: Object representing License Manager products.
      type: object
      properties:
        id:
          deprecated: true
          description: License Manager product ID.
          type: string
          nullable: true
        categoryId:
          deprecated: true
          description: Category ID.
          type: string
          nullable: true
        categoryName:
          deprecated: true
          type: string
          description: Category name.
          nullable: true
        description:
          deprecated: true
          type: string
          description: Description.
          nullable: true
        consoleUrlMask:
          deprecated: true
          type: string
          description: Console URL mask.
          nullable: true
        urlConfiguration:
          deprecated: true
          type: string
          description: URL configuration.
          nullable: true
        webApiUrlMask:
          deprecated: true
          type: string
          description: Web API mask.
          nullable: true
        url:
          deprecated: true
          type: string
          description: URL.
          nullable: true
        productResources:
          deprecated: true
          type: string
          description: Product resources.
          nullable: true
        name:
          description: Name of the License Manager product.
          type: string
    StoreItems:
      description: Object containing summarized information from a store.
      type: object
      properties:
        id:
          description: ID of the store.
          type: number
        name:
          description: Name of the store.
          type: string
        hosts:
          description: Array of hosts corresponding to the store.
          type: array
          items:
            type: string
            description: Host address.
    VLMError:
      description: Object representing VLMError.
      type: object
      properties:
        Details:
          description: Details of error.
          type: string
          nullable: true
        HttpStatusCode:
          description: Status code of HTTP response.
          type: integer
        VLMErrorCode:
          description: Error code for License Manager.
          type: integer
        Message:
          description: Error message.
          type: string
  parameters:
    Content-Type:
      name: Content-Type
      in: header
      description: Type of the content being sent.
      required: true
      style: simple
      schema:
        type: string
        default: application/json
    Accept:
      name: Accept
      in: header
      description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
      required: true
      style: simple
      schema:
        type: string
        default: application/json
tags:
  - name: Account
  - name: App Keys
  - name: Roles
  - name: Stores
  - name: Users