Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
Dim queryParams As New Chilkat.JsonObject
queryParams.UpdateString("key","<string>")
queryParams.UpdateString("username","<string>")
queryParams.UpdateString("accountId","<string>")
queryParams.UpdateInt("start",0)
queryParams.UpdateInt("limit",200)
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
Dim resp As Chilkat.HttpResponse = http.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/user/memberof",queryParams)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(resp.Header)
Debug.WriteLine("Failed.")
Exit Sub
End If
' 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
Dim v_type As String
Dim name As String
Dim id As String
Dim start As Integer = jResp.IntOf("start")
Dim limit As Integer = jResp.IntOf("limit")
Dim size As Integer = jResp.IntOf("size")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("results")
While i < count_i
jResp.I = i
v_type = jResp.StringOf("results[i].type")
name = jResp.StringOf("results[i].name")
id = jResp.StringOf("results[i].id")
i = i + 1
End While
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": ""
}
]
}
