Identity Provider

Master this essential documentation concept

Quick Definition

A trusted system or service (such as Okta, Azure AD, or Google) that manages and verifies user identities, enabling SSO and centralized authentication across multiple applications.

How Identity Provider Works

sequenceDiagram participant U as User Browser participant SP as Service Provider
(App/SaaS Tool) participant IdP as Identity Provider
(Okta / Azure AD) participant Dir as User Directory
(LDAP / AD) U->>SP: Access protected resource SP-->>U: Redirect to IdP (SAML/OIDC request) U->>IdP: Present login credentials IdP->>Dir: Validate user identity & fetch attributes Dir-->>IdP: User verified + group memberships IdP-->>U: Issue signed token (SAML assertion / JWT) U->>SP: Submit token to Service Provider SP-->>U: Grant access based on IdP claims Note over IdP,SP: SSO session established — subsequent apps skip re-authentication

Understanding Identity Provider

A trusted system or service (such as Okta, Azure AD, or Google) that manages and verifies user identities, enabling SSO and centralized authentication across multiple applications.

Key Features

  • Centralized information management
  • Improved documentation workflows
  • Better team collaboration
  • Enhanced user experience

Benefits for Documentation Teams

  • Reduces repetitive documentation tasks
  • Improves content consistency
  • Enables better content reuse
  • Streamlines review processes

Documenting Your Identity Provider Configuration Before It Lives Only in a Recording

When your team sets up or migrates an identity provider like Okta or Azure AD, the walkthrough almost always happens on a call. An engineer shares their screen, steps through the SAML configuration, explains the attribute mappings, and answers questions in real time. The session gets recorded, and everyone agrees it was useful — until three months later when a new team member needs to troubleshoot an SSO issue and has to scrub through 47 minutes of video to find the one screen where the redirect URI was configured.

This is a genuine problem with identity provider documentation specifically, because the configuration details matter enormously. A missed claim mapping or an incorrect audience URI can break authentication across every connected application. That context rarely survives in a video format that no one can search, skim, or reference quickly under pressure.

Converting those setup recordings and onboarding walkthroughs into structured documentation gives your team something they can actually use: searchable steps, copyable configuration values, and clear explanations of why each identity provider setting exists — not just what it is. When someone needs to add a new application to your SSO setup at 11pm, they need a doc, not a recording.

Real-World Documentation Use Cases

Onboarding 500 Engineers to an Internal Developer Portal via Okta SSO

Problem

Engineering teams manually provision accounts across Confluence, GitHub Enterprise, Jira, and internal dashboards for every new hire, causing 2–3 day delays and inconsistent access permissions that create security audit failures.

Solution

The Identity Provider (Okta) becomes the single source of truth for user identity. New hires are added to Okta once, and group-based SAML/OIDC integrations automatically provision accounts and role-based access across all connected tools.

Implementation

['Configure Okta as the SAML 2.0 IdP for each tool (Confluence, GitHub Enterprise, Jira) by uploading the IdP metadata XML and setting attribute mappings for email, department, and role.', "Define Okta groups (e.g., 'eng-backend', 'eng-frontend') and assign those groups to each application with corresponding permission levels using Okta's Application Assignment rules.", 'Enable SCIM provisioning between Okta and each tool so that group membership changes in Okta automatically create, update, or deactivate accounts in downstream apps within minutes.', 'Document the onboarding runbook in the developer portal itself, linking to the Okta admin guide and specifying which groups grant which tool access, so IT and team leads can self-serve.']

Expected Outcome

New engineer access provisioning drops from 2–3 days to under 15 minutes, and security audits show 100% consistent role assignments with a full audit trail in Okta's system log.

Enforcing MFA Across All Documentation Portals Using Azure AD Conditional Access

Problem

A SaaS company's internal documentation (Notion, Confluence, SharePoint) is accessible with just a username and password. After a credential-stuffing attack exposed sensitive product roadmaps, the security team mandates MFA but cannot enforce it consistently across each tool individually.

Solution

Azure Active Directory acts as the central Identity Provider for all documentation platforms via OIDC. Conditional Access policies in Azure AD enforce MFA requirements universally — any login attempt to any connected documentation tool triggers the MFA challenge at the IdP level before a token is issued.

Implementation

['Register Notion, Confluence Cloud, and SharePoint as Enterprise Applications in Azure AD, configuring OIDC client credentials and redirect URIs for each.', "Create a Conditional Access policy in Azure AD targeting the 'Documentation Tools' application group, requiring MFA for all users and blocking access from non-compliant or unmanaged devices.", "Set the MFA method to Microsoft Authenticator push notifications via Azure AD's Authentication Methods policy, and run a 2-week pilot with the engineering team before rolling out company-wide.", 'Publish a user-facing guide in SharePoint explaining the new MFA login flow with screenshots of each step, and update the IT helpdesk runbook with troubleshooting steps for locked-out users.']

Expected Outcome

MFA adoption reaches 100% across all documentation tools within one policy change. The security team gains a single Azure AD sign-in log showing all authentication events, reducing incident investigation time from hours to minutes.

Migrating a Legacy VPN-Based Doc System to Google Workspace IdP with SAML

Problem

A mid-size company requires employees to connect to a VPN before accessing internal documentation hosted on a self-managed Confluence server. Remote workers experience frequent VPN dropouts, and the IT team spends 40% of their support hours on VPN-related access issues.

Solution

Google Workspace is configured as the SAML Identity Provider for Confluence, replacing VPN-gated access with identity-based authentication. Employees authenticate through Google's familiar login page, and Confluence trusts the signed SAML assertion from Google to grant access from any network.

Implementation

["In Google Admin Console, create a Custom SAML App for Confluence, downloading the IdP metadata (Entity ID, SSO URL, certificate) and configuring the ACS URL and Entity ID from Confluence's SAML settings.", "Map Google Workspace attributes (email, department, Google Groups) to Confluence's user and group fields so that Confluence Space permissions align automatically with existing Google Group membership.", 'Run a parallel access period of two weeks where both VPN and SAML login are available, monitoring Confluence access logs to confirm SAML logins are succeeding before decommissioning VPN access.', 'Update the internal IT documentation to reflect the new login URL, publish a 60-second video walkthrough of the Google SSO login flow for Confluence, and set up a redirect from the old VPN-only URL.']

Expected Outcome

VPN-related support tickets drop by 85%. Employees access documentation 3x faster without VPN latency, and IT reclaims 40% of support bandwidth previously spent on VPN troubleshooting.

Granting Temporary Contractor Access to API Documentation via IdP Guest Accounts

Problem

External contractors need time-limited access to a company's internal API documentation portal (hosted on Backstage or ReadMe) to complete an integration project. Currently, full Active Directory accounts are created for contractors and are frequently never deactivated, creating orphaned accounts that fail compliance audits.

Solution

Azure AD B2B Guest Accounts are used as the Identity Provider mechanism for contractor access. Guest accounts are issued with a defined expiration date, and the API documentation portal trusts Azure AD as its IdP. When the guest account expires, access to all connected tools is automatically revoked.

Implementation

["Invite contractors as Azure AD B2B Guest users via the Azure Portal, setting an account expiration date matching the project end date and assigning them only to the 'External-API-Docs' security group.", "Configure the internal API documentation portal (e.g., Backstage) to use Azure AD as its OIDC provider, restricting access to users in the 'External-API-Docs' group via the app's role assignment settings.", 'Create an Azure AD Access Review scheduled to run monthly, automatically flagging guest accounts with no recent sign-in activity for removal and notifying the project manager to confirm continued need.', 'Document the contractor access request process in the IT service catalog, including the form to submit contractor details, the expected provisioning time (under 1 hour), and the automatic expiration policy.']

Expected Outcome

Zero orphaned contractor accounts remain after project completion. Compliance audits confirm all external access is time-bound and logged, and contractor onboarding time drops from 2 days to under 1 hour.

Best Practices

Map IdP Group Attributes to Application Roles Before Going Live

Before enabling SSO for any application, explicitly define how IdP groups (e.g., Okta groups or Azure AD security groups) map to application-level roles. Failing to plan attribute mapping results in all SSO users landing in a default low-permission role, causing immediate access complaints and emergency reconfiguration during rollout.

✓ Do: Create a role-mapping matrix document listing each IdP group, its corresponding application role (e.g., 'okta-group: eng-leads' → 'Confluence role: Space Admin'), and test the mapping in a staging environment before production cutover.
✗ Don't: Do not rely on just-in-time provisioning without pre-defining role mappings, and never assign all SSO users to a single generic role with the intent to 'sort it out later' — this creates a permission sprawl that is difficult to audit and remediate.

Always Configure a Break-Glass Admin Account Outside the IdP

If the Identity Provider experiences an outage (Okta, Azure AD, or Google can and do have incidents), every application relying on SSO becomes inaccessible unless a local fallback admin account exists. This is a critical operational risk that affects the ability to restore services during an IdP outage.

✓ Do: Create at least one local administrator account in each critical application (e.g., a local Confluence admin, a local Jira admin) that uses password authentication independent of the IdP, store the credentials in a hardware-secured password vault (e.g., HashiCorp Vault or 1Password Teams), and document the break-glass procedure in your incident runbook.
✗ Don't: Do not disable or remove all local authentication methods when enabling SSO, and never store break-glass credentials in a system that itself requires IdP authentication to access.

Validate SAML Token Signing Certificates Before and After Renewal

SAML integrations rely on a signing certificate issued by the Identity Provider. When this certificate expires or is rotated, all SAML-based SSO integrations break simultaneously unless the new certificate is uploaded to every Service Provider in advance. Certificate expiry is one of the most common causes of unexpected SSO outages.

✓ Do: Set calendar reminders 60 and 30 days before IdP signing certificate expiration, maintain a registry of all SAML-integrated applications with their certificate update procedures, and test the new certificate in a staging integration before rotating it in production.
✗ Don't: Do not wait for the certificate to expire before rotating it, and never assume that updating the certificate in the IdP automatically propagates to connected Service Providers — each SP must have the new certificate uploaded manually.

Enable and Monitor IdP Audit Logs as Part of Your Security Documentation

Identity Providers generate detailed authentication event logs (login success, login failure, MFA bypass, token issuance) that are invaluable for security incident response and compliance reporting. Without actively routing and monitoring these logs, teams lose visibility into credential-based attacks and unauthorized access patterns.

✓ Do: Configure your IdP (Okta System Log, Azure AD Sign-in Logs, Google Workspace Audit) to stream events to a SIEM (e.g., Splunk, Datadog, or Microsoft Sentinel), create alerts for anomalous events like impossible travel logins or repeated MFA failures, and include a log query guide in your security runbook.
✗ Don't: Do not rely solely on the IdP's native log retention window (often 30–90 days) for compliance purposes, and never treat IdP logs as a reactive-only tool — proactive alerting on authentication anomalies is essential for early threat detection.

Use OIDC Over SAML for Modern Web and SPA Applications

While SAML 2.0 is widely supported and appropriate for enterprise applications, it was designed for browser-based redirects and is poorly suited for single-page applications, mobile apps, and API-first architectures. OIDC (OpenID Connect) uses JSON-based JWTs and supports OAuth 2.0 flows, making it the correct choice for modern application authentication patterns.

✓ Do: Evaluate each new application integration and default to OIDC with PKCE for SPAs and mobile apps, use SAML only when the target application does not support OIDC (common in legacy enterprise tools), and document which protocol is used for each integration in your SSO integration registry.
✗ Don't: Do not implement SAML for a React or Vue.js single-page application simply because it is familiar — the XML-based redirect flow is incompatible with token-based SPA authentication patterns and will require significant workarounds.

How Docsie Helps with Identity Provider

Build Better Documentation with Docsie

Join thousands of teams creating outstanding documentation

Start Free Trial