Identity System

Master this essential documentation concept

Quick Definition

A platform or service that manages and verifies user identities within an organization, such as Azure AD or an SSO provider, often used to control access to tools and content.

How Identity System Works

graph TD A[User Interface] --> B[API Gateway] B --> C[Service Layer] C --> D[Data Layer] D --> E[(Database)] B --> F[Authentication] F --> C

Understanding Identity System

A platform or service that manages and verifies user identities within an organization, such as Azure AD or an SSO provider, often used to control access to tools and content.

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

Making Identity System Knowledge Searchable Across Your Team

When your organization onboards a new identity system — whether that's configuring Azure AD groups, setting up SSO provider rules, or mapping roles to access permissions — the people doing that work often record walkthroughs, live demos, or training sessions to share what they've learned. It's a practical instinct: the configuration steps are complex, and video captures the nuance well.

The problem surfaces weeks later, when a new team member needs to understand how your identity system is structured, or when someone troubleshooting an access issue needs to find the step where a specific permission was defined. Scrubbing through a 45-minute onboarding recording to locate that one segment about SSO provider configuration is a real time cost — and it compounds every time someone new joins or a policy changes.

Converting those recordings into structured documentation changes how your team interacts with that institutional knowledge. Instead of replaying videos, colleagues can search directly for terms like "role assignment" or "conditional access policy" and land on the exact section they need. When your identity system configuration evolves, updating a document is also far more straightforward than re-recording an entire session.

If your team relies on video to document access management workflows, see how converting those recordings into searchable documentation can make that knowledge genuinely reusable.

Real-World Documentation Use Cases

Automatically Revoking Contractor Access to Internal Docs After Contract End

Problem

Technical writers and doc managers manually track contractor offboarding, often leaving ex-contractors with active access to sensitive internal documentation, API specs, and architecture diagrams for weeks after their contracts expire.

Solution

The Identity System (e.g., Azure AD) acts as the single source of truth for user lifecycle. When a contractor account is deprovisioned, all SSO-connected documentation platforms like Confluence, GitBook, or Notion automatically lose access without any manual intervention.

Implementation

['Connect your documentation portal (e.g., Confluence Cloud) to Azure AD via SAML 2.0 or OIDC, enabling SSO so all logins are brokered through the identity provider.', "Create a dedicated Azure AD security group (e.g., 'Contractors-DocAccess') and map it to a Confluence space permission set with read-only access to relevant spaces.", 'Set account expiration dates on contractor identities in Azure AD aligned to contract end dates, triggering automatic account disabling on the specified date.', 'Enable Azure AD access reviews on the Contractors-DocAccess group to send quarterly reminders to managers to confirm continued access needs.']

Expected Outcome

Zero manual offboarding steps for documentation access; contractor access is revoked within minutes of account expiration, eliminating the risk of stale access to proprietary technical content.

Enforcing Role-Based Doc Editing Rights Across a Multi-Team Engineering Org

Problem

In large engineering organizations, anyone with a Confluence or Notion account can accidentally overwrite critical runbooks, API references, or architecture docs, causing versioning chaos and unreviewed changes to production-critical documentation.

Solution

The Identity System maps organizational roles (e.g., 'SRE-Team', 'Frontend-Engineers', 'TechWriters') from Azure AD or Okta groups directly to documentation platform permission tiers, ensuring only authorized users can edit specific spaces or pages.

Implementation

["Define AD/Okta groups that mirror your org chart: 'TechWriters-Editors', 'Engineers-Reviewers', 'Managers-Admins', and 'AllStaff-Viewers'.", 'Configure SCIM provisioning between your identity provider and Confluence or Notion so group memberships are synced automatically when HR updates roles in the directory.', 'Map each synced group to a Confluence permission scheme: TechWriters-Editors get page-create/edit rights, Engineers-Reviewers get comment/suggest rights, AllStaff-Viewers get read-only.', 'Test permission boundaries by provisioning a sandbox user in each group and verifying they can only perform their designated actions in the documentation platform.']

Expected Outcome

Editing permissions are tied to job function rather than individual accounts, reducing accidental overwrites and ensuring documentation governance scales automatically as the organization grows.

Enabling Seamless Docs Access for Acquired Company Employees via Identity Federation

Problem

When a company acquires another organization, the acquired employees cannot access the parent company's documentation portals because they exist in a separate identity directory, forcing IT to manually create duplicate accounts or share credentials insecurely.

Solution

Identity federation via Azure AD B2B or SAML trust between the two organizations' identity systems allows acquired employees to authenticate with their existing credentials and gain scoped access to the parent company's documentation without account duplication.

Implementation

["Establish an Azure AD B2B federation or SAML trust relationship between the parent company's Azure AD tenant and the acquired company's identity provider (e.g., Google Workspace or another Azure AD tenant).", "Create a dedicated 'Acquired-Company-DocAccess' group in the parent Azure AD and invite acquired employee identities as guest users or federated identities into this group.", "Map the 'Acquired-Company-DocAccess' group to a restricted Confluence space containing only onboarding docs, shared architecture overviews, and integration guides relevant to the acquisition.", 'Set a time-bound conditional access policy that requires MFA for all federated guest users accessing the documentation portal, adding a security layer without blocking productivity.']

Expected Outcome

Acquired employees gain access to necessary documentation within hours of the federation setup, with no duplicate accounts created and access automatically scoped to only what is relevant for their integration work.

Restricting Access to Security-Sensitive API Docs Using Conditional Access Policies

Problem

Internal developer portals hosting authentication flows, encryption key management docs, and vulnerability disclosure procedures are accessible to all authenticated employees, including those in unrelated departments, creating unnecessary exposure of sensitive technical details.

Solution

The Identity System's conditional access policies layer additional requirements (device compliance, location, role membership) on top of standard authentication before granting access to high-sensitivity documentation spaces, limiting exposure to only verified, need-to-know users.

Implementation

["Tag high-sensitivity documentation spaces in your portal (e.g., 'Security-Architecture', 'Pen-Test-Reports') and identify the Azure AD groups whose members legitimately need access (e.g., 'SecurityEngineers', 'CISOs').", 'Create a conditional access policy in Azure AD targeting the documentation portal app, scoped to users outside the approved groups, that blocks access or requires a Privileged Identity Management (PIM) just-in-time role activation.', 'Enable Azure AD sign-in logs and integrate them with your SIEM (e.g., Microsoft Sentinel) to alert on any access attempts to the security docs space from unexpected user roles or geographies.', 'Document the access request process in a public-facing internal wiki page so engineers who legitimately need temporary access know how to request PIM elevation.']

Expected Outcome

Security-sensitive documentation is accessible only to personnel with verified roles and compliant devices, with a full audit trail of every access event, satisfying SOC 2 and ISO 27001 audit requirements for information access controls.

Best Practices

Use SCIM Provisioning to Sync Identity Groups Directly to Documentation Platforms

Manually managing user accounts in documentation tools like Confluence, GitBook, or Notion creates drift between your identity system and actual access rights. SCIM (System for Cross-domain Identity Management) automates the creation, update, and deactivation of user accounts in your docs platform whenever changes occur in Azure AD or Okta. This ensures that a new hire provisioned in HR systems gains documentation access the same day without a ticket.

✓ Do: Enable SCIM 2.0 provisioning between your identity provider (Azure AD, Okta) and your documentation platform, and map AD security groups to documentation roles so access is driven by group membership.
✗ Don't: Don't create local user accounts directly in the documentation tool for new employees; this bypasses the identity system and creates orphaned accounts that survive offboarding.

Map Documentation Access Tiers to Existing Organizational Role Groups

Documentation platforms often have their own internal permission models, but these should mirror the role taxonomy already defined in your identity system rather than create a parallel structure. Aligning documentation access tiers (viewer, commenter, editor, admin) to existing AD groups like 'Engineering-Staff' or 'TechWriters-Core' ensures that role changes in HR propagate automatically to documentation permissions. This eliminates the need for documentation admins to manually adjust permissions when someone changes teams.

✓ Do: Audit your existing Azure AD or Okta groups and create a documented mapping table that links each group to a specific documentation permission level before configuring SSO.
✗ Don't: Don't assign documentation permissions to individual user accounts; always assign to groups so that permissions scale with organizational changes rather than requiring per-user updates.

Enforce MFA for All Documentation Portal Logins via Identity Provider Policy

Documentation portals often contain sensitive internal information including architecture diagrams, runbooks, and API credentials embedded in examples. Enforcing multi-factor authentication at the identity provider level (rather than relying on the documentation tool's own MFA) ensures consistent enforcement across all SSO-connected platforms. This prevents credential stuffing attacks from granting access to internal docs even when passwords are compromised.

✓ Do: Create a conditional access policy in Azure AD or Okta that requires MFA for any authentication request targeting your documentation portal application, including external access from home networks.
✗ Don't: Don't rely on the documentation platform's built-in MFA setting, as this only applies to direct logins and can be bypassed if SSO is misconfigured or if legacy authentication methods are still enabled.

Conduct Quarterly Access Reviews on Documentation Space Permissions via Identity System

Over time, employees accumulate access to documentation spaces beyond their current role, especially after project transitions, promotions, or team reorganizations. Azure AD Access Reviews and Okta's lifecycle management features allow documentation space owners or managers to periodically certify whether specific users still need their current level of access. Uncertified access is automatically revoked, keeping permissions lean and audit-ready.

✓ Do: Schedule quarterly Azure AD Access Reviews scoped to the security groups that control documentation platform access, assigning review responsibility to the relevant team leads or documentation space owners.
✗ Don't: Don't skip access reviews for 'read-only' documentation roles; read access to internal runbooks, security procedures, or unreleased product specs still represents a data exposure risk if granted to the wrong personnel.

Implement Just-in-Time Access for Sensitive Documentation Spaces Using PIM

Permanent standing access to highly sensitive documentation spaces (security audits, executive strategy docs, incident post-mortems) increases the blast radius if an account is compromised. Azure AD Privileged Identity Management (PIM) allows eligible users to activate time-bound access to elevated documentation roles only when needed, with full audit logging of who activated access, when, and for how long. This applies the principle of least privilege to documentation access without blocking legitimate workflows.

✓ Do: Configure PIM eligible assignments for the Azure AD groups that grant access to sensitive documentation spaces, requiring users to provide a business justification and manager approval before access is activated.
✗ Don't: Don't grant permanent admin or editor access to sensitive documentation spaces for users who only need it occasionally; standing access that is rarely used is a high-value target for attackers and is difficult to justify in compliance audits.

How Docsie Helps with Identity System

Build Better Documentation with Docsie

Join thousands of teams creating outstanding documentation

Start Free Trial