mkdocs.yml

site_name: 'CITZ IMB SSO CSS API (NPM Package)'
site_description: 'An npm package that offers the Common Hosted Single Sign-on API Account as functions, allowing SSO management through code instead of through the dashboard.'
docs_dir: 'techdocs/docs'
repo_url: 'https://github.com/bcgov/citz-imb-sso-css-api'
edit_uri: edit/main/techdocs/docs
nav:
  - Introduction: index.md
  - Getting Started:
      - Installing the Package: getting-started/installing-the-package.md
      - Quick Start Guide: getting-started/quick-start-guide.md
      - Environment Variables: getting-started/environment-variables.md
      - SSO Settings & CSS API Account: getting-started/sso-settings.md
  - Using the Package:
      - APIs & Components:
          - getIntegration: using-the-package/apis-&-components/get-integration.md
          - Roles:
              - getRoles: using-the-package/apis-&-components/roles/get-roles.md
              - createRole: using-the-package/apis-&-components/roles/create-role.md
              - getRole: using-the-package/apis-&-components/roles/get-role.md
              - updateRole: using-the-package/apis-&-components/roles/update-role.md
              - deleteRole: using-the-package/apis-&-components/roles/delete-role.md
              - getRoleComposites: using-the-package/apis-&-components/roles/get-role-composites.md
              - addRoleComposite: using-the-package/apis-&-components/roles/add-role-composite.md
              - getRoleComposite: using-the-package/apis-&-components/roles/get-role-composite.md
              - deleteRoleComposite: using-the-package/apis-&-components/roles/delete-role-composite.md
          - Role Mapping:
              - getUserRoles: using-the-package/apis-&-components/role-mapping/get-user-roles.md
              - assignUserRoles: using-the-package/apis-&-components/role-mapping/assign-user-roles.md
              - unassignUserRole: using-the-package/apis-&-components/role-mapping/unassign-user-role.md
              - getUsersWithRole: using-the-package/apis-&-components/role-mapping/get-users-with-role.md
          - Users:
              - getIDIRUsers: using-the-package/apis-&-components/users/get-idir-users.md
              - getAzureIDIRUsers: using-the-package/apis-&-components/users/get-azure-idir-users.md
              - getGitHubBCGovUsers: using-the-package/apis-&-components/users/get-github-bcgov-users.md
              - getGitHubPublicUsers: using-the-package/apis-&-components/users/get-github-public-users.md
              - getBasicBCeIDUser: using-the-package/apis-&-components/users/get-basic-bceid-user.md
              - getBusinessBCeIDUser: using-the-package/apis-&-components/users/get-business-bceid-user.md
              - getBothBCeIDUser: using-the-package/apis-&-components/users/get-both-bceid-user.md
      - Major Releases:
          - 1.0.0: major-releases/major-release-1.md
      - Module Exports: using-the-package/module-exports.md
      - TypeScript Types: using-the-package/typescript-types.md
      - Troubleshooting: using-the-package/troubleshooting.md
plugins:
  - techdocs-core
  - git-revision-date-localized
markdown_extensions:
  - md_in_html