Create Microsoft Entra ID Application based on Client Credentials grant type

The OAuth 2.0 Client Credentials grant can be used in apps that are installed on a device to gain access to protected resources, such as web APIs. Using the Microsoft identity platform implementation of OAuth 2.0, you can add sign in and API access to your app.

Registering your application establishes a trust relationship between your app and the Microsoft identity platform. The trust is unidirectional: your app trusts the Microsoft identity platform, and not the other way around.

Prerequisites

• An Azure account that has an active subscription.
• The Azure account must have permission to manage applications in Microsoft Entra ID (formerly Azure AD). Any of the following Microsoft Entra ID roles include the required permissions:
  • Application administrator
  • Application developer
  • Cloud application administrator
• Completion of the Set up a tenant quickstart.

Register an application

Follow these steps to create the app registration:

1. Sign in to the Microsoft Azure portal.

2. Search for and select Microsoft Entra ID.

3. Under Manage, select App registrations > New registration.

   a. Enter a display Name for your application.

   b. Specify who can use the application. We recommend using the Accounts in this organizational directory only option.

   c. Don't enter anything for Redirect URI (optional). No redirect URIs are necessary for the Client Credentials grant type.

   d. Select Register to complete the initial app registration.

   

4. When registration finishes, the Azure portal displays the app registration's Overview pane.

Add credentials

Credentials allow your application to authenticate as itself, requiring no interaction from a user at runtime.

Add a client secret

To add client secrets (a string) as credentials to your confidential client app registration, follow these steps:

1. In the Azure portal, in App registrations, select your application.

2. Select Certificates & secrets > Client secrets > New client secret.

   a. Add a description for your client secret.

   b. Select an expiration for the secret or specify a custom lifetime. Client secret lifetime is limited to two years (24 months) or less. You can't specify a custom lifetime longer than 24 months.

   c. Select Add.

Important

Client secret values cannot be viewed again, except for immediately after creation. Be sure to record the secret's value before you leave the page.

For application security recommendations, see Microsoft identity platform best practices and recommendations.

Add API permissions

Permissions allow your application to perform basic operations.

Add permissions to access SharePoint

To configure the client's permissions to the SharePoint API, follow these steps:

1. In the Azure portal, in App registrations, select your application.

2. Select API permissions > Add a permission > Microsoft APIs, select SharePoint.

3. Select the required permission type for the web API.

   Select Application permissions. Application permissions are suitable for scenarios where an application needs to access resources or APIs independently, without user interaction. Its access is restricted to the permissions granted by the administrator.

4. Under Select permissions, expand the resource whose scopes you defined for your web API, and select the permissions the client app should have on behalf of the signed-in user. We recommend using the Sites.Selected option.

5. Select Add permissions to complete the process.

The Configured permissions table on the API permissions pane shows the list of permissions that your application requires for basic operation.

The Grant admin consent for {your tenant} button allows an admin to grant admin consent to the permissions configured for the application. When you select the button, a dialog is shown requesting that you confirm the consent action.

After granting consent, the permissions that required admin consent are shown as having consent granted:

To add permissions for app in SharePoint

The app needs permissions to perform actions in SharePoint. All actions from COSMO Document Management System are executed in app credential context (read, write, create etc.).

1. Go to https://[mytenant].sharepoint.com/sites/[mysubsite]/_layouts/15/appinv.aspx
2. Enter the App Id (Client Id) from the first step and then select Lookup.

3. In the App's Permissions Request XML, enter a valid XML based on SharePoint Add-In Permissions, see https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/add-in-permissions-in-sharepoint
4. Select the Create button.

5. Then select the Trust It button in the next dialog.

Example permissions for reading, writing, and deleting items in all lists/libraries on the sitecollection:

<AppPermissionRequests AllowAppOnlyPolicy="true">
    <AppPermissionRequest Scope="http://sharepoint/content/sitecollection" Right="Write"/>
</AppPermissionRequests>

To execute the library set construction plan, the Full Control permission level is required to create web and lists.

<AppPermissionRequests AllowAppOnlyPolicy="true">
    <AppPermissionRequest Scope="http://sharepoint/content/sitecollection" Right="FullControl"/>
</AppPermissionRequests>

Additional information for AppPermissionRequests

• http://sharepoint/content/sitecollection gives permissions to all webs and subsites inside the sitecollection, no matter on which web the appinv.aspx-permissions were granted

• http://sharepoint/content/sitecollection/web does not inherit permissions to subsites. Permissions must be granted on all subsites (for example, https://[mytenant].sharepoint.com/sites/[mysubsite]/[mysubsubsite]/_layouts/15/appinv.aspx)

• http://sharepoint/content/sitecollection/web/list does not inherit permission to subsites. It gives permission to one specified list after appinv.aspx-permission request. It is possible to add list templates as property.

To validate app principal on web

The app is now permitted on the specified sites. To verify this, go to https://[mytenant].sharepoint.com/sites/[mysubsite]/_layouts/15/appprincipals.aspx and find your app listed.

Pay attention to the scope in the URL, for example https://[mytenant].sharepoint.com/sites/[mysubsite]/_layouts/15/appprincipals.aspx?Scope=Web. Apps with web specific permissions (like http://sharepoint/content/sitecollection/web or http://sharepoint/content/sitecollection/web/list) are listed in web scope. Apps with sitecollection permissions are listed without scope.

Feedback

Submit feedback for this page.