{
  "opencollection": "1.0.0",
  "info": {
    "name": "Openpath API Documentation auth orgs/roles API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "orgs/roles",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/orgs/:orgId/roles",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query"
              },
              {
                "name": "order",
                "value": "",
                "type": "query"
              },
              {
                "name": "q",
                "value": "",
                "type": "query"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query"
              },
              {
                "name": "preFilter",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o{params.orgId}-user:r,o{params.orgId}-role:w,o{params.orgId}-role:r,o{params.orgId}-rpt:r,o{params.orgId}-rpt:w,o:w,o:r,s-o:w,s-o:r,o-user:r,o-user:w,o-role:r,o-role:w<br/><br/>__Endpoint name__: listRoles"
        },
        {
          "info": {
            "name": "Create a role",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/orgs/:orgId/roles",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o:w,s-o:w,o-role:w<br/><br/>__Endpoint name__: createRole"
        },
        {
          "info": {
            "name": "Describe a role",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/orgs/:orgId/roles/:roleId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "roleId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o{params.orgId}-role:r,o:w,o:r,s-o:w,s-o:r,o-role:r,o-role:w<br/><br/>__Endpoint name__: describeRole"
        },
        {
          "info": {
            "name": "Update a role",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/orgs/:orgId/roles/:roleId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "roleId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o:w,s-o:w,o-role:w<br/><br/>__Endpoint name__: updateRole"
        },
        {
          "info": {
            "name": "Delete a role",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/orgs/:orgId/roles/:roleId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "roleId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o:w,s-o:w,o-role:w<br/><br/>__Endpoint name__: deleteRole"
        },
        {
          "info": {
            "name": "List all users of a role",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/orgs/:orgId/roles/:roleId/users",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "roleId",
                "value": "",
                "type": "path"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query"
              },
              {
                "name": "order",
                "value": "",
                "type": "query"
              },
              {
                "name": "q",
                "value": "",
                "type": "query"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query"
              },
              {
                "name": "preFilter",
                "value": "",
                "type": "query"
              },
              {
                "name": "options",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o{params.orgId}-role:r,o:w,o:r,s-o:w,s-o:r,o-role:r,o-role:w<br/><br/>__Endpoint name__: listRoleUsers"
        },
        {
          "info": {
            "name": "List all scope ids of a role",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/orgs/:orgId/roles/:roleId/scopeIds",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "roleId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o{params.orgId}-role:r,o:w,o:r,s-o:w,s-o:r,o-role:r,o-role:w<br/><br/>__Endpoint name__: listRoleScopeIds"
        },
        {
          "info": {
            "name": "Set a role's scopes by replacing the entire set with this one",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/orgs/:orgId/roles/:roleId/scopeIds",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "roleId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o:w,s-o:w<br/><br/>__Endpoint name__: setRoleScopeIds"
        },
        {
          "info": {
            "name": "Add a user to a role",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/orgs/:orgId/roles/:roleId/users/:userId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "roleId",
                "value": "",
                "type": "path"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o:w,s-o:w,o-role:w<br/><br/>__Endpoint name__: setUserToRole"
        },
        {
          "info": {
            "name": "Remove a user from a role",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/orgs/:orgId/roles/:roleId/users/:userId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "roleId",
                "value": "",
                "type": "path"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o:w,s-o:w,o-role:w<br/><br/>__Endpoint name__: removeUserFromRole"
        },
        {
          "info": {
            "name": "Set a role's users by replacing the entire set with this one",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/orgs/:orgId/roles/:roleId/userIds",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "roleId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o:w,s-o:w,o-role:w<br/><br/>__Endpoint name__: setRoleUserIds"
        },
        {
          "info": {
            "name": "Bulk-update a role's users",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/orgs/:orgId/roles/:roleId/userIds",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "roleId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o:w,s-o:w,o-role:w<br/><br/>__Endpoint name__: updateRoleUserIds"
        },
        {
          "info": {
            "name": "Set a role's sites by replacing the entire set with this one",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/orgs/:orgId/roles/:roleId/siteIds",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "roleId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o:w,s-o:w,o-role:w<br/><br/>__Endpoint name__: setRoleSiteIds"
        }
      ]
    }
  ],
  "bundled": true
}