---
title: "Retrieve tenant Microsoft 365 provisioning details"
method: GET
path: "/ms365"
tags: ["Microsoft 365"]
---

# Retrieve tenant Microsoft 365 provisioning details

`GET /ms365`

Retrieve details of tenant Microsoft 365 settings.

## Response `200`

OK

- object
  - `national_cloud` 'GLOBAL' | 'CHINA' — The Microsoft cloud services are available in several separate national clouds. These national cloud versions are physical and logical network-isolated instances of Microsoft enterprise cloud services that are confined within the geographic borders of specific countries and operated by local personnel. Can be either: - `GLOBAL`: Azure global service. - `CHINA`: Azure China service.
  - `directory_id` string — The Directory ID (Tenant ID) of Microsoft identity platform.
  - `application_id` string — The Application (client) ID of Azure AD.
  - `redirect_uri` string — Redirect URI. The URIs we will accept as destinations when returning authentication responses (tokens) after successfully authenticating or signing out users. The redirect URI you send in the request to the login server should match one listed here. Also referred to as reply URLs.
  - `sbc_redirect_uri` string — Same as the `redirect_uri`, but via the sbc network topology.
  - `sync_time` string — The crontab expression <https://en.wikipedia.org/wiki/Cron>
  - `users` object
    - `enabled` boolean — Whether to enable Microsoft 365 users with extensions synchronization.
    - `sync_guest_users` boolean — Whether to enable gust user synchronization.
    - `sync_photo` boolean — Whether to synchronize user photo.
    - `starting_extension_number` string — The starting extension number for synchronized users. Left padding with zeros is not allowed.
    - `selected_users` string[] — A collection of Microsoft 365 user's ID.
    - `sync_type` 'ALL' | 'INCLUDE' | 'EXCLUDE' — The synchronization policy: Can be either: - `ALL`: All users will be synced. - `INCLUDE`: All users except selected users will be synced. - `EXCLUDE`: All selected users will be synced.
  - `sign_in_as_administrator` object
    - `enabled` boolean — Whether to enable Microsoft 365 users with extensions synchronization.
    - `selected_users` string[] — A collection of Microsoft 365 user's ID.
  - `sign_in_as_standard_user` object
    - `enabled` boolean — Whether to enable Microsoft 365 users with extensions synchronization.
    - `selected_users` string[] — A collection of Microsoft 365 user's ID.
    - `sync_type` 'ALL' | 'INCLUDE' | 'EXCLUDE' — The synchronization policy: Can be either: - `ALL`: All users will be synced. - `INCLUDE`: All users except selected users will be synced. - `EXCLUDE`: All selected users will be synced.
  - `personal_contacts` object
    - `enabled` boolean — Whether to enable user personal contacts synchronization.
    - `selected_users` string[] — A collection of Microsoft 365 user's ID.
    - `sync_type` 'ALL' | 'INCLUDE' | 'EXCLUDE' — The synchronization policy: Can be either: - `ALL`: All users will be synced. - `INCLUDE`: All users except selected users will be synced. - `EXCLUDE`: All selected users will be synced.
  - `shared_mailbox` object
    - `enabled` boolean — Whether to enable Microsoft 365 users with extensions synchronization.
    - `selected_users` string[] — A collection of Microsoft 365 user's ID.
    - `sync_type` 'ALL' | 'INCLUDE' | 'EXCLUDE' — The synchronization policy: Can be either: - `ALL`: All users will be synced. - `INCLUDE`: All users except selected users will be synced. - `EXCLUDE`: All selected users will be synced.
  - `events` object
    - `enabled` boolean — Whether to enable Microsoft 365 users with extensions synchronization.
    - `selected_users` string[] — A collection of Microsoft 365 user's ID.
    - `sync_type` 'ALL' | 'INCLUDE' | 'EXCLUDE' — The synchronization policy: Can be either: - `ALL`: All users will be synced. - `INCLUDE`: All users except selected users will be synced. - `EXCLUDE`: All selected users will be synced.

## Other responses

- `4XX` — Error

---

[API](https://skmtc.net/portsip/apis/portsip-pbx-rest-api.md) · [All operations](https://skmtc.net/portsip/apis/portsip-pbx-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/portsip/portsip-pbx-rest-api/revisions/577415d4a3d5/schema)