keycloak-keycloak

Namespace

keycloak-keycloak

Description:
  • Effortlessly add authentication to your applications with Keycloak. Secure services, manage users, and implement strong authentication—all with minimal setup. Transform your identity management now!

Author:

Methods

(async, static) createKeycloakKeycloakInstance(context, body) → {KeycloakKeycloak}

Description:
  • Create a new Keycloak instance

Example
import { Context } from '@osaas/client-core';
import { createKeycloakKeycloakInstance } from '@osaas/client-services';

const ctx = new Context();
const body: KeycloakKeycloakConfig = { name: 'myinstance', ... };
const instance = await createKeycloakKeycloakInstance(ctx, body);
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

body KeycloakKeycloakConfig

Service instance configuration

Returns:
  • Service instance
Type
KeycloakKeycloak

(async, static) getKeycloakKeycloakInstance(context, name) → {KeycloakKeycloak}

Description:
  • Get a Keycloak instance

Example
import { Context } from '@osaas/client-core';
import { getKeycloakKeycloakInstance } from '@osaas/client-services';

const ctx = new Context();
const instance = await getKeycloakKeycloakInstance(ctx, 'myinstance');
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

name string

Name of the keycloak to be retrieved

Returns:
  • Service instance
Type
KeycloakKeycloak

(async, static) removeKeycloakKeycloakInstance(context, name)

Description:
  • Remove a Keycloak instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

name string

Name of the keycloak to be removed