Skip to main content

A Pulumi package for creating and managing keycloak cloud resources.

Project description

Actions Status Slack NPM version Python version NuGet version PkgGoDev License

Keycloak Resource Provider

The Keycloak resource provider for Pulumi lets you manage Keycloak resources in your cloud programs. To use this package, please install the Pulumi CLI first.

Installing

This package is available in many languages in the standard packaging formats.

Node.js (Java/TypeScript)

To use from JavaScript or TypeScript in Node.js, install using either npm:

$ npm install @pulumi/keycloak

or yarn:

$ yarn add @pulumi/keycloak

Python

To use from Python, install using pip:

$ pip install pulumi_keycloak

Go

To use from Go, use go get to grab the latest version of the library

$ go get github.com/pulumi/pulumi-keycloak/sdk/v6

.NET

To use from .NET, install using dotnet add package:

$ dotnet add package Pulumi.Keycloak

Configuration

The following configuration points are available:

  • keycloak:clientId - (Required) The client_id for the client that was created in the "Keycloak Setup" section. Use the admin-cli client if you are using the password grant. Defaults to the environment variable KEYCLOAK_CLIENT_ID.
  • keycloak:url - (Required) - The URL of the Keycloak instance, before /auth/admin. Defaults to the environment variable KEYCLOAK_URL.
  • keycloak:clientSecret - (Optional) The secret for the client used by the provider for authentication via the client credentials grant. This can be found or changed using the "Credentials" tab in the client settings. Defaults to the environment variable KEYCLOAK_CLIENT_SECRET. This attribute is required when using the client credentials grant, and cannot be set when using the password grant.
  • keycloak:username- (Optional) The username of the user used by the provider for authentication via the password grant. Defaults to environment variable KEYCLOAK_USER. This attribute is required when using the password grant, and cannot be set when using the client credentials grant.
  • keycloak:password- (Optional) The password of the user used by the provider for authentication via the password grant. Defaults to environment variable KEYCLOAK_PASSWORD. This attribute is required when using the password grant, and cannot be set when using the client credentials grant.
  • keycloak:realm - (Optional) The realm used by the provider for authentication. Defaults to environment variable KEYCLOAK_REALM, or master if the environment variable is not specified.
  • keycloak:initialLogin - (Optional) Optionally avoid Keycloak login during provider setup, for when Keycloak itself is being provisioned by terraform. Defaults to true, which is the original method.
  • keycloak:clientTimeout - (Optional) Sets the timeout of the client when addressing Keycloak, in seconds. Defaults to 5.

Reference

For further information, please visit the Keycloak provider docs or for detailed reference documentation, please visit the API docs.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pulumi_keycloak-6.10.0.tar.gz (306.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pulumi_keycloak-6.10.0-py3-none-any.whl (475.2 kB view details)

Uploaded Python 3

File details

Details for the file pulumi_keycloak-6.10.0.tar.gz.

File metadata

  • Download URL: pulumi_keycloak-6.10.0.tar.gz
  • Upload date:
  • Size: 306.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.8

File hashes

Hashes for pulumi_keycloak-6.10.0.tar.gz
Algorithm Hash digest
SHA256 de8371f33a4075d5d218f57f667d20d25d384a8196f5a11c48e89a07b8fc3d64
MD5 b26a5820bcc1222aa94ebced349da2b4
BLAKE2b-256 05360e0edc0678e9b0cdc2e3ab8f88d58ca028ae6857de45036bd2a8ad6f9855

See more details on using hashes here.

File details

Details for the file pulumi_keycloak-6.10.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pulumi_keycloak-6.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0042b8553ec4cc7a1c3a214ea8c4bdbbd4f44ff97892b5e80e0543836825c1ba
MD5 d5b8ce2b95999f262128dbe0a84baa90
BLAKE2b-256 5ae35080c6dbd192dbe0711c3d2d2143367b54ad4daac1e3880cb5a24fb0e22f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page