{
  "opencollection": "1.0.0",
  "info": {
    "name": "Atlassian Admin Account Restrictions API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Restrictions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Atlassian List Branch Restrictions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/branch-restrictions",
            "params": [
              {
                "name": "repo_slug",
                "value": "",
                "type": "path",
                "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n"
              },
              {
                "name": "workspace",
                "value": "",
                "type": "path",
                "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n"
              },
              {
                "name": "kind",
                "value": "",
                "type": "query",
                "description": "Branch restrictions of this type"
              },
              {
                "name": "pattern",
                "value": "",
                "type": "query",
                "description": "Branch restrictions applied to branches of this pattern"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://auth.atlassian.com/authorize",
              "accessTokenUrl": "https://auth.atlassian.com/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "This operation retrieves all branch restrictions configured for a specific repository within a Bitbucket workspace. Branch restrictions are rules that control who can push to branches, require pull requests, enforce merge checks, or limit branch deletions. By sending a GET request to this endpoint with the workspace ID and repository slug, you receive a paginated list of all active restrictions including their types, patterns (which branches they apply to), and associated users or groups. This i"
        },
        {
          "info": {
            "name": "Atlassian Get Restrictions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the content to be queried for its restrictions."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "A multi-value parameter indicating which properties of the content\nrestrictions to expand. By default, the following objects are expanded:\n`restrictions.user`, `restrictions.group`.\n\n- `restrictions.user` returns the piece of content that the restrictions are\napplied to.\n- `restrictions.group` returns the piece of content that the restrictions are\napplied to.\n- `content` returns the piece of content that the restrictions are\napplied to."
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "The starting index of the users and groups in the returned restrictions."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of users and the maximum number of groups, in the\nreturned restrictions, to return per page. Note, this may be restricted\nby fixed system limits."
              }
            ]
          },
          "docs": "This API operation retrieves the restrictions applied to a specific piece of Confluence content identified by its ID. When called, it returns information about who can view or edit the content, including any user or group-based access controls that have been configured. The restrictions help enforce content security by limiting which users or groups have permission to interact with pages, blog posts, or other content types within a Confluence space. The response typically includes details about "
        },
        {
          "info": {
            "name": "Atlassian Add Restrictions",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the content to add restrictions to."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "A multi-value parameter indicating which properties of the content\nrestrictions (returned in response) to expand.\n\n- `restrictions.user` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `restrictions.group` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `content` returns the piece of content that the restrictions are\napplied to."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "The Add Restrictions operation in the Atlassian Confluence Content API allows you to apply access controls to a specific piece of content by sending a POST request to /wiki/rest/api/content/{id}/restriction, where {id} represents the unique identifier of the content you want to restrict. This endpoint enables administrators and authorized users to define who can view or edit the content by specifying user accounts, groups, or both in the request payload. The restrictions can be applied at differ"
        },
        {
          "info": {
            "name": "Atlassian Update Restrictions",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the content to update restrictions for."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "A multi-value parameter indicating which properties of the content\nrestrictions (returned in response) to expand.\n\n- `restrictions.user` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `restrictions.group` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `content` returns the piece of content that the restrictions are\napplied to."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates restrictions for a piece of Confluence content identified by the content ID. This operation allows you to modify who can view or edit the content by setting user and group permissions. The request requires the content ID in the URL path and a JSON payload containing the restriction details, including operation type (read or update), restrictions by user or group, and can completely replace existing restrictions. You must have appropriate permissions to modify restrictions on the content,"
        },
        {
          "info": {
            "name": "Atlassian Delete Restrictions",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the content to remove restrictions from."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "A multi-value parameter indicating which properties of the content\nrestrictions (returned in response) to expand.\n\n- `restrictions.user` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `restrictions.group` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `content` returns the piece of content that the restrictions are\napplied to."
              }
            ]
          },
          "docs": "Removes content restrictions from a specific piece of Confluence content identified by its ID. This operation deletes all restriction settings that control who can view or edit the content, effectively making it accessible according to the space's default permissions. When executed successfully, any user or group-based restrictions previously applied to the content are removed, and the content inherits the broader permission scheme of its parent space. This is useful when you need to open up pre"
        },
        {
          "info": {
            "name": "Atlassian Get Restrictions by Operation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the content to be queried for its restrictions."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "A multi-value parameter indicating which properties of the content\nrestrictions to expand.\n\n- `restrictions.user` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `restrictions.group` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `content` returns the piece of content that the restrictions are\napplied to."
              }
            ]
          },
          "docs": "This API operation retrieves content restrictions for a specific Confluence page or blog post, organized by operation type (such as read or update). By providing the content ID in the path parameter, you can fetch all restriction details that determine which users or groups have permission to perform specific operations on that content. The response returns restrictions grouped by operation, making it easy to understand the access control rules applied to the content and identify who can view, e"
        },
        {
          "info": {
            "name": "Atlassian Get Restrictions for Operation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation/:operationKey",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the content to be queried for its restrictions."
              },
              {
                "name": "operationKey",
                "value": "",
                "type": "path",
                "description": "The operation type of the restrictions to be returned."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "A multi-value parameter indicating which properties of the content\nrestrictions to expand.\n\n- `restrictions.user` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `restrictions.group` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `content` returns the piece of content that the restrictions are\napplied to."
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "The starting index of the users and groups in the returned restrictions."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of users and the maximum number of groups, in the\nreturned restrictions, to return per page. Note, this may be restricted\nby fixed system limits."
              }
            ]
          },
          "docs": "This API endpoint retrieves content restrictions that have been applied to a specific Confluence page or blog post for a particular operation type. By providing the content ID and an operation key (such as 'read' or 'update'), you can fetch details about which users or groups have restricted access to perform that operation on the content. The response includes information about the restrictions in place, helping administrators and developers understand and manage access controls for Confluence "
        },
        {
          "info": {
            "name": "Atlassian Get Content Restriction Status for Group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/group/:groupName",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the content that the restriction applies to."
              },
              {
                "name": "operationKey",
                "value": "",
                "type": "path",
                "description": "The operation that the restriction applies to."
              },
              {
                "name": "groupName",
                "value": "",
                "type": "path",
                "description": "The name of the group to be queried for whether the content restriction\napplies to it."
              }
            ]
          },
          "docs": "The Atlassian Confluence Content API endpoint `/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}` using the GET method retrieves the restriction status for a specific group on a particular piece of content. This operation allows administrators and authorized users to check whether a designated group has restrictions applied for a specific operation (such as read or update) on content identified by its unique ID. The endpoint requires three path parameters: the "
        },
        {
          "info": {
            "name": "Atlassian Add Group to Content Restriction",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/group/:groupName",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the content that the restriction applies to."
              },
              {
                "name": "operationKey",
                "value": "",
                "type": "path",
                "description": "The operation that the restriction applies to."
              },
              {
                "name": "groupName",
                "value": "",
                "type": "path",
                "description": "The name of the group to add to the content restriction."
              }
            ]
          },
          "docs": "The PUT operation on the Atlassian Confluence Content API endpoint `/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}` adds a specified group to an existing content restriction for a particular operation type. This allows administrators to grant a group access to perform specific operations (such as read, update, or delete) on restricted Confluence content by including the group in the restriction's allowed list. The endpoint requires three path parameters: the"
        },
        {
          "info": {
            "name": "Atlassian Remove Group From Content Restriction",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/group/:groupName",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the content that the restriction applies to."
              },
              {
                "name": "operationKey",
                "value": "",
                "type": "path",
                "description": "The operation that the restriction applies to."
              },
              {
                "name": "groupName",
                "value": "",
                "type": "path",
                "description": "The name of the group to remove from the content restriction."
              }
            ]
          },
          "docs": "This API operation removes a specific group from content restrictions for a given operation on a Confluence page or blog post. By sending a DELETE request to this endpoint with the content ID, operation key (such as 'read' or 'update'), and group name, administrators can revoke the specified group's access permissions for that particular operation on the content. This is useful for managing granular access control when you need to remove a group's ability to perform specific actions on restricte"
        },
        {
          "info": {
            "name": "Atlassian Get Content Restriction Status for Group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/byGroupId/:groupId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the content that the restriction applies to."
              },
              {
                "name": "operationKey",
                "value": "",
                "type": "path",
                "description": "The operation that the restriction applies to."
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "The id of the group to be queried for whether the content restriction\napplies to it."
              }
            ]
          },
          "docs": "This API endpoint retrieves the restriction status for a specific group on a piece of Confluence content. It requires three path parameters: the content ID, an operation key (typically 'read' or 'update'), and a group ID. When called, it returns information about whether the specified group has restrictions applied for the given operation on that content, helping administrators and developers understand access control configurations. This is useful for auditing permissions, validating security p"
        },
        {
          "info": {
            "name": "Atlassian Add Group to Content Restriction",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/byGroupId/:groupId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the content that the restriction applies to."
              },
              {
                "name": "operationKey",
                "value": "",
                "type": "path",
                "description": "The operation that the restriction applies to."
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "The groupId of the group to add to the content restriction."
              }
            ]
          },
          "docs": "This PUT operation adds a specified group to content restrictions for a particular operation on a Confluence page or blog post. The endpoint requires three path parameters: the content ID, an operation key (such as 'read' or 'update'), and the group ID to be added to the restriction. When executed, it grants the specified group permission to perform the designated operation on the content, effectively managing fine-grained access control at the group level. This is useful for administrators who "
        },
        {
          "info": {
            "name": "Atlassian Remove Group From Content Restriction",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/byGroupId/:groupId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the content that the restriction applies to."
              },
              {
                "name": "operationKey",
                "value": "",
                "type": "path",
                "description": "The operation that the restriction applies to."
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "The id of the group to remove from the content restriction."
              }
            ]
          },
          "docs": "This API operation removes a specific group from content restrictions in Atlassian Confluence by deleting the association between a group and an operation-based restriction on a particular piece of content. It requires three path parameters: the content ID identifying the restricted content, the operationKey specifying the type of operation (such as read or update), and the groupId representing the group to be removed from the restriction. When executed successfully, this DELETE request revokes "
        },
        {
          "info": {
            "name": "Atlassian Get Content Restriction Status for User",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/user",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the content that the restriction applies to."
              },
              {
                "name": "operationKey",
                "value": "",
                "type": "path",
                "description": "The operation that is restricted."
              },
              {
                "name": "key",
                "value": "",
                "type": "query",
                "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."
              },
              {
                "name": "username",
                "value": "",
                "type": "query",
                "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."
              },
              {
                "name": "accountId",
                "value": "",
                "type": "query",
                "description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`."
              }
            ]
          },
          "docs": "Retrieves the restriction status for a specific user on a piece of Confluence content based on a given operation key. This endpoint allows you to check whether a particular user has access to perform a specific operation (such as read, update, or delete) on content identified by its ID. The operation key parameter specifies which type of operation restriction to check, while the request targets a specific user to determine if content restrictions apply to them. This is useful for administrators "
        },
        {
          "info": {
            "name": "Atlassian Add User to Content Restriction",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/user",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the content that the restriction applies to."
              },
              {
                "name": "operationKey",
                "value": "",
                "type": "path",
                "description": "The operation that the restriction applies to."
              },
              {
                "name": "key",
                "value": "",
                "type": "query",
                "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."
              },
              {
                "name": "username",
                "value": "",
                "type": "query",
                "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."
              },
              {
                "name": "accountId",
                "value": "",
                "type": "query",
                "description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`."
              }
            ]
          },
          "docs": "Updates content restrictions by adding a user to a specific operation-based restriction on a Confluence content item. This endpoint allows administrators to grant a particular user permission to perform a specified operation (such as 'read' or 'update') on restricted content by adding them to the allowlist for that operation. The request requires the content ID, the operation key (the type of restriction being modified), and the user details to be added. This is useful for managing granular acce"
        },
        {
          "info": {
            "name": "Atlassian Remove User From Content Restriction",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/user",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the content that the restriction applies to."
              },
              {
                "name": "operationKey",
                "value": "",
                "type": "path",
                "description": "The operation that the restriction applies to."
              },
              {
                "name": "key",
                "value": "",
                "type": "query",
                "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."
              },
              {
                "name": "username",
                "value": "",
                "type": "query",
                "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."
              },
              {
                "name": "accountId",
                "value": "",
                "type": "query",
                "description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`."
              }
            ]
          },
          "docs": "This API operation removes a specific user from content restrictions for a given operation type in Atlassian Confluence. By making a DELETE request to the endpoint with the content ID, operation key (such as 'read' or 'update'), and user account ID as parameters, administrators can revoke previously granted or denied permissions for that user on the specified content. This is useful for managing access control when a user's permissions need to be changed or when cleaning up outdated restrictions"
        }
      ]
    }
  ],
  "bundled": true
}