{
  "opencollection": "1.0.0",
  "info": {
    "name": "Auth0 Authentication actions roles API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "roles",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/roles",
            "params": [
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of results per page. Defaults to 50."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page index of the results to return. First page is 0."
              },
              {
                "name": "include_totals",
                "value": "",
                "type": "query",
                "description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
              },
              {
                "name": "name_filter",
                "value": "",
                "type": "query",
                "description": "Optional filter on name (case-insensitive)."
              }
            ]
          },
          "docs": "Retrieve detailed list of user roles created in your tenant.\n\n<b>Note</b>: The returned list does not include standard roles available for tenant members, such as Admin or Support Access.\n"
        },
        {
          "info": {
            "name": "Create a Role",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{auth0_domain}/roles",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a user role for <a href=\"https://auth0.com/docs/manage-users/access-control/rbac\">Role-Based Access Control</a>.\n\n<b>Note</b>: New roles are not associated with any permissions by default. To assign existing permissions to your role, review Associate Permissions with a Role. To create new permissions, review Add API Permissions.\n"
        },
        {
          "info": {
            "name": "Get a Role",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/roles/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the role to retrieve."
              }
            ]
          },
          "docs": "Retrieve details about a specific <a href=\"https://auth0.com/docs/manage-users/access-control/rbac\">user role</a> specified by ID.\n"
        },
        {
          "info": {
            "name": "Update a Role",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{auth0_domain}/roles/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the role to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modify the details of a specific <a href=\"https://auth0.com/docs/manage-users/access-control/rbac\">user role</a> specified by ID.\n"
        },
        {
          "info": {
            "name": "Delete a Role",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{auth0_domain}/roles/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the role to delete."
              }
            ]
          },
          "docs": "Delete a specific <a href=\"https://auth0.com/docs/manage-users/access-control/rbac\">user role</a> from your tenant. Once deleted, it is removed from any user who was previously assigned that role. This action cannot be undone.\n"
        },
        {
          "info": {
            "name": "Get Permissions Granted by Role",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/roles/:id/permissions",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the role to list granted permissions."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of results per page. Defaults to 50."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page index of the results to return. First page is 0."
              },
              {
                "name": "include_totals",
                "value": "",
                "type": "query",
                "description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
              }
            ]
          },
          "docs": "Retrieve detailed list (name, description, resource server) of permissions granted by a specified user role.\n"
        },
        {
          "info": {
            "name": "Associate Permissions with a Role",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{auth0_domain}/roles/:id/permissions",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the role to add permissions to."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add one or more <a href=\"https://auth0.com/docs/manage-users/access-control/configure-core-rbac/manage-permissions\">permissions</a> to a specified user role.\n"
        },
        {
          "info": {
            "name": "Remove Permissions from a Role",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{auth0_domain}/roles/:id/permissions",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the role to remove permissions from."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Remove one or more <a href=\"https://auth0.com/docs/manage-users/access-control/configure-core-rbac/manage-permissions\">permissions</a> from a specified user role.\n"
        },
        {
          "info": {
            "name": "Get a Role's Users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/roles/:id/users",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the role to retrieve a list of users associated with."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of results per page. Defaults to 50."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page index of the results to return. First page is 0."
              },
              {
                "name": "include_totals",
                "value": "",
                "type": "query",
                "description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Optional Id from which to start selection."
              },
              {
                "name": "take",
                "value": "",
                "type": "query",
                "description": "Number of results per page. Defaults to 50."
              }
            ]
          },
          "docs": "Retrieve list of users associated with a specific role. For Dashboard instructions, review <a href=\"https://auth0.com/docs/manage-users/access-control/configure-core-rbac/roles/view-users-assigned-to-roles\">View Users Assigned to Roles</a>.\n\nThis endpoint supports two types of pagination:\n<ul>\n<li>Offset pagination</li>\n<li>Checkpoint pagination</li>\n</ul>\n\nCheckpoint pagination must be used if you need to retrieve more than 1000 organization members.\n\n<h2>Checkpoint Pagination</h2>\n\nTo search b"
        },
        {
          "info": {
            "name": "Assign Users to a Role",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{auth0_domain}/roles/:id/users",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the role to assign users to."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Assign one or more users to an existing user role. To learn more, review <a href=\"https://auth0.com/docs/manage-users/access-control/rbac\">Role-Based Access Control</a>.\n\n<b>Note</b>: New roles cannot be created through this action.\n"
        }
      ]
    }
  ],
  "bundled": true
}