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.0a1771567723.tar.gz (295.8 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.0a1771567723-py3-none-any.whl (460.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for pulumi_keycloak-6.10.0a1771567723.tar.gz
Algorithm Hash digest
SHA256 b594c69a2d0d92f5a5caeff2c088140ee2f5ce42c334f28ee3f00313c809120d
MD5 761c0bdd70984f6360f2989c91334a27
BLAKE2b-256 90032f3f029c4e3eeda4619ff3ea138c39d0c96234e0629cd6eed22dd2a1f4f2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pulumi_keycloak-6.10.0a1771567723-py3-none-any.whl
Algorithm Hash digest
SHA256 f5dc538adc1b55203817149f0e8a9bb5353e09f07f7b09667b1c8cf72b2282d5
MD5 786d89b2032ee5bbab7f0cac91bad966
BLAKE2b-256 64823b33fecce23d4fa22d5aa674be6a003c0c27e6dee276457297586a8a50ee

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