{
  "opencollection": "1.0.0",
  "info": {
    "name": "VTex Anti-fraud Provider Account Roles API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Roles",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "VTex Get roles by user or appKey",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/license-manager/users/:userId/roles",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "ID of the user."
              }
            ]
          },
          "docs": "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 recei"
        },
        {
          "info": {
            "name": "VTex Add roles to user or appKey",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{providerApiEndpoint}/api/license-manager/users/:userId/roles",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "ID of the user."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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 a"
        },
        {
          "info": {
            "name": "VTex Remove role from user or appKey",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{providerApiEndpoint}/api/license-manager/users/:userId/roles/:roleId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "ID of the user."
              },
              {
                "name": "roleId",
                "value": "",
                "type": "path",
                "description": "ID of the role which will be removed from the user."
              }
            ]
          },
          "docs": "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 e"
        },
        {
          "info": {
            "name": "VTex Get list of roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/license-manager/site/pvt/roles/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 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/e"
        }
      ]
    }
  ],
  "bundled": true
}