# EntraID

Documentation owner: module `entraid`; documentation version: `2026.28`.
Source: `content/modules/entraid/2026.28/README.mdx` at commit `eaf7a020437971baeee95e87eaf963636040ac71`.

:::note
**Module name:** `EntraID`
:::

The module communicates with Microsoft Graph using certificate-based client credentials. Configure either a certificate file or a keystore-backed certificate and private key.

### Properties

| Name | Description | Default | Mandatory |
| --- | --- | --- | --- |
| `namespace` | Namespace used to correlate module requests and valves. |  | No |
| `http_client_name` | Name of the HttpClient destination. | `"default"` | No |
| `client_id` | Entra application/client ID. |  | Yes |
| `tenant_id` | Entra tenant ID. |  | Yes |
| `assertion_ttl` | Lifetime of the signed client assertion in milliseconds. | `5000` | No |
| `certificate_file_path` | Path to a PKCS12 certificate file. When set, this certificate source is used instead of `keystore`. |  | No |
| `certificate_alias` | Certificate alias in `certificate_file_path`. | `"1"` | No |
| `certificate_password` | Password for `certificate_file_path`. | `""` | No |
| `keystore` | Keystore object containing the certificate and private key. Required when `certificate_file_path` is not configured. |  | No |
| `keystore_alias` | Key alias in the keystore. | `"1"` | No |
| `keystore_password` | Keystore key password when the keystore source is used. |  | No |
| `audit.create` | Record successful create operations in audit. | `false` | No |
| `audit.update` | Record successful update operations in audit. | `false` | No |
| `audit.delete` | Record successful delete operations in audit. | `false` | No |

### Certificate file example

```json
{
  "name": "EntraID",
  "config": {
    "namespace": "default",
    "http_client_name": "default",
    "client_id": "b6e27dbf-8bb8-49bf-a2a0-3a32140b045a",
    "tenant_id": "9576dfaf-0f8a-49d9-982e-40839345c6bc",
    "assertion_ttl": 5000,
    "certificate_file_path": "/path/to/certificate.pfx",
    "certificate_alias": "1",
    "certificate_password": "password",
    "audit": {
      "create": true,
      "update": true,
      "delete": true
    }
  }
}
```
