Ms365

Retrieve tenant Microsoft 365 provisioning details

get

Retrieve details of tenant Microsoft 365 settings.

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

4XX

200

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

OK

Reprovision tenant Microsoft 365 integration.

post

Update tenant Microsoft 365 settings.

Authorizations

Body

national_cloudstring · enum · default: "GLOBAL"optional

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

directory_idstringoptional

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

application_idstringoptional

The Application (client) ID of Azure AD.

sync_timestringoptional

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

usersobjectoptional

sign_in_as_administratorobjectoptional

sign_in_as_standard_userobjectoptional

personal_contactsobjectoptional

shared_mailboxobjectoptional

eventsobjectoptional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/ms365' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "national_cloud": "GLOBAL",
    "directory_id": "text",
    "application_id": "text",
    "sync_time": "text",
    "users": {
      "enabled": true,
      "sync_guest_users": true,
      "sync_photo": true,
      "starting_extension_number": "text",
      "selected_users": [
        "text"
      ],
      "sync_type": "ALL"
    },
    "sign_in_as_administrator": {
      "enabled": true,
      "selected_users": [
        "text"
      ]
    },
    "sign_in_as_standard_user": {
      "enabled": true,
      "selected_users": [
        "text"
      ],
      "sync_type": "ALL"
    },
    "personal_contacts": {
      "enabled": true,
      "selected_users": [
        "text"
      ],
      "sync_type": "ALL"
    },
    "shared_mailbox": {
      "enabled": true,
      "selected_users": [
        "text"
      ],
      "sync_type": "ALL"
    },
    "events": {
      "enabled": true,
      "selected_users": [
        "text"
      ],
      "sync_type": "ALL"
    }
  }'

200

4XX

200

No body

OK