Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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.

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.14.0a1786015482.tar.gz (365.5 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.14.0a1786015482-py3-none-any.whl (549.6 kB view details)

Uploaded Python 3

File details

Details for the file pulumi_keycloak-6.14.0a1786015482.tar.gz.

File metadata

File hashes

Hashes for pulumi_keycloak-6.14.0a1786015482.tar.gz
Algorithm Hash digest
SHA256 a87145faffce55e2df6df2be133efe002b01c26f27d2a46522d326d2a8461c87
MD5 3c7af531c82945b5e12eed512a72e155
BLAKE2b-256 d5ddbd2a61922fc7f43d3b0b77b0afd1ea9d2ca4c2f14459b7738bd46fa9c681

See more details on using hashes here.

File details

Details for the file pulumi_keycloak-6.14.0a1786015482-py3-none-any.whl.

File metadata

File hashes

Hashes for pulumi_keycloak-6.14.0a1786015482-py3-none-any.whl
Algorithm Hash digest
SHA256 0dc58812b63ab59a69c97676966c89ad497551fff469de514eabb0d357dc9e31
MD5 872749e8f37ed3aa02f148b87a5fcde0
BLAKE2b-256 48e7aae497c62a5a11cdb7693d663eb3a805d4462763f621331f66b767dd48cf

See more details on using hashes here.

Release history Release notifications | RSS feed

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