A Pulumi package for creating and managing keycloak cloud resources.
Project description
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/go/...
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 variableKEYCLOAK_CLIENT_ID
.keycloak:url
- (Required) - The URL of the Keycloak instance, before /auth/admin. Defaults to the environment variableKEYCLOAK_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 variableKEYCLOAK_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 variableKEYCLOAK_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 variableKEYCLOAK_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 variableKEYCLOAK_REALM
, ormaster
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 totrue
, which is the original method.keycloak:clientTimeout
- (Optional) Sets the timeout of the client when addressing Keycloak, in seconds. Defaults to5
.
Reference
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
File details
Details for the file pulumi_keycloak-1.0.0.tar.gz
.
File metadata
- Download URL: pulumi_keycloak-1.0.0.tar.gz
- Upload date:
- Size: 40.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.6.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf742940104df4e1513e2c6ca6a9641e14d3821c775bfcd1118181364469bf79 |
|
MD5 | 97d279772667888b57357d788ab36f1e |
|
BLAKE2b-256 | 03f2c52bbcf7bf1a85ac9bbcb0ce273c025ac20f34cb0165d313476d1cf02368 |