Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Keycloak Provider
  3. API Docs
  4. Provider
Keycloak v6.4.0 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-keycloak

keycloak.Provider

Explore with Pulumi AI

Keycloak v6.4.0 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-keycloak

The provider type for the keycloak package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Create Provider Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Provider(name: string, args: ProviderArgs, opts?: CustomResourceOptions);
@overload
def Provider(resource_name: str,
             args: ProviderArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             additional_headers: Optional[Mapping[str, str]] = None,
             base_path: Optional[str] = None,
             client_id: Optional[str] = None,
             client_secret: Optional[str] = None,
             client_timeout: Optional[int] = None,
             initial_login: Optional[bool] = None,
             password: Optional[str] = None,
             realm: Optional[str] = None,
             red_hat_sso: Optional[bool] = None,
             root_ca_certificate: Optional[str] = None,
             tls_insecure_skip_verify: Optional[bool] = None,
             url: Optional[str] = None,
             username: Optional[str] = None)
func NewProvider(ctx *Context, name string, args ProviderArgs, opts ...ResourceOption) (*Provider, error)
public Provider(string name, ProviderArgs args, CustomResourceOptions? opts = null)
public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

type: pulumi:providers:keycloak
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ProviderArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ProviderArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ProviderArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Provider Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Provider resource accepts the following input properties:

ClientId This property is required. string
Url This property is required. string
The base URL of the Keycloak instance, before /auth
AdditionalHeaders Dictionary<string, string>
BasePath string
ClientSecret string
ClientTimeout int
Timeout (in seconds) of the Keycloak client It can also be sourced from the following environment variable: KEYCLOAK_CLIENT_TIMEOUT
InitialLogin bool
Whether or not to login to Keycloak instance on provider initialization
Password string
Realm string
RedHatSso bool
When true, the provider will treat the Keycloak instance as a Red Hat SSO server, specifically when parsing the version returned from the /serverinfo API endpoint.
RootCaCertificate string
Allows x509 calls using an unknown CA certificate (for development purposes)
TlsInsecureSkipVerify bool
Allows ignoring insecure certificates when set to true. Defaults to false. Disabling security check is dangerous and should be avoided.
Username string
ClientId This property is required. string
Url This property is required. string
The base URL of the Keycloak instance, before /auth
AdditionalHeaders map[string]string
BasePath string
ClientSecret string
ClientTimeout int
Timeout (in seconds) of the Keycloak client It can also be sourced from the following environment variable: KEYCLOAK_CLIENT_TIMEOUT
InitialLogin bool
Whether or not to login to Keycloak instance on provider initialization
Password string
Realm string
RedHatSso bool
When true, the provider will treat the Keycloak instance as a Red Hat SSO server, specifically when parsing the version returned from the /serverinfo API endpoint.
RootCaCertificate string
Allows x509 calls using an unknown CA certificate (for development purposes)
TlsInsecureSkipVerify bool
Allows ignoring insecure certificates when set to true. Defaults to false. Disabling security check is dangerous and should be avoided.
Username string
clientId This property is required. String
url This property is required. String
The base URL of the Keycloak instance, before /auth
additionalHeaders Map<String,String>
basePath String
clientSecret String
clientTimeout Integer
Timeout (in seconds) of the Keycloak client It can also be sourced from the following environment variable: KEYCLOAK_CLIENT_TIMEOUT
initialLogin Boolean
Whether or not to login to Keycloak instance on provider initialization
password String
realm String
redHatSso Boolean
When true, the provider will treat the Keycloak instance as a Red Hat SSO server, specifically when parsing the version returned from the /serverinfo API endpoint.
rootCaCertificate String
Allows x509 calls using an unknown CA certificate (for development purposes)
tlsInsecureSkipVerify Boolean
Allows ignoring insecure certificates when set to true. Defaults to false. Disabling security check is dangerous and should be avoided.
username String
clientId This property is required. string
url This property is required. string
The base URL of the Keycloak instance, before /auth
additionalHeaders {[key: string]: string}
basePath string
clientSecret string
clientTimeout number
Timeout (in seconds) of the Keycloak client It can also be sourced from the following environment variable: KEYCLOAK_CLIENT_TIMEOUT
initialLogin boolean
Whether or not to login to Keycloak instance on provider initialization
password string
realm string
redHatSso boolean
When true, the provider will treat the Keycloak instance as a Red Hat SSO server, specifically when parsing the version returned from the /serverinfo API endpoint.
rootCaCertificate string
Allows x509 calls using an unknown CA certificate (for development purposes)
tlsInsecureSkipVerify boolean
Allows ignoring insecure certificates when set to true. Defaults to false. Disabling security check is dangerous and should be avoided.
username string
client_id This property is required. str
url This property is required. str
The base URL of the Keycloak instance, before /auth
additional_headers Mapping[str, str]
base_path str
client_secret str
client_timeout int
Timeout (in seconds) of the Keycloak client It can also be sourced from the following environment variable: KEYCLOAK_CLIENT_TIMEOUT
initial_login bool
Whether or not to login to Keycloak instance on provider initialization
password str
realm str
red_hat_sso bool
When true, the provider will treat the Keycloak instance as a Red Hat SSO server, specifically when parsing the version returned from the /serverinfo API endpoint.
root_ca_certificate str
Allows x509 calls using an unknown CA certificate (for development purposes)
tls_insecure_skip_verify bool
Allows ignoring insecure certificates when set to true. Defaults to false. Disabling security check is dangerous and should be avoided.
username str
clientId This property is required. String
url This property is required. String
The base URL of the Keycloak instance, before /auth
additionalHeaders Map<String>
basePath String
clientSecret String
clientTimeout Number
Timeout (in seconds) of the Keycloak client It can also be sourced from the following environment variable: KEYCLOAK_CLIENT_TIMEOUT
initialLogin Boolean
Whether or not to login to Keycloak instance on provider initialization
password String
realm String
redHatSso Boolean
When true, the provider will treat the Keycloak instance as a Red Hat SSO server, specifically when parsing the version returned from the /serverinfo API endpoint.
rootCaCertificate String
Allows x509 calls using an unknown CA certificate (for development purposes)
tlsInsecureSkipVerify Boolean
Allows ignoring insecure certificates when set to true. Defaults to false. Disabling security check is dangerous and should be avoided.
username String

Outputs

All input properties are implicitly available as output properties. Additionally, the Provider resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Package Details

Repository
Keycloak pulumi/pulumi-keycloak
License
Apache-2.0
Notes
This Pulumi package is based on the keycloak Terraform Provider.
Keycloak v6.4.0 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-keycloak