Chilkat Online Tools

Perl / Atlassian Confluence Cloud / Get anonymous user

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

$queryParams = chilkat::CkJsonObject->new();
$queryParams->UpdateString("expand","<string>");
$queryParams->UpdateString("expand","<string>");

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

# resp is a HttpResponse
$resp = $http->QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/user/anonymous",$queryParams);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $resp->header() . "\r\n";
    print "Failed." . "\r\n";

    exit;
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "type": "non ut",
#   "profilePicture": {
#     "path": "id pariatur occaecat cillum",
#     "width": 98006898,
#     "height": 65551585,
#     "isDefault": true
#   },
#   "displayName": "eiusmod",
#   "_expandable": {
#     "operations": "Duis"
#   },
#   "_links": {},
#   "operations": [
#     {
#       "operation": "purge",
#       "targetType": "page"
#     },
#     {
#       "operation": "purge",
#       "targetType": "attachment"
#     }
#   ]
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

$v_type = $jResp->stringOf("type");
$Path = $jResp->stringOf("profilePicture.path");
$Width = $jResp->IntOf("profilePicture.width");
$Height = $jResp->IntOf("profilePicture.height");
$IsDefault = $jResp->BoolOf("profilePicture.isDefault");
$displayName = $jResp->stringOf("displayName");
$Operations = $jResp->stringOf("_expandable.operations");
$i = 0;
$count_i = $jResp->SizeOfArray("operations");
while ($i < $count_i) {
    $jResp->put_I($i);
    $operation = $jResp->stringOf("operations[i].operation");
    $targetType = $jResp->stringOf("operations[i].targetType");
    $i = $i + 1;
}

Curl Command

curl -G -d "expand=%3Cstring%3E"
	-d "expand=%3Cstring%3E"
	-H "Authorization: Bearer <access_token>"
https://your-domain.atlassian.net/wiki/rest/api/user/anonymous

Postman Collection Item JSON

{
  "name": "Get anonymous user",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/user/anonymous?expand=<string>&expand=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "user",
        "anonymous"
      ],
      "query": [
        {
          "key": "expand",
          "value": "<string>",
          "description": "A multi-value parameter indicating which properties of the user to\nexpand.\n\n  - `operations` returns the operations that the user is allowed to do."
        },
        {
          "key": "expand",
          "value": "<string>",
          "description": "A multi-value parameter indicating which properties of the user to\nexpand.\n\n  - `operations` returns the operations that the user is allowed to do."
        }
      ]
    },
    "description": "Returns information about how anonymous users are represented, like the\nprofile picture and display name.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission)."
  },
  "response": [
    {
      "name": "Returned if the anonymous user representation is returned.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: oauth2",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/user/anonymous?expand=<string>&expand=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "user",
            "anonymous"
          ],
          "query": [
            {
              "key": "expand",
              "value": "<string>"
            },
            {
              "key": "expand",
              "value": "<string>"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"type\": \"non ut\",\n \"profilePicture\": {\n  \"path\": \"id pariatur occaecat cillum\",\n  \"width\": 98006898,\n  \"height\": 65551585,\n  \"isDefault\": true\n },\n \"displayName\": \"eiusmod\",\n \"_expandable\": {\n  \"operations\": \"Duis\"\n },\n \"_links\": {},\n \"operations\": [\n  {\n   \"operation\": \"purge\",\n   \"targetType\": \"page\"\n  },\n  {\n   \"operation\": \"purge\",\n   \"targetType\": \"attachment\"\n  }\n ]\n}"
    },
    {
      "name": "Returned if the calling user does not have permission to use\nConfluence.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: oauth2",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/user/anonymous?expand=<string>&expand=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "user",
            "anonymous"
          ],
          "query": [
            {
              "key": "expand",
              "value": "<string>"
            },
            {
              "key": "expand",
              "value": "<string>"
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}