From 738ce569558e79ea7360e42be7b60fddd97adf78 Mon Sep 17 00:00:00 2001 From: Hugo Pereira Brito <101209179+HugoPBrito@users.noreply.github.com> Date: Wed, 23 Apr 2025 15:58:32 +0200 Subject: [PATCH] fix(docs): overview m365 auth (#7588) --- docs/getting-started/requirements.md | 9 ++++++++- docs/index.md | 4 ++++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/getting-started/requirements.md b/docs/getting-started/requirements.md index 6e4ba9c267..81791b1b31 100644 --- a/docs/getting-started/requirements.md +++ b/docs/getting-started/requirements.md @@ -134,6 +134,8 @@ Prowler for M365 currently supports the following authentication types: ### Service Principal authentication +Authentication flag: `--sp-env-auth` + To allow Prowler assume the service principal identity to start the scan it is needed to configure the following environment variables: ```console @@ -146,6 +148,9 @@ If you try to execute Prowler with the `--sp-env-auth` flag and those variables Follow the instructions in the [Create Prowler Service Principal](../tutorials/azure/create-prowler-service-principal.md) section to create a service principal. ### Service Principal and User Credentials authentication (recommended) + +Authentication flag: `--env-auth` + This authentication method follows the same approach as the service principal method but introduces two additional environment variables for user credentials: `M365_USER` and `M365_ENCRYPTED_PASSWORD`. ```console @@ -176,4 +181,6 @@ Write-Output $encryptedPassword ### Interactive Browser authentication -To use `--browser-auth` the user needs to authenticate against Azure using the default browser to start the scan, also `--tenant-id` flag is required. +Authentication flag: `--browser-auth` + +This authentication method requires the user to authenticate against Azure using the default browser to start the scan, also `--tenant-id` flag is required. diff --git a/docs/index.md b/docs/index.md index ac8d50461f..ff63c9fd02 100644 --- a/docs/index.md +++ b/docs/index.md @@ -570,6 +570,10 @@ kubectl logs prowler-XXXXX --namespace prowler-ns With M365 you need to specify which auth method is going to be used: ```console + +# To use both service principal (for MSGraph) and user credentials (for PowerShell modules) +prowler m365 --env-auth + # To use service principal authentication prowler m365 --sp-env-auth