mkdocs.yml

site_name: OneWelcome Identity Cloud for Developers
site_description: 'Documentation of the OneWelcome Identity Cloud: architecture, concepts, functional descriptions and the APIs explained.'
repo_url: https://github.com/onewelcome/onegini-identity-cloud-documentation

nav:
  - 'Introduction': index.md
  - 'OneWelcome Identity Cloud':
      - 'Platform architecture':
          - 'Mobile Identity & Access': architecture/mobile-identity-access.md
          - 'Identity & Single Sign-On': architecture/identity-single-sign-on.md
          - 'Interfaces': architecture/interfaces.md
  - 'Topic guides':
      - 'Third party identity providers': identity-providers.md
      - 'Single sign-on (SSO)':
          - 'Protected data in Single Page Apps': single-sign-on/protected-data-openid-connect-access-tokens.md
      - 'Client environment embedding (implementation)':
          - 'OAuth vs OpenID Connect': oauth-vs-oidc.md
          - 'Responsibilities of external system connected to DABP': dabp/guides/technical/external-systems-responsibilities.md
  - 'Products':
      - 'Customer Service': products/customer-service.md
      - 'Messaging service':
          - 'Introduction': messaging-service/index.md
          - 'Configuration':
              - 'SMS gateway configuration': messaging-service/sms-config.md
              - 'Email gateway configuration': messaging-service/email-config.md
          - 'API Reference': messaging-service/outgoing-api-spec.md
      - 'Delegated administration':
          - 'Introduction': dabp/index.md
          - 'Release notes': dabp/release-notes/index.md
          - 'Concepts':
              - 'In-depth view on permissions': dabp/guides/concepts/permissions-in-depth.md
              - 'In-depth view on policies': dabp/guides/concepts/policies-in-depth.md
              - 'In-depth view on resources': dabp/guides/concepts/resources-in-depth.md
          - 'How to - Functional':
              - 'Inviting users in DABP': dabp/guides/functional/inviting-users.md
              - 'Managing subgroups - Best practices': dabp/guides/functional/subgroups-best-practices.md
              - 'How and when to use custom attributes on groups': dabp/guides/functional/group-attributes.md
              - 'Manage policies': dabp/guides/functional/manage-policy-via-ui.md
              - 'Manage resources': dabp/guides/functional/manage-resource-via-ui.md
          - 'How to - Technical':
              - 'How to create a new policy via the API': dabp/guides/technical/create-policy-via-api.md
              - 'How to create a new resource type via the API': dabp/guides/technical/create-resource-type-via-api.md
              - 'How to create a new resource via the API': dabp/guides/technical/create-resource-via-api.md
              - 'Person report': dabp/guides/technical/person-report.md
              - 'Non-personal requests': dabp/guides/technical/non-personal-requests.md
              - 'Responsibilities of the external system connected to DABP': dabp/guides/technical/external-systems-responsibilities.md
              - 'Using Customer Self Styling for changing looks and behaviour of DABP': dabp/guides/technical/using-ers.md
              - 'Example palette.json': dabp/guides/technical/palette-example.md
      - 'Identity & Single Sign-On': products/identity-single-sign-on.md
      - 'Mobile Identity & Access':
          - 'Introduction': products/mobile-identity-access.md
          - 'How to technical':
              - 'Securing resources': products/access/how-to-technical/securing-resources.md
          - 'Topic guides':
              - 'Introduction': products/access/topics/index.md
              - 'Client authentication methods': products/access/topics/authentication-methods/authentication-methods.md
              - 'General client application configuration':
                  - 'Introduction': products/access/topics/general-app-config/index.md
                  - 'PIN policy configuration': products/access/topics/general-app-config/pin-policy/pin-policy.md
                  - 'Scopes configuration': products/access/topics/general-app-config/scopes/scopes.md
                  - 'Identity provider configuration': products/access/topics/general-app-config/identity-providers/identity-providers.md
                  - 'Resource gateway configuration': products/access/topics/general-app-config/resource-gateway/resource-gateway.md
                  - 'OS version management': products/access/topics/general-app-config/os-version-configuration/os-version-configuration.md
              - 'Mobile applications':
                  - 'Introduction': products/access/topics/mobile-apps/index.md
                  - 'Mobile application configuration': products/access/topics/mobile-apps/app-configuration/app-configuration.md
                  - 'Mobile application version management': products/access/topics/mobile-apps/app-configuration/app-version-management.md
                  - 'Mobile application delivery lifecycle': products/access/topics/mobile-apps/app-delivery-lifecycle/app-delivery-lifecycle.md
                  - 'Mobile authentication':
                      - 'Introduction': products/access/topics/mobile-apps/mobile-authentication/mobile-authentication.md
                      - 'Push authentication': products/access/topics/mobile-apps/mobile-authentication/push-authentication.md
                      - 'SMS authentication': products/access/topics/mobile-apps/mobile-authentication/sms-authentication.md
                      - 'One Time Password': products/access/topics/mobile-apps/mobile-authentication/one-time-password.md
                  - 'Transaction signing': products/access/topics/mobile-apps/transaction-signing/transaction-signing.md
                  - 'Implicit authentication': products/access/topics/mobile-apps/implicit-authentication/implicit-authentication.md
              - 'Web clients':
                  - 'Introduction': products/access/topics/web-clients/index.md
                  - 'Web client configuration': products/access/topics/web-clients/web-client-configuration.md
                  - 'Resource Owner Password Credentials': products/access/topics/web-clients/resource-owner-password-credentials.md
                  - 'Migration of Web Clients with hashed secrets': products/access/topics/web-clients/web-client-migration.md
              - 'Tokens':
                  - 'Introduction': products/access/topics/tokens/index.md
                  - 'Access Token': products/access/topics/tokens/access-token.md
                  - 'ID Token': products/access/topics/tokens/id-token.md
                  - 'Refresh Token': products/access/topics/tokens/refresh-token.md
              - 'OpenID Connect':
                  - 'Introduction': products/access/topics/oidc/index.md
                  - 'OpenID Connect overview': products/access/topics/oidc/overview/overview.md
                  - 'Authentication': products/access/topics/oidc/overview/authentication.md
                  - 'Scopes and claims': products/access/topics/oidc/overview/scopes-and-claims.md
                  - 'Claims lifecycle': products/access/topics/oidc/claims-lifecycle/claims-lifecycle.md
                  - 'Configuration': products/access/topics/oidc/configuration/configuration.md
                  - 'ID Token Encryption': products/access/topics/oidc/id-token-encryption/id-token-encryption.md
                  - 'Session Management':
                      - 'Introduction': products/access/topics/oidc/session-management/index.md
                      - 'Session Monitoring with iFrames': products/access/topics/oidc/session-management/session-monitoring-with-iframes.md
                      - 'Relying Party iFrame': products/access/topics/oidc/session-management/relying-party-iframe.md
                      - 'End Session Endpoint behavior and configuration': products/access/topics/oidc/session-management/end-session-guide.md
                  - 'Relying Party Examples': products/access/topics/oidc/relying-party/index.md
              - 'Custom Authenticators':
                  - 'Introduction': products/access/topics/custom-authenticators/index.md
                  - 'Custom Authenticators Configuration': products/access/topics/custom-authenticators/custom-authenticators-configuration.md
                  - 'Custom Authenticator Example': products/access/topics/custom-authenticators/custom-authenticator-example.md
              - 'Custom Registration':
                  - 'Introduction': products/access/topics/custom-registration/index.md
                  - 'Custom API Example': products/access/topics/custom-registration/custom-api-example.md
                  - 'QR Registration Example': products/access/topics/custom-registration/qr-registration-example.md
                  - 'Stateless Custom Registration': products/access/topics/custom-registration/stateless-custom-registration.md
              - 'End user support':
                  - 'Introduction': products/access/topics/end-user-support/index.md
                  - 'User management': products/access/topics/end-user-support/user-management/user-management.md
              - 'Technical application management':
                  - 'Introduction': products/access/topics/technical-app-management/index.md
                  - 'General configuration': products/access/topics/technical-app-management/general-config/general-config.md
                  - 'System features configuration': products/access/topics/technical-app-management/system-features-config/system-features-config.md
                  - 'Session configuration': products/access/topics/technical-app-management/session-config/session-config.md
                  - 'Api configuration': products/access/topics/technical-app-management/api-configuration/api-configuration.md
                  - 'CORS configuration': products/access/topics/technical-app-management/cors-support/cors-support.md
                  - 'Extension Engine': products/access/topics/technical-app-management/extension-engine/extension-engine-properties.md
                  - 'SAML Service Provider configuration': products/access/topics/technical-app-management/idp-saml-sp-config/idp-saml-sp-config.md
                  - 'Events': products/access/topics/technical-app-management/events/events.md
              - 'Integration and extension':
                  - 'Introduction': products/access/topics/integration-extension/index.md
                  - 'Configure Scope Verification Service': products/access/topics/integration-extension/scope-verification/scope-verification.md
                  - 'Web Hooks':
                      - 'Introduction': products/access/topics/integration-extension/hooks/index.md
                      - 'User Details Customization': products/access/topics/integration-extension/hooks/customize-user-details/customize-user-details-hook.md
                      - 'Access Token Customization': products/access/topics/integration-extension/hooks/customize-access-token/customize-access-token-hook.md
              - 'Look and Feel':
                  - 'Introduction': products/access/topics/look-and-feel/index.md
                  - 'Templates': products/access/topics/look-and-feel/templates/templates.md
                  - 'Translations': products/access/topics/look-and-feel/translations/translations.md
              - 'App To Web SSO': products/access/topics/app-to-web/index.md
              - 'Delegated User Management':
                  - 'Introduction': products/access/topics/dum-report/index.md
                  - 'DUM Engine Configuration': products/access/topics/dum-report/dum-engine-configuration.md
              - 'OneSee security events': products/access/topics/aws/onesee-events.md
          - 'Mobile SDKs':
              - 'Android SDK': 'https://developer.onewelcome.com/android/android-sdk/'
              - 'iOS SDK': 'https://developer.onewelcome.com/ios/sdk'
          - 'API Reference':
              - 'Introduction': products/access/api-reference/index.md
              - 'OAuth endpoints': products/access/api-reference/description-oauth-endpoint.md
              - 'OpenID Connect':
                  - 'Introduction': products/access/api-reference/oidc/index.md
                  - 'Discovery API': products/access/api-reference/oidc/discovery.md
                  - 'JSON Web Key Set API': products/access/api-reference/oidc/jwks.md
                  - 'User Info API': products/access/api-reference/oidc/user-info.md
                  - 'Session Management':
                      - 'Introduction': products/access/api-reference/oidc/session-management/index.md
                      - 'Check Session API': products/access/api-reference/oidc/session-management/check-session.md
                      - 'End Session API': products/access/api-reference/oidc/session-management/end-session.md
              - 'Token Introspection': products/access/api-reference/token-introspection.md
              - 'Mobile authentication':
                  - 'Introduction': products/access/api-reference/mobile-authentication/index.md
                  - 'API version 4': products/access/api-reference/mobile-authentication/mobile-authentication-v4.md
                  - 'API version 3': products/access/api-reference/mobile-authentication/mobile-authentication-v3.md
              - Custom Registration:
                  - 'Backchannel': products/access/api-reference/custom-registration/backchannel-custom-registration.md
                  - 'API version 2': products/access/api-reference/custom-registration/custom-registration-v2.md
                  - 'API version 1': products/access/api-reference/custom-registration/custom-registration-v1.md
              - 'Admin API':
                  - 'Introduction': products/access/api-reference/admin-api/index.md
                  - 'API Client': products/access/api-reference/admin-api/api-client.md
              - 'Config API':
                  - 'Introduction': products/access/api-reference/config-api/index.md
                  - 'Applications': products/access/api-reference/config-api/applications/index.md
                  - 'Application versions': products/access/api-reference/config-api/applications/application-version-api.md
                  - 'Identity Providers': products/access/api-reference/config-api/identity-provider-api.md
                  - 'Scopes': products/access/api-reference/config-api/scope.md
                  - 'Web Client': products/access/api-reference/config-api/web-client.md
                  - 'Web Hooks': products/access/api-reference/config-api/webhooks-configuration-api.md
              - 'End user':
                  - 'Introduction': products/access/api-reference/end-user/index.md
                  - 'Access token API': products/access/api-reference/end-user/access-token.md
                  - 'User Sessions API': products/access/api-reference/end-user/session.md
                  - 'Application API': products/access/api-reference/end-user/application.md
                  - 'Consent API': products/access/api-reference/end-user/consent.md
                  - 'Device API version 3 (deprecated)': products/access/api-reference/end-user/device-v3.md
                  - 'Device API version 4': products/access/api-reference/end-user/device-v4.md
                  - 'Events API': products/access/api-reference/events-api/index.md
          - 'Appendix':
              - 'Introduction': products/access/appendix/index.md
              - 'Activity': products/access/appendix/administration/events.md
              - 'OAuth Config': products/access/appendix/administration/oauth-config.md
              - 'API Config': products/access/appendix/administration/api-config.md
              - 'Templates': products/access/appendix/templates/templates.md
              - 'Extension Points':
                  - 'Introduction': products/access/appendix/api-rest-services/index.md
                  - 'REST Scope Verification Service': products/access/appendix/api-rest-services/scope-verification-service.md
              - 'OneWelcome Access events': products/access/appendix/access-events.md
              - 'Responsible disclosure policy': products/access/appendix/responsible-disclosure-policy.md
              - 'Deprecation': products/access/appendix/deprecation.md
          - 'Release notes': products/access/release-notes/index.md
      - Self-styling:
          - 'Introduction': self-styling/index.md
          - 'Frontend styling': self-styling/configuration-page.md
          - 'Release notes': self-styling/release-notes/release-notes.md
copyright: "OneWelcome B.V."

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/reading-time.js
  - javascripts/mermaid-config.js
  - javascripts/mermaid-custom-loader.js

theme:
  name: 'material'
  logo: 'images/onegini-logo-white.svg'
  favicon: 'images/favicon.ico'
  font: false
  custom_dir: 'theme'

extra:
  search:
    tokenizer: '[\s\-\.]+'
  manifest: 'manifest.webmanifest'
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/OneWelcome
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/onewelcome/

markdown_extensions:
  - admonition
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format