vtex.local – License-Manager-API

Tools (14)

Extracted live via the executor SDK.

• account.getAccount

  Retrieves information from an account, such as company and sponsor user details, stores, and appTokens.

  This 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.

• appKeys.createnewappkey

  Creates a new pair of appKey and appToken.

• appKeys.getappkeysfromaccount

  Gets all application keys from an account.

• appKeys.updateappkey

  Activates or deactivates an appKey by its ID.

• roles.getListRoles

  Returns a list of available roles. 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.

• roles.getRolesbyUser

  Gets roles of a particular user or application key.

• roles.putRolesinUser

  Allows you to add roles to a particular user or application key by specifying the list of roles' IDs on the request's body.

• roles.removeRolefromUser

  Allows you to remove a role 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.

  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.

• store.getByAccount

  Gets the stores and respective hosts of the account

• user.createUser

  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.

• user.getListUsers

  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.

• user.getUser

  Allows you to get a user from the database, using the userId as the identifier.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools