Integrations | PortSIP Knowledge Base

Retrieve global Microsoft 365 provisioning details

get

Retrieve details of global Microsoft 365 settings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/admin/ms365

GET /api/admin/ms365 HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "national_cloud": "GLOBAL",
  "directory_id": "text",
  "application_id": "text",
  "redirect_uri": "text",
  "sbc_redirect_uri": "text"
}

Reprovision global Microsoft 365 integration.

post

Update global Microsoft 365 settings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

national_cloudstring · enumOptional

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.

Default: GLOBALPossible values:

directory_idstringOptional

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

application_idstringOptional

The Application (client) ID of Azure AD.

Responses

200

OK

No content

4XX

Error

post

/admin/ms365

POST /api/admin/ms365 HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "national_cloud": "GLOBAL",
  "directory_id": "text",
  "application_id": "text"
}

No content

Download global Microsoft 365 certificate

get

Download global Microsoft 365 certificate.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/octet-stream

Responsestring · binary

4XX

Error

get

/admin/ms365/certificate

GET /api/admin/ms365/certificate HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Generate new global Microsoft 365 certificate

post

Generate new global Microsoft 365 certificate.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/octet-stream

Responsestring · binary

4XX

Error

post

/admin/ms365/certificate

POST /api/admin/ms365/certificate HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Retrieve global Google integrations

get

Retrieve details of global Google integrations settings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/admin/google

GET /api/admin/google HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "client_id": "text",
  "client_secret": "text",
  "redirect_uri": "text",
  "sbc_redirect_uri": "text",
  "auth_consent_uri": "text"
}

Update global Google integration.

post

Update global Google integration settings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

client_idstringOptional

The client ID of Google Cloud project.

client_secretstringOptional

The client secret of Google Cloud project.

Responses

200

OK

No content

4XX

Error

post

/admin/google

POST /api/admin/google HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "client_id": "text",
  "client_secret": "text"
}

No content

Retrieve tenant Microsoft 365 provisioning details

get

Retrieve details of tenant Microsoft 365 settings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/ms365

GET /api/ms365 HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Reprovision tenant Microsoft 365 integration.

post

Update tenant Microsoft 365 settings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

national_cloudstring · enumOptional

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.

Default: GLOBALPossible values:

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

Responses

200

OK

No content

4XX

Error

post

/ms365

POST /api/ms365 HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 633

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

No content

Download Microsoft 365 certificate

get

Download Microsoft 365 certificate.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/octet-stream

Responsestring · binary

4XX

Error

get

/ms365/certificate

GET /api/ms365/certificate HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Generate new Microsoft 365 certificate

post

Generate new Microsoft 365 certificate.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/octet-stream

Responsestring · binary

4XX

Error

post

/ms365/certificate

POST /api/ms365/certificate HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Retrieve a collection of Microsoft 365 users

get

Retrieve a collection of Microsoft 365 users.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/ms365/users

GET /api/ms365/users HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "text",
      "name": "text",
      "email": null
    }
  ]
}

Retrieve tenant Google integrations

get

Retrieve details of tenant Google integrations settings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/google

GET /api/google HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "client_id": "text",
  "client_secret": "text",
  "redirect_uri": "text",
  "sbc_redirect_uri": "text",
  "auth_consent_uri": "text"
}

Update tenant Google integration.

post

Update tenant Google integration settings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

client_idstringOptional

The client ID of Google Cloud project.

client_secretstringOptional

The client secret of Google Cloud project.

Responses

200

OK

No content

4XX

Error

post

/google

POST /api/google HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "client_id": "text",
  "client_secret": "text"
}

No content