Exchange Active Sync Resource

Provide information about Microsoft Exchange Active Sync connections

GET /{tenantGuid}/api/v1/exchangeConfigurations

Available Since:
12.20.0

Get details of the Microsoft Exchange Active Sync connections from a query.

Sample request

 GET /SRP00000/api/v1/exchangeConfigurations?query=expiryDate>=2024-01-01T00:00:00.000Z,expiryDate<2040-01-01T00:00:00.000Z
 

Sample response body

  {
    "exchangeActiveSyncConnections": [ {
      "name": "example",
      "modernAuthentication": true,
      "azureApplicationId": "b545-920a-4331-b80a-8ce48ceaef0b",
      "azureOrganization": "example01.example.com",
      "certificate": {
          "expiryDate": "2025-12-01T14:05:29.000Z",
          "alias": null,
          "subject": "CN=Example,DC=Example,DC=com",
          "altNames": null
          }
    } ]
  }
 

Request Parameters
Name Location Description
query query Query parameter for filtering the results.

The format is operator field name< field-value (field-name)(operator)(field-value). Also, we can have a multiple filters separated by comma. (field-name)(operator)(field-value) , (field-name)(operator)(field-value).

The following table describes the fields that can be used in the query.

> or >= for the minimum date, and/or < or <= for the maximum date. For example: expiryDate>=2021-07-01T00:00:00.000Z,expiryDate<2021-07-31T00:00:00.000Z
Field Type Description
expiryDate string The Microsoft Exchange Active Sync connection's certificate expiry date.
Response Codes
Code Condition Data type
200 OK (even if no Exchange Active Sync connections are found).
400 Invalid request. For example, invalid field semantics or missing required field.
Response Body
Media type Data type Description
application/vnd.blackberry.exchangeactivesync-v1+json Exchange Active Sync connections (JSON)