Ms365

PreviousTest email NextCertificate

Was this helpful?

Retrieve tenant Microsoft 365 provisioning details

Retrieve details of tenant Microsoft 365 settings.

get

/ms365

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/ms365' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "directory_id": "text",
  "application_id": "text",
  "redirect_uri": "text",
  "sbc_redirect_uri": "text",
  "sync_time": "text",
  "national_cloud": "GLOBAL",
  "users": {
    "enabled": false,
    "sync_guest_users": false,
    "sync_photo": false,
    "starting_extension_number": "text",
    "sync_type": "ALL",
    "selected_users": [
      "text"
    ]
  },
  "sign_in_as_administrator": {
    "enabled": false,
    "selected_users": [
      "text"
    ]
  },
  "sign_in_as_standard_user": {
    "enabled": false,
    "sync_type": "ALL",
    "selected_users": [
      "text"
    ]
  },
  "personal_contacts": {
    "enabled": false,
    "sync_type": "ALL",
    "selected_users": [
      "text"
    ]
  },
  "shared_mailbox": {
    "enabled": false,
    "sync_type": "ALL",
    "selected_users": [
      "text"
    ]
  },
  "events": {
    "enabled": false,
    "sync_type": "ALL",
    "selected_users": [
      "text"
    ]
  }
}

Reprovision tenant Microsoft 365 integration.

Update tenant Microsoft 365 settings.

post

/ms365

Authorizations

Body

directory_idstring

The Directory ID (Tenant ID) of Microsoft identity platform.

application_idstring

The Application (client) ID of Azure AD.

sync_timestring

The crontab expression https://en.wikipedia.org/wiki/Cron

national_cloudstring · enum · default: GLOBAL

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.

Options: GLOBAL, CHINA

usersobject

sign_in_as_administratorobject

sign_in_as_standard_userobject

personal_contactsobject

shared_mailboxobject

eventsobject