office365-rest-python-client/.env.example at master · vgrem/office365-rest-python-client · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# Copy to .env and fill in the blocks you need:  cp .env.example .env
# tests/settings.py loads it automatically (real environment variables win).
# The same values are shared by the integration tests and every script under examples/.
# Check what is configured at any time with:  python -m tests.doctor
#
# Only step 2 is manual: register ONE app (portal), then set the tenant, client id and
# an admin username below. Everything else can be filled by the guided wizard:
#   python -m tests.setup
# or by individual scripts under examples/ — see "Set up live authentication" in README-dev.md.

# --- Every flow needs an app registration: tenant + client id + admin username ---
# Register the app once: https://learn.microsoft.com/entra/identity-platform/quickstart-register-app
# (create.py --keep registers one for you once an admin app exists)
OFFICE365_TENANT=contoso.onmicrosoft.com
OFFICE365_CLIENT_ID=00000000-0000-0000-0000-000000000000
# Admin used by the setup scripts for interactive consent
OFFICE365_ADMIN_USERNAME=admin@contoso.onmicrosoft.com
# Optional: app the SharePoint setup script signs in with, kept separate from the
# provisioned app above. Written automatically; falls back to OFFICE365_CLIENT_ID.
# OFFICE365_SETUP_CLIENT_ID=

# --- Delegated access: primary test user (also the ROPC account; no MFA) ---
# Grant the delegated scope:   python examples/entraid/applications/grant_delegated_perms.py
# ROPC needs MFA turned off:   python examples/entraid/users/disable_mfa.py
OFFICE365_USERNAME=user1@contoso.onmicrosoft.com
OFFICE365_PASSWORD=

# --- App-only access via client secret (Graph application permissions) ---
# Create the secret (prints CLIENT_SECRET=...):  python examples/entraid/applications/rotate_secret.py
# Grant permissions + admin consent:             python examples/entraid/applications/grant_application_perms.py
OFFICE365_CLIENT_SECRET=

# --- App-only access via certificate (SharePoint / Entra ID App-Only) ---
# Full-cycle setup (cert + Sites.Selected consent + per-site access, prints values):
#   python examples/sharepoint/getting-started/setup_sharepoint_app.py --site https://contoso.sharepoint.com/sites/project
# Certificate + site grant only (app already has Sites.Selected):
#   python examples/sharepoint/auth/setup/certificate_auth.py --site https://contoso.sharepoint.com/sites/project
# Graph app-only with a certificate instead:     python examples/entraid/applications/rotate_cert.py --generate
OFFICE365_CERT_THUMBPRINT=

# --- Optional: derived from OFFICE365_TENANT when omitted ---
# OFFICE365_TENANT_PREFIX=contoso
# OFFICE365_ROOT_SITE_URL=https://contoso.sharepoint.com
# OFFICE365_SITE_URL=https://contoso.sharepoint.com
# OFFICE365_TEAM_SITE_URL=https://contoso.sharepoint.com/sites/team
# OFFICE365_ADMIN_SITE_URL=https://contoso-admin.sharepoint.com
# OFFICE365_CONTENT_TYPE_HUB_URL=https://contoso.sharepoint.com/sites/contentTypeHub
# OFFICE365_CERT_PATH=tests/selfsigncert.pem

# --- Optional: only needed by specific tests (left empty = those tests skip) ---
# Secondary user for sharing / delegation tests
# OFFICE365_USERNAME_ALT=
# Shared mailbox used by the shared-mailbox tests
# OFFICE365_SHARED_MAILBOX_UPN=