{ "opencollection": "1.0.0", "info": { "name": "VTex Anti-fraud Provider Account Users API", "version": "1.0" }, "items": [ { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "VTex Get user", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/license-manager/users/:userId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "ID from queried user." } ] }, "docs": "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 res" }, { "info": { "name": "VTex Delete user", "type": "http" }, "http": { "method": "DELETE", "url": "https://{providerApiEndpoint}/api/license-manager/users/:userId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "ID from queried user." } ] }, "docs": "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 " }, { "info": { "name": "VTex Create user", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/license-manager/users", "body": { "type": "json", "data": "{}" } }, "docs": "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 succ" }, { "info": { "name": "VTex Get list of users", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/license-manager/site/pvt/logins/list/paged", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "numItems", "value": "", "type": "query", "description": "Number of items in the returned page." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Which page from the whole list will be returned." }, { "name": "sort", "value": "", "type": "query", "description": "Chooses the field that the list will be sorted by." }, { "name": "sortType", "value": "", "type": "query", "description": "Defines the sorting order. `ASC` is used for ascendant order. `DSC` is used for descendant order." } ] }, "docs": "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" } ] } ], "bundled": true }