Chilkat Online Tools

Ruby / Atlassian Confluence Cloud / Get user accountIds

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("key","<string>")
queryParams.UpdateString("key","<string>")
queryParams.UpdateString("username","<string>")
queryParams.UpdateString("username","<string>")
queryParams.UpdateInt("start",0)
queryParams.UpdateInt("limit",200)

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/user/bulk/migration",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# 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

start = jResp.IntOf("start")
limit = jResp.IntOf("limit")
size = jResp.IntOf("size")
i = 0
count_i = jResp.SizeOfArray("results")
while i < count_i
    jResp.put_I(i)
    username = jResp.stringOf("results[i].username")
    key = jResp.stringOf("results[i].key")
    accountId = jResp.stringOf("results[i].accountId")
    i = i + 1
end

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