{
  "opencollection": "1.0.0",
  "info": {
    "name": "Beyond Identity Secure Access Applications Groups API",
    "version": "1.7.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Groups",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Groups for a Realm",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/groups",
            "params": [
              {
                "name": "tenant_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a tenant."
              },
              {
                "name": "realm_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a realm."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Number of items returned per page. The response will include at most this many results but may include fewer. If this value is omitted, the response will return the default number of results allowed by the method.\n"
              },
              {
                "name": "page_token",
                "value": "",
                "type": "query",
                "description": "Token to retrieve the subsequent page of the previous request. All other parameters to the list endpoint should match the original request that provided this token unless otherwise specified.\n"
              },
              {
                "name": "skip",
                "value": "",
                "type": "query",
                "description": "Number of items to skip. This is the zero-based index of the first result.\n"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "To list all groups for a realm, send a GET request to\n`/v1/tenants/$TENANT_ID/realms/$REALM_ID/groups`.\n\nThe response will contain at most 200 items and may contain a page token to\nquery the remaining items. If page size is not specified, the response will\ncontain 20 items. There is no defined ordering of the list of groups in the\nresponse. Note that the maximum and default page sizes are subject to\nchange.\n\nWhen paginating, the page size is maintained by the page token but may be\noverridden on "
        },
        {
          "info": {
            "name": "Create a New Group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/groups",
            "params": [
              {
                "name": "tenant_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a tenant."
              },
              {
                "name": "realm_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a realm."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "To create a group, send a POST request to `/v1/tenants/$TENANT_ID/realms/$REALM_ID/groups`. Values in the request body for read-only fields will be ignored.\n"
        },
        {
          "info": {
            "name": "Retrieve an Existing Group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/groups/:group_id",
            "params": [
              {
                "name": "tenant_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a tenant."
              },
              {
                "name": "realm_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a realm."
              },
              {
                "name": "group_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a group."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "To retrieve an existing group, send a GET request to `/v1/tenants/$TENANT_ID/realms/$REALM_ID/groups/$GROUP_ID`.\n"
        },
        {
          "info": {
            "name": "Patch a Group",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/groups/:group_id",
            "params": [
              {
                "name": "tenant_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a tenant."
              },
              {
                "name": "realm_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a realm."
              },
              {
                "name": "group_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a group."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "To update only specific attributes of an existing group, send a PATCH request to `/v1/tenants/$TENANT_ID/realms/$REALM_ID/groups/$GROUP_ID`. Values in the request body for immutable or read-only fields will be ignored. Fields that are omitted from the request body will be left unchanged.\n"
        },
        {
          "info": {
            "name": "Delete a Group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/groups/:group_id",
            "params": [
              {
                "name": "tenant_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a tenant."
              },
              {
                "name": "realm_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a realm."
              },
              {
                "name": "group_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a group."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "To delete a group, send a DELETE request to `/v1/tenants/$TENANT_ID/realms/$REALM_ID/groups/$GROUP_ID`. To be deleted, a group must not have any members. Any existing members must first be deleted or you will receive a 409 error.\nA successful request will receive a 200 status code with no body in the response. This indicates that the request was processed successfully.\n"
        },
        {
          "info": {
            "name": "Add Members to a Group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/groups/:group_id:addMembers",
            "params": [
              {
                "name": "tenant_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a tenant."
              },
              {
                "name": "realm_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a realm."
              },
              {
                "name": "group_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a group."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "To add members to a group, send a POST request to `/v1/tenants/$TENANT_ID/realms/$REALM_ID/groups/$GROUP_ID:addMembers`. The request must contain at least one and no more than 1000 identity IDs.\n"
        },
        {
          "info": {
            "name": "Delete Members from a Group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/groups/:group_id:deleteMembers",
            "params": [
              {
                "name": "tenant_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a tenant."
              },
              {
                "name": "realm_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a realm."
              },
              {
                "name": "group_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a group."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "To delete members from a group, send a POST request to `/v1/tenants/$TENANT_ID/realms/$REALM_ID/groups/$GROUP_ID:deleteMembers`. The request must contain at least one and no more than 1000 identity IDs.\n"
        },
        {
          "info": {
            "name": "List Members for a Group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/groups/:group_id:listMembers",
            "params": [
              {
                "name": "tenant_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a tenant."
              },
              {
                "name": "realm_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a realm."
              },
              {
                "name": "group_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a group."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Number of items returned per page. The response will include at most this many results but may include fewer. If this value is omitted, the response will return the default number of results allowed by the method.\n"
              },
              {
                "name": "page_token",
                "value": "",
                "type": "query",
                "description": "Token to retrieve the subsequent page of the previous request. All other parameters to the list endpoint should match the original request that provided this token unless otherwise specified.\n"
              },
              {
                "name": "skip",
                "value": "",
                "type": "query",
                "description": "Number of items to skip. This is the zero-based index of the first result.\n"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "To list members belonging to a group, send a GET request to\n`/v1/tenants/$TENANT_ID/realms/$REALM_ID/groups/$GROUP_ID:listMembers`.\n\nThe response will contain at most 200 items and may contain a page token to\nquery the remaining items. If page size is not specified, the response will\ncontain 20 items. There is no defined ordering of the list of members in the\nresponse. Note that the maximum and default page sizes are subject to\nchange.\n\nWhen paginating, the page size is maintained by the page to"
        },
        {
          "info": {
            "name": "List Role Memberships for a Group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/groups/:group_id:listRoles",
            "params": [
              {
                "name": "tenant_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a tenant."
              },
              {
                "name": "realm_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a realm."
              },
              {
                "name": "group_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a group."
              },
              {
                "name": "resource_server_id",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the resource server used to filter roles."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Number of items returned per page. The response will include at most this many results but may include fewer. If this value is omitted, the response will return the default number of results allowed by the method.\n"
              },
              {
                "name": "page_token",
                "value": "",
                "type": "query",
                "description": "Token to retrieve the subsequent page of the previous request. All other parameters to the list endpoint should match the original request that provided this token unless otherwise specified.\n"
              },
              {
                "name": "skip",
                "value": "",
                "type": "query",
                "description": "Number of items to skip. This is the zero-based index of the first result.\n"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "To list the roles to which a group is assigned, send a GET request to\n`/v1/tenants/$TENANT_ID/realms/$REALM_ID/groups/$GROUP_ID:listRoles`.\n\nThe request must include the `resource_server_id` query parameter specifying\nthe resource server on which to filter the roles. If the specified resource\nserver does not exist, you will receive a 409 error.\n\nThe response will contain at most 200 items and may contain a page token to\nquery the remaining items. If page size is not specified, the response will\n"
        }
      ]
    }
  ],
  "bundled": true
}