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.5.0.tar.gz (258.3 kB view details)

Uploaded Source

Built Distribution

pulumi_keycloak-6.5.0-py3-none-any.whl (412.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pulumi_keycloak-6.5.0.tar.gz
Algorithm Hash digest
SHA256 4cb3a3d9a9d4d189e1cda7e092fcd40570a7d1a00cd473dc3f515b624c47e448
MD5 cea0b69e130e3f1cfd2d6e8ef9b4dc5d
BLAKE2b-256 0e08ec469ed5f9d19170b83c1474682aa5bb958172f935bfcac41c01baf0817c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pulumi_keycloak-6.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2ee90bd9a0af0f057871439ab95e705e3c0576ed845433e58f43b56bca73b41e
MD5 b5e2a985441d233f320ad9b738a0836b
BLAKE2b-256 b37e12d88dc708bc5e85ee36509e9424e7e25c106ca6f4232b082fc29e1e4ac4

See more details on using hashes here.

Supported by

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