Organization Groups

The /Organizations/{organizationId}/Groups resource collection represents organization groups.

Get Organization Groups

Returns a collection of organization groups.

SecurityBearer

Request

path Parameters

organizationId

required

string <uuid>

Specifies the identification number of the Microsoft 365 organization. For more information on how to get this parameter, see Get Organizations.

query Parameters

limit	integer <int32> Limits the maximum number of items that the server will return on a page. The maximum supported number of items per page is 10,000. The default value is 30.
offset	integer <int32> Excludes from a response page the first N items of a collection resource. The default value is 0.
setId	string <uuid> Specifies ID of a request sent earlier and stored in cache. Using the ID, you decrease the number of requests to the cloud.
displayName	string Specifies a display name of the organization group. To filter objects, you can use * and ? wildcard characters.
groupName	string Specifies a name of the organization group.
locationFilter	string Specifies an organization group location type. Note: Use this parameter for organizations of the Hybrid type. Enum: "Cloud" "OnPremises" "Hybrid" "CloudOrHybrid" "OnPremisesOrHybrid" "Any"
dataSource	string Defines the representation of the organization groups that will be returned to the client. The following values are available: PreferLocal. For Microsoft organizations with modern app-only authentication, data is returned from either the organization cache database if organization objects are already synchronized to this source, or directly from the organization if synchronization is in progress. For Microsoft organizations with modern authentication and legacy protocols or with basic authentication, data is returned directly from the organization. Production. Data is returned directly from the organization. PreferLocalResynced. For Microsoft organizations with modern app-only authentication, synchronization of objects with the organization cache database is started and upon synchronization completes, data is returned from the organization cache database. For Microsoft organizations with modern authentication and legacy protocols or with basic authentication, data is returned directly from the organization. The default value is PreferLocal. Enum: "PreferLocal" "Production" "PreferLocalResynced"

Responses

200

default

Operation failure response.

get/v8/Organizations/{organizationId}/Groups

Request samples

curl
Python
JavaScript
C#
Go

Response samples

200
default

application/json

{"offset": 0,
"limit": 0,
"setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
"results": [{"id": "string",
"eTag": 0,
"onPremisesSid": "string",
"displayName": "string",
"name": "string",
"managedBy": "string",
"site": "string",
"type": "Office365",
"locationType": "OnPremises",
"msid": "87dd99df-6b92-4088-9037-e179379ebcf2",
"_links": {"property1": {"href": "string"
},
"property2": {"href": "string"
}
}
}
],
"_links": {"property1": {"href": "string"
},
"property2": {"href": "string"
}
}
}

Get Organization Group

Returns a resource representation of an organization group with the specified ID.

SecurityBearer

Request

path Parameters

organizationId required	string <uuid> Specifies the identification number of the Microsoft 365 organization. For more information on how to get this parameter, see Get Organizations.
groupId required	string Specifies the identification number of the group. For more information on how to get this parameter, see Get Organization Groups.

query Parameters

dataSource

string

Defines the representation of the organization groups that will be returned to the client. The following values are available:

PreferLocal. For Microsoft organizations with modern app-only authentication, data is returned from either the organization cache database if organization objects are already synchronized to this source, or directly from the organization if synchronization is in progress. For Microsoft organizations with modern authentication and legacy protocols or with basic authentication, data is returned directly from the organization.
Production. Data is returned directly from the organization.
PreferLocalResynced. For Microsoft organizations with modern app-only authentication, synchronization of objects with the organization cache database is started and upon synchronization completes, data is returned from the organization cache database. For Microsoft organizations with modern authentication and legacy protocols or with basic authentication, data is returned directly from the organization.

The default value is PreferLocal.

Enum: "PreferLocal" "Production" "PreferLocalResynced"