DOC-983: Update Microsoft credentials (#2298)

This commit is contained in:
Kate Mueller 2024-08-05 03:48:22 -04:00 committed by GitHub
parent d513440826
commit 0bb40f556a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 85 additions and 41 deletions

View File

@ -12,7 +12,7 @@ Use the Microsoft Dynamics CRM node to automate work in Microsoft Dynamics CRM,
On this page, you'll find a list of operations the Microsoft Dynamics CRM node supports and links to more resources.
/// note | Credentials
Refer to [Microsoft Dynamics CRM credentials](/integrations/builtin/credentials/microsoft/) for guidance on setting up authentication.
Refer to [Microsoft credentials](/integrations/builtin/credentials/microsoft/) for guidance on setting up authentication.
///
## Operations

View File

@ -13,7 +13,7 @@ Use the Microsoft Excel node to automate work in Microsoft Excel, and integrate
On this page, you'll find a list of operations the Microsoft Excel node supports and links to more resources.
/// note | Credentials
Refer to [Microsoft Excel credentials](/integrations/builtin/credentials/microsoft/) for guidance on setting up authentication.
Refer to [Microsoft credentials](/integrations/builtin/credentials/microsoft/) for guidance on setting up authentication.
///
## Operations

View File

@ -12,7 +12,7 @@ Use the Microsoft Graph Security node to automate work in Microsoft Graph Securi
On this page, you'll find a list of operations the Microsoft Graph Security node supports and links to more resources.
/// note | Credentials
Refer to [Microsoft Graph Security credentials](/integrations/builtin/credentials/microsoft/) for guidance on setting up authentication.
Refer to [Microsoft credentials](/integrations/builtin/credentials/microsoft/) for guidance on setting up authentication.
///
## Operations

View File

@ -13,7 +13,7 @@ Use the Microsoft OneDrive node to automate work in Microsoft OneDrive, and inte
On this page, you'll find a list of operations the Microsoft OneDrive node supports and links to more resources.
/// note | Credentials
Refer to [Microsoft OneDrive credentials](/integrations/builtin/credentials/microsoft/) for guidance on setting up authentication.
Refer to [Microsoft credentials](/integrations/builtin/credentials/microsoft/) for guidance on setting up authentication.
///
## Operations

View File

@ -13,7 +13,7 @@ Use the Microsoft Outlook node to automate work in Microsoft Outlook, and integr
On this page, you'll find a list of operations the Microsoft Outlook node supports and links to more resources.
/// note | Credentials
Refer to [Microsoft Outlook credentials](/integrations/builtin/credentials/microsoft/) for guidance on setting up authentication.
Refer to [Microsoft credentials](/integrations/builtin/credentials/microsoft/) for guidance on setting up authentication.
///
## Operations

View File

@ -13,7 +13,7 @@ Use the Microsoft Teams node to automate work in Microsoft Teams, and integrate
On this page, you'll find a list of operations the Microsoft Teams node supports and links to more resources.
/// note | Credentials
Refer to [Microsoft credentials](/integrations/builtin/credentials/microsoft/) for guidance on setting up authentication.
Refer to [Microsoft credentials](/integrations/builtin/credentials/microsoft/) for guidance on setting up authentication.
///
## Operations

View File

@ -12,7 +12,7 @@ Use the Microsoft To Do node to automate work in Microsoft To Do, and integrate
On this page, you'll find a list of operations the Microsoft To Do node supports and links to more resources.
/// note | Credentials
Refer to [Microsoft To Do credentials](/integrations/builtin/credentials/microsoft/) for guidance on setting up authentication.
Refer to [Microsoft credentials](/integrations/builtin/credentials/microsoft/) for guidance on setting up authentication.
///
## Operations

View File

@ -45,51 +45,68 @@ Refer to the linked Microsoft API documentation below for more information about
Some Microsoft services require extra information for OAuth2. Refer to [Service-specific settings](#service-specific-settings) for more guidance on those services.
To configure OAuth2 from scratch, [register an application with the Microsoft Identity Platform](https://learn.microsoft.com/en-us/graph/auth-register-app-v2){:target=_blank .external-link} and follow the instructions below:
For self-hosted users, there are two main steps to configure OAuth2 from scratch:
1. [Register an application](#register-an-application) with the Microsoft Identity Platform.
2. [Generate a client secret](#generate-a-client-secret) for that application.
Follow the detailed instructions for each step below. For more detail on the Microsoft OAuth2 web flow, refer to [Microsoft authentication and authorization basics](https://learn.microsoft.com/en-us/graph/auth/auth-concepts){:target=_blank .external-link}.
### Register an application
Register an application with the Microsoft Identity Platform:
1. Open the [Microsoft Application Registration Portal](https://aka.ms/appregistrations){:target=_blank .external-link}.
2. Select **Register an application**.
3. Enter a name for your app in the **Name** field.
3. Enter a **Name** for your app.
4. In **Supported account types**, select **Accounts in any organizational directory (Any Azure AD directory - Multi-tenant) and personal Microsoft accounts (for example, Skype, Xbox)**.
5. In **Register an application**:
1. Copy the **OAuth Callback URL** from your n8n credential.
2. Paste it into the **Redirect URI (optional)** field.
3. Select **Select a platform** > **Web**.
6. Select **Register** to finish creating your application.
7. Copy the **Application (client) ID**.
8. Paste it into n8n as the **Client ID**.
9. On your Microsoft application page, select **Certificates & secrets** in the left sidebar.
10. In **Client secrets**, select **+ New client secret**. Refer to the instructions in [Add credentials](https://learn.microsoft.com/en-us/graph/auth-register-app-v2#add-credentials){:target=_blank .external-link} for further details.
11. Enter a description in the **Description** field, such as `n8n credential`.
12. Select **Add**.
13. Copy the **Secret** in the **Value** column.
14. Paste it into n8n as the **Client Secret**.
15. If you see other fields in the n8n credential, refer to [Service-specific settings](#service-specific-settings) below for guidance on completing those fields.
16. Select the circle button in the OAuth section to connect a Microsoft account to n8n.
17. Log in to your Microsoft account and allow the app to access your info.
7. Copy the **Application (client) ID** and paste it into n8n as the **Client ID**.
For more detail on the Microsoft OAuth2 web flow, refer to [Microsoft authentication and authorization basics](https://learn.microsoft.com/en-us/graph/auth/auth-concepts){:target=_blank .external-link}.
Refer to [Register an application with the Microsoft Identity Platform](https://learn.microsoft.com/en-us/graph/auth-register-app-v2){:target=_blank .external-link} for more information.
## Service-specific settings
### Generate a client secret
With your application created, generate a client secret for it:
1. On your Microsoft application page, select **Certificates & secrets** in the left navigation.
1. In **Client secrets**, select **+ New client secret**.
1. Enter a **Description** for your client secret, such as `n8n credential`.
1. Select **Add**.
1. Copy the **Secret** in the **Value** column.
1. Paste it into n8n as the **Client Secret**.
1. If you see other fields in the n8n credential, refer to [Service-specific settings](#service-specific-settings) below for guidance on completing those fields.
1. Select **Connect my account** in n8n to finish setting up the connection.
1. Log in to your Microsoft account and allow the app to access your info.
Refer to Microsoft's [Add credentials](https://learn.microsoft.com/en-us/graph/auth-register-app-v2#add-credentials){:target=_blank .external-link} for more information on adding a client secret.
### Service-specific settings
The following services require extra information for OAuth2:
### Dynamics
#### Dynamics
Dynamics OAuth2 also requires these fields:
Dynamics OAuth2 requires information about your Dynamics domain and region. Follow these extra steps to complete the credential:
- Your **Domain**
- **Region**: Select the Dynamics datacenter region you're within. Refer to the [Microsoft Datacenter regions documentation](https://learn.microsoft.com/en-us/power-platform/admin/new-datacenter-regions){:target=_blank .external-link} for more information on the options and corresponding URLs.
1. Enter your Dynamics **Domain**.
2. Select the Dynamics data center **Region** you're within.
### Microsoft (general)
Refer to the [Microsoft Datacenter regions documentation](https://learn.microsoft.com/en-us/power-platform/admin/new-datacenter-regions){:target=_blank .external-link} for more information on the region options and corresponding URLs.
The general Microsoft OAuth2 also requires these fields:
#### Microsoft (general)
- **Scope**: Provide a space-separated list of scopes for this credential. Refer to [Scopes and permissions in the Microsoft identity platform](https://learn.microsoft.com/en-us/entra/identity-platform/scopes-oidc){:target=_blank .external-link} for a list of possible scopes.
The general Microsoft OAuth2 also requires you to provide a space-separated list of **Scope**s for this credential.
### Outlook
Refer to [Scopes and permissions in the Microsoft identity platform](https://learn.microsoft.com/en-us/entra/identity-platform/scopes-oidc){:target=_blank .external-link} for a list of possible scopes.
Outlook OAuth also requires these fields:
#### Outlook
- **Use Shared Inbox**: The API supports accessing a user's primary email inbox or a shared inbox. Turning this on indicates that the credential should access a shared inbox. If selected, you'll also need:
- **User Principal Name**: Enter the target user's UPN or ID.
Outlook OAuth2 supports the credential accessing a user's primary email inbox or a shared inbox. By default, the credential will access a user's primary email inbox. To change this behavior:
1. Turn on **Use Shared Inbox**.
2. Enter the target user's UPN or ID as the **User Principal Name**.

View File

@ -28,14 +28,41 @@ This is a credential-only node. Refer to [Custom API operations](/integrations/c
--8<-- "_snippets/integrations/builtin/credentials/cloud-oauth-button.md"
If you need more detail on what's happening in the Microsoft OAuth web flow, refer to [Microsoft authentication and authorization basics](https://learn.microsoft.com/en-us/graph/auth/auth-concepts){:target=_blank .external-link}.
For self-hosted users, there are two main steps to configure OAuth2 from scratch:
To configure OAuth2 from scratch, [register an application with the Microsoft Identity Platform](https://learn.microsoft.com/en-us/graph/auth-register-app-v2){:target=_blank .external-link}.
1. [Register an application](#register-an-application) with the Microsoft Identity Platform.
2. [Generate a client secret](#generate-a-client-secret) for that application.
Use these settings for your application:
Follow the detailed instructions for each step below. For more detail on the Microsoft OAuth2 web flow, refer to [Microsoft authentication and authorization basics](https://learn.microsoft.com/en-us/graph/auth/auth-concepts){:target=_blank .external-link}.
- For **Supported account types**, select **Accounts in any organizational directory (Any Azure AD directory - Multi-tenant) and personal Microsoft accounts (for example, Skype, Xbox)**.
- Copy the **OAuth Callback URL** from n8n and use that as the **Redirect URI** in your Microsoft application.
- Copy the **Application (client) ID** from your Microsoft application and add it as the **Client ID** in n8n.
- Generate a new client secret in your application. Refer to the instructions in [Add credentials](https://learn.microsoft.com/en-us/graph/auth-register-app-v2#add-credentials){:target=_blank .external-link}.
- Copy the secret's **Value** and add it as the **Client Secret** in n8n.
### Register an application
Register an application with the Microsoft Identity Platform:
1. Open the [Microsoft Application Registration Portal](https://aka.ms/appregistrations){:target=_blank .external-link}.
2. Select **Register an application**.
3. Enter a **Name** for your app.
4. In **Supported account types**, select **Accounts in any organizational directory (Any Azure AD directory - Multi-tenant) and personal Microsoft accounts (for example, Skype, Xbox)**.
5. In **Register an application**:
1. Copy the **OAuth Callback URL** from your n8n credential.
2. Paste it into the **Redirect URI (optional)** field.
3. Select **Select a platform** > **Web**.
6. Select **Register** to finish creating your application.
7. Copy the **Application (client) ID** and paste it into n8n as the **Client ID**.
Refer to [Register an application with the Microsoft Identity Platform](https://learn.microsoft.com/en-us/graph/auth-register-app-v2){:target=_blank .external-link} for more information.
### Generate a client secret
With your application created, generate a client secret for it:
1. On your Microsoft application page, select **Certificates & secrets** in the left navigation.
1. In **Client secrets**, select **+ New client secret**.
1. Enter a **Description** for your client secret, such as `n8n credential`.
1. Select **Add**.
1. Copy the **Secret** in the **Value** column.
1. Paste it into n8n as the **Client Secret**.
1. Select **Connect my account** in n8n to finish setting up the connection.
1. Log in to your Microsoft account and allow the app to access your info.
Refer to Microsoft's [Add credentials](https://learn.microsoft.com/en-us/graph/auth-register-app-v2#add-credentials){:target=_blank .external-link} for more information on adding a client secret.