Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"key","<string>")
CkJsonObject::ckUpdateString(queryParams,"username","<string>")
CkJsonObject::ckUpdateString(queryParams,"accountId","<string>")
CkJsonObject::ckUpdateInt(queryParams,"start",0)
CkJsonObject::ckUpdateInt(queryParams,"limit",200)
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://your-domain.atlassian.net/wiki/rest/api/user/memberof",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "results": [
; {
; "type": "group",
; "name": "consequat amet ",
; "id": "Ut",
; "_links": {}
; },
; {
; "type": "group",
; "name": "qui eu",
; "id": "consequat quis occaecat proident voluptate",
; "_links": {}
; }
; ],
; "start": -67251213,
; "limit": 46114380,
; "size": -50386405
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
v_type.s
name.s
id.s
start.i = CkJsonObject::ckIntOf(jResp,"start")
limit.i = CkJsonObject::ckIntOf(jResp,"limit")
size.i = CkJsonObject::ckIntOf(jResp,"size")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"results")
While i < count_i
CkJsonObject::setCkI(jResp, i)
v_type = CkJsonObject::ckStringOf(jResp,"results[i].type")
name = CkJsonObject::ckStringOf(jResp,"results[i].name")
id = CkJsonObject::ckStringOf(jResp,"results[i].id")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -G -d "key=%3Cstring%3E"
-d "username=%3Cstring%3E"
-d "accountId=%3Cstring%3E"
-d "start=0"
-d "limit=200"
-H "Authorization: Bearer <access_token>"
https://your-domain.atlassian.net/wiki/rest/api/user/memberof
Postman Collection Item JSON
{
"name": "Get group memberships for user",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/user/memberof?key=<string>&username=<string>&accountId=<string>&start=0&limit=200",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"user",
"memberof"
],
"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": "start",
"value": "0",
"description": "The starting index of the returned groups."
},
{
"key": "limit",
"value": "200",
"description": "The maximum number of groups to return per page.\nNote, this may be restricted by fixed system limits."
}
]
},
"description": "Returns the groups that a user is a member of.\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 groups are 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/memberof?key=<string>&username=<string>&accountId=<string>&start=0&limit=200",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"user",
"memberof"
],
"query": [
{
"key": "key",
"value": "<string>"
},
{
"key": "username",
"value": "<string>"
},
{
"key": "accountId",
"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 \"type\": \"group\",\n \"name\": \"consequat amet \",\n \"id\": \"Ut\",\n \"_links\": {}\n },\n {\n \"type\": \"group\",\n \"name\": \"qui eu\",\n \"id\": \"consequat quis occaecat proident voluptate\",\n \"_links\": {}\n }\n ],\n \"start\": -67251213,\n \"limit\": 46114380,\n \"size\": -50386405\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/memberof?key=<string>&username=<string>&accountId=<string>&start=0&limit=200",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"user",
"memberof"
],
"query": [
{
"key": "key",
"value": "<string>"
},
{
"key": "username",
"value": "<string>"
},
{
"key": "accountId",
"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": ""
}
]
}
