mkdocs.yml

copyright: Copyright © 2024, The Janssen Project
docs_dir: ./docs
edit_uri: edit/main/docs/
extra:
  generator: false
  social:
  - icon: fontawesome/brands/github
    link: https://github.com/JanssenProject/jans
    name: Janssen on GitHub
  - icon: fontawesome/solid/link
    link: https://jans.io/docs
    name: Janssen Website
  version:
    default: stable
    provider: mike
extra_css:
- css/tabs.css
- stylesheets/mermaid-extra.css
markdown_extensions:
- admonition
- attr_list
- toc:
    permalink: '#'
- codehilite
- pymdownx.superfences:
    custom_fences:
    - class: mermaid
      format: !!python/name:pymdownx.superfences.fence_code_format
      name: mermaid
- pymdownx.tabbed
- pymdownx.emoji:
    emoji_generator: !!python/name:materialx.emoji.to_svg
    emoji_index: !!python/name:materialx.emoji.twemoji
nav:
- Administration:
  - Introduction: admin/README.md
  - Deployment and Planning Guide:
    - admin/planning/README.md
    - Platform Goal: admin/planning/platform-goal.md
    - Use Cases: admin/planning/use-cases.md
    - Components: admin/planning/components.md
    - Kubernetes: admin/planning/kubernetes.md
    - VM Cluster: admin/planning/vm-cluster.md
    - VM Single Instance: admin/planning/vm-single-instance.md
    - Persistence: admin/planning/persistence.md
    - Caching: admin/planning/caching.md
    - Security Best Practices: admin/planning/security-best-practices.md
    - Load Balancers: admin/planning/load-balancers.md
    - Certificates/Keys: admin/planning/certificates-keys.md
    - DNS: admin/planning/dns.md
    - Multi-tenancy: admin/planning/multi-tenancy.md
    - Benchmarking: admin/planning/benchmarking.md
    - Application Portal: admin/planning/application-portal.md
    - Discovery: admin/planning/discovery.md
    - Customization/Localization: admin/planning/customization.md
    - Timeout Management: admin/planning/timeout-management.md
    - Identity Management: admin/planning/identity-management.md
    - Self-Service Password/2FA Portal: admin/planning/self-service-password-2fa.md
    - Identity Access Governance: admin/planning/identity-access-governance.md
    - Role Based Access Management: admin/planning/role-based-access-management.md
    - Central Authorization Service Integration: admin/planning/central-auth-service.md
    - Stepped-up Authentication: admin/planning/stepped-up-auth.md
    - Delegated User Administration: admin/planning/delegated-user-admin.md
    - Passwordless Authentication: admin/planning/passwordless-auth.md
    - Machine-to-Machine Authentication: admin/planning/machine-to-machine.md
  - Installation:
    - admin/install/README.md
    - VM Installation:
      - admin/install/vm-install/README.md
      - VM Requirements: admin/install/vm-install/vm-requirements.md
      - Ubuntu: admin/install/vm-install/ubuntu.md
      - RHEL: admin/install/vm-install/rhel.md
      - Suse: admin/install/vm-install/suse.md
      - Dynamic Download: admin/install/vm-install/dynamic-download.md
    - Helm Deployments:
      - admin/install/helm-install/README.md
      - Local Kubernetes Cluster: admin/install/helm-install/local.md
      - Amazon EKS: admin/install/helm-install/amazon-eks.md
      - Google GKE: admin/install/helm-install/google-gke.md
      - Microsoft Azure AKS: admin/install/helm-install/microsoft-azure.md
      - Using Rancher Marketplace: admin/install/helm-install/rancher.md
    - Docker Deployments:
      - Quick Start: admin/install/docker-install/quick-start.md
      - Docker compose: admin/install/docker-install/compose.md  
    - Setup Instructions: admin/install/setup.md
    - FAQ: admin/install/install-faq.md
  - Kubernetes Operation Guide:
    - admin/kubernetes-ops/README.md
    - Upgrade: admin/kubernetes-ops/upgrade.md
    - Scaling: admin/kubernetes-ops/scaling.md
    - Backup and Restore: admin/kubernetes-ops/backup-restore.md
    - Certificate Management: admin/kubernetes-ops/cert-management.md
    - Customization: admin/kubernetes-ops/customization.md
    - Start Order: admin/kubernetes-ops/start-order.md
    - Logs: admin/kubernetes-ops/logs.md
    - External Secrets and Configmaps: admin/kubernetes-ops/external-secrets-configmaps.md
    - Health Check: admin/kubernetes-ops/health-check.md
    - TUI K8s: admin/kubernetes-ops/tui-k8s.md
    - Custom Attributes: admin/kubernetes-ops/custom-attributes.md
    - Jans SAML/Keycloak: admin/kubernetes-ops/jans-saml.md
  - VM Operation Guide:
    - admin/vm-ops/README.md
    - Upgrade: admin/vm-ops/upgrade.md
    - Backup: admin/vm-ops/backup.md
    - Logs: admin/vm-ops/logs.md
    - Checking Service Status: admin/vm-ops/checking-service-status.md
    - Restarting Services: admin/vm-ops/restarting-services.md
    - Managing Key Rotation: admin/vm-ops/managing-key-rotation.md
    - Certificates: admin/vm-ops/certificates.md
  - Terraform and IaC:
    - admin/terraform/README.md   
  - Configuration Guide:
    - Configuration Tools:
      - TUI - Text-Based UI:
          - admin/config-guide/config-tools/jans-tui/README.md
          - Navigation Guide: admin/config-guide/config-tools/jans-tui/navigation-guide.md
          - Using Logs: admin/config-guide/config-tools/jans-tui/using-command-line-log.md
      - CLI - Command Line:
          - admin/config-guide/config-tools/jans-cli/README.md
      - REST API:
        - admin/config-guide/config-tools/config-api/README.md
        - Settings: admin/config-guide/config-tools/config-api/config.md
        - Attributes: admin/config-guide/config-tools/config-api/attribute.md
        - Security: admin/config-guide/config-tools/config-api/security.md
        - Logs: admin/config-guide/config-tools/config-api/logs.md
        - Monitoring: admin/config-guide/config-tools/config-api/monitoring.md
        - Plugins: admin/config-guide/config-tools/config-api/plugins.md
      - CURL: admin/config-guide/config-tools/curl-guide.md
    - Agama Configuration: admin/config-guide/agama-configuration.md
    - Attribute: admin/config-guide/attribute-configuration.md
    - Default Authentication: admin/config-guide/default-authentication-method-config.md
    - Cache Configuration: admin/config-guide/cache-configuration.md
    - Auth Server Configuration: admin/config-guide/jans-authorization-server-config.md
    - FIDO2 Configuration: admin/config-guide/janssen-fido2-configuration.md
    - Logging: admin/config-guide/logging-configuration.md
    - JSON Web Key: admin/config-guide/json-web-key-config.md
    - LDAP Configuration: admin/config-guide/ldap-configuration.md
    - Couchbase Configuration: admin/config-guide/couchbase-configuration.md
    - OAuth Scope Management: admin/config-guide/oauth-scopes-config.md
    - UMA Management: admin/config-guide/oauth-umaresources-config.md
    - OpenID Connect Client Configuration: admin/config-guide/openid-connect-client-configuration.md
    - SMTP Configuration: admin/config-guide/smtp-configuration.md
    - Custom Scripts: admin/config-guide/custom-scripts-config.md
    - SCIM User Resources: admin/config-guide/user-config.md
    - SCIM Group Management: admin/config-guide/scim-group-config.md
    - Authentication via Device Flow: admin/config-guide/device-flow-config.md
    - Password Validation: admin/config-guide/user-password-validation.md
  - Database Guide:
    - admin/reference/database/README.md
    - RDBMS Erwin Table: admin/reference/database/rdbms-erwin.md
    - LDAP:
      - LDAP Schema: admin/reference/database/ldap-schema.md
      - LDAP Configuration: admin/reference/database/ldap-config.md
      - LDAP Operation: admin/reference/database/ldap-ops.md
      - LDAP Namespace Diagram: admin/reference/database/ldap-namespace.md
    - Couchbase:
      - Couchbase Configuration: admin/reference/database/cb-config.md
      - Couchbase Operation: admin/reference/database/cb-ops.md
      - Couchbase Buckets: admin/reference/database/cb-buckets.md
    - MySQL:
      - MySQL Schema: admin/reference/database/mysql-schema.md
      - MySQL Configuration: admin/reference/database/mysql-config.md
      - MySQL Operation: admin/reference/database/mysql-ops.md
    - Spanner:
      - Spanner Schema: admin/reference/database/spanner-schema.md
      - Spanner Configuration: admin/reference/database/spanner-config.md
      - Spanner Operation: admin/reference/database/spanner-ops.md
    - PostgreSQL:
      - PostgreSQL Schema: admin/reference/database/pgsql-schema.md
      - PostgreSQL Indexes: admin/reference/database/pgsql-schema-indexes.md
      - PostgreSQL Configuration: admin/reference/database/pgsql-config.md
      - PostgreSQL Operation: admin/reference/database/pgsql-ops.md
    - Converting Data: admin/reference/database/converting-data.md
  - Auth Server Admin Guide:
    - admin/auth-server/README.md
    - Auth Server Config: admin/auth-server/config.md
    - Session Management:
      - admin/auth-server/session-management/README.md
      - IDP v RP Sessions: admin/auth-server/session-management/idp-v-rp.md
      - Multiple Sessions in One Browser: admin/auth-server/session-management/multiple-sessions-one-browser.md
    - Tokens:
      - admin/auth-server/tokens/README.md
      - OAuth Access Tokens: admin/auth-server/tokens/oauth-access-tokens.md
      - OAuth Refresh Tokens: admin/auth-server/tokens/oauth-refresh-tokens.md
      - OAuth Transaction Tokens: admin/auth-server/tokens/oauth-tx-tokens.md
      - OpenID id_token: admin/auth-server/tokens/openid-id-token.md
      - OpenID Userinfo Token: admin/auth-server/tokens/openid-userinfo-token.md
      - UMA RPT Token: admin/auth-server/tokens/uma-rpt-token.md
    - Scopes: admin/auth-server/scopes/README.md
    - Rich Authorization Requests : admin/auth-server/authz-details/README.md
    - Endpoints:
      - admin/auth-server/endpoints/README.md
      - OpenID Configuration: admin/auth-server/endpoints/configuration.md
      - Client Registration: admin/auth-server/endpoints/client-registration.md
      - Authorization: admin/auth-server/endpoints/authorization.md
      - Authorization Challenge: admin/auth-server/endpoints/authorization-challenge.md
      - Token: admin/auth-server/endpoints/token.md
      - SSA: admin/auth-server/endpoints/ssa.md
      - Userinfo: admin/auth-server/endpoints/userinfo.md
      - Token Revocation: admin/auth-server/endpoints/token-revocation.md
      - Session Revocation: admin/auth-server/endpoints/session-revocation.md
      - End Session: admin/auth-server/endpoints/end-session.md
      - Clientinfo: admin/auth-server/endpoints/clientinfo.md
      - JWKS URI: admin/auth-server/endpoints/jwks-uri.md
      - Archived JWKS URI: admin/auth-server/endpoints/archived-jwks-uri.md
      - Introspection: admin/auth-server/endpoints/introspection.md
      - Device Authorization: admin/auth-server/endpoints/device-authorization.md
      - PAR: admin/auth-server/endpoints/par.md
      - Backchannel Authentication: admin/auth-server/endpoints/backchannel-authentication.md
    - Crypto:
      - admin/auth-server/crypto/README.md
      - Keys: admin/auth-server/crypto/keys.md
      - Key Storage: admin/auth-server/crypto/key-storage.md
      - Key Rotation and Generation: admin/auth-server/crypto/key-generation.md
    - OpenID Features:
      - admin/auth-server/openid-features/README.md
      - Pairwise/Public Subject Identifiers: admin/auth-server/openid-features/subject-identifiers.md
      - id_token: admin/auth-server/openid-features/id-token.md
      - ACRs: admin/auth-server/openid-features/acrs.md
      - Request Objects: admin/auth-server/openid-features/request-objects.md
      - Prompt Parameter: admin/auth-server/openid-features/prompt-parameter.md
      - Consent:
        - admin/auth-server/openid-features/consent/README.md
        - Customize: admin/auth-server/openid-features/consent/customize.md
        - List/Delete Consent: admin/auth-server/openid-features/consent/list-delete.md
      - CIBA: admin/auth-server/openid-features/ciba.md
      - JARM: admin/auth-server/openid-features/jarm.md
      - Native SSO: admin/auth-server/openid-features/native-sso.md
      - User Claims:
        - admin/auth-server/openid-features/user-claims/README.md
        - Built-in Claims: admin/auth-server/openid-features/user-claims/built-in-claims.md
        - Adding Custom Claims: admin/auth-server/openid-features/user-claims/custom-claims.md
      - Logout:
        - admin/auth-server/openid-features/logout/README.md
        - Front Channel: admin/auth-server/openid-features/logout/front-channel.md
        - Back Channel: admin/auth-server/openid-features/logout/back-channel.md
        - Customizing Logout: admin/auth-server/openid-features/logout/customizing-logout.md
        - Forcing Logout on Browser Exit: admin/auth-server/openid-features/logout/forcing-logout.md
    - OAuth Features:
      - admin/auth-server/oauth-features/README.md
      - Authorization Code Grant: admin/auth-server/oauth-features/auth-code-grant.md
      - Implicit Grant: admin/auth-server/oauth-features/implicit-grant.md
      - Password Grant: admin/auth-server/oauth-features/password-grant.md
      - Device Grant: admin/auth-server/oauth-features/device-grant.md
      - Client Credential Grant: admin/auth-server/oauth-features/client-credential-grant.md
      - PKCE: admin/auth-server/oauth-features/pkce.md
      - DPoP: admin/auth-server/oauth-features/dpop.md
      - MTLS: admin/auth-server/oauth-features/mtls.md
      - PAR: admin/auth-server/oauth-features/par.md
    - UMA Features:
      - admin/auth-server/uma-features/README.md
      - RPT Endpoint: admin/auth-server/uma-features/rpt-endpoint.md
      - Claims Gathering Endpoint: admin/auth-server/uma-features/claims-gathering-endpoint.md
    - Client Management:
      - admin/auth-server/client-management/README.md
      - Client Schema: admin/auth-server/client-management/client-schema.md
      - Client Authentication: admin/auth-server/client-management/client-authn.md
      - Configuration: admin/auth-server/client-management/client-configuration.md
      - Software Statements: admin/auth-server/client-management/software-statements.md
      - Sector Identifiers: admin/auth-server/client-management/sector-identifiers.md
      - Client Scripts: admin/auth-server/client-management/client-scripts.md
    - Internationalization:
      - admin/auth-server/international/README.md
      - Web Pages: admin/auth-server/international/web-pages.md
      - Client Configuration: admin/auth-server/international/client-config.md
      - Scope Descriptions: admin/auth-server/international/scope-descriptions.md
    - Reporting and Metrics:
      - admin/auth-server/reporting-metrics/README.md
    - Logging:
      - admin/auth-server/logging/README.md
      - Standard Logs: admin/auth-server/logging/standard-logs.md
      - Log Levels: admin/auth-server/logging/log-levels.md
      - Audit Logs: admin/auth-server/logging/audit-logs.md
      - Custom Logs: admin/auth-server/logging/custom-logs.md
      - log4j2 Configuration: admin/auth-server/logging/log4j2.md
  - Keycloak:
      - admin/keycloak/README.md
      - SAML SSO: admin/keycloak/keycloak-saml-sso.md
      - Inbound SAML: admin/keycloak/keycloak-saml-inbound.md
  - Developer Guide:
    - admin/developer/README.md
    - Agama:
      - Agama engine: admin/developer/agama/jans-agama-engine.md
      - Navigation, UI pages and assets: admin/developer/agama/flows-navigation-ui.md
      - Projects deployment: admin/developer/agama/projects-deployment.md
      - Agama Best Practices:  admin/developer/agama/agama-best-practices.md
      - Advanced usages: admin/developer/agama/advanced-usages.md
      - Engine and bridge configurations: admin/developer/agama/engine-bridge-config.md
      - FAQ: admin/developer/agama/faq.md      
      - Quick Start Using Agama Lab: admin/developer/agama/quick-start-using-agama-lab.md
    - External Libraries: admin/developer/external-libraries.md
    - CORS: admin/developer/cors.md
    - Managed Beans: admin/developer/managed-beans.md
    - Customization:
      - admin/developer/customization/README.md
      - Customize Web pages: admin/developer/customization/customize-web-pages.md
      - Custom client logs: admin/developer/customization/custom-client-logs.md
    - Interception Scripts:
      - admin/developer/scripts/README.md
      - Application Session: admin/developer/scripts/application-session.md
      - Authorization Challenge: admin/developer/scripts/authorization-challenge.md
      - CIBA End User Notification: admin/developer/scripts/ciba.md
      - Client Registration: admin/developer/scripts/client-registration.md
      - Config API: admin/developer/scripts/config-api.md
      - Consent Gathering: admin/developer/scripts/consent-gathering.md
      - Dynamic Scope: admin/developer/scripts/dynamic-scope.md
      - End Session: admin/developer/scripts/end-session.md
      - ID Generator: admin/developer/scripts/id-generator.md
      - Introspection: admin/developer/scripts/introspection.md
      - OpenID Configuration: admin/developer/scripts/discovery.md
      - Persistence: admin/developer/scripts/persistence.md
      - Person Authentication: admin/developer/scripts/person-authentication.md
      - Post Authentication: admin/developer/scripts/post-authentication.md
      - Resource Owner Password Credentials: admin/developer/scripts/ropc.md
      - Revoke Token: admin/developer/scripts/revoke-token.md
      - SCIM: admin/developer/scripts/scim.md
      - Script Debugging: admin/developer/scripts/interception-scripts-debug.md
      - Select Account: admin/developer/scripts/select-account.md
      - Spontaneous Scope: admin/developer/scripts/spontaneous-scope.md
      - UMA Claims (JWT Transformation): admin/developer/scripts/uma-claims-jwt.md
      - UMA Claims Gathering (Web Flow): admin/developer/scripts/uma-claims-web.md
      - UMA RPT Policies: admin/developer/scripts/uma-rpt.md
      - Update Token: admin/developer/scripts/update-token.md
  - Reference Guide:
    - admin/reference/README.md
    - Javadocs / OpenAPI:
      - admin/reference/openapi.md
      - agama: https://janssenproject.github.io/javadocs/agama/transpiler/index.html
      - jans-auth-server: https://janssenproject.github.io/javadocs/jans-auth-server/server/index.html
      - jans-casa: https://janssenproject.github.io/javadocs/jans-casa/config/index.html
      - jans-config-api: https://janssenproject.github.io/javadocs/jans-config-api/server/index.html
      - jans-core: https://janssenproject.github.io/javadocs/jans-core/server/io/jans/server/filters/package-summary.html
      - jans-fido2: https://janssenproject.github.io/javadocs/jans-fido2/server/index.html
      - jans-keycloak-integration: https://janssenproject.github.io/javadocs/jans-keycloak-integration/server/index.html
      - jans-keycloak-link: https://janssenproject.github.io/javadocs/jans-keycloak-link/server/index.html
      - jans-link: https://janssenproject.github.io/javadocs/jans-link/server/index.html
      - jans-lock: https://janssenproject.github.io/javadocs/jans-lock/server/index.html
      - jans-orm: https://janssenproject.github.io/javadocs/jans-orm/cdi/io/jans/orm/service/package-summary.html
      - jans-scim: https://janssenproject.github.io/javadocs/jans-scim/server/index.html
    - JSON Configuration/Properties:
      - admin/reference/json/README.md
      - Properties:
        - admin/reference/json/properties/README.md
        - Auth Server: admin/reference/json/properties/janssenauthserver-properties.md
        - FIDO: admin/reference/json/properties/fido2-properties.md
        - SCIM: admin/reference/json/properties/scim-properties.md
        - Config API: admin/reference/json/properties/config-api-properties.md
      - Feature Flags:
        - admin/reference/json/feature-flags/README.md
        - Auth Server: admin/reference/json/feature-flags/janssenauthserver-feature-flags.md
    - Kubernetes:
      - admin/reference/kubernetes/README.md
      - Helm Chart: admin/reference/kubernetes/helm-chart.md
      - Config and Secret Keys: admin/reference/kubernetes/config-secret-keys.md
      - Image Config Properties:
        - Auth Server: admin/reference/kubernetes/docker-jans-auth-server.md
        - Casa: admin/reference/kubernetes/docker-jans-casa.md
        - Cert Manager: admin/reference/kubernetes/docker-jans-certmanager.md
        - Config API: admin/reference/kubernetes/docker-jans-config-api.md
        - Configurator: admin/reference/kubernetes/docker-jans-configurator.md
        - FIDO2: admin/reference/kubernetes/docker-jans-fido2.md
        - Monolith: admin/reference/kubernetes/docker-jans-monolith.md
        - Persistence: admin/reference/kubernetes/docker-jans-persistence-loader.md
        - SCIM: admin/reference/kubernetes/docker-jans-scim.md
        - Gluu OpenDJ: admin/reference/kubernetes/docker-opendj.md
    - Learning Reference: admin/reference/learning-reference.md
  - FIDO Admin Guide:
    - admin/fido/README.md
    - Configuration: admin/fido/config.md
    - Vendor Metadata Management: admin/fido/vendor-metadata.md
    - Key Management/Rotation: admin/fido/key-mgt.md
    - Logs: admin/fido/logs.md
    - Monitoring: admin/fido/monitoring.md
    - USB Authenticator Support: admin/fido/usb-authn.md
    - Platform Authenticator Support: admin/fido/platform-authn.md
    - Bluetooth Authenticator Support: admin/fido/bluetooth-authn.md
    - SCIM Extension: admin/fido/scim.md
  - SCIM Admin Guide:
    - admin/scim/README.md
    - Configuration: admin/scim/config.md
    - Logs: admin/scim/logs.md
    - Monitoring: admin/scim/monitoring.md
    - OAuth Protection: admin/scim/oauth-protection.md
    - Security Considerations: admin/scim/security.md
    - Bulk Adding Users: admin/scim/bulk-users.md
    - Adding Custom Attributes: admin/scim/custom-attributes.md
  - Link Guide:
    - admin/link/README.md
    - Jans LDAP Link: admin/link/jans-link.md
    - Jans Keycloak Link: admin/link/jans-keycloak-link.md
  - Lock Guide:
      - admin/lock/README.md
      - Lock Installation: admin/lock/lock_installation.md
      - Auth Server Configuration: admin/lock/lock_auth_server_config.md
      - Lock Client Configuration: admin/lock/lock_client_config.md
      - Implement Lock PDP Plugin: admin/lock/lock_pdp_plugin.md
      - Policy Store Integration: admin/lock/lock_opa.md
  - Janssen Recipes:
    - admin/recipes/README.md
    - Benchmark: admin/recipes/benchmark.md
    - Social Login: admin/recipes/social-login.md
    - Inbound OIDC: admin/recipes/inbound-oidc.md
    - Registration: admin/recipes/registration.md
    - Password Expirations: admin/recipes/password-expirations.md
    - Locking or Disabling Accounts: admin/recipes/locking-accounts.md
    - Stepped-up Authentication: admin/recipes/stepped-up-authn.md
    - User Journeys: admin/recipes/ACRouter.md
  - User Management:
      - admin/usermgmt/README.md
      - Using SCIM: admin/usermgmt/usermgmt-scim.md
      - Using CLI/TUI: admin/usermgmt/usermgmt-cli-tui.md
      - Using jans-link: admin/usermgmt/usermgmt-jans-link.md
- Contribute:
  - Contribution Guidelines: CONTRIBUTING.md
  - Code of Conduct: CODE_OF_CONDUCT.md
  - Design and Implementation:
    - contribute/implementation-design/README.md
    - Agama: contribute/implementation-design/agama.md
    - jans-auth-server: contribute/implementation-design/jans-auth-server.md
    - jans-cli: contribute/implementation-design/jans-cli.md
    - jans-config-api: contribute/implementation-design/jans-config-api.md
    - jans-core: contribute/implementation-design/jans-core.md
    - jans-fido2: contribute/implementation-design/jans-fido2.md
    - jans-orm: contribute/implementation-design/jans-orm.md
    - jans-scim: contribute/implementation-design/jans-scim.md
  - CI-CD:
    - GitHub CI: contribute/ci-cd/github-ci.md
    - Jenkins CI: contribute/ci-cd/jenkins-ci.md
    - Release Process: contribute/ci-cd/release-process.md
  - Development: contribute/development.md
  - Testing: contribute/testing.md
  - Developer FAQ: contribute/developer-faq.md
- Governance:
  - Charter: governance/charter.md
  - Copyright-notice: governance/copyright-notices.md
  - Triage: governance/triage.md
- Agama:
  - Introduction: agama/introduction.md
  - Language reference: agama/language-reference.md
  - Execution rules: agama/execution-rules.md
  - gama format: agama/gama-format.md
- 'Jans Casa':
    - 'casa/index.md'
    - Administration Guide:
        - 'Quick Start': 'casa/administration/quick-start.md'
        - 'Admin console': 'casa/administration/admin-console.md'
        - 'About 2FA': 'casa/administration/2fa-basics.md'
        - 'Credentials storage': 'casa/administration/credentials-stored.md'
        - 'Custom branding': 'casa/administration/custom-branding.md'
        - 'URL path customization': 'casa/administration/change-context-path.md'
        - 'Localization': 'casa/administration/localization.md'
        - 'Plugins':
            - '2FA Settings': 'casa/plugins/2fa-settings.md'
            - 'Accounts Linking':
              - 'casa/plugins/accts-linking/account-linking-index.md'
              - 'Configuring Agama Project': 'casa/plugins/accts-linking/accts-linking-agama.md'
            - 'BioID': 'casa/plugins/bioid.md'
            - 'Consent Management': 'casa/plugins/consent-management.md'
            - 'Custom Branding': 'casa/plugins/custom-branding.md'
        - 'FAQ': 'casa/administration/faq.md'
    - Developer Guide:
        - 'Adding authentication methods': 'casa/developer/add-authn-methods.md'
    - User Guide: 'casa/user-guide.md'
plugins:
- include-markdown
- tags
- search
- exclude-search:
    exclude_unreferenced: true
- git-revision-date-localized:
    enable_creation_date: true
    type: timeago
repo_name: GitHub
repo_url: https://github.com/JanssenProject/jans/
site_author: Janssen, Inc.
site_description: Janssen Project Deployment and Operation References
site_name: Janssen Documentation
site_url: https://jans.io/docs
theme:
  custom_dir: docs/overrides
  favicon: assets/janssen_project_favicon_transparent_50px_50px.ico
  features:
  - toc.autohide - search.suggest - search.highlight
  - navigation.tracking
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.indexes
  font:
    code: Roboto Mono
    text: Roboto
  highlightjs: true
  hljs_languages:
  - yaml
  - java
  - bash
  - python
  language: en
  logo: assets/janssen_project.svg
  name: material
  palette:
  - accent: green
    media: (prefers-color-scheme)
    primary: green
    toggle:
      icon: material/brightness-auto
      name: Switch to light mode
  - accent: green
    media: '(prefers-color-scheme: light)'
    primary: green
    scheme: default
    toggle:
      icon: material/brightness-7
      name: Switch to dark mode
  - accent: green
    media: '(prefers-color-scheme: dark)'
    primary: green
    scheme: slate
    toggle:
      icon: material/brightness-4
      name: Switch to system preference
  shortcuts:
    help: 191
    next: 78
    previous: 80
    search: 83