Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
$queryParams = New-Object Chilkat.JsonObject
$queryParams.UpdateString("expand","<string>")
$queryParams.UpdateString("expand","<string>")
# Adds the "Authorization: Bearer <access_token>" header.
$http.AuthToken = "<access_token>"
$resp = $http.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/user/current",$queryParams)
if ($http.LastMethodSuccess -eq $false) {
$($http.LastErrorText)
exit
}
$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($resp.Header)
$("Failed.")
exit
}
# 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
$v_type = $jResp.StringOf("type")
$accountId = $jResp.StringOf("accountId")
$accountType = $jResp.StringOf("accountType")
$email = $jResp.StringOf("email")
$publicName = $jResp.StringOf("publicName")
$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")
$Details = $jResp.StringOf("_expandable.details")
$PersonalSpace = $jResp.StringOf("_expandable.personalSpace")
$username = $jResp.StringOf("username")
$userKey = $jResp.StringOf("userKey")
$Value = $jResp.StringOf("details.business.value")
$PersonalValue = $jResp.StringOf("details.personal.value")
$Id = $jResp.IntOf("personalSpace.id")
$Key = $jResp.StringOf("personalSpace.key")
$Name = $jResp.StringOf("personalSpace.name")
$v_Type = $jResp.StringOf("personalSpace.type")
$Status = $jResp.StringOf("personalSpace.status")
$Settings = $jResp.StringOf("personalSpace._expandable.settings")
$Metadata = $jResp.StringOf("personalSpace._expandable.metadata")
$v_expandableOperations = $jResp.StringOf("personalSpace._expandable.operations")
$LookAndFeel = $jResp.StringOf("personalSpace._expandable.lookAndFeel")
$Permissions = $jResp.StringOf("personalSpace._expandable.permissions")
$Icon = $jResp.StringOf("personalSpace._expandable.icon")
$Description = $jResp.StringOf("personalSpace._expandable.description")
$Theme = $jResp.StringOf("personalSpace._expandable.theme")
$History = $jResp.StringOf("personalSpace._expandable.history")
$Homepage = $jResp.StringOf("personalSpace._expandable.homepage")
$IconPath = $jResp.StringOf("personalSpace.icon.path")
$IconWidth = $jResp.IntOf("personalSpace.icon.width")
$IconHeight = $jResp.IntOf("personalSpace.icon.height")
$IconIsDefault = $jResp.BoolOf("personalSpace.icon.isDefault")
$PlainValue = $jResp.StringOf("personalSpace.description.plain.value")
$Representation = $jResp.StringOf("personalSpace.description.plain.representation")
$ViewValue = $jResp.StringOf("personalSpace.description.view.value")
$ViewRepresentation = $jResp.StringOf("personalSpace.description.view.representation")
$HomepageValue = $jResp.StringOf("personalSpace.homepage.value")
$Start = $jResp.IntOf("personalSpace.metadata.labels.start")
$Limit = $jResp.IntOf("personalSpace.metadata.labels.limit")
$Size = $jResp.IntOf("personalSpace.metadata.labels.size")
$RouteOverrideEnabled = $jResp.BoolOf("personalSpace.settings.routeOverrideEnabled")
$Color = $jResp.StringOf("personalSpace.lookAndFeel.headings.color")
$LinksColor = $jResp.StringOf("personalSpace.lookAndFeel.links.color")
$HoverOrFocusValue = $jResp.StringOf("personalSpace.lookAndFeel.menus.hoverOrFocus.value")
$ColorValue = $jResp.StringOf("personalSpace.lookAndFeel.menus.color.value")
$BackgroundColorValue = $jResp.StringOf("personalSpace.lookAndFeel.header.backgroundColor.value")
$ButtonValue = $jResp.StringOf("personalSpace.lookAndFeel.header.button.value")
$PrimaryNavigationValue = $jResp.StringOf("personalSpace.lookAndFeel.header.primaryNavigation.value")
$SecondaryNavigationValue = $jResp.StringOf("personalSpace.lookAndFeel.header.secondaryNavigation.value")
$SearchValue = $jResp.StringOf("personalSpace.lookAndFeel.header.search.value")
$ScreenValue = $jResp.StringOf("personalSpace.lookAndFeel.content.screen.value")
$ContainerValue = $jResp.StringOf("personalSpace.lookAndFeel.content.container.value")
$HeaderValue = $jResp.StringOf("personalSpace.lookAndFeel.content.header.value")
$BodyValue = $jResp.StringOf("personalSpace.lookAndFeel.content.body.value")
$BordersAndDividersColor = $jResp.StringOf("personalSpace.lookAndFeel.bordersAndDividers.color")
$CreatedDate = $jResp.StringOf("personalSpace.history.createdDate")
$i = 0
$count_i = $jResp.SizeOfArray("operations")
while ($i -lt $count_i) {
$jResp.I = $i
$operation = $jResp.StringOf("operations[i].operation")
$targetType = $jResp.StringOf("operations[i].targetType")
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("personalSpace.description.plain.embeddedContent")
while ($i -lt $count_i) {
$jResp.I = $i
$value = $jResp.StringOf("personalSpace.description.plain.embeddedContent[i].value")
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("personalSpace.description.view.embeddedContent")
while ($i -lt $count_i) {
$jResp.I = $i
$value = $jResp.StringOf("personalSpace.description.view.embeddedContent[i].value")
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("personalSpace.metadata.labels.results")
while ($i -lt $count_i) {
$jResp.I = $i
$value = $jResp.StringOf("personalSpace.metadata.labels.results[i].value")
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("personalSpace.operations")
while ($i -lt $count_i) {
$jResp.I = $i
$operation = $jResp.StringOf("personalSpace.operations[i].operation")
$targetType = $jResp.StringOf("personalSpace.operations[i].targetType")
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("personalSpace.permissions")
while ($i -lt $count_i) {
$jResp.I = $i
$v_expandableValue = $jResp.StringOf("personalSpace.permissions[i].subjects._expandable.value")
$UserValue = $jResp.StringOf("personalSpace.permissions[i].subjects.user.value")
$GroupValue = $jResp.StringOf("personalSpace.permissions[i].subjects.group.value")
$Operation = $jResp.StringOf("personalSpace.permissions[i].operation.operation")
$TargetType = $jResp.StringOf("personalSpace.permissions[i].operation.targetType")
$anonymousAccess = $jResp.BoolOf("personalSpace.permissions[i].anonymousAccess")
$unlicensedAccess = $jResp.BoolOf("personalSpace.permissions[i].unlicensedAccess")
$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/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": ""
}
]
}
