Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateString $queryParams "key" "<string>"
CkJsonObject_UpdateString $queryParams "key" "<string>"
CkJsonObject_UpdateString $queryParams "username" "<string>"
CkJsonObject_UpdateString $queryParams "username" "<string>"
CkJsonObject_UpdateInt $queryParams "start" 0
CkJsonObject_UpdateInt $queryParams "limit" 200
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://your-domain.atlassian.net/wiki/rest/api/user/bulk/migration" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "results": [
# {
# "username": "minim quis Ut ut",
# "key": "nisi dolore eu",
# "accountId": "ut esse"
# },
# {
# "username": "consectetur reprehend",
# "key": "irure eu in",
# "accountId": "aliqua occaecat"
# }
# ],
# "start": 64265328,
# "limit": 95109652,
# "size": -92940668,
# "_links": {}
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set start [CkJsonObject_IntOf $jResp "start"]
set limit [CkJsonObject_IntOf $jResp "limit"]
set size [CkJsonObject_IntOf $jResp "size"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "results"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set username [CkJsonObject_stringOf $jResp "results[i].username"]
set key [CkJsonObject_stringOf $jResp "results[i].key"]
set accountId [CkJsonObject_stringOf $jResp "results[i].accountId"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -G -d "key=%3Cstring%3E"
-d "key=%3Cstring%3E"
-d "username=%3Cstring%3E"
-d "username=%3Cstring%3E"
-d "start=0"
-d "limit=200"
-H "Authorization: Bearer <access_token>"
https://your-domain.atlassian.net/wiki/rest/api/user/bulk/migration
Postman Collection Item JSON
{
"name": "Get user accountIds",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/user/bulk/migration?key=<string>&key=<string>&username=<string>&username=<string>&start=0&limit=200",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"user",
"bulk",
"migration"
],
"query": [
{
"key": "key",
"value": "<string>",
"description": "(Required) The key of a user. To specify multiple users, pass multiple key parameters separated by ampersands.\nFor example, key=mia&key=alana. Required if username isn't provided. Cannot be provided if username is present."
},
{
"key": "key",
"value": "<string>",
"description": "(Required) The key of a user. To specify multiple users, pass multiple key parameters separated by ampersands.\nFor example, key=mia&key=alana. Required if username isn't provided. Cannot be provided if username is present."
},
{
"key": "username",
"value": "<string>",
"description": "The username of a user. To specify multiple users, pass multiple username parameters separated by ampersands.\nFor example, username=mia&username=alana. Required if key isn't provided. Cannot be provided if key is present."
},
{
"key": "username",
"value": "<string>",
"description": "The username of a user. To specify multiple users, pass multiple username parameters separated by ampersands.\nFor example, username=mia&username=alana. Required if key isn't provided. Cannot be provided if key is present."
},
{
"key": "start",
"value": "0",
"description": "The index of the first item to return in a page of results (page offset)."
},
{
"key": "limit",
"value": "200",
"description": "The maximum number of results to return per page.\nNote, this may be restricted by fixed system limits."
}
]
},
"description": "Returns the accountIds for the users specified in the key or username parameters. Note that multiple key and username parameters can be specified.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Confluence Administrator' global permission if specifying a user, otherwise\npermission to access the Confluence site ('Can use' global permission)."
},
"response": [
{
"name": "Returned if the request is successful.",
"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/bulk/migration?key=<string>&key=<string>&username=<string>&username=<string>&start=0&limit=200",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"user",
"bulk",
"migration"
],
"query": [
{
"key": "key",
"value": "<string>"
},
{
"key": "key",
"value": "<string>"
},
{
"key": "username",
"value": "<string>"
},
{
"key": "username",
"value": "<string>"
},
{
"key": "start",
"value": "0"
},
{
"key": "limit",
"value": "200"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"results\": [\n {\n \"username\": \"minim quis Ut ut\",\n \"key\": \"nisi dolore eu\",\n \"accountId\": \"ut esse\"\n },\n {\n \"username\": \"consectetur reprehend\",\n \"key\": \"irure eu in\",\n \"accountId\": \"aliqua occaecat\"\n }\n ],\n \"start\": 64265328,\n \"limit\": 95109652,\n \"size\": -92940668,\n \"_links\": {}\n}"
},
{
"name": "Returned if no `username` or 'key' is specified.",
"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/bulk/migration?key=<string>&key=<string>&username=<string>&username=<string>&start=0&limit=200",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"user",
"bulk",
"migration"
],
"query": [
{
"key": "key",
"value": "<string>"
},
{
"key": "key",
"value": "<string>"
},
{
"key": "username",
"value": "<string>"
},
{
"key": "username",
"value": "<string>"
},
{
"key": "start",
"value": "0"
},
{
"key": "limit",
"value": "200"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "Returned if;\n\n- The calling user does not have permission to view users.\n- A schema has not been defined for this response code.",
"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/bulk/migration?key=<string>&key=<string>&username=<string>&username=<string>&start=0&limit=200",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"user",
"bulk",
"migration"
],
"query": [
{
"key": "key",
"value": "<string>"
},
{
"key": "key",
"value": "<string>"
},
{
"key": "username",
"value": "<string>"
},
{
"key": "username",
"value": "<string>"
},
{
"key": "start",
"value": "0"
},
{
"key": "limit",
"value": "200"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
