How to Check AAD/SPO Connection Using Advantco REST Workbench

Recently, I had a chance to work with windows Azure and SharePoint integration with SAP PI 7.4. In this blog, I will be sharing the use of Advantco REST adapter workbench and how to check AAD/SPO connection from the same.

1. PREPARATION STEPS:

STEP 1: Login to REST Workbench. For example, we have different URLs to access the REST WB in different environments.

STEP 2: Load the required channel from the options and by clicking “Load from channel configuration”. (Refer below)

Best Practice-Table 1: AAD/SPO Connection details: (Prepare this table for your ease. It will be a single point of reference for all your scenario configurations in various environments)

Eg:

This detail is configured in the “Authentication /Authorization” tab in the REST workbench.

Note:

The Client secret can either encoded or decoded using the online tool, http://www.urldecoder.org/

2. Testing AAD connection:

• Go to “Authentication/Authorization” Tab in the REST workbench.
• Fill in the required details manually from Table1 above to test the AAD connection, in case you are not loading the details from the channel.

• Click “Test Auth Configuration” button. If the connection is successful, we will get HTTP 200 response.

Sample AAD Operation: Eg Update Azure User details

• It is a POST request.
• The resource URL should be https://graph.windows.net/mysaptest.onmicrosoft.com/users/%UserID%
• The highlighted portion is the user ID that we want to update.( Eg: ab.cd@mysaptest.onmicrosoft.com)
• The required HTTP headers are added in the request.
• The response can be HTTP 204 status, without response payload.

Below is an example of updating the Azure user information from REST Workbench.

Azure Screenshot:

This confirms that we could connect to Azure system from REST WB.

Azure related information can be seen under the site, https://msdn.microsoft.com/en-us/library/azure/

3. Testing SPO Connection:

We have to get the Request Digest Token in order to do any SPO operation. This involves three steps;

STEP 1: Get Authorization Token

• It is a POST request.
• Resource URL should be https://login.microsoftonline.com/rst2.srf
• Authentication should be OAuth2.0 with the details given in Table1.

• Refer below, for the request that should be “posted” (remember HTTP Get/Post methods?) in this step. Change the Username and password fields in the below request according to the environment. This is for the service account we have in SPO.

• Click “Execute Request” button.
• The response would be an xml. The value inside the tag “<wsse:BinarySecurityToken Id=”Compact0″>” is the authorization token.

Eg: The token would be looking like below value;

• Concatenate “BPOSIDCRL” to the above value. We can call it as “AUTHTOKEN_VALUE”

STEP 2: Get Cookie.

• It is a GET request.
• Resource URL should be https://mysaptest.sharepoint.com/sites/XYZ/_vti_bin/idcrl.svc/
• The above highlighted part will change according to the environment. Refer Table 1.
• From this step, we don’t need OAuth2.0 authorization. So, it should be set to null.
• In the “HTTP Headers” section, paste the “AUTHTOKEN_VALUE” with the name “Authorization“
• Click “Execute Request” button. The successful response is indicated by HTTP 200 status code.

Eg:

• The value returned by the header “Set-Cookie” is the cookie value. Let us call it as “COOKIE_VALUE”.

Sample Cookie Value:

STEP 3: Get Digest Token

• It is a POST request.
• The Resource URL should be https://mysaptest.sharepoint.com/sites/XYZ/_api/contextinfo
• The above highlighted part will change according to the environment. Refer Table 1.
• In the “HTTP Headers” section, paste the “COOKIE_VALUE” with the name “Cookie“
• We don’t need to paste anything in the Request Body section.
• The response would be an XML like below;

• The Digest Value is the highlighted portion above. (I.e) The value inside the tag, <d:FormDigestValue>.

So, now we have the Digest Token to do any operation in SharePoint site.

SAMPLE SPO OPERATION: Create SPO Site:

• It is a POST request.
• Resource URL should be, https://mysaptest.sharepoint.com/sites/XYZ/_api/web/webinfos/add
• Insert the headers “cookie” and “X-RequestDigest”.
• Click “Execute Request” button.
• The response would be with HTTP 200 or HTTP 204 header with/without an XML depending on the operation.

This confirms that we could connect to SharePoint Online system from REST Workbench.