Chilkat Online Tools

Xojo / Atlassian Confluence Cloud / Get anonymous user

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

Dim queryParams As New Chilkat.JsonObject
success = queryParams.UpdateString("expand","<string>")
success = queryParams.UpdateString("expand","<string>")

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"

Dim resp As Chilkat.HttpResponse
resp = http.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/user/anonymous",queryParams)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("Failed.")

    Return
End If

// 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

Dim operation As String
Dim targetType As String

Dim v_type As String
v_type = jResp.StringOf("type")
Dim Path As String
Path = jResp.StringOf("profilePicture.path")
Dim Width As Int32
Width = jResp.IntOf("profilePicture.width")
Dim Height As Int32
Height = jResp.IntOf("profilePicture.height")
Dim IsDefault As Boolean
IsDefault = jResp.BoolOf("profilePicture.isDefault")
Dim displayName As String
displayName = jResp.StringOf("displayName")
Dim Operations As String
Operations = jResp.StringOf("_expandable.operations")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("operations")
While i < count_i
    jResp.I = i
    operation = jResp.StringOf("operations[i].operation")
    targetType = jResp.StringOf("operations[i].targetType")
    i = i + 1
Wend

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": ""
    }
  ]
}