Giter VIP home page Giter VIP logo

bcgov / citz-imb-sso-css-api Goto Github PK

View Code? Open in Web Editor NEW
11.0 2.0 2.0 166 KB

An npm package for providing functions to use the https://github.com/bcgov/sso-keycloak/wiki/CSS-API-Account.

Home Page: https://coco-frontend-argo-baf95e-prod.apps.silver.devops.gov.bc.ca/

License: Apache License 2.0

JavaScript 16.13% TypeScript 83.87%
api auth authentication authorization citz common css imb keycloak npm oauth oidc sso

citz-imb-sso-css-api's Introduction

BCGov SSO CSS API Functions

Lifecycle:Experimental License

Maintainability Test Coverage

NPM NodeJS Typescript

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.


GitHub release
Npm package total downloads
GitHub stars

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.


Return to Top

citz-imb-sso-css-api's People

Contributors

bradymitch avatar actions-user avatar akroon3r avatar grahams-quartech avatar

Stargazers

ANTSAND avatar Sylar Z. Zhang avatar  avatar  avatar  avatar  avatar  avatar  avatar Craig Shutko avatar  avatar  avatar

Watchers

 avatar  avatar

citz-imb-sso-css-api's Issues

assignUserRoles not mapping to objects correctly.

The role names were being mapped incorrectly. The map didn't return an object for each element because the body of the map function was a function, not an object. Hard to describe, but here's some updated code:

export const assignUserRoles = async (
  username: string,
  roleNames: string[]
) => {
  if (DEBUG) logDebug("assignUserRoles");
  return await request({
    integrationEndpoint: true,
    endpoint: `users/${username}/roles`,
    method: "POST",
    body:
      (roleNames.map((roleName) => ({
        name: roleName,
      })) as RequestBody) ?? [],
  });
};

NPM Dependency Report

NPM Dependency Report - Saturday, February 3rd, 2024

Versions of npm packages have been checked against their latest versions from the npm registry.

COVERAGE_PERCENTAGE

✔️ - Production dependencies are all up-to-date.
⚠️ - 1 Development dependencies are out-of-date.


Development Dependencies to Update:

patch_dev

Expand to see individual installs.

npm install -D @types/[email protected]
  • @types/node Update from version 20.11.10 to 20.11.16 by running...
npm install -D @types/[email protected]

NPM Dependency Report

NPM Dependency Report - Thursday, February 1st, 2024

Versions of npm packages have been checked against their latest versions from the npm registry.

COVERAGE_PERCENTAGE

✔️ - Production dependencies are all up-to-date.
⚠️ - 1 Development dependencies are out-of-date.


Development Dependencies to Update:

patch_dev

Expand to see individual installs.

npm install -D @types/[email protected]
  • @types/node Update from version 20.11.10 to 20.11.15 by running...
npm install -D @types/[email protected]

NPM Dependency Report

NPM Dependency Report - Tuesday, February 13th, 2024

Versions of npm packages have been checked against their latest versions from the npm registry.

COVERAGE_PERCENTAGE

⚠️ - 1 Production dependencies are out-of-date.
⚠️ - 1 Development dependencies are out-of-date.


Production Dependencies to Update:

patch

Expand to see individual installs.

npm install [email protected]
  • dotenv Update from version 16.4.1 to 16.4.3 by running...
npm install [email protected]


Development Dependencies to Update:

patch_dev

Expand to see individual installs.

npm install -D @types/[email protected]
  • @types/node Update from version 20.11.10 to 20.11.17 by running...
npm install -D @types/[email protected]

NPM Dependency Report

NPM Dependency Report - Monday, January 22nd, 2024

Versions of npm packages have been checked against their latest versions from the npm registry.

COVERAGE_PERCENTAGE

⚠️ - 1 Production dependencies are out-of-date.
⚠️ - 4 Development dependencies are out-of-date.


Production Dependencies to Update:

patch

Expand to see individual installs.

npm install [email protected]
  • dotenv Update from version 16.3.1 to 16.3.2 by running...
npm install [email protected]


Development Dependencies to Update:

minor_dev

Expand to see individual installs.

  • @types/node Update from version 20.10.5 to 20.11.5 by running...
npm install -D @types/[email protected]
  • rollup-plugin-dts Update from version 6.0.2 to 6.1.0 by running...
npm install -D [email protected]
  • typescript Update from version 5.2.2 to 5.3.3 by running...
npm install -D [email protected]

patch_dev

Expand to see individual installs.

npm install -D @rollup/[email protected]
  • @rollup/plugin-typescript Update from version 11.1.5 to 11.1.6 by running...
npm install -D @rollup/[email protected]

First Name is not truly required when getting users

The query objects used to search for IDIR users require a firstName field in the documentation, but in practice the Keycloak CSS API doesn't require that field. You can search as long as at least one field in the query parameters (firstName, lastName, email, guid) is populated.

It would be nice if the functions to get IDIR users would make the firstName field optional as well, making the new type:

type IDIRUserQuery = {
  firstName?: string;
  lastName?: string;
  email?: string;
  guid?: string;
};

NPM Dependency Report

NPM Dependency Report - Tuesday, February 27th, 2024

Versions of npm packages have been checked against their latest versions from the npm registry.

COVERAGE_PERCENTAGE

⚠️ - 1 Production dependencies are out-of-date.
⚠️ - 1 Development dependencies are out-of-date.


Production Dependencies to Update:

patch

Expand to see individual installs.

npm install [email protected]
  • dotenv Update from version 16.4.1 to 16.4.5 by running...
npm install [email protected]


Development Dependencies to Update:

patch_dev

Expand to see individual installs.

npm install -D @types/[email protected]
  • @types/node Update from version 20.11.10 to 20.11.20 by running...
npm install -D @types/[email protected]

NPM Dependency Report

NPM Dependency Report - Monday, February 5th, 2024

Versions of npm packages have been checked against their latest versions from the npm registry.

COVERAGE_PERCENTAGE

✔️ - Production dependencies are all up-to-date.
⚠️ - 1 Development dependencies are out-of-date.


Development Dependencies to Update:

patch_dev

Expand to see individual installs.

npm install -D @types/[email protected]
  • @types/node Update from version 20.11.10 to 20.11.16 by running...
npm install -D @types/[email protected]

NPM Dependency Report

NPM Dependency Report - Tuesday, January 30th, 2024

Versions of npm packages have been checked against their latest versions from the npm registry.

COVERAGE_PERCENTAGE

✔️ - Production dependencies are all up-to-date.
⚠️ - 1 Development dependencies are out-of-date.


Development Dependencies to Update:

patch_dev

Expand to see individual installs.

npm install -D @types/[email protected]
  • @types/node Update from version 20.11.10 to 20.11.12 by running...
npm install -D @types/[email protected]

NPM Dependency Report

NPM Dependency Report - Tuesday, April 9th, 2024

Versions of npm packages have been checked against their latest versions from the npm registry.

COVERAGE_PERCENTAGE

⚠️ - 1 Production dependencies are out-of-date.
⚠️ - 2 Development dependencies are out-of-date.


Production Dependencies to Update:

patch

Expand to see individual installs.

npm install [email protected]
  • dotenv Update from version 16.4.1 to 16.4.5 by running...
npm install [email protected]


Development Dependencies to Update:

minor_dev

Expand to see individual installs.

npm install -D @types/[email protected] [email protected]
  • @types/node Update from version 20.11.10 to 20.12.6 by running...
npm install -D @types/[email protected]
  • typescript Update from version 5.3.3 to 5.4.4 by running...
npm install -D [email protected]

NPM Dependency Report

NPM Dependency Report - Tuesday, February 6th, 2024

Versions of npm packages have been checked against their latest versions from the npm registry.

COVERAGE_PERCENTAGE

✔️ - Production dependencies are all up-to-date.
⚠️ - 1 Development dependencies are out-of-date.


Development Dependencies to Update:

patch_dev

Expand to see individual installs.

npm install -D @types/[email protected]
  • @types/node Update from version 20.11.10 to 20.11.16 by running...
npm install -D @types/[email protected]

NPM Dependency Report

NPM Dependency Report - Tuesday, January 30th, 2024

Versions of npm packages have been checked against their latest versions from the npm registry.

COVERAGE_PERCENTAGE

⚠️ - 1 Production dependencies are out-of-date.
⚠️ - 4 Development dependencies are out-of-date.


Production Dependencies to Update:

minor

Expand to see individual installs.

npm install [email protected]
  • dotenv Update from version 16.3.1 to 16.4.1 by running...
npm install [email protected]


Development Dependencies to Update:

minor_dev

Expand to see individual installs.

  • @types/node Update from version 20.10.5 to 20.11.10 by running...
npm install -D @types/[email protected]
  • rollup-plugin-dts Update from version 6.0.2 to 6.1.0 by running...
npm install -D [email protected]
  • typescript Update from version 5.2.2 to 5.3.3 by running...
npm install -D [email protected]

patch_dev

Expand to see individual installs.

npm install -D @rollup/[email protected]
  • @rollup/plugin-typescript Update from version 11.1.5 to 11.1.6 by running...
npm install -D @rollup/[email protected]

NPM Dependency Report

NPM Dependency Report - Sunday, February 4th, 2024

Versions of npm packages have been checked against their latest versions from the npm registry.

COVERAGE_PERCENTAGE

✔️ - Production dependencies are all up-to-date.
⚠️ - 1 Development dependencies are out-of-date.


Development Dependencies to Update:

patch_dev

Expand to see individual installs.

npm install -D @types/[email protected]
  • @types/node Update from version 20.11.10 to 20.11.16 by running...
npm install -D @types/[email protected]

NPM Dependency Report

NPM Dependency Report - Tuesday, March 12th, 2024

Versions of npm packages have been checked against their latest versions from the npm registry.

COVERAGE_PERCENTAGE

⚠️ - 1 Production dependencies are out-of-date.
⚠️ - 2 Development dependencies are out-of-date.


Production Dependencies to Update:

patch

Expand to see individual installs.

npm install [email protected]
  • dotenv Update from version 16.4.1 to 16.4.5 by running...
npm install [email protected]


Development Dependencies to Update:

minor_dev

Expand to see individual installs.

npm install -D [email protected]
  • typescript Update from version 5.3.3 to 5.4.2 by running...
npm install -D [email protected]

patch_dev

Expand to see individual installs.

npm install -D @types/[email protected]
  • @types/node Update from version 20.11.10 to 20.11.26 by running...
npm install -D @types/[email protected]

NPM Dependency Report

NPM Dependency Report - Tuesday, March 26th, 2024

Versions of npm packages have been checked against their latest versions from the npm registry.

COVERAGE_PERCENTAGE

⚠️ - 1 Production dependencies are out-of-date.
⚠️ - 2 Development dependencies are out-of-date.


Production Dependencies to Update:

patch

Expand to see individual installs.

npm install [email protected]
  • dotenv Update from version 16.4.1 to 16.4.5 by running...
npm install [email protected]


Development Dependencies to Update:

minor_dev

Expand to see individual installs.

npm install -D [email protected]
  • typescript Update from version 5.3.3 to 5.4.3 by running...
npm install -D [email protected]

patch_dev

Expand to see individual installs.

npm install -D @types/[email protected]
  • @types/node Update from version 20.11.10 to 20.11.30 by running...
npm install -D @types/[email protected]

NPM Dependency Report

NPM Dependency Report - Thursday, January 18th, 2024

Versions of npm packages have been checked against their latest versions from the npm registry.

COVERAGE_PERCENTAGE

✔️ - Production dependencies are all up-to-date.
⚠️ - 4 Development dependencies are out-of-date.

Make sure to change directory to where the package.json is located using...

cd .

Development Dependencies to Update:

minor_dev

Expand to see individual installs.

  • @types/node Update from version 20.10.5 to 20.11.5 by running...
npm install -D @types/[email protected]
  • rollup-plugin-dts Update from version 6.0.2 to 6.1.0 by running...
npm install -D [email protected]
  • typescript Update from version 5.2.2 to 5.3.3 by running...
npm install -D [email protected]

patch_dev

Expand to see individual installs.

npm install -D @rollup/[email protected]
  • @rollup/plugin-typescript Update from version 11.1.5 to 11.1.6 by running...
npm install -D @rollup/[email protected]

NPM Dependency Report

NPM Dependency Report - Tuesday, March 5th, 2024

Versions of npm packages have been checked against their latest versions from the npm registry.

COVERAGE_PERCENTAGE

⚠️ - 1 Production dependencies are out-of-date.
⚠️ - 1 Development dependencies are out-of-date.


Production Dependencies to Update:

patch

Expand to see individual installs.

npm install [email protected]
  • dotenv Update from version 16.4.1 to 16.4.5 by running...
npm install [email protected]


Development Dependencies to Update:

patch_dev

Expand to see individual installs.

npm install -D @types/[email protected]
  • @types/node Update from version 20.11.10 to 20.11.24 by running...
npm install -D @types/[email protected]

NPM Dependency Report

NPM Dependency Report - Tuesday, April 2nd, 2024

Versions of npm packages have been checked against their latest versions from the npm registry.

COVERAGE_PERCENTAGE

⚠️ - 1 Production dependencies are out-of-date.
⚠️ - 2 Development dependencies are out-of-date.


Production Dependencies to Update:

patch

Expand to see individual installs.

npm install [email protected]
  • dotenv Update from version 16.4.1 to 16.4.5 by running...
npm install [email protected]


Development Dependencies to Update:

minor_dev

Expand to see individual installs.

npm install -D @types/[email protected] [email protected]
  • @types/node Update from version 20.11.10 to 20.12.2 by running...
npm install -D @types/[email protected]
  • typescript Update from version 5.3.3 to 5.4.3 by running...
npm install -D [email protected]

NPM Dependency Report

NPM Dependency Report - Tuesday, April 16th, 2024

Versions of npm packages have been checked against their latest versions from the npm registry.

COVERAGE_PERCENTAGE

⚠️ - 1 Production dependencies are out-of-date.
⚠️ - 2 Development dependencies are out-of-date.


Production Dependencies to Update:

patch

Expand to see individual installs.

npm install [email protected]
  • dotenv Update from version 16.4.1 to 16.4.5 by running...
npm install [email protected]


Development Dependencies to Update:

minor_dev

Expand to see individual installs.

npm install -D @types/[email protected] [email protected]
  • @types/node Update from version 20.11.10 to 20.12.7 by running...
npm install -D @types/[email protected]
  • typescript Update from version 5.3.3 to 5.4.5 by running...
npm install -D [email protected]

NPM Dependency Report

NPM Dependency Report - Friday, February 2nd, 2024

Versions of npm packages have been checked against their latest versions from the npm registry.

COVERAGE_PERCENTAGE

✔️ - Production dependencies are all up-to-date.
⚠️ - 1 Development dependencies are out-of-date.


Development Dependencies to Update:

patch_dev

Expand to see individual installs.

npm install -D @types/[email protected]
  • @types/node Update from version 20.11.10 to 20.11.16 by running...
npm install -D @types/[email protected]

NPM Dependency Report

NPM Dependency Report - Tuesday, January 23rd, 2024

Versions of npm packages have been checked against their latest versions from the npm registry.

COVERAGE_PERCENTAGE

⚠️ - 1 Production dependencies are out-of-date.
⚠️ - 4 Development dependencies are out-of-date.


Production Dependencies to Update:

patch

Expand to see individual installs.

npm install [email protected]
  • dotenv Update from version 16.3.1 to 16.3.2 by running...
npm install [email protected]


Development Dependencies to Update:

minor_dev

Expand to see individual installs.

  • @types/node Update from version 20.10.5 to 20.11.5 by running...
npm install -D @types/[email protected]
  • rollup-plugin-dts Update from version 6.0.2 to 6.1.0 by running...
npm install -D [email protected]
  • typescript Update from version 5.2.2 to 5.3.3 by running...
npm install -D [email protected]

patch_dev

Expand to see individual installs.

npm install -D @rollup/[email protected]
  • @rollup/plugin-typescript Update from version 11.1.5 to 11.1.6 by running...
npm install -D @rollup/[email protected]

NPM Dependency Report

NPM Dependency Report - Tuesday, March 19th, 2024

Versions of npm packages have been checked against their latest versions from the npm registry.

COVERAGE_PERCENTAGE

⚠️ - 1 Production dependencies are out-of-date.
⚠️ - 2 Development dependencies are out-of-date.


Production Dependencies to Update:

patch

Expand to see individual installs.

npm install [email protected]
  • dotenv Update from version 16.4.1 to 16.4.5 by running...
npm install [email protected]


Development Dependencies to Update:

minor_dev

Expand to see individual installs.

npm install -D [email protected]
  • typescript Update from version 5.3.3 to 5.4.2 by running...
npm install -D [email protected]

patch_dev

Expand to see individual installs.

npm install -D @types/[email protected]
  • @types/node Update from version 20.11.10 to 20.11.30 by running...
npm install -D @types/[email protected]

NPM Dependency Report

NPM Dependency Report - Tuesday, February 20th, 2024

Versions of npm packages have been checked against their latest versions from the npm registry.

COVERAGE_PERCENTAGE

⚠️ - 1 Production dependencies are out-of-date.
⚠️ - 1 Development dependencies are out-of-date.


Production Dependencies to Update:

patch

Expand to see individual installs.

npm install [email protected]
  • dotenv Update from version 16.4.1 to 16.4.5 by running...
npm install [email protected]


Development Dependencies to Update:

patch_dev

Expand to see individual installs.

npm install -D @types/[email protected]
  • @types/node Update from version 20.11.10 to 20.11.19 by running...
npm install -D @types/[email protected]

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.