Connect to Dynamics 365 Common Data Service with OAuth 2.0

Recently, I had a requirement to connect to CDS using OAuth 2.0 so that an AAD token can be generated without having to prompt a user for sign in. I have listed out the steps below to achieve this.

App Registration

  1. Login to azure portal.
  2. Navigate to 'Azure Active Directory' > 'App registrations' > 'New registration'


  3. Enter the name of the app register and click 'Register' to create a new app registration


  4. Open 'API permissions' within the app registration, click 'Add a permissions' and choose 'Dynamics CRM'



  5. Select 'Delegated permissions', check 'user_impersonation' and click 'Add permission'


  6. Click 'Grant admin consent'


  7. Navigate to 'Certificates & secrets' and generate a 'New client secret'. Keep a copy of the client secret. 
  8. Navigate to overview and copy the 'Client Id/Application Id'
  9. Click Endpoints and copy the 'OAuth 2.0 token endpoint'

Common Data Service

  1. Login to your CDS environment and navigate to 'Advanced Settings' > 'Security' > 'Users'


  2. Select 'Application Users' and click 'New'

  3. Enter the 'Name', 'User Name' and 'Email Address' for the user. Enter the 'Application ID' that was copied earlier. When the record is saved the 'Application ID URI' and 'Azure Object ID' will be automatically created.


  4. Click on manage roles and assign 'System Administrator' role to the user.

Generate AAD Token

The AAD token can be generated as follows;

clientId -  this is the application Id of the app registration created earlier
clientSecret - this is the secret generated for the app registration earlier
url - this is the OAuth 2.0 token endpoint
resourceURI - this is the API url, for example, https://orgxxx.crm.dynamics.com

ClientCredential clientCrendential = new ClientCredential(clientId, clientSecret);
AuthenticationContext authContext = new AuthenticationContext(url);
AuthenticationResult authResult = await authContext.AcquireTokenAsync(resourceUri, clientCrendential);
string token = authResult.AccessToken;

Read data

I was able to extract data from entities using the following code;

URL - this is the odata url for example, https://orgxxx.crm.dynamics.com/api/data/v9.0/

HttpClient httpClient = new HttpClient();
httpClient.DefaultRequestHeaders.Add("OData-MaxVersion", "4.0");
httpClient.DefaultRequestHeaders.Add("OData-Version", "4.0");
httpClient.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token);

httpClient.BaseAddress = new Uri(URL);
HttpRequestMessage getRequest = new HttpRequestMessage(HttpMethod.Get, queryOptions);

HttpResponseMessage result = await httpClient.SendAsync(getRequest);

Comments

Post a Comment

Popular posts from this blog

D365FO - Create a multi-select lookup in batch jobs

Image
D365FO - Create a multi-select lookup in batch jobs In this article, I will be describing how we can create a multi-select lookup for display within the batch job dialog. Contract class Create a new variable of type 'List'. This will store the selected values of the user for the dropdown from the dialog. Create a parm method to access the new list object Ensure to specify the DataMember attribute Add an appropriate label Specify the data type for the list's content Ensure to specify the DataContract and SysOperationContactProcessing attributes above the class declaration. An UI builder is also required. The requirements for this is explained in the next section. Example: UI builder class Create an UI builder class that extends SrsReportDataContractUIBuilder Add a new variable of type 'DialogField'. This will be displayed on the UI for user. Implement the postBuild method. Initialize the contract from this.dataContractObject() and bind the dialog field variable to th...
Read more

Generate and download a csv file using X++

Within Dynamics 365 HQ we often need to be able to export data as a csv file. This article explains how we can generate a csv file. The following lines of code can be used to create and download a csv file Create a writable stream. CommaStreamIo streamIO = CommaStreamIo::constructForWrite();   streamIO.writeExp('Id', 'Title'); // These will represent the header of the csv file  streamIO.writeExp('001', 'Science'); // Row 1 streamIO.writeExp('002', 'Nature'); // Row 2 // Get the stream System.IO.Stream        stream              = streamIO.getStream(); const str               extensionCsv        = '.csv'; stream.Position = 0; // StreamReader to read as str System.IO.StreamReader...
Read more

Creating a batch job with query based filter in D365 back-office

There are often business processes that requires us to run specific operations as a batch process. Dynamics 365 Head quarters (HQ) allows us to be able to periodically execute batch jobs. To create a custom batch job you need to extend the  RunBaseBatch class. The following lines of code show how we can create a simple export job.  class InvoiceExport extends RunBaseBatch {      Query                   query;     QueryRun                invoiceQueryRun; // QueryRun object that will be used to generate data for invoices to be exported.      DialogGroup             dialogGroupSetup; // This is a dialog group.     DialogField      ...
Read more