Skip to main content

Microsoft Integrations - Authentication

Microsoft integrations (Graph and Azure) in Cortex XSOAR use Azure Active Directory applications to authenticate with Microsoft APIs. These integrations use OAuth 2.0 and OpenID Connect standard-compliant authentication services, which use an Application to sign-in or delegate authentication. For more information, see the Microsoft identity platform overview.

There are 2 application authentication methods available:

  1. Cortex XSOAR Application
  2. Self-Deployed Application

Cortex XSOAR Application#

In this method, you grant consent for the Cortex XSOAR multi-tenant application to access your data. The application is maintained by Cortex XSOAR. Depending on the integration, this requires either admin consent to get access without a user or user consent to get access on behalf of a user. Note: This method requires that you give consent to all permissions requested by the application.

To start the authentication process, go to the integration's detailed instructions:

  1. Navigate to Settings > Integration > Servers & Services.

  2. Search for wanted Microsoft integration, e.g. O365 Outlook Mail (Using Graph API).

  3. Click Add instance.

  4. Click the Link that appears in the Help section:.

  5. In the XSOAR Web Page that appears, click the Start Authorization Process button to initiate the authorization flow.

Self Deployed Application#

To use a self-configured Azure application, you need to add a new Azure App Registration in the Azure Portal.

The application must have the required permissions for the relevant APIs, which are documented in the integration documentation, for example see Microsoft Defender Advanced Threat Protection required permissions.

To add the registration, refer to the Microsoft documentation

The Tenant ID, Client ID, and Client secret are required for the integration.

When you configure the integration in Cortex XSOAR, enter those parameters in the appropriate fields:

  • ID - Client ID
  • Token - Tenant ID
  • Key - Client Secret
    • Alternatively, instead of providing the Client Secret, you can authenticate using certificate credentials by providing:
      • Certificate Thumbprint - The certificate thumbprint as appears when registering the certificate to the App
      • Private Key - The private key of the registered certificate

In addition, make sure to select the Use a self-deployed Azure Application checkbox in the integration instance configuration.

Authorize on behalf of a user#

Some of the Cortex XSOAR-Microsoft integrations (e.g., Azure Sentinel) require authorization on behalf of a user (not admin consent). For more information about this authorization flow, refer to the Microsoft documentation.

To configure a Microsoft integration that uses this authorization flow with a self-deployed Azure application:

  1. Make sure the needed permissions are granted for the app registration, e.g for Microsoft Graph User: API/Permission name Directory.AccessAsUser.All of type Delegated.
  2. The Redirect URI can direct any web application that you wish to receive responses from Azure AD. If you are not sure what to set, you can use https://localhost.
  3. Copy the following URL and replace the TENANT_ID, CLIENT_ID, REDIRECT_URI, SCOPE with your own client ID and redirect URI, accordingly. https://login.microsoftonline.com/TENANT_ID/oauth2/v2.0/authorize?response_type=code&scope=offline_access%20SCOPE&client_id=CLIENT_ID&redirect_uri=REDIRECT_URI For example, for Microsoft Graph User, replace the SCOPE with directory.accessasuser.all.
  4. Enter the link and you will be prompted to grant Cortex XSOAR permissions for your Azure Service Management. You will be automatically redirected to a link with the following structure: REDIRECT_URI?code=AUTH_CODE&session_state=SESSION_STATE
  5. Copy the AUTH_CODE (without the "code=" prefix) and paste it in your instance configuration under the Authorization code parameter.
  6. Enter your client ID in the ID parameter field.
  7. Enter your client secret in the Key parameter field.
  8. Enter your tenant ID in the Token parameter field.
  9. Enter your redirect URI in the Redirect URI parameter field.

Using National Cloud#

Some of the Cortex XSOAR-Microsoft integrations support the deployment of national clouds through the self-deployed authorization flow. For more information about Microsoft National Clouds, refer to the Microsoft documentation. Currently, the following integration supports national clouds:

  • O365 Outlook Mail (Using Graph API)

In order to use a national cloud, change the URL parameter to the corresponding address of the national cloud you are using. For example, see O365 Outlook Mail (Using Graph API) - National Clouds, for the supported cloud endpoints in this integration.

Device Code Flow#

Some of the Cortex XSOAR-Microsoft integrations use the device code flow.

To configure a Microsoft integration that uses this authorization flow with a self-deployed Azure application:

  1. Make sure the needed permissions are granted for the app registration.

  2. The Redirect URI can direct any web application that you wish to receive responses from Azure AD. If you are not sure what to set, you can use https://localhost.

  3. In Supported account types, Accounts in any organizational directory (Any Azure AD directory - Multitenant) should be selected.

  4. In the app registration, navigate to Authentication > Advanced Settings, and enable the mobile and desktop flows.

  5. Enter your application ID in the Application ID parameter field.

Revoke Consent#

In order to revoke consent to a Cortex XSOAR Microsoft application, refer to the Microsoft documentation.

Azure Integrations Parameters#

In order to use the Cortex XSOAR Azure application, you need to fill in your subscription ID and resource group name, which you can find in the Azure Portal.

  1. Log in to the Azure Portal Home Page using your Azure credentials.

  2. Search for your Azure product, for example SQL Servers:

Azure Portal Home Page

  1. Click on your resource:

Choose your resource

After you a redirected to the next page, in the Overview tab you will find your Resource group and Subscription ID:

Overview

Self Deployed Application - Example#

  1. In Microsoft Azure portal, create a new app registration.

    1. Select Azure Active Directory> App registrations> New registration. app

    2. In the Redirect URI (optional) field select Web and type a name (you can enter an arbitrary name). In this example we use https<nolink>://xsoar. reg-app

    3. Click Register.

      You can see the Essential information here: essentials

    4. Copy the following information:

      • Application (client) ID
      • Directory (tenant) ID
  2. Get the client secret, which is used for the key in the integration settings.

    1. Click Certificate and secrets -> New client secret.

      Copy the client secret.

  3. Ensure the needed permissions are granted for the app registration.

    1. Go to API permissions>Add a permission>Microsoft Graph>Delegated permissions and search for Directory.AccessAsUser.All of type Delegated.

    2. Click Add permissions. app-api

      NOTE: Ensure that you have the following permissions:

    • Directory.Read.All - Delegated
    • User.ReadWrite.All - Application
    • User.Read - Delegated
  4. Get the authorization code.

    1. Type the following in a browser: https://login.microsoftonline.com/<tenant_id\>/oauth2/v2.0/authorize?response_type=code&scope=offline_access%20directory.accessasuser.all&client_id=*<client_id\>*&redirect_uri=https%3A%2F%2Fxsoar

    Replace tenant_id and client-id with the tenant ID that was generated in step 1.iv.
    The URI is the https<nolink>://xsoar.

    This prompts the admin user to sign in and grant the app the appropriate permissions: app-perm

    Once completed you are redirected to the redirect URI and will receive an authorization code in the query parameters of the URI.

    NOTE: If there are multiple query parameters returned you should just copy the code value. app-connect

  1. Copy the AUTH_CODE (without the "code=" prefix). This value must be used in the MS Graph User in Cortex XSOAR integration in the Authorization Code field.

  2. Add the information to the instance in Cortex XSOAR by going to Settings>Integrations>Microsoft Graph User>Add Instance.

    1. In the ID parameter field, type the client ID.
    2. in the Token parameter field, type the tenant ID.
    3. In the Key parameter field, type your client secret.
    4. Click the Use a self-deployed Azure application checkbox.
    5. In the Redirect URI field, type the redirect URI we entered in the Azure portal.
    6. In the Authorization code for self-deployed mode - received from the authorization step, type the code that was generated in 4.2.
    7. Save the integration settings and test the setup by running the !msgraph-user-test command from the Cortex XSOAR CLI.