{
  "opencollection": "1.0.0",
  "info": {
    "name": "Secret Server Rest Activations Roles API",
    "version": "11.7.2"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Roles",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Role",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/roles/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "id"
              }
            ]
          },
          "docs": "Get Role by Role ID"
        },
        {
          "info": {
            "name": "Update Role",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/SecretServer/api/v1/roles/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Role ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a single Role by ID"
        },
        {
          "info": {
            "name": "Search Roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/roles",
            "params": [
              {
                "name": "filter.groupId",
                "value": "",
                "type": "query",
                "description": "Only return roles assigned to this group id.  Will be ignored if UserId is set"
              },
              {
                "name": "filter.includeInactive",
                "value": "",
                "type": "query",
                "description": "Whether to include inactive Roles in the results"
              },
              {
                "name": "filter.userId",
                "value": "",
                "type": "query",
                "description": "Only return roles assigned to this user id.  Will supercede GroupId if set"
              },
              {
                "name": "skip",
                "value": "",
                "type": "query",
                "description": "Number of records to skip before taking results"
              },
              {
                "name": "sortBy[0].direction",
                "value": "",
                "type": "query",
                "description": "Sort direction"
              },
              {
                "name": "sortBy[0].name",
                "value": "",
                "type": "query",
                "description": "Sort field name"
              },
              {
                "name": "sortBy[0].priority",
                "value": "",
                "type": "query",
                "description": "Priority index. Sorts with lower values are executed earlier"
              },
              {
                "name": "take",
                "value": "",
                "type": "query",
                "description": "Maximum number of records to include in results"
              }
            ]
          },
          "docs": "Search, filter, sort, and page Roles"
        },
        {
          "info": {
            "name": "Create Role",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/SecretServer/api/v1/roles",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new Role"
        },
        {
          "info": {
            "name": "Get Role Groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/roles/:id/groups",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "id"
              },
              {
                "name": "filter.includeInactiveUsersForGroup",
                "value": "",
                "type": "query",
                "description": "Whether to include inactive users in the results"
              },
              {
                "name": "filter.userDomainId",
                "value": "",
                "type": "query",
                "description": "Filter only users in a specific domain"
              },
              {
                "name": "skip",
                "value": "",
                "type": "query",
                "description": "Number of records to skip before taking results"
              },
              {
                "name": "sortBy[0].direction",
                "value": "",
                "type": "query",
                "description": "Sort direction"
              },
              {
                "name": "sortBy[0].name",
                "value": "",
                "type": "query",
                "description": "Sort field name"
              },
              {
                "name": "sortBy[0].priority",
                "value": "",
                "type": "query",
                "description": "Priority index. Sorts with lower values are executed earlier"
              },
              {
                "name": "take",
                "value": "",
                "type": "query",
                "description": "Maximum number of records to include in results"
              }
            ]
          },
          "docs": "Get assigned Groups by RoleId"
        },
        {
          "info": {
            "name": "Get Assigned Role Permissions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/roles/:id/permissions",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "id"
              },
              {
                "name": "skip",
                "value": "",
                "type": "query",
                "description": "Number of records to skip before taking results"
              },
              {
                "name": "sortBy[0].direction",
                "value": "",
                "type": "query",
                "description": "Sort direction"
              },
              {
                "name": "sortBy[0].name",
                "value": "",
                "type": "query",
                "description": "Sort field name"
              },
              {
                "name": "sortBy[0].priority",
                "value": "",
                "type": "query",
                "description": "Priority index. Sorts with lower values are executed earlier"
              },
              {
                "name": "take",
                "value": "",
                "type": "query",
                "description": "Maximum number of records to include in results"
              }
            ]
          },
          "docs": "Get Permissions assigned to a single Role by Role ID"
        },
        {
          "info": {
            "name": "Update Role Permission Assignments",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/SecretServer/api/v1/roles/:id/permissions",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update all Permissions assigned to Role"
        },
        {
          "info": {
            "name": "Get Unassigned Role Permissions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/roles/:id/permissions/unassigned",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "id"
              },
              {
                "name": "skip",
                "value": "",
                "type": "query",
                "description": "Number of records to skip before taking results"
              },
              {
                "name": "sortBy[0].direction",
                "value": "",
                "type": "query",
                "description": "Sort direction"
              },
              {
                "name": "sortBy[0].name",
                "value": "",
                "type": "query",
                "description": "Sort field name"
              },
              {
                "name": "sortBy[0].priority",
                "value": "",
                "type": "query",
                "description": "Priority index. Sorts with lower values are executed earlier"
              },
              {
                "name": "take",
                "value": "",
                "type": "query",
                "description": "Maximum number of records to include in results"
              }
            ]
          },
          "docs": "Get unassigned Role Permissions matching the type of a specific Role by Role ID"
        },
        {
          "info": {
            "name": "Get Role Stub",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/roles/stub"
          },
          "docs": "Return the default values for a new Role"
        },
        {
          "info": {
            "name": "Patch Role Group Assignments",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/SecretServer/api/v1/roles/:roleId/groups",
            "params": [
              {
                "name": "roleId",
                "value": "",
                "type": "path",
                "description": "Role ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update Groups assigned to a Role by sending list(s) of Group IDs to add/remove"
        }
      ]
    }
  ],
  "bundled": true
}