| Name | pulumi-keycloak JSON |
| Version |
5.3.1
JSON |
| download |
| home_page | |
| Summary | A Pulumi package for creating and managing keycloak cloud resources. |
| upload_time | 2024-03-11 12:52:13 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | Apache-2.0 |
| keywords |
pulumi
keycloak
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://github.com/pulumi/pulumi-keycloak/actions)
[](https://slack.pulumi.com)
[](https://www.npmjs.com/package/@pulumi/keycloak)
[](https://pypi.org/project/pulumi-keycloak)
[](https://badge.fury.io/nu/pulumi.keycloak)
[](https://pkg.go.dev/github.com/pulumi/pulumi-keycloak/sdk/v5/go)
[](https://github.com/pulumi/pulumi-keycloak/blob/master/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](https://www.pulumi.com/docs/reference/cli/).
## 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/v5
### .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](https://www.pulumi.com/docs/intro/cloud-providers/keycloak) or for detailed reference documentation, please visit [the API docs](https://www.pulumi.com/docs/reference/pkg/keycloak).
Raw data
{
"_id": null,
"home_page": "",
"name": "pulumi-keycloak",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "pulumi,keycloak",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/c3/37/e3fdac73138b09da79374d93eb295307e55882f512fbb9dab9a0c5621ff3/pulumi_keycloak-5.3.1.tar.gz",
"platform": null,
"description": "[](https://github.com/pulumi/pulumi-keycloak/actions)\n[](https://slack.pulumi.com)\n[](https://www.npmjs.com/package/@pulumi/keycloak)\n[](https://pypi.org/project/pulumi-keycloak)\n[](https://badge.fury.io/nu/pulumi.keycloak)\n[](https://pkg.go.dev/github.com/pulumi/pulumi-keycloak/sdk/v5/go)\n[](https://github.com/pulumi/pulumi-keycloak/blob/master/LICENSE)\n\n# Keycloak Resource Provider\n\nThe Keycloak resource provider for Pulumi lets you manage Keycloak resources in your cloud programs. To use\nthis package, please [install the Pulumi CLI first](https://www.pulumi.com/docs/reference/cli/).\n\n## Installing\n\nThis package is available in many languages in the standard packaging formats.\n\n### Node.js (Java/TypeScript)\n\nTo use from JavaScript or TypeScript in Node.js, install using either `npm`:\n\n $ npm install @pulumi/keycloak\n\nor `yarn`:\n\n $ yarn add @pulumi/keycloak\n\n### Python\n\nTo use from Python, install using `pip`:\n\n $ pip install pulumi_keycloak\n\n### Go\n\nTo use from Go, use `go get` to grab the latest version of the library\n\n $ go get github.com/pulumi/pulumi-keycloak/sdk/v5\n\n### .NET\n\nTo use from .NET, install using `dotnet add package`:\n\n $ dotnet add package Pulumi.Keycloak\n\n## Configuration\n\nThe following configuration points are available:\n\n- `keycloak:clientId` - (Required) The client_id for the client that was created in the \"Keycloak Setup\" section. \n Use the admin-cli client if you are using the password grant. Defaults to the environment variable `KEYCLOAK_CLIENT_ID`.\n- `keycloak:url` - (Required) - The URL of the Keycloak instance, before /auth/admin. Defaults to the environment \n variable `KEYCLOAK_URL`.\n- `keycloak:clientSecret` - (Optional) The secret for the client used by the provider for authentication via the client\n credentials grant. This can be found or changed using the \"Credentials\" tab in the client settings. Defaults to the \n environment variable `KEYCLOAK_CLIENT_SECRET`. This attribute is required when using the client credentials grant,\n and cannot be set when using the password grant.\n- `keycloak:username`- (Optional) The username of the user used by the provider for authentication via the password grant.\n Defaults to environment variable `KEYCLOAK_USER`. This attribute is required when using the password grant, and cannot \n be set when using the client credentials grant.\n- `keycloak:password`- (Optional) The password of the user used by the provider for authentication via the password grant. Defaults to \n environment variable `KEYCLOAK_PASSWORD`. This attribute is required when using the password grant, and cannot be set when\n using the client credentials grant.\n- `keycloak:realm` - (Optional) The realm used by the provider for authentication. Defaults to environment variable \n `KEYCLOAK_REALM`, or `master` if the environment variable is not specified.\n- `keycloak:initialLogin` - (Optional) Optionally avoid Keycloak login during provider setup, for when Keycloak itself \n is being provisioned by terraform. Defaults to `true`, which is the original method.\n- `keycloak:clientTimeout` - (Optional) Sets the timeout of the client when addressing Keycloak, in seconds. Defaults to `5`.\n\n## Reference\n\nFor further information, please visit [the Keycloak provider docs](https://www.pulumi.com/docs/intro/cloud-providers/keycloak) or for detailed reference documentation, please visit [the API docs](https://www.pulumi.com/docs/reference/pkg/keycloak).\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A Pulumi package for creating and managing keycloak cloud resources.",
"version": "5.3.1",
"project_urls": {
"Homepage": "https://pulumi.io",
"Repository": "https://github.com/pulumi/pulumi-keycloak"
},
"split_keywords": [
"pulumi",
"keycloak"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ac5c6f7d63c85fd8c88f816319027ff39476297c25335a5afdd9110a3461edd5",
"md5": "8a82e9b82e4d325edd997e9c5cc1a309",
"sha256": "edbe1f3e2c003985f6dd2292915ed6e36adc8a5803df4dd60a6768e0e5c19ec2"
},
"downloads": -1,
"filename": "pulumi_keycloak-5.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8a82e9b82e4d325edd997e9c5cc1a309",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 364500,
"upload_time": "2024-03-11T12:52:10",
"upload_time_iso_8601": "2024-03-11T12:52:10.763177Z",
"url": "https://files.pythonhosted.org/packages/ac/5c/6f7d63c85fd8c88f816319027ff39476297c25335a5afdd9110a3461edd5/pulumi_keycloak-5.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c337e3fdac73138b09da79374d93eb295307e55882f512fbb9dab9a0c5621ff3",
"md5": "34cb9d1276442dbb2970d68fc38d6af5",
"sha256": "8b799d3c314a01eadca5b9efd9bc1173fa9dbac188265fe6d8b54ce15dc46b56"
},
"downloads": -1,
"filename": "pulumi_keycloak-5.3.1.tar.gz",
"has_sig": false,
"md5_digest": "34cb9d1276442dbb2970d68fc38d6af5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 219824,
"upload_time": "2024-03-11T12:52:13",
"upload_time_iso_8601": "2024-03-11T12:52:13.175054Z",
"url": "https://files.pythonhosted.org/packages/c3/37/e3fdac73138b09da79374d93eb295307e55882f512fbb9dab9a0c5621ff3/pulumi_keycloak-5.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-11 12:52:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pulumi",
"github_project": "pulumi-keycloak",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pulumi-keycloak"
}
