Get List of AD Groups
You can get a list of Azure AD groups available to the service account.
Request
To retrieve a representation of a collection of Azure AD groups, send the HTTP POST request to the /accounts/azure/service/listAdGroups endpoint.
HTTP Request
POST https://<hostname>/api/v2/accounts/azure/service/listAdGroups |
Request Headers
The request contains the following headers.
Header | Required | Value | Description |
|---|---|---|---|
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Request Body
To get a list of all Azure AD groups, send the parameters of the ListAdGroupRequestV2 schema in the request body.
Note |
To obtain an accessTokenCache, follow the instructions in section Authenticate Service Account . |
{ "azureAuthentication": { "authenticatedByCertificate": true, "azureEnvironment": "Global", "azureAccountPurpose": "Service", "accessTokenCache": "string", "displayableId": "string", "familyName": "string", "givenName": "string", "identityProvider": "string", "tenantId": "string", "_links": { "additionalProp1": { "href": "string" }, "additionalProp2": { "href": "string" }, "additionalProp3": { "href": "string" } } }, "queryOptions": {} } |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 (OK).
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Value | Description |
|---|---|---|
Content-length | integer | Identifies the length of the response body message, in bytes. |
Content-type |
| Identifies the media type of the response body message. |
Response Body
In the response body, Veeam Backup for Microsoft Azure returns a representation of the /accounts/azure/service/listAdgroups collection. The AdGroupListingResultV2 schema is used for the collection representation.
Example
The following request returns a list of Azure AD groups.
|