Chilkat Online Tools

phpExt / Atlassian Confluence Cloud / Remove user from content restriction

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$http = new CkHttp();

// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');

// resp is a CkHttpResponse
$resp = $http->QuickRequest('DELETE','https://your-domain.atlassian.net/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/user?key=<string>&userName=<string>&accountId=<string>');
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";


?>

Curl Command

curl -X DELETE
	-H "Authorization: Bearer <access_token>"
https://your-domain.atlassian.net/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/user?key=<string>&userName=<string>&accountId=<string>

Postman Collection Item JSON

{
  "name": "Remove user from content restriction",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "DELETE",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/content/:id/restriction/byOperation/:operationKey/user?key=<string>&userName=<string>&accountId=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "content",
        ":id",
        "restriction",
        "byOperation",
        ":operationKey",
        "user"
      ],
      "query": [
        {
          "key": "key",
          "value": "<string>",
          "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."
        },
        {
          "key": "userName",
          "value": "<string>",
          "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."
        },
        {
          "key": "accountId",
          "value": "<string>",
          "description": "(Required) The account ID of the user to remove from the content restriction. The accountId uniquely identifies the user\nacross all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`."
        }
      ],
      "variable": [
        {
          "key": "id",
          "value": "<string>",
          "type": "string",
          "description": "(Required) The ID of the content that the restriction applies to."
        },
        {
          "key": "operationKey",
          "value": "<string>",
          "type": "string",
          "description": "(Required) The operation that the restriction applies to."
        }
      ]
    },
    "description": "Removes a group from a content restriction. That is, remove read or update\npermission for the group for a piece of content.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to edit the content."
  },
  "response": [
    {
      "name": "Returned if the user is removed from the content restriction. The response\nbody will be empty.",
      "originalRequest": {
        "method": "DELETE",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: oauth2",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/content/:id/restriction/byOperation/:operationKey/user?key=<string>&userName=<string>&accountId=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "content",
            ":id",
            "restriction",
            "byOperation",
            ":operationKey",
            "user"
          ],
          "query": [
            {
              "key": "key",
              "value": "<string>"
            },
            {
              "key": "userName",
              "value": "<string>"
            },
            {
              "key": "accountId",
              "value": "<string>"
            }
          ],
          "variable": [
            {
              "key": "id"
            },
            {
              "key": "operationKey"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.\n- An invalid operation or group is specified.",
      "originalRequest": {
        "method": "DELETE",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: oauth2",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/content/:id/restriction/byOperation/:operationKey/user?key=<string>&userName=<string>&accountId=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "content",
            ":id",
            "restriction",
            "byOperation",
            ":operationKey",
            "user"
          ],
          "query": [
            {
              "key": "key",
              "value": "<string>"
            },
            {
              "key": "userName",
              "value": "<string>"
            },
            {
              "key": "accountId",
              "value": "<string>"
            }
          ],
          "variable": [
            {
              "key": "id"
            },
            {
              "key": "operationKey"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}