{
"opencollection": "1.0.0",
"info": {
"name": "Atlassian Admin Account Content Restrictions API",
"version": "1.0.0"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "Content Restrictions",
"type": "folder"
},
"items": [
{
"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": "Returns the restrictions on a piece of content.
**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the content."
},
{
"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": "Adds restrictions to a piece of content. Note, this does not change any
existing restrictions on the content.
**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to edit the content."
},
{
"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 content. For each operation specified in the request, it removes
any existing restrictions on the content for that operation, and replaces them with the restrictions in the request.
Note: Not specifying an operation will ignore restrictions of that type, and passing an empty list for an operation
will remove all existing restrictions of that type.
**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to edit the c"
},
{
"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 all restrictions (read and update) on a piece of content.
**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to edit the content."
},
{
"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": "Returns restrictions on a piece of content by operation. This method is
similar to [Get restrictions](#api-content-id-restriction-get) except that
the operations are properties of the return object, rather than items in
a results array.
**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the content."
},
{
"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": "Returns the restictions on a piece of content for a given operation (read
or update).
**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the content."
},
{
"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": "Deprecated, use [Get content restriction status for group via groupId](https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-restrictions/#api-wiki-rest-api-content-id-restriction-byoperation-operationkey-bygroupid-groupid-get).
Returns whether the specified content restriction applies to a group.
For example, if a page with `id=123` has a `read` restriction for the `admins` group,
the following request will return `true`:
`/wiki/rest/api/content/123/restrict"
},
{
"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": "Deprecated, use [Add group to content restriction via groupId](https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-restrictions/#api-wiki-rest-api-content-id-restriction-byoperation-operationkey-bygroupid-groupid-put).
Adds a group to a content restriction. That is, grant read or update
permission to the group for a piece of content.
**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to edit the content."
},
{
"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": "Deprecated, use [Remove group from content restriction by groupId](https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-restrictions/#api-wiki-rest-api-content-id-restriction-byoperation-operationkey-user-delete).
Removes a group from a content restriction. That is, remove read or update
permission for the group for a piece of content.
**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to edit the content."
},
{
"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": "Returns whether the specified content restriction applies to a group.
For example, if a page with `id=123` has a `read` restriction for the `123456` group id,
the following request will return `true`:
`/wiki/rest/api/content/123/restriction/byOperation/read/byGroupId/123456`
Note that a response of `true` does not guarantee that the group can view the page, as it does not account for
account-inherited restrictions, space permissions, or even product access. For more
inf"
},
{
"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": "Adds a group to a content restriction by Group Id. That is, grant read or update
permission to the group for a piece of content.
**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to edit the content."
},
{
"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": "Removes a group from a content restriction. That is, remove read or update
permission for the group for a piece of content.
**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to edit the content."
},
{
"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": "Returns whether the specified content restriction applies to a user.
For example, if a page with `id=123` has a `read` restriction for a user with an account ID of
`384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`, the following request will return `true`:
`/wiki/rest/api/content/123/restriction/byOperation/read/user?accountId=384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`
Note that a response of `true` does not guarantee that the user can view the page, as it does not account for<"
},
{
"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": "Adds a user to a content restriction. That is, grant read or update
permission to the user for a piece of content.
**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to edit the content."
},
{
"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": "Removes a group from a content restriction. That is, remove read or update
permission for the group for a piece of content.
**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to edit the content."
}
]
}
],
"bundled": true
}