Back to Collection Items
void ChilkatSample(void)
{
queryParams.UpdateString(L"key",L"<string>"); queryParams.UpdateString(L"username",L"<string>"); queryParams.UpdateString(L"accountId",L"<string>"); queryParams.UpdateString(L"expand",L"<string>"); queryParams.UpdateString(L"expand",L"<string>"); http.put_AuthToken(L"<access_token>"); success = http.HttpParams(L"GET",L"https://your-domain.atlassian.net/wiki/rest/api/user",queryParams,resp); resp.GetBodySb(sbResponseBody); jResp.LoadSb(sbResponseBody); jResp.put_EmitCompact(false); jResp.put_I(i); operation = jResp.stringOf(L"operations[i].operation"); targetType = jResp.stringOf(L"operations[i].targetType"); i = i + 1; i = 0; count_i = jResp.SizeOfArray(L"personalSpace.description.plain.embeddedContent"); jResp.put_I(i); value = jResp.stringOf(L"personalSpace.description.plain.embeddedContent[i].value"); i = i + 1; i = 0; count_i = jResp.SizeOfArray(L"personalSpace.description.view.embeddedContent"); jResp.put_I(i); value = jResp.stringOf(L"personalSpace.description.view.embeddedContent[i].value"); i = i + 1; i = 0; count_i = jResp.SizeOfArray(L"personalSpace.metadata.labels.results"); jResp.put_I(i); value = jResp.stringOf(L"personalSpace.metadata.labels.results[i].value"); i = i + 1; i = 0; count_i = jResp.SizeOfArray(L"personalSpace.operations"); jResp.put_I(i); operation = jResp.stringOf(L"personalSpace.operations[i].operation"); targetType = jResp.stringOf(L"personalSpace.operations[i].targetType"); i = i + 1; i = 0; count_i = jResp.SizeOfArray(L"personalSpace.permissions"); jResp.put_I(i); v_expandableValue = jResp.stringOf(L"personalSpace.permissions[i].subjects._expandable.value"); UserValue = jResp.stringOf(L"personalSpace.permissions[i].subjects.user.value"); GroupValue = jResp.stringOf(L"personalSpace.permissions[i].subjects.group.value"); Operation = jResp.stringOf(L"personalSpace.permissions[i].operation.operation"); TargetType = jResp.stringOf(L"personalSpace.permissions[i].operation.targetType"); anonymousAccess = jResp.BoolOf(L"personalSpace.permissions[i].anonymousAccess"); unlicensedAccess = jResp.BoolOf(L"personalSpace.permissions[i].unlicensedAccess"); i = i + 1;
}
Curl Command
curl -G -d "key=%3Cstring%3E"
-d "username=%3Cstring%3E"
-d "accountId=%3Cstring%3E"
-d "expand=%3Cstring%3E"
-d "expand=%3Cstring%3E"
-H "Authorization: Bearer <access_token>"
https://your-domain.atlassian.net/wiki/rest/api/user
Postman Collection Item JSON
{
"name": "Get user",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/user?key=<string>&username=<string>&accountId=<string>&expand=<string>&expand=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"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, which uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`."
},
{
"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 a user. This includes information about the user, such as the\ndisplay name, account ID, profile picture, and more. The information returned may be\nrestricted by the user's profile visibility settings.\n\n**Note:** to add, edit, or delete users in your organization, see the\n[user management REST API](/cloud/admin/user-management/about/).\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 requested 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?key=<string>&username=<string>&accountId=<string>&expand=<string>&expand=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"user"
],
"query": [
{
"key": "key",
"value": "<string>"
},
{
"key": "username",
"value": "<string>"
},
{
"key": "accountId",
"value": "<string>"
},
{
"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 authentication credentials are incorrect or missing\nfrom the request.",
"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?key=<string>&username=<string>&accountId=<string>&expand=<string>&expand=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"user"
],
"query": [
{
"key": "key",
"value": "<string>"
},
{
"key": "username",
"value": "<string>"
},
{
"key": "accountId",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "Returned if the calling user does not have permission to view users.",
"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?key=<string>&username=<string>&accountId=<string>&expand=<string>&expand=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"user"
],
"query": [
{
"key": "key",
"value": "<string>"
},
{
"key": "username",
"value": "<string>"
},
{
"key": "accountId",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "Returned if a user with the given accountId does not exist.",
"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?key=<string>&username=<string>&accountId=<string>&expand=<string>&expand=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"user"
],
"query": [
{
"key": "key",
"value": "<string>"
},
{
"key": "username",
"value": "<string>"
},
{
"key": "accountId",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
