{
  "opencollection": "1.0.0",
  "info": {
    "name": "Secret Server Rest Activations Groups API",
    "version": "11.7.2"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Groups",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/groups/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Group ID"
              }
            ]
          },
          "docs": "Get a single group by ID"
        },
        {
          "info": {
            "name": "Update Group",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/SecretServer/api/v1/groups/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Group ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a single group by ID"
        },
        {
          "info": {
            "name": "Delete Group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/SecretServer/api/v1/groups/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Group ID"
              }
            ]
          },
          "docs": "Delete a group by ID"
        },
        {
          "info": {
            "name": "Get User In Group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/groups/:id/users/:userId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Group ID"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "User ID"
              }
            ]
          },
          "docs": "Get a user in a group"
        },
        {
          "info": {
            "name": "Remove User From Group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/SecretServer/api/v1/groups/:id/users/:userId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Group ID"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "User ID"
              }
            ]
          },
          "docs": "Remove a user from a group"
        },
        {
          "info": {
            "name": "Gets roles for group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/groups/:id/roles",
            "params": [
              {
                "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"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "id"
              }
            ]
          },
          "docs": "Gets roles for group"
        },
        {
          "info": {
            "name": "Add roles to existing group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/SecretServer/api/v1/groups/:id/roles",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add roles to existing group"
        },
        {
          "info": {
            "name": "Remove roles from existing group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/SecretServer/api/v1/groups/:id/roles",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Remove roles from existing group"
        },
        {
          "info": {
            "name": "Search Groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/groups",
            "params": [
              {
                "name": "filter.domainId",
                "value": "",
                "type": "query",
                "description": "Active Directory domain ID"
              },
              {
                "name": "filter.excludeInboxRuleIdSubscribers",
                "value": "",
                "type": "query",
                "description": "Do not include any groups already subscribed this inbox notification rule"
              },
              {
                "name": "filter.includeInactive",
                "value": "",
                "type": "query",
                "description": "Whether to include inactive groups in the results"
              },
              {
                "name": "filter.limitToViewableGroups",
                "value": "",
                "type": "query",
                "description": "Limit groups to groups that current user can view details of"
              },
              {
                "name": "filter.platformOnly",
                "value": "",
                "type": "query",
                "description": "Limit groups to only Platform groups"
              },
              {
                "name": "filter.searchText",
                "value": "",
                "type": "query",
                "description": "Search text"
              },
              {
                "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 groups"
        },
        {
          "info": {
            "name": "Create Group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/SecretServer/api/v1/groups",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new group"
        },
        {
          "info": {
            "name": "Lookup Groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/groups/lookup",
            "params": [
              {
                "name": "filter.domainId",
                "value": "",
                "type": "query",
                "description": "Active Directory domain ID"
              },
              {
                "name": "filter.excludeInboxRuleIdSubscribers",
                "value": "",
                "type": "query",
                "description": "Do not include any groups already subscribed this inbox notification rule"
              },
              {
                "name": "filter.includeInactive",
                "value": "",
                "type": "query",
                "description": "Whether to include inactive groups in the results"
              },
              {
                "name": "filter.limitToViewableGroups",
                "value": "",
                "type": "query",
                "description": "Limit groups to groups that current user can view details of"
              },
              {
                "name": "filter.platformOnly",
                "value": "",
                "type": "query",
                "description": "Limit groups to only Platform groups"
              },
              {
                "name": "filter.searchText",
                "value": "",
                "type": "query",
                "description": "Search text"
              },
              {
                "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 groups, returning only group ID and name"
        },
        {
          "info": {
            "name": "Get Group Stub",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/groups/stub"
          },
          "docs": "Return the default values for a new group"
        },
        {
          "info": {
            "name": "Get Group Membership",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/groups/:id/users",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Group 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 group membership will return all of the users that are assigned as members of the group"
        },
        {
          "info": {
            "name": "Add User To Group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/SecretServer/api/v1/groups/:id/users",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Group ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add a user to a group"
        },
        {
          "info": {
            "name": "Patch Group Membership",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/SecretServer/api/v1/groups/:id/users",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Group ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update group memberships by sending a list of add and remove IDs"
        },
        {
          "info": {
            "name": "Get group audits",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/groups/audit",
            "params": [
              {
                "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": "Audit records for group assignments"
        },
        {
          "info": {
            "name": "Get Group Users for display",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/groups/:id/users-lookup",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Group ID"
              }
            ]
          },
          "docs": "Get Group Users for display by group id"
        },
        {
          "info": {
            "name": "Group members search",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/groups/:id/users/search",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Group ID"
              },
              {
                "name": "filter.assigned",
                "value": "",
                "type": "query",
                "description": "Include or exclude Users assigned to the specified Group; include both assigned and unassigned if null."
              },
              {
                "name": "filter.domainId",
                "value": "",
                "type": "query",
                "description": "Include only Users in this domain. Pass -1 to return local accounts.  Null or empty will not filter by domain."
              },
              {
                "name": "filter.groupId",
                "value": "",
                "type": "query",
                "description": "Include/exclude members of this Group depending on the value of the Assigned parameter."
              },
              {
                "name": "filter.searchTerm",
                "value": "",
                "type": "query",
                "description": "Include only Users whose display name contains the search term."
              },
              {
                "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": "Group members search will return all of the users that are assigned and/or unassigned as members of the group."
        },
        {
          "info": {
            "name": "Get Group by domain identifier",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/groups/platform/:adGuid",
            "params": [
              {
                "name": "adGuid",
                "value": "",
                "type": "path",
                "description": "Group ID"
              }
            ]
          },
          "docs": "Get a single group by AD Guid"
        },
        {
          "info": {
            "name": "Patch Group",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/SecretServer/api/v1/groups/:groupId",
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "Group ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Patch a single group by ID"
        },
        {
          "info": {
            "name": "Update all roles on group",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/SecretServer/api/v2/groups/:id/roles",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update all roles on group"
        },
        {
          "info": {
            "name": "Update all members of a group",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/SecretServer/api/v1/groups/:groupId/users",
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "groupId"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update all members of a group"
        }
      ]
    }
  ],
  "bundled": true
}