{ "openapi": "3.0.0", "info": { "title": "License Manager API", "description": "## Welcome!\r\n\r\nThe License Manager API allows you to create users, modify their names and emails, as well as add and remove roles from users.\r\n\r\n### ATTRIBUTES\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 looked up on the License Manager UI |", "contact": {}, "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.", "default": "vtexcommercestable" } } } ], "paths": { "/api/license-manager/users/{userId}": { "get": { "tags": ["User"], "summary": "Get User", "description": "Allows you to get a user from the database, using the `userId` as the identifier.", "operationId": "GetUser", "parameters": [ { "name": "Content-Type", "in": "header", "description": "The media type of the body of the request. Default value for license manager protocol is application/json", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "userId", "in": "path", "description": "ID from queried user.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "ID of user", "type": "string" }, "name": { "description": "Name of user", "type": "string" }, "email": { "description": "Email of user", "type": "string" } } }, "example": { "id": "a404870467d24533a085a6b3c6a5a320", "name": "testuser", "email": "mynewuser@mydomain.com" } } } }, "400": { "description": "Bad Request", "headers": {}, "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.", "headers": {} } }, "deprecated": false } }, "/api/license-manager/users": { "post": { "tags": ["User"], "summary": "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.", "operationId": "CreateUser", "parameters": [ ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" }, "example": { "name": "My New User Name", "email": "mynewuser@mydomain.com" } } }, "required": true }, "responses": { "200": { "description": "Success", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "ID of user", "type": "string" }, "email": { "description": "Email of user", "type": "string" }, "name": { "description": "Name of user", "type": "string" } } }, "example": { "id": "a404870467d24533a085a6b3c6a5a320", "email": "mynewuser@mydomain.com", "name": "testuser" } } } }, "400": { "description": "Bad Request", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "Message": { "type": "string" } } }, "example": { "Message": "Invalid email" } } } } }, "deprecated": false } }, "/api/license-manager/users/{userId}/roles": { "put": { "tags": ["Roles"], "summary": "Put Roles in User/appKey", "description": "Allows you to add roles to a particular user or application key by specifying the list of roles' IDs on the request's body.", "operationId": "PutRolesinUser", "parameters": [ { "name": "userId", "in": "path", "description": "ID corresponding to the user", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "List of roles' IDs to add to the user or application key.", "content": { "application/json": { "schema": { "type": "array", "description": "Array containing IDs of the roles", "items": { "type": "integer", "format": "int32" } }, "example": [9000, 9111, 9333, 9444] } }, "required": true }, "responses": { "204": { "description": "Success - A no-content response, but the roles were added successfully.", "headers": {} }, "400": { "description": "Bad Request - A userId or role list with invalid format. The message on the body of the response will contain further information.", "headers": {}, "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.", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "Message": { "type": "string" } } }, "example": { "Message": "Unexpected error" } } } } }, "deprecated": false }, "get": { "tags": ["Roles"], "summary": "Get Roles by User/appKey", "description": "Gets roles of a particular user or application key.", "operationId": "GetRolesbyUser", "parameters": [ { "name": "Content-Type", "in": "header", "description": "The media type of the body of the request. Default value for license manager protocol is application/json", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "userId", "in": "path", "description": "ID corresponding to the user", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "description": "Array of role objects", "items": { "type": "object", "properties": { "id": { "description": "ID of role", "type": "integer", "format": "int32" }, "name": { "description": "Name of 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": "Remove Role from User/appKey", "description": "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.", "operationId": "RemoveRolefromUser", "parameters": [ { "name": "Content-Type", "in": "header", "description": "The media type of the body of the request. Default value for license manager protocol is application/json", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "userId", "in": "path", "description": "ID corresponding to the user", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "roleId", "in": "path", "description": "ID of the role which will be removed from the user", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success - A no-content response, but the role deletion was performed successfully.", "headers": {} }, "400": { "description": "Bad Request - A userId or role list with invalid format. The message on the body of the response will contain further information.", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "Message": { "type": "string" } } }, "example": { "Message": "Invalid UserId" } } } }, "405": { "description": "Method Not Allowed", "headers": {} } }, "deprecated": false } }, "/api/vlm/appkeys": { "post": { "tags": ["App Keys"], "summary": "Create new appkey", "description": "Creates a new pair of `appKey` and `appToken`.", "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": "Get appKeys from account", "description": "Gets all application keys from an account.", "operationId": "Getappkeysfromaccount", "parameters": [ { "name": "Content-Type", "in": "header", "description": "The media type of the body of the request. Default value for license manager protocol is application/json", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } } ], "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": "Update appkey", "description": "Activates or deactivates an `appKey` by its ID.", "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", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VLMError" }, "example": { "Details": null, "HttpStatusCode": 400, "VLMErrorCode": 17, "Message": "Token not exists for this account" } } } } }, "deprecated": false } }, "/api/vlm/account/stores": { "get": { "tags": ["Store"], "summary": "Get Stores", "description": "Gets the stores and respective hosts of the account", "operationId": "GetByAccount", "parameters": [ ], "responses": { "200": { "description": "Success", "headers": {}, "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": "Get information about account", "description": "Retrieves information from an account, such as company and sponsor user details, stores, and appTokens.", "operationId": "GetAccount", "parameters": [ ], "responses": { "200": { "description": "Success", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountResponse" }, "example": { "isActive": true, "id": "71fe5fdabc4940ad81c226d43b754ba8", "name": "UNISUPER, SOCIEDAD ANONIMA", "accountName": "apiexamples", "lv": null, "isOperating": false, "defaultUrl": null, "district": null, "country": null, "complement": null, "companyName": "UNISUPER, SOCIEDAD ANONIMA", "cnpj": null, "haveParentAccount": false, "parentAccountId": null, "parentAccountName": null, "city": null, "address": null, "logo": null, "hasLogo": false, "number": null, "postalCode": null, "state": null, "telephone": "+219999999", "tradingName": "UNISUPER, SOCIEDAD ANONIMA", "licenses": [ { "expiration": null, "id": 24, "isPurchased": false, "products": [ { "id": 1, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "License Manager" }, { "id": 9, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Logistics" }, { "id": 14, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Log" }, { "id": 23, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Message Center" }, { "id": 43, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Billing" }, { "id": 55, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Audit" }, { "id": 64, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Vtex ID" }, { "id": 66, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX IO" }, { "id": 73, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Seller Register" }, { "id": 75, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Time Series" }, { "id": 91, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Releases" } ], "name": "Carrier" }, { "expiration": null, "id": 10, "isPurchased": false, "products": [ { "id": 1, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "License Manager" }, { "id": 3, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Master Data" }, { "id": 14, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Log" }, { "id": 17, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX DWT" }, { "id": 18, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Unikey" }, { "id": 23, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Message Center" }, { "id": 25, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Dynamic Storage" }, { "id": 30, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Key Store" }, { "id": 48, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX Bridge" }, { "id": 51, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Vtex My Account" }, { "id": 55, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Audit" }, { "id": 64, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Vtex ID" }, { "id": 67, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTable" }, { "id": 68, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Zendesk" }, { "id": 73, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Seller Register" }, { "id": 75, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Time Series" }, { "id": 91, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Releases" } ], "name": "CRM" }, { "expiration": null, "id": 8, "isPurchased": false, "products": [ { "id": 1, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "License Manager" }, { "id": 2, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Catalog" }, { "id": 3, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Master Data" }, { "id": 4, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Request Capture" }, { "id": 5, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Checkout" }, { "id": 6, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "PCI Gateway" }, { "id": 9, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Logistics" }, { "id": 13, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Channels" }, { "id": 14, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Log" }, { "id": 16, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Rates and Benefits" }, { "id": 17, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX DWT" }, { "id": 18, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Unikey" }, { "id": 19, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "OMS" }, { "id": 20, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Conversation Tracker" }, { "id": 23, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Message Center" }, { "id": 25, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Dynamic Storage" }, { "id": 27, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Portal" }, { "id": 38, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "CMS" }, { "id": 43, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Billing" }, { "id": 48, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX Bridge" }, { "id": 50, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Suggestion" }, { "id": 51, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Vtex My Account" }, { "id": 53, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Network" }, { "id": 55, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Audit" }, { "id": 57, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Insights" }, { "id": 58, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Credit Control" }, { "id": 61, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "WebService" }, { "id": 64, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Vtex ID" }, { "id": 65, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Pricing" }, { "id": 66, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX IO" }, { "id": 67, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTable" }, { "id": 69, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Conditions Evaluator" }, { "id": 70, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "GiftCard" }, { "id": 73, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Seller Register" }, { "id": 74, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Order Authorization" }, { "id": 75, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Time Series" }, { "id": 76, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Search" }, { "id": 81, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Application Logs Stream" }, { "id": 83, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Subscriptions" }, { "id": 84, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "CDN Service" }, { "id": 85, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Dandelion" }, { "id": 88, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Tenant Switcher" }, { "id": 89, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Promotions Policy Engine" }, { "id": 91, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Releases" } ], "name": "E-Commerce Professional" }, { "expiration": null, "id": 6, "isPurchased": false, "products": [ { "id": 1, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "License Manager" }, { "id": 2, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Catalog" }, { "id": 3, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Master Data" }, { "id": 4, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Request Capture" }, { "id": 5, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Checkout" }, { "id": 6, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "PCI Gateway" }, { "id": 7, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Buscapé Connect" }, { "id": 9, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Logistics" }, { "id": 13, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Channels" }, { "id": 14, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Log" }, { "id": 16, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Rates and Benefits" }, { "id": 17, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX DWT" }, { "id": 18, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Unikey" }, { "id": 19, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "OMS" }, { "id": 20, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Conversation Tracker" }, { "id": 23, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Message Center" }, { "id": 25, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Dynamic Storage" }, { "id": 27, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Portal" }, { "id": 38, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "CMS" }, { "id": 43, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Billing" }, { "id": 48, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX Bridge" }, { "id": 50, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Suggestion" }, { "id": 51, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Vtex My Account" }, { "id": 53, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Network" }, { "id": 55, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Audit" }, { "id": 57, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Insights" }, { "id": 58, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Credit Control" }, { "id": 61, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "WebService" }, { "id": 64, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Vtex ID" }, { "id": 65, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Pricing" }, { "id": 66, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX IO" }, { "id": 67, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTable" }, { "id": 68, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Zendesk" }, { "id": 69, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Conditions Evaluator" }, { "id": 70, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "GiftCard" }, { "id": 73, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Seller Register" }, { "id": 74, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Order Authorization" }, { "id": 75, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Time Series" }, { "id": 76, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Search" }, { "id": 81, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Application Logs Stream" }, { "id": 83, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Subscriptions" }, { "id": 84, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "CDN Service" }, { "id": 85, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Dandelion" }, { "id": 88, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Tenant Switcher" }, { "id": 89, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Promotions Policy Engine" }, { "id": 91, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Releases" } ], "name": "E-Commerce Starter" }, { "expiration": null, "id": 7, "isPurchased": true, "products": [ { "id": 1, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "License Manager" }, { "id": 2, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Catalog" }, { "id": 3, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Master Data" }, { "id": 4, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Request Capture" }, { "id": 5, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Checkout" }, { "id": 6, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "PCI Gateway" }, { "id": 7, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Buscapé Connect" }, { "id": 8, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX Events" }, { "id": 9, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Logistics" }, { "id": 10, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Shipping Notification" }, { "id": 13, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Channels" }, { "id": 14, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Log" }, { "id": 15, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX Fulfilment" }, { "id": 16, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Rates and Benefits" }, { "id": 17, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX DWT" }, { "id": 18, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Unikey" }, { "id": 19, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "OMS" }, { "id": 20, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Conversation Tracker" }, { "id": 22, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VtexID" }, { "id": 23, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Message Center" }, { "id": 25, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Dynamic Storage" }, { "id": 27, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Portal" }, { "id": 28, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Dumbo" }, { "id": 30, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Key Store" }, { "id": 31, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Dashboard" }, { "id": 37, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Vtex PAI" }, { "id": 38, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "CMS" }, { "id": 39, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Availability" }, { "id": 41, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Big Data" }, { "id": 43, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Billing" }, { "id": 45, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Healthcheck" }, { "id": 46, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX Home" }, { "id": 48, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX Bridge" }, { "id": 50, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Suggestion" }, { "id": 51, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Vtex My Account" }, { "id": 53, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Network" }, { "id": 55, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Audit" }, { "id": 57, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Insights" }, { "id": 58, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Credit Control" }, { "id": 60, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Extension Store" }, { "id": 61, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "WebService" }, { "id": 64, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Vtex ID" }, { "id": 65, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Pricing" }, { "id": 66, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX IO" }, { "id": 67, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTable" }, { "id": 68, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Zendesk" }, { "id": 69, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Conditions Evaluator" }, { "id": 70, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "GiftCard" }, { "id": 73, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Seller Register" }, { "id": 74, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Order Authorization" }, { "id": 75, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Time Series" }, { "id": 76, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Search" }, { "id": 81, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Application Logs Stream" }, { "id": 83, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Subscriptions" }, { "id": 84, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "CDN Service" }, { "id": 85, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Dandelion" }, { "id": 88, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Tenant Switcher" }, { "id": 89, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Promotions Policy Engine" }, { "id": 91, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Releases" } ], "name": "E-Commerce Unlimited" }, { "expiration": null, "id": 28, "isPurchased": false, "products": [ { "id": 1, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "License Manager" }, { "id": 2, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Catalog" }, { "id": 3, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Master Data" }, { "id": 4, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Request Capture" }, { "id": 5, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Checkout" }, { "id": 6, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "PCI Gateway" }, { "id": 7, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Buscapé Connect" }, { "id": 8, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX Events" }, { "id": 9, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Logistics" }, { "id": 10, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Shipping Notification" }, { "id": 13, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Channels" }, { "id": 14, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Log" }, { "id": 15, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX Fulfilment" }, { "id": 16, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Rates and Benefits" }, { "id": 17, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX DWT" }, { "id": 18, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Unikey" }, { "id": 19, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "OMS" }, { "id": 20, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Conversation Tracker" }, { "id": 22, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VtexID" }, { "id": 23, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Message Center" }, { "id": 25, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Dynamic Storage" }, { "id": 27, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Portal" }, { "id": 28, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Dumbo" }, { "id": 30, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Key Store" }, { "id": 31, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Dashboard" }, { "id": 37, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Vtex PAI" }, { "id": 38, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "CMS" }, { "id": 39, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Availability" }, { "id": 41, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Big Data" }, { "id": 45, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Healthcheck" }, { "id": 46, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX Home" }, { "id": 48, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX Bridge" }, { "id": 50, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Suggestion" }, { "id": 51, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Vtex My Account" }, { "id": 53, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Network" }, { "id": 55, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Audit" }, { "id": 57, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Insights" }, { "id": 58, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Credit Control" }, { "id": 60, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Extension Store" }, { "id": 61, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "WebService" }, { "id": 64, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Vtex ID" }, { "id": 65, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Pricing" }, { "id": 66, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX IO" }, { "id": 67, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTable" }, { "id": 68, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Zendesk" }, { "id": 69, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Conditions Evaluator" }, { "id": 70, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "GiftCard" }, { "id": 73, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Seller Register" }, { "id": 74, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Order Authorization" }, { "id": 75, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Time Series" }, { "id": 76, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Search" }, { "id": 81, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Application Logs Stream" }, { "id": 83, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Subscriptions" }, { "id": 84, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "CDN Service" }, { "id": 88, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Tenant Switcher" }, { "id": 89, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Promotions Policy Engine" }, { "id": 91, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Releases" } ], "name": "E-Commerce Unlimited No Billing" }, { "expiration": null, "id": 11, "isPurchased": false, "products": [ { "id": 1, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "License Manager" }, { "id": 6, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "PCI Gateway" }, { "id": 8, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX Events" }, { "id": 14, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Log" }, { "id": 16, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Rates and Benefits" }, { "id": 17, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX DWT" }, { "id": 18, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Unikey" }, { "id": 22, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VtexID" }, { "id": 48, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX Bridge" }, { "id": 55, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Audit" }, { "id": 64, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Vtex ID" }, { "id": 66, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX IO" }, { "id": 73, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Seller Register" }, { "id": 75, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Time Series" }, { "id": 89, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Promotions Policy Engine" }, { "id": 91, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Releases" } ], "name": "Gateway" }, { "expiration": null, "id": 15, "isPurchased": false, "products": [ { "id": 1, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "License Manager" }, { "id": 6, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "PCI Gateway" }, { "id": 8, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX Events" }, { "id": 14, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Log" }, { "id": 16, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Rates and Benefits" }, { "id": 17, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX DWT" }, { "id": 18, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Unikey" }, { "id": 22, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VtexID" }, { "id": 43, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Billing" }, { "id": 48, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX Bridge" }, { "id": 55, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Audit" }, { "id": 64, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Vtex ID" }, { "id": 66, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX IO" }, { "id": 73, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Seller Register" }, { "id": 75, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Time Series" }, { "id": 89, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Promotions Policy Engine" }, { "id": 91, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Releases" } ], "name": "Gateway Seller Nao VTEX" }, { "expiration": null, "id": 29, "isPurchased": false, "products": [ { "id": 1, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "License Manager" }, { "id": 23, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Message Center" }, { "id": 55, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Audit" }, { "id": 64, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Vtex ID" }, { "id": 91, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Releases" } ], "name": "Indeva" }, { "expiration": null, "id": 30, "isPurchased": false, "products": [ { "id": 1, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "License Manager" }, { "id": 2, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Catalog" }, { "id": 5, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Checkout" }, { "id": 6, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "PCI Gateway" }, { "id": 9, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Logistics" }, { "id": 13, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Channels" }, { "id": 16, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Rates and Benefits" }, { "id": 19, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "OMS" }, { "id": 20, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Conversation Tracker" }, { "id": 23, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Message Center" }, { "id": 43, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Billing" }, { "id": 46, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX Home" }, { "id": 55, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Audit" }, { "id": 64, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Vtex ID" }, { "id": 65, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Pricing" }, { "id": 66, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX IO" }, { "id": 74, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Order Authorization" }, { "id": 86, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "CatalogV2" }, { "id": 89, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Promotions Policy Engine" }, { "id": 91, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Releases" } ], "name": "Marketplace Seller" }, { "expiration": null, "id": 23, "isPurchased": false, "products": [ { "id": 1, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "License Manager" }, { "id": 14, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Log" }, { "id": 55, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Audit" }, { "id": 64, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Vtex ID" }, { "id": 73, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Seller Register" }, { "id": 75, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Time Series" }, { "id": 84, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "CDN Service" }, { "id": 88, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Tenant Switcher" }, { "id": 90, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Payments' Provider Manager" }, { "id": 91, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Releases" } ], "name": "VTEX Backoffice" }, { "expiration": null, "id": 26, "isPurchased": false, "products": [ { "id": 55, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Audit" }, { "id": 64, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Vtex ID" }, { "id": 82, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Banking Service" } ], "name": "VTEX Bank" }, { "expiration": null, "id": 22, "isPurchased": false, "products": [ { "id": 1, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "License Manager" }, { "id": 14, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Log" }, { "id": 43, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Billing" }, { "id": 55, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Audit" }, { "id": 64, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Vtex ID" }, { "id": 66, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX IO" }, { "id": 73, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Seller Register" }, { "id": 75, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Time Series" } ], "name": "VTEX Billing" }, { "expiration": null, "id": 27, "isPurchased": false, "products": [ { "id": 43, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Billing" }, { "id": 55, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Audit" }, { "id": 88, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Tenant Switcher" } ], "name": "VTEX Partner" }, { "expiration": null, "id": 25, "isPurchased": false, "products": [ { "id": 14, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Log" }, { "id": 43, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Billing" }, { "id": 55, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Audit" }, { "id": 64, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Vtex ID" }, { "id": 72, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX Payment" }, { "id": 73, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Seller Register" }, { "id": 75, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Time Series" } ], "name": "VTEX Payment" }, { "expiration": null, "id": 19, "isPurchased": false, "products": [ { "id": 1, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "License Manager" }, { "id": 2, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Catalog" }, { "id": 3, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Master Data" }, { "id": 5, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Checkout" }, { "id": 6, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "PCI Gateway" }, { "id": 9, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Logistics" }, { "id": 14, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Log" }, { "id": 16, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Rates and Benefits" }, { "id": 19, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "OMS" }, { "id": 23, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Message Center" }, { "id": 25, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Dynamic Storage" }, { "id": 27, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Portal" }, { "id": 39, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Availability" }, { "id": 43, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Billing" }, { "id": 55, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Audit" }, { "id": 57, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Insights" }, { "id": 64, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Vtex ID" }, { "id": 65, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Pricing" }, { "id": 66, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX IO" }, { "id": 67, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTable" }, { "id": 68, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Zendesk" }, { "id": 73, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Seller Register" }, { "id": 74, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Order Authorization" }, { "id": 75, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Time Series" }, { "id": 76, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Search" }, { "id": 81, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Application Logs Stream" }, { "id": 89, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Promotions Policy Engine" }, { "id": 91, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Releases" } ], "name": "WhiteLabel" }, { "expiration": null, "id": 21, "isPurchased": false, "products": [ { "id": 2, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Catalog" }, { "id": 14, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Log" }, { "id": 55, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Audit" }, { "id": 64, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Vtex ID" }, { "id": 66, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX IO" }, { "id": 73, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Seller Register" }, { "id": 75, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Time Series" } ], "name": "Whitelabel Instore" }, { "expiration": null, "id": 31, "isPurchased": false, "products": [ { "id": 1, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "License Manager" }, { "id": 2, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Catalog" }, { "id": 5, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Checkout" }, { "id": 6, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "PCI Gateway" }, { "id": 9, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Logistics" }, { "id": 16, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Rates and Benefits" }, { "id": 19, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "OMS" }, { "id": 20, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Conversation Tracker" }, { "id": 23, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Message Center" }, { "id": 43, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Billing" }, { "id": 46, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX Home" }, { "id": 55, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Audit" }, { "id": 64, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Vtex ID" }, { "id": 65, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Pricing" }, { "id": 66, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "VTEX IO" }, { "id": 74, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Order Authorization" }, { "id": 86, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "CatalogV2" }, { "id": 89, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Promotions Policy Engine" }, { "id": 91, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Releases" } ], "name": "Marketplace Seller Whitelabel" }, { "expiration": null, "id": 33, "isPurchased": false, "products": [ { "id": 1, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "License Manager" }, { "id": 55, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Audit" }, { "id": 64, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "name": "Vtex ID" }, { "id": 91, "domains": [], "endpoints": { "webApiUrl": null, "consoleUrl": null }, "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": null, "inactivationDate": null, "creationDate": "2019-12-11T17:02:34", "hosts": [], "sites": [ { "id": 23117, "name": "apiexamples", "tradingName": "UNISUPER, SOCIEDAD ANONIMA", "LV": null, "logo": null, "monetaryUnitId": 1, "domains": null, "hosts": [], "aliases": [] } ], "appKey": { "token": null, "name": null }, "appKeys": [ { "id": "03ccde55547d43b09bbb2e1e6f7d455e", "appKey": "vtexappkey-apiexamples-YSTRGZ", "appToken": null, "label": "apiexamples", "createdIn": "2019-12-11T21:06:33", "isActive": true, "isBlocked": false }, { "id": "d585d6d94fd5415fb36c574a4c22986f", "appKey": "vtexappkey-apiexamples-LVQVVA", "appToken": null, "label": "tadashi-test", "createdIn": "2021-10-21T20:00:21.308679", "isActive": true, "isBlocked": false } ] } } } } }, "deprecated": false } }, "/api/license-manager/site/pvt/logins/list/paged": { "get": { "tags": ["User"], "summary": "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.", "operationId": "GetListUsers", "parameters": [ { "name": "Content-Type", "in": "header", "description": "The media type of the body of the request. Default value for license manager protocol is application/json", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "numItems", "in": "query", "description": "Number of items in the returned page", "required": false, "style": "form", "schema": { "type": "integer", "default": 10 } }, { "name": "pageNumber", "in": "query", "description": "Which page from the whole list will be returned", "required": false, "style": "form", "schema": { "type": "integer", "default": 1 } }, { "name": "sort", "in": "query", "description": "Chooses the field that the list will be sorted by", "required": false, "style": "form", "schema": { "type": "string", "default": "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", "default": "ASC" } } ], "responses": { "200": { "description": "Success", "headers": {}, "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/site/pvt/roles/list/paged": { "get": { "tags": ["Roles"], "summary": "Get List of Roles", "description": "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.", "operationId": "GetListRoles", "parameters": [ { "name": "Content-Type", "in": "header", "description": "The media type of the body of the request. Default value for license manager protocol is application/json", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "numItems", "in": "query", "description": "Number of items in the returned page", "required": false, "style": "form", "schema": { "type": "integer", "default": 10 } }, { "name": "pageNumber", "in": "query", "description": "Which page from the whole list will be returned", "required": false, "style": "form", "schema": { "type": "integer", "default": 1 } }, { "name": "sort", "in": "query", "description": "Chooses the field that the list will be sorted by", "required": false, "style": "form", "schema": { "type": "string", "default": "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", "default": "ASC" } } ], "responses": { "200": { "description": "Success", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRolesResponse" }, "example": { "items": [ { "id": 957, "isAdmin": false, "roleType": 0, "products": [ { "id": null, "categoryId": null, "categoryName": null, "description": null, "consoleUrlMask": null, "urlConfiguration": null, "webApiUrlMask": null, "url": null, "productResources": null, "name": "Catalog" }, { "id": null, "categoryId": null, "categoryName": null, "description": null, "consoleUrlMask": null, "urlConfiguration": null, "webApiUrlMask": null, "url": null, "productResources": null, "name": "OMS" } ], "resources": null, "logins": null, "name": "Call center operator" } ], "paging": { "page": 1, "perPage": 1, "total": 1, "pages": 1 } } } } } } } } }, "security": [ { "appKey": [], "appToken": [] } ], "components": { "securitySchemes": { "appKey": { "type": "apiKey", "in": "header", "name": "X-VTEX-API-AppKey" }, "appToken": { "type": "apiKey", "in": "header", "name": "X-VTEX-API-AppToken" } }, "schemas": { "AccountResponse": { "description": "Successful response for `/api/vlm/account`", "type": "object", "properties": { "isActive": { "description": "If account is active or not", "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", "nullable": true, "deprecated": true }, "isOperating": { "description": "If it is in production", "type": "boolean" }, "defaultUrl": { "deprecated": true, "type": "string", "nullable": true }, "district": { "description": "Neighborhood of contact", "type": "string", "nullable": true }, "country": { "description": "Country of contact", "type": "string", "nullable": true }, "complement": { "description": "Additional address of contact", "type": "string", "nullable": true }, "companyName": { "description": "Company name", "type": "string" }, "cnpj": { "description": "CNPJ (Tax ID) of account", "type": "string", "nullable": true }, "haveParentAccount": { "description": "If it has a parent account", "type": "boolean" }, "parentAccountId": { "description": "The ID of the parent account", "type": "string", "nullable": true }, "parentAccountName": { "description": "The name of the parent account", "type": "string", "nullable": true }, "city": { "description": "City of contact", "type": "string", "nullable": true }, "address": { "description": "Address of contact", "type": "string", "nullable": true }, "logo": { "description": "Filename of account logo", "type": "string", "nullable": true }, "hasLogo": { "description": "If logo has been setup", "type": "boolean" }, "number": { "description": "Number of the address of contact", "type": "string", "nullable": true }, "postalCode": { "description": "Zip Code of contact", "type": "string", "nullable": true }, "state": { "description": "State/Province of contact", "type": "string", "nullable": true }, "telephone": { "description": "Telephone of contact", "type": "string" }, "tradingName": { "description": "Trading name", "type": "string" }, "licenses": { "description": "Licenses of the account", "type": "array", "items": { "$ref": "#/components/schemas/LicenseItems" } }, "sponsor": { "description": "Object representing 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", "properties": { "name": { "description": "Name of the contact", "type": "string" }, "email": { "description": "Email of the contact", "type": "string" }, "phone": { "description": "Phone of the contact", "type": "string" } } }, "operationDate": { "description": "The date when the account went into production", "type": "string", "nullable": true, "format": "date-time" }, "inactivationDate": { "description": "The date when the account was deactivated", "type": "string", "nullable": true, "format": "date-time" }, "creationDate": { "description": "The date when the account was created", "type": "string", "format": "date-time" }, "hosts": { "description": "Hosts of all stores", "type": "array", "items": { "type": "string" } }, "sites": { "description": "Array of objects representing a store", "type": "array", "items": { "$ref": "#/components/schemas/SiteItems" } }, "appKey": { "description": "Deprecated. Check appKeys object for all appKeys", "type": "object", "properties": { "token": { "type": "string", "nullable": true, "deprecated": true }, "name": { "type": "string", "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 }, "id": { "description": "ID of the category of the license", "type": "number" }, "isPurchased": { "description": "If the license is purchased", "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": { "type": "array", "items": { "type": "string" }, "deprecated": true }, "endpoints": { "type": "object", "properties": { "webApiUrl": { "type": "string", "nullable": true, "deprecated": true }, "consoleUrl": { "type": "string", "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", "nullable": true, "deprecated": true }, "logo": { "type": "string", "nullable": true, "deprecated": true }, "monetaryUnitId": { "type": "number", "deprecated": true }, "domains": { "type": "array", "items": { "type": "string" }, "nullable": true, "deprecated": true }, "hosts": { "description": "Hosts associated to the store", "type": "array", "items": { "type": "string" } }, "aliases": { "type": "array", "items": { "type": "string" }, "deprecated": true } } }, "AppKeyItems": { "description": "Object representing application keys", "type": "object", "properties": { "id": { "description": "ID of the application key", "type": "string" }, "appKey": { "description": "AppKey (Access Key in the license manager UI)", "type": "string" }, "appToken": { "description": "AppToken. For security reasons, 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": "If the application key is active", "type": "boolean" }, "isBlocked": { "description": "If the application key is blocked", "type": "boolean" } } }, "CreateUserRequest": { "description": "Request body for creating users", "required": ["name", "email"], "type": "object", "properties": { "name": { "description": "Name of the user", "type": "string" }, "email": { "description": "Email of the user", "type": "string" } } }, "CreatenewappkeyRequest": { "description": "Request body for creating new application key (/api/vlm/appkeys)", "required": ["label"], "type": "object", "properties": { "label": { "description": "Label for application key", "type": "string" } } }, "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 application key", "type": "string" }, "appKey": { "description": "AppKey (Access Key in the license manager UI)", "type": "string" }, "appToken": { "description": "Secret of application key", "type": "string" }, "label": { "description": "Label for application key", "type": "string" }, "createdIn": { "description": "Date of creation of application key", "type": "string", "format": "date-time" }, "isActive": { "description": "If the application key is active", "type": "boolean" } } }, "UpdateappkeyRequest": { "description": "Request body for activating/deactivating application keys", "required": ["isActive"], "type": "object", "properties": { "isActive": { "description": "If the application key should be active or inactive", "type": "boolean" } } }, "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 application key", "type": "string" }, "appKey": { "description": "AppKey (Access Key in the license manager UI)", "type": "string" }, "label": { "description": "Label for application key", "type": "string" }, "createdIn": { "description": "Date of creation of application key", "type": "string", "format": "date-time" }, "isActive": { "description": "If the application key is active", "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 representing users", "type": "object", "properties": { "id": { "description": "ID of the user", "type": "string" }, "email": { "description": "Email of the user", "type": "string" }, "isAdmin": { "description": "If user is admin", "type": "boolean" }, "isReliable": { "description": "For internal use only", "type": "boolean" }, "isBlocked": { "description": "If user is blocked", "type": "boolean" }, "roles": { "type": "array", "description": "Array of roles", "items": { "type": "string" }, "maxItems": 0 }, "accountNames": { "type": "array", "description": "Array of account names", "items": { "type": "string" }, "maxItems": 0 }, "name": { "description": "Name of the user", "type": "string" } } }, "RoleItems": { "description": "Object representing roles", "type": "object", "properties": { "id": { "description": "ID of the role", "type": "integer" }, "isAdmin": { "description": "If the role is admin", "type": "boolean" }, "roleType": { "description": "Returns 1 for custom roles, and 0 otherwise", "type": "integer" }, "products": { "type": "array", "description": "Array of product objects", "items": { "$ref": "#/components/schemas/ProductItems" } }, "resources": { "type": "string", "nullable": true, "deprecated": true }, "logins": { "type": "string", "nullable": true, "deprecated": true }, "name": { "description": "Name of the role", "type": "string" } } }, "ProductItems": { "description": "Object representing products", "type": "object", "properties": { "id": { "deprecated": true, "type": "string", "nullable": true }, "categoryId": { "deprecated": true, "type": "string", "nullable": true }, "categoryName": { "deprecated": true, "type": "string", "nullable": true }, "description": { "deprecated": true, "type": "string", "nullable": true }, "consoleUrlMask": { "deprecated": true, "type": "string", "nullable": true }, "urlConfiguration": { "deprecated": true, "type": "string", "nullable": true }, "webApiUrlMask": { "deprecated": true, "type": "string", "nullable": true }, "url": { "deprecated": true, "type": "string", "nullable": true }, "productResources": { "deprecated": true, "type": "string", "nullable": true }, "name": { "description": "Name of the 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" } } } }, "VLMError": { "description": "Object representing VLMError", "type": "object", "properties": { "Detais": { "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" } } } } }, "tags": [ { "name": "User" }, { "name": "App Keys" }, { "name": "Roles" }, { "name": "Store" }, { "name": "Account" } ] }