Microsoft Office 365 Authenticate an Element Instance

You can authenticate with Microsoft to create your own instance of the Microsoft Office 365 element through the UI or through APIs. Once authenticated, you can use the element instance to access the different functionality offered by the Microsoft Office 365 platform.

Note: The Microsoft Office 365 trial does not provide API access. See Microsoft's documentation for additional information on trial and full-featured accounts.

Authenticate Through the UI

Use the UI to authenticate with Microsoft and create an element instance. Because you authenticate with Microsoft via OAuth 2.0, all you need to do is add a name for the instance. After you create the instance, you'll log in to Microsoft Office 365 to authorize Cloud Elements access to your account. For more information about authenticating an element instance, see Authenticate an Element Instance (UI)

After successfully authenticating, we give you several options for next steps. Make requests using the API docs associated with the instance, map the instance to a virtual data resource, or use it in a formula template.

Authenticate Through API

Authenticating through API is a multi-step process that involves:


1
Redirect URL




2
Authenticate Users




3
Authenticate Instance


Getting a Redirect URL


1
Redirect URL




2
Authenticate Users




3
Authenticate Instance


Use the following API call to request a redirect URL where the user can authenticate with the vendor. Replace {keyOrId} with the element key,office365.

GET /elements/{keyOrId}/oauth/url?apiKey=<api_key>&apiSecret=<api_secret>&callbackUrl=<url>&siteAddress=<url>

Query Parameters

Query ParameterDescription
apiKeyThe key obtained from registering your app with the provider. This is the Application (client) ID value that you recorded during Microsoft Office 365 API Provider Setup.
apiSecretThe client secret obtained from registering your app with the provider. This is the Client Secret value that you recorded during Microsoft Office 365 API Provider Setup.
callbackUrlThe URL that will receive the code from the vendor to be used to create an element instance. The default Cloud Elements callback URL is https://auth.cloudelements.io/oauth.

Example cURL

curl -X GET
-H 'Content-Type: application/json'
'https://api.cloud-elements.com/elements/api-v2/elements/office365/oauth/url?apiKey=fake_api_key&apiSecret=fake_api_secret&callbackUrl=https://www.mycoolapp.com/auth&state=office365'

Example Response

Use the oauthUrl in the response to allow users to authenticate with the vendor.

{
"element": "office365",
"oauthUrl": "https://login.microsoftonline.com/common/oauth2/authorize"
}

Authenticating users and receiving the authorization grant code


1
Redirect URL




2
Authenticate Users




3
Authenticate Instance


Provide the response from the previous step to the users. After they authenticate, Microsoft Office 365 provides the following information in the response:

  • code
  • state
Response ParameterDescription
codeThe Authorization Grant Code required by Cloud Elements to retrieve the OAuth access and refresh tokens from the endpoint.
stateA customizable identifier, typically the element key (office365) .
Note: If the user denies authentication and/or authorization, there will be a query string parameter called error instead of the code parameter. In this case, your application can handle the error gracefully.

Authenticating the Element Instance


1
Redirect URL




2
Authenticate Users




3
Authenticate Instance


Use the /instances endpoint to authenticate with Microsoft and create an element instance.

Note: The endpoint returns an element id and token upon successful completion. Retain the token and id for all subsequent requests involving this element instance.

To create an element instance:

  1. Construct a JSON body as shown below (see Parameters):

    {
      "element": {
        "key": "office365"
      },
      "providerData": {
        "code": "<AUTHORIZATION_CODE>"
      },
      "configuration": {
        "oauth.api.secret": "dhi2ioep76lqbtr82jiof90dsyyw7bbznooppe6",
        "oauth.callback.url": "https://auth.cloudelements.io/oauth",
        "oauth.api.key": "fehio889-fes2-9esj-24d2-fi29297sohi",
        "filter.response.nulls": "true",
      },
      "tags": [
        "<ADD_YOUR_TAGS>"
      ],
      "name": "<INSTANCE_NAME>"
    }
  2. Call the following, including the JSON body you constructed in the previous step:

    POST /instances
    
    Note: Make sure that you include the User and Organization keys in the header. For more information, see Authorization Headers, Organization Secret, and User Secret.
  3. Note the Token and ID and save them for all future requests using the element instance.

Example cURL

{"element": {
      "key": "office365"
    },
    "providerData": {
      "code": "8aa74ff8ae16ba3ca19defiefho29f79waff16bddcd7"
    },
  "configuration": {
      "oauth.api.secret": "dhi2ioe5252rodypsoe82jiof90ds234df2oppe6",
      "oauth.callback.url": "https://auth.cloudelements.io/oauth",
      "oauth.api.key": "fehi241i9-fes2-9esj-24d2-w2oop8douowwq",
      "filter.response.nulls": "true",

    "tags": [
      "Test"
    ],
    "name": "API Instance"}
} 

Parameters

API parameters not shown in Cloud Elements are in code formatting. In addition, event-related parameters are described in Microsoft Office 365 Events.

ParameterDescriptionData Type
'key'The element key.
office365
string
Name
name
The name for the element instance created during authentication.Body
oauth.callback.urlThe Callback URL for the connected app you registered. This value is https://auth.cloudelements.io/oauth.string
oauth.api.keyYour Microsoft Office 365 OAuth API key. This is a value you recorded during Microsoft Office 365 API Provider Setup.string
oauth.api.secretYour Microsoft Office 365 OAuth API secret. This is a value you recorded during Microsoft Office 365 API Provider Setup.string
tagsOptional. User-defined tags to further identify the instance.string

Example Response for an Authenticated Element Instance

{
  "id": 12345,
  "name": "myCoolInstance",
  "createdDate": "2019-08-03T14:41:52Z",
  "token": "5MOxxxxxxxxxxxxxxxxxxxxxxxxx",
  "element": {
    "id": 7601,
    "name": "Microsoft Office 365",
    "key": "office365",
    "description": "Add a Microsoft Office 365 instance to connect your existing Office 365 account to the Productivity Hub, allowing you to manage your mails, calendar, documents etc., all under the same umbrella. You will need your Microsoft Office 365 account information, including registered applications, to add an instance.",
    "image": "elements/provider_office365.png",
    "active": true,
    "deleted": false,
    "typeOauth": true,
    "trialAccount": false,
    "configDescription": "If you do not have a Microsoft Office 365 account, visit Microsoft.com for additional information.",
    "transformationsEnabled": false,
    "bulkDownloadEnabled": true,
    "bulkUploadEnabled": true,
    "cloneable": false,
    "extendable": false,
    "beta": false,
    "authentication": {
      "type": "oauth2"
    },
    "extended": false,
    "hub": "productivity",
    "protocolType": "http",
    "parameters": [],
    "private": false
  },
  "provisionInteractions": [],
  "valid": true,
  "disabled": false,
  "maxCacheSize": 0,
  "cacheTimeToLive": 0,
  "configuration": {},
  "eventsEnabled": false,
  "traceLoggingEnabled": false,
  "cachingEnabled": false,
  "externalAuthentication": "none",
  "user": {
    "id": 12345
  }
}