(Ruby) 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.

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

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

http = Chilkat::CkHttp.new()

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

jsonToken = Chilkat::CkJsonObject.new()
success = jsonToken.LoadFile("qa_data/tokens/msGraphGroup.json")
if (success == false)
    print jsonToken.lastErrorText() + "\n";
    exit
end

http.put_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.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

json = Chilkat::CkJsonObject.new()
json.Load(strResponse)
json.put_EmitCompact(false)

if (http.get_LastStatus() != 200)
    print json.emit() + "\n";
    print "Failed, response status code = " + http.get_LastStatus().to_s() + "\n";
    exit
end

print json.emit() + "\n";

# 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")
while i < count_i
    json.put_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")
    while j < count_j
        json.put_J(j)
        # ...
        j = j + 1
    end
    j = 0
    count_j = json.SizeOfArray("value[i].groupTypes")
    while j < count_j
        json.put_J(j)
        strVal = json.stringOf("value[i].groupTypes[j]")
        j = j + 1
    end
    j = 0
    count_j = json.SizeOfArray("value[i].proxyAddresses")
    while j < count_j
        json.put_J(j)
        strVal = json.stringOf("value[i].proxyAddresses[j]")
        j = j + 1
    end
    j = 0
    count_j = json.SizeOfArray("value[i].resourceBehaviorOptions")
    while j < count_j
        json.put_J(j)
        # ...
        j = j + 1
    end
    j = 0
    count_j = json.SizeOfArray("value[i].resourceProvisioningOptions")
    while j < count_j
        json.put_J(j)
        # ...
        j = j + 1
    end
    j = 0
    count_j = json.SizeOfArray("value[i].onPremisesProvisioningErrors")
    while j < count_j
        json.put_J(j)
        # ...
        j = j + 1
    end
    i = i + 1
end

print "Success." + "\n";