@bcgov/citz-imb-sso-css-api

BCGov SSO CSS API Functions

Introduction

This npm package offers the CSS API Account functionality through easy to use functions in your NodeJS application. The CSS API Account is part of the B.C. government's Single Sign-On (CSS) service. The endpoints outlined in the CSS API Swagger Docs will have a corresponding functions in this package.

The CSS API Account let's you interact with CSS Application for your SSO Integration in a RESTful way for both user and role management.

• Built for a NodeJS:20.
• For CSS Teams with a CSS API Account.
• Works with Vanilla JavaScript or TypeScript 5.
• Built for standalone use. Does NOT require @bcgov/citz-imb-sso-react or @bcgov/citz-imb-sso-express

Get Started Here!

Documentation - Installation, setup and usage guides.

IMPORTANT

This package complements, rather than replicates, Common Hosted Single Sign-On (CSS).
It allows our own applications to make use of the CSS API Account in an easy to consume way.
It is developed and maintained by the CITZ IMB Common Code team, separate from the Common Hosted Single Sign-On (CSS) team.

For Developers working on this package:

We emphasize the inclusion of documentation on our code to enhance onboarding efficiency. Understanding the project's architecture and operational dynamics create efficient team members.

We encourage collaboration by making our project's infrastructure transparent and accessible. Enabling developers to easily navigate and contribute to different parts of the codebase without barriers. Enriching our documentation contributes to a self-documenting codebase. The project's structure and commands are defined and updated within the repository itself. Ultimately, making the project more maintainable and scalable over time.

Use the links below to help you understand the codebase better.

• Directory Structure
• Scripts
• Package Management Plan
• Publishing a New Release Version

Return to Top