0.0.0-alpha • Published 12 months ago

@backingman/keycloak v0.0.0-alpha

Weekly downloads
-
License
ISC
Repository
-
Last release
12 months ago

Install

Installing the library with command:

npm i @backingman/keycloak

Configuration

Environment Variables needed on your project

  BACKINGMAN_KEYCLOAK_URL= your_keycloak_url
  BACKINGMAN_KEYCLOAK_REALM= your_keycloak_realm
  BACKINGMAN_KEYCLOAK_CLIENT_ID= your_keycloak_client_id
  BACKINGMAN_KEYCLOAK_CLIEN_SECRET= your_keycloak_client_secret
  BACKINGMAN_KEYCLOAK_USERNAME= your_keycloak_admin_username
  BACKINGMAN_KEYCLOAK_PASSWORD= your_keycloak_admin_password
  BACKINGMAN_KEYCLOAK_TOKEN_EXPIRATION_IN_SECONDS= your_keycloak_client_token_expiration

Usage

Some examples of the library usage

Create user

  import { KeycloakUser } from '@backingman/keycloak'

  KeycloakUser.createKeycloakUser({
    firstName: "Foo",
    lastName: "Bar",
    password: "123456",
    username: "foobar",
    email: "foo@bar.co",
    userIsEnabled: true,
  })

Authenticate user

  import { KeycloakAuth } from '@backingman/keycloak'

  KeycloakAuth.signKeycloakUserIn({
    username: 'foobar',
    password: '123456'
  });