Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("expand","<string>")
loQueryParams.UpdateString("expand","<string>")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loResp = loHttp.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/user/current",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loQueryParams
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
return
endif
release loResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "type": "unknown",
// "accountId": "sit consectetur",
// "accountType": "atlassian",
// "email": "do",
// "publicName": "et nostrud mollit id",
// "profilePicture": {
// "path": "eiusmod Excepteur",
// "width": 61811707,
// "height": -27758421,
// "isDefault": true
// },
// "displayName": "eiusmod pariatur aliqua cupidatat",
// "_expandable": {
// "operations": "officia nu",
// "details": "exercitation ipsum elit tempor laborum",
// "personalSpace": "exercitation re"
// },
// "_links": {},
// "username": "sed velit Ut",
// "userKey": "labore anim",
// "operations": [
// {
// "operation": "use",
// "targetType": "application"
// },
// {
// "operation": "restore",
// "targetType": "space"
// }
// ],
// "details": {
// "business": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "personal": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "personalSpace": {
// "id": -69293677,
// "key": "minim",
// "name": "adipisicing minim nulla nisi consequat",
// "type": "reprehenderit",
// "status": "amet officia pariatur sed",
// "_expandable": {
// "settings": "deserunt dolore velit laborum",
// "metadata": "ullamco quis non sunt",
// "operations": "qui aliquip",
// "lookAndFeel": "eiusmod cillum ex",
// "permissions": "in ullamco",
// "icon": "veniam quis",
// "description": "officia adip",
// "theme": "ea nisi",
// "history": "aliquip est irure",
// "homepage": "aliqua est deserunt"
// },
// "_links": {},
// "icon": {
// "path": "adipisicing sed officia",
// "width": 33631448,
// "height": -10767970,
// "isDefault": true
// },
// "description": {
// "plain": {
// "value": "cupidatat nulla",
// "representation": "view",
// "embeddedContent": [
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// ]
// },
// "view": {
// "value": "magna aliquip ea",
// "representation": "plain",
// "embeddedContent": [
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// ]
// }
// },
// "homepage": {
// "value": "<Circular reference to #/components/schemas/Content detected>"
// },
// "metadata": {
// "labels": {
// "results": [
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// ],
// "start": 58105433,
// "limit": 10735114,
// "size": -29792214,
// "_links": {}
// }
// },
// "operations": [
// {
// "operation": "delete",
// "targetType": "blogpost"
// },
// {
// "operation": "restore",
// "targetType": "blogpost"
// }
// ],
// "permissions": [
// {
// "subjects": {
// "_expandable": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "user": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "group": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "operation": {
// "operation": "create",
// "targetType": "page"
// },
// "anonymousAccess": false,
// "unlicensedAccess": false
// },
// {
// "subjects": {
// "_expandable": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "user": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "group": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "operation": {
// "operation": "restore",
// "targetType": "blogpost"
// },
// "anonymousAccess": false,
// "unlicensedAccess": false
// }
// ],
// "settings": {
// "routeOverrideEnabled": false,
// "_links": {}
// },
// "theme": {},
// "lookAndFeel": {
// "headings": {
// "color": "<string>"
// },
// "links": {
// "color": "<string>"
// },
// "menus": {
// "hoverOrFocus": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "color": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "header": {
// "backgroundColor": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "button": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "primaryNavigation": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "secondaryNavigation": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "search": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "content": {
// "screen": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "container": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "header": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "body": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "bordersAndDividers": {
// "color": "<string>"
// }
// },
// "history": {
// "createdDate": "2014-12-12T23:08:45.947Z"
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcV_type = loJResp.StringOf("type")
lcAccountId = loJResp.StringOf("accountId")
lcAccountType = loJResp.StringOf("accountType")
lcEmail = loJResp.StringOf("email")
lcPublicName = loJResp.StringOf("publicName")
lcPath = loJResp.StringOf("profilePicture.path")
lnWidth = loJResp.IntOf("profilePicture.width")
lnHeight = loJResp.IntOf("profilePicture.height")
llIsDefault = loJResp.BoolOf("profilePicture.isDefault")
lcDisplayName = loJResp.StringOf("displayName")
lcOperations = loJResp.StringOf("_expandable.operations")
lcDetails = loJResp.StringOf("_expandable.details")
lcPersonalSpace = loJResp.StringOf("_expandable.personalSpace")
lcUsername = loJResp.StringOf("username")
lcUserKey = loJResp.StringOf("userKey")
lcValue = loJResp.StringOf("details.business.value")
lcPersonalValue = loJResp.StringOf("details.personal.value")
lnId = loJResp.IntOf("personalSpace.id")
lcKey = loJResp.StringOf("personalSpace.key")
lcName = loJResp.StringOf("personalSpace.name")
lcV_Type = loJResp.StringOf("personalSpace.type")
lcStatus = loJResp.StringOf("personalSpace.status")
lcSettings = loJResp.StringOf("personalSpace._expandable.settings")
lcMetadata = loJResp.StringOf("personalSpace._expandable.metadata")
lcV_expandableOperations = loJResp.StringOf("personalSpace._expandable.operations")
lcLookAndFeel = loJResp.StringOf("personalSpace._expandable.lookAndFeel")
lcPermissions = loJResp.StringOf("personalSpace._expandable.permissions")
lcIcon = loJResp.StringOf("personalSpace._expandable.icon")
lcDescription = loJResp.StringOf("personalSpace._expandable.description")
lcTheme = loJResp.StringOf("personalSpace._expandable.theme")
lcHistory = loJResp.StringOf("personalSpace._expandable.history")
lcHomepage = loJResp.StringOf("personalSpace._expandable.homepage")
lcIconPath = loJResp.StringOf("personalSpace.icon.path")
lnIconWidth = loJResp.IntOf("personalSpace.icon.width")
lnIconHeight = loJResp.IntOf("personalSpace.icon.height")
llIconIsDefault = loJResp.BoolOf("personalSpace.icon.isDefault")
lcPlainValue = loJResp.StringOf("personalSpace.description.plain.value")
lcRepresentation = loJResp.StringOf("personalSpace.description.plain.representation")
lcViewValue = loJResp.StringOf("personalSpace.description.view.value")
lcViewRepresentation = loJResp.StringOf("personalSpace.description.view.representation")
lcHomepageValue = loJResp.StringOf("personalSpace.homepage.value")
lnStart = loJResp.IntOf("personalSpace.metadata.labels.start")
lnLimit = loJResp.IntOf("personalSpace.metadata.labels.limit")
lnSize = loJResp.IntOf("personalSpace.metadata.labels.size")
llRouteOverrideEnabled = loJResp.BoolOf("personalSpace.settings.routeOverrideEnabled")
lcColor = loJResp.StringOf("personalSpace.lookAndFeel.headings.color")
lcLinksColor = loJResp.StringOf("personalSpace.lookAndFeel.links.color")
lcHoverOrFocusValue = loJResp.StringOf("personalSpace.lookAndFeel.menus.hoverOrFocus.value")
lcColorValue = loJResp.StringOf("personalSpace.lookAndFeel.menus.color.value")
lcBackgroundColorValue = loJResp.StringOf("personalSpace.lookAndFeel.header.backgroundColor.value")
lcButtonValue = loJResp.StringOf("personalSpace.lookAndFeel.header.button.value")
lcPrimaryNavigationValue = loJResp.StringOf("personalSpace.lookAndFeel.header.primaryNavigation.value")
lcSecondaryNavigationValue = loJResp.StringOf("personalSpace.lookAndFeel.header.secondaryNavigation.value")
lcSearchValue = loJResp.StringOf("personalSpace.lookAndFeel.header.search.value")
lcScreenValue = loJResp.StringOf("personalSpace.lookAndFeel.content.screen.value")
lcContainerValue = loJResp.StringOf("personalSpace.lookAndFeel.content.container.value")
lcHeaderValue = loJResp.StringOf("personalSpace.lookAndFeel.content.header.value")
lcBodyValue = loJResp.StringOf("personalSpace.lookAndFeel.content.body.value")
lcBordersAndDividersColor = loJResp.StringOf("personalSpace.lookAndFeel.bordersAndDividers.color")
lcCreatedDate = loJResp.StringOf("personalSpace.history.createdDate")
i = 0
lnCount_i = loJResp.SizeOfArray("operations")
do while i < lnCount_i
loJResp.I = i
lcOperation = loJResp.StringOf("operations[i].operation")
lcTargetType = loJResp.StringOf("operations[i].targetType")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("personalSpace.description.plain.embeddedContent")
do while i < lnCount_i
loJResp.I = i
lcValue = loJResp.StringOf("personalSpace.description.plain.embeddedContent[i].value")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("personalSpace.description.view.embeddedContent")
do while i < lnCount_i
loJResp.I = i
lcValue = loJResp.StringOf("personalSpace.description.view.embeddedContent[i].value")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("personalSpace.metadata.labels.results")
do while i < lnCount_i
loJResp.I = i
lcValue = loJResp.StringOf("personalSpace.metadata.labels.results[i].value")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("personalSpace.operations")
do while i < lnCount_i
loJResp.I = i
lcOperation = loJResp.StringOf("personalSpace.operations[i].operation")
lcTargetType = loJResp.StringOf("personalSpace.operations[i].targetType")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("personalSpace.permissions")
do while i < lnCount_i
loJResp.I = i
lcV_expandableValue = loJResp.StringOf("personalSpace.permissions[i].subjects._expandable.value")
lcUserValue = loJResp.StringOf("personalSpace.permissions[i].subjects.user.value")
lcGroupValue = loJResp.StringOf("personalSpace.permissions[i].subjects.group.value")
lcOperation = loJResp.StringOf("personalSpace.permissions[i].operation.operation")
lcTargetType = loJResp.StringOf("personalSpace.permissions[i].operation.targetType")
llAnonymousAccess = loJResp.BoolOf("personalSpace.permissions[i].anonymousAccess")
llUnlicensedAccess = loJResp.BoolOf("personalSpace.permissions[i].unlicensedAccess")
i = i + 1
enddo
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
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/current
Postman Collection Item JSON
{
"name": "Get current user",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/user/current?expand=<string>&expand=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"user",
"current"
],
"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.\n - `details.personal` returns the 'Personal' details in the user's profile, like the 'Email' and 'Phone'.\n Note that these fields have been deprecated due to privacy changes. See the\n [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\n for details.\n - `details.business` returns the 'Company' details in the user's profile, like the 'Position' and 'Department'.\n Note that these fields have been deprecated due to privacy changes. See the\n [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\n for details.\n - personalSpace returns the user's personal space, if it exists."
},
{
"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.\n - `details.personal` returns the 'Personal' details in the user's profile, like the 'Email' and 'Phone'.\n Note that these fields have been deprecated due to privacy changes. See the\n [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\n for details.\n - `details.business` returns the 'Company' details in the user's profile, like the 'Position' and 'Department'.\n Note that these fields have been deprecated due to privacy changes. See the\n [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\n for details.\n - personalSpace returns the user's personal space, if it exists."
}
]
},
"description": "Returns the currently logged-in user. This includes information about\nthe user, like the display name, userKey, account ID, profile picture,\nand more.\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 current user 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/current?expand=<string>&expand=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"user",
"current"
],
"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\": \"unknown\",\n \"accountId\": \"sit consectetur\",\n \"accountType\": \"atlassian\",\n \"email\": \"do\",\n \"publicName\": \"et nostrud mollit id\",\n \"profilePicture\": {\n \"path\": \"eiusmod Excepteur\",\n \"width\": 61811707,\n \"height\": -27758421,\n \"isDefault\": true\n },\n \"displayName\": \"eiusmod pariatur aliqua cupidatat\",\n \"_expandable\": {\n \"operations\": \"officia nu\",\n \"details\": \"exercitation ipsum elit tempor laborum\",\n \"personalSpace\": \"exercitation re\"\n },\n \"_links\": {},\n \"username\": \"sed velit Ut\",\n \"userKey\": \"labore anim\",\n \"operations\": [\n {\n \"operation\": \"use\",\n \"targetType\": \"application\"\n },\n {\n \"operation\": \"restore\",\n \"targetType\": \"space\"\n }\n ],\n \"details\": {\n \"business\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"personal\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"personalSpace\": {\n \"id\": -69293677,\n \"key\": \"minim\",\n \"name\": \"adipisicing minim nulla nisi consequat\",\n \"type\": \"reprehenderit\",\n \"status\": \"amet officia pariatur sed\",\n \"_expandable\": {\n \"settings\": \"deserunt dolore velit laborum\",\n \"metadata\": \"ullamco quis non sunt\",\n \"operations\": \"qui aliquip\",\n \"lookAndFeel\": \"eiusmod cillum ex\",\n \"permissions\": \"in ullamco\",\n \"icon\": \"veniam quis\",\n \"description\": \"officia adip\",\n \"theme\": \"ea nisi\",\n \"history\": \"aliquip est irure\",\n \"homepage\": \"aliqua est deserunt\"\n },\n \"_links\": {},\n \"icon\": {\n \"path\": \"adipisicing sed officia\",\n \"width\": 33631448,\n \"height\": -10767970,\n \"isDefault\": true\n },\n \"description\": {\n \"plain\": {\n \"value\": \"cupidatat nulla\",\n \"representation\": \"view\",\n \"embeddedContent\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ]\n },\n \"view\": {\n \"value\": \"magna aliquip ea\",\n \"representation\": \"plain\",\n \"embeddedContent\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ]\n }\n },\n \"homepage\": {\n \"value\": \"<Circular reference to #/components/schemas/Content detected>\"\n },\n \"metadata\": {\n \"labels\": {\n \"results\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ],\n \"start\": 58105433,\n \"limit\": 10735114,\n \"size\": -29792214,\n \"_links\": {}\n }\n },\n \"operations\": [\n {\n \"operation\": \"delete\",\n \"targetType\": \"blogpost\"\n },\n {\n \"operation\": \"restore\",\n \"targetType\": \"blogpost\"\n }\n ],\n \"permissions\": [\n {\n \"subjects\": {\n \"_expandable\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"user\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"group\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"operation\": {\n \"operation\": \"create\",\n \"targetType\": \"page\"\n },\n \"anonymousAccess\": false,\n \"unlicensedAccess\": false\n },\n {\n \"subjects\": {\n \"_expandable\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"user\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"group\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"operation\": {\n \"operation\": \"restore\",\n \"targetType\": \"blogpost\"\n },\n \"anonymousAccess\": false,\n \"unlicensedAccess\": false\n }\n ],\n \"settings\": {\n \"routeOverrideEnabled\": false,\n \"_links\": {}\n },\n \"theme\": {},\n \"lookAndFeel\": {\n \"headings\": {\n \"color\": \"<string>\"\n },\n \"links\": {\n \"color\": \"<string>\"\n },\n \"menus\": {\n \"hoverOrFocus\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"color\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"header\": {\n \"backgroundColor\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"button\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"primaryNavigation\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"secondaryNavigation\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"search\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"content\": {\n \"screen\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"container\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"header\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"body\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"bordersAndDividers\": {\n \"color\": \"<string>\"\n }\n },\n \"history\": {\n \"createdDate\": \"2014-12-12T23:08:45.947Z\"\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/current?expand=<string>&expand=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"user",
"current"
],
"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": ""
}
]
}
