(Excel) List Groups

List all the groups available in an organization, including but not limited to Office 365 Groups.

See https://docs.microsoft.com/en-us/graph/api/group-list?view=graph-rest-1.0 for more information.

Download Excel Class Modules Chilkat Excel Class Modules

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

Dim http As Chilkat.Http
Set http = Chilkat.NewHttp

' Use your previously obtained access token as shown here:
'    Get Microsoft Graph OAuth2 Access Token with Group.ReadWrite.All scope.

Dim jsonToken As Chilkat.JsonObject
Set jsonToken = Chilkat.NewJsonObject

success = jsonToken.LoadFile("qa_data/tokens/msGraphGroup.json")
If (success = False) Then
    Debug.Print jsonToken.LastErrorText
    Exit Sub
End If

http.AuthToken = jsonToken.StringOf("access_token")

' Send a GET request to https://graph.microsoft.com/v1.0/groups?$orderby=displayName

strResponse = http.QuickGetStr("https://graph.microsoft.com/v1.0/groups?$orderby=displayName")
If (http.LastMethodSuccess = False) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim json As Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
success = json.Load(strResponse)
json.EmitCompact = False

If (http.LastStatus <> 200) Then
    Debug.Print json.Emit()
    Debug.Print "Failed, response status code = "; http.LastStatus
    Exit Sub
End If

Debug.Print json.Emit()

' Sample output:
' (See parsing code below..)

' {
'     "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups",
'     "value": [
'         {
'             "id": "45b7d2e7-b882-4a80-ba97-10b7a63b8fa4",
'             "deletedDateTime": null,
'             "classification": null,
'             "createdDateTime": "2018-12-22T02:21:05Z",
'             "creationOptions": [],
'             "description": "Self help community for golf",
'             "displayName": "Golf Assist",
'             "groupTypes": [
'                 "Unified"
'             ],
'             "mail": "golfassist@contoso.com",
'             "mailEnabled": true,
'             "mailNickname": "golfassist",
'             "onPremisesLastSyncDateTime": null,
'             "onPremisesSecurityIdentifier": null,
'             "onPremisesSyncEnabled": null,
'             "preferredDataLocation": "CAN",
'             "proxyAddresses": [
'                 "smtp:golfassist@contoso.onmicrosoft.com",
'                 "SMTP:golfassist@contoso.com"
'             ],
'             "renewedDateTime": "2018-12-22T02:21:05Z",
'             "resourceBehaviorOptions": [],
'             "resourceProvisioningOptions": [],
'             "securityEnabled": false,
'             "visibility": "Public",
'             "onPremisesProvisioningErrors": []
'         },
'         {
'             "id": "d7797254-3084-44d0-99c9-a3b5ab149538",
'             "deletedDateTime": null,
'             "classification": null,
'             "createdDateTime": "2018-11-19T20:29:40Z",
'             "creationOptions": [],
'             "description": "Talk about golf",
'             "displayName": "Golf Discussion",
'             "groupTypes": [],
'             "mail": "golftalk@contoso.com",
'             "mailEnabled": true,
'             "mailNickname": "golftalk",
'             "onPremisesLastSyncDateTime": null,
'             "onPremisesSecurityIdentifier": null,
'             "onPremisesSyncEnabled": null,
'             "preferredDataLocation": "CAN",
'             "proxyAddresses": [
'                 "smtp:golftalk@contoso.onmicrosoft.com",
'                 "SMTP:golftalk@contoso.com"
'             ],
'             "renewedDateTime": "2018-11-19T20:29:40Z",
'             "resourceBehaviorOptions": [],
'             "resourceProvisioningOptions": [],
'             "securityEnabled": false,
'             "visibility": null,
'             "onPremisesProvisioningErrors": []
'         }
'     ]
' }
' 
' Use this online tool to generate parsing code from sample JSON: 
' Generate Parsing Code from JSON

odataContext = json.StringOf("""@odata.context""")
i = 0
count_i = json.SizeOfArray("value")
Do While i < count_i
    json.I = i
    id = json.StringOf("value[i].id")
    deletedDateTime = json.StringOf("value[i].deletedDateTime")
    classification = json.StringOf("value[i].classification")
    createdDateTime = json.StringOf("value[i].createdDateTime")
    description = json.StringOf("value[i].description")
    displayName = json.StringOf("value[i].displayName")
    mail = json.StringOf("value[i].mail")
    mailEnabled = json.BoolOf("value[i].mailEnabled")
    mailNickname = json.StringOf("value[i].mailNickname")
    onPremisesLastSyncDateTime = json.StringOf("value[i].onPremisesLastSyncDateTime")
    onPremisesSecurityIdentifier = json.StringOf("value[i].onPremisesSecurityIdentifier")
    onPremisesSyncEnabled = json.StringOf("value[i].onPremisesSyncEnabled")
    preferredDataLocation = json.StringOf("value[i].preferredDataLocation")
    renewedDateTime = json.StringOf("value[i].renewedDateTime")
    securityEnabled = json.BoolOf("value[i].securityEnabled")
    visibility = json.StringOf("value[i].visibility")
    j = 0
    count_j = json.SizeOfArray("value[i].creationOptions")
    Do While j < count_j
        json.J = j
        ' ...
        j = j + 1
    Loop
    j = 0
    count_j = json.SizeOfArray("value[i].groupTypes")
    Do While j < count_j
        json.J = j
        strVal = json.StringOf("value[i].groupTypes[j]")
        j = j + 1
    Loop
    j = 0
    count_j = json.SizeOfArray("value[i].proxyAddresses")
    Do While j < count_j
        json.J = j
        strVal = json.StringOf("value[i].proxyAddresses[j]")
        j = j + 1
    Loop
    j = 0
    count_j = json.SizeOfArray("value[i].resourceBehaviorOptions")
    Do While j < count_j
        json.J = j
        ' ...
        j = j + 1
    Loop
    j = 0
    count_j = json.SizeOfArray("value[i].resourceProvisioningOptions")
    Do While j < count_j
        json.J = j
        ' ...
        j = j + 1
    Loop
    j = 0
    count_j = json.SizeOfArray("value[i].onPremisesProvisioningErrors")
    Do While j < count_j
        json.J = j
        ' ...
        j = j + 1
    Loop
    i = i + 1
Loop

Debug.Print "Success."