Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Rancher2 Provider
  3. API Docs
  4. AuthConfigKeycloak
Rancher 2 v8.1.2 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-rancher2

rancher2.AuthConfigKeycloak

Explore with Pulumi AI

rancher2 logo
Rancher 2 v8.1.2 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-rancher2

    Provides a Rancher v2 Auth Config KeyCloak resource. This can be used to configure and enable Auth Config KeyCloak for Rancher v2 RKE clusters and retrieve their information.

    In addition to the built-in local auth, only one external auth config provider can be enabled at a time.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 Auth Config KeyCloak
const keycloak = new rancher2.AuthConfigKeycloak("keycloak", {
    displayNameField: "<DISPLAY_NAME_FIELD>",
    groupsField: "<GROUPS_FIELD>",
    idpMetadataContent: "<IDP_METADATA_CONTENT>",
    rancherApiHost: "https://<RANCHER_API_HOST>",
    spCert: "<SP_CERT>",
    spKey: "<SP_KEY>",
    uidField: "<UID_FIELD>",
    userNameField: "<USER_NAME_FIELD>",
});

    import pulumi
import pulumi_rancher2 as rancher2

# Create a new rancher2 Auth Config KeyCloak
keycloak = rancher2.AuthConfigKeycloak("keycloak",
    display_name_field="<DISPLAY_NAME_FIELD>",
    groups_field="<GROUPS_FIELD>",
    idp_metadata_content="<IDP_METADATA_CONTENT>",
    rancher_api_host="https://<RANCHER_API_HOST>",
    sp_cert="<SP_CERT>",
    sp_key="<SP_KEY>",
    uid_field="<UID_FIELD>",
    user_name_field="<USER_NAME_FIELD>")

    package main

import (
	"github.com/pulumi/pulumi-rancher2/sdk/v8/go/rancher2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a new rancher2 Auth Config KeyCloak
		_, err := rancher2.NewAuthConfigKeycloak(ctx, "keycloak", &rancher2.AuthConfigKeycloakArgs{
			DisplayNameField:   pulumi.String("<DISPLAY_NAME_FIELD>"),
			GroupsField:        pulumi.String("<GROUPS_FIELD>"),
			IdpMetadataContent: pulumi.String("<IDP_METADATA_CONTENT>"),
			RancherApiHost:     pulumi.String("https://<RANCHER_API_HOST>"),
			SpCert:             pulumi.String("<SP_CERT>"),
			SpKey:              pulumi.String("<SP_KEY>"),
			UidField:           pulumi.String("<UID_FIELD>"),
			UserNameField:      pulumi.String("<USER_NAME_FIELD>"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Rancher2 = Pulumi.Rancher2;

return await Deployment.RunAsync(() => 
{
    // Create a new rancher2 Auth Config KeyCloak
    var keycloak = new Rancher2.AuthConfigKeycloak("keycloak", new()
    {
        DisplayNameField = "<DISPLAY_NAME_FIELD>",
        GroupsField = "<GROUPS_FIELD>",
        IdpMetadataContent = "<IDP_METADATA_CONTENT>",
        RancherApiHost = "https://<RANCHER_API_HOST>",
        SpCert = "<SP_CERT>",
        SpKey = "<SP_KEY>",
        UidField = "<UID_FIELD>",
        UserNameField = "<USER_NAME_FIELD>",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.rancher2.AuthConfigKeycloak;
import com.pulumi.rancher2.AuthConfigKeycloakArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Create a new rancher2 Auth Config KeyCloak
        var keycloak = new AuthConfigKeycloak("keycloak", AuthConfigKeycloakArgs.builder()
            .displayNameField("<DISPLAY_NAME_FIELD>")
            .groupsField("<GROUPS_FIELD>")
            .idpMetadataContent("<IDP_METADATA_CONTENT>")
            .rancherApiHost("https://<RANCHER_API_HOST>")
            .spCert("<SP_CERT>")
            .spKey("<SP_KEY>")
            .uidField("<UID_FIELD>")
            .userNameField("<USER_NAME_FIELD>")
            .build());

    }
}

    resources:
  # Create a new rancher2 Auth Config KeyCloak
  keycloak:
    type: rancher2:AuthConfigKeycloak
    properties:
      displayNameField: <DISPLAY_NAME_FIELD>
      groupsField: <GROUPS_FIELD>
      idpMetadataContent: <IDP_METADATA_CONTENT>
      rancherApiHost: https://<RANCHER_API_HOST>
      spCert: <SP_CERT>
      spKey: <SP_KEY>
      uidField: <UID_FIELD>
      userNameField: <USER_NAME_FIELD>

    Create AuthConfigKeycloak Resource

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

    Constructor syntax

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

@overload
def AuthConfigKeycloak(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       groups_field: Optional[str] = None,
                       sp_cert: Optional[str] = None,
                       user_name_field: Optional[str] = None,
                       display_name_field: Optional[str] = None,
                       uid_field: Optional[str] = None,
                       sp_key: Optional[str] = None,
                       rancher_api_host: Optional[str] = None,
                       idp_metadata_content: Optional[str] = None,
                       access_mode: Optional[str] = None,
                       allowed_principal_ids: Optional[Sequence[str]] = None,
                       labels: Optional[Mapping[str, str]] = None,
                       entity_id: Optional[str] = None,
                       enabled: Optional[bool] = None,
                       annotations: Optional[Mapping[str, str]] = None)
    func NewAuthConfigKeycloak(ctx *Context, name string, args AuthConfigKeycloakArgs, opts ...ResourceOption) (*AuthConfigKeycloak, error)
    public AuthConfigKeycloak(string name, AuthConfigKeycloakArgs args, CustomResourceOptions? opts = null)
    public AuthConfigKeycloak(String name, AuthConfigKeycloakArgs args)
public AuthConfigKeycloak(String name, AuthConfigKeycloakArgs args, CustomResourceOptions options)

    type: rancher2:AuthConfigKeycloak
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

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

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var authConfigKeycloakResource = new Rancher2.AuthConfigKeycloak("authConfigKeycloakResource", new()
{
    GroupsField = "string",
    SpCert = "string",
    UserNameField = "string",
    DisplayNameField = "string",
    UidField = "string",
    SpKey = "string",
    RancherApiHost = "string",
    IdpMetadataContent = "string",
    AccessMode = "string",
    AllowedPrincipalIds = new[]
    {
        "string",
    },
    Labels = 
    {
        { "string", "string" },
    },
    EntityId = "string",
    Enabled = false,
    Annotations = 
    {
        { "string", "string" },
    },
});

    example, err := rancher2.NewAuthConfigKeycloak(ctx, "authConfigKeycloakResource", &rancher2.AuthConfigKeycloakArgs{
	GroupsField:        pulumi.String("string"),
	SpCert:             pulumi.String("string"),
	UserNameField:      pulumi.String("string"),
	DisplayNameField:   pulumi.String("string"),
	UidField:           pulumi.String("string"),
	SpKey:              pulumi.String("string"),
	RancherApiHost:     pulumi.String("string"),
	IdpMetadataContent: pulumi.String("string"),
	AccessMode:         pulumi.String("string"),
	AllowedPrincipalIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	EntityId: pulumi.String("string"),
	Enabled:  pulumi.Bool(false),
	Annotations: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var authConfigKeycloakResource = new AuthConfigKeycloak("authConfigKeycloakResource", AuthConfigKeycloakArgs.builder()
    .groupsField("string")
    .spCert("string")
    .userNameField("string")
    .displayNameField("string")
    .uidField("string")
    .spKey("string")
    .rancherApiHost("string")
    .idpMetadataContent("string")
    .accessMode("string")
    .allowedPrincipalIds("string")
    .labels(Map.of("string", "string"))
    .entityId("string")
    .enabled(false)
    .annotations(Map.of("string", "string"))
    .build());

    auth_config_keycloak_resource = rancher2.AuthConfigKeycloak("authConfigKeycloakResource",
    groups_field="string",
    sp_cert="string",
    user_name_field="string",
    display_name_field="string",
    uid_field="string",
    sp_key="string",
    rancher_api_host="string",
    idp_metadata_content="string",
    access_mode="string",
    allowed_principal_ids=["string"],
    labels={
        "string": "string",
    },
    entity_id="string",
    enabled=False,
    annotations={
        "string": "string",
    })

    const authConfigKeycloakResource = new rancher2.AuthConfigKeycloak("authConfigKeycloakResource", {
    groupsField: "string",
    spCert: "string",
    userNameField: "string",
    displayNameField: "string",
    uidField: "string",
    spKey: "string",
    rancherApiHost: "string",
    idpMetadataContent: "string",
    accessMode: "string",
    allowedPrincipalIds: ["string"],
    labels: {
        string: "string",
    },
    entityId: "string",
    enabled: false,
    annotations: {
        string: "string",
    },
});

    type: rancher2:AuthConfigKeycloak
properties:
    accessMode: string
    allowedPrincipalIds:
        - string
    annotations:
        string: string
    displayNameField: string
    enabled: false
    entityId: string
    groupsField: string
    idpMetadataContent: string
    labels:
        string: string
    rancherApiHost: string
    spCert: string
    spKey: string
    uidField: string
    userNameField: string

    AuthConfigKeycloak 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 AuthConfigKeycloak resource accepts the following input properties:

    DisplayNameField string
    KeyCloak display name field (string)
    GroupsField string
    KeyCloak group field (string)
    IdpMetadataContent string
    KeyCloak IDP metadata content (string)
    RancherApiHost string
    Rancher URL. URL scheme needs to be specified, https://<RANCHER_API_HOST> (string)
    SpCert string
    KeyCloak SP cert (string)
    SpKey string
    KeyCloak SP key (string)
    UidField string
    KeyCloak UID field (string)
    UserNameField string
    KeyCloak user name field (string)
    AccessMode string
    Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
    AllowedPrincipalIds List<string>
    Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: keycloak_user://<USER_ID> keycloak_group://<GROUP_ID> (list)
    Annotations Dictionary<string, string>
    Annotations of the resource (map)
    Enabled bool
    Enable auth config provider. Default true (bool)
    EntityId string
    KeyCloak Client ID field (string)
    Labels Dictionary<string, string>
    Labels of the resource (map)
    DisplayNameField string
    KeyCloak display name field (string)
    GroupsField string
    KeyCloak group field (string)
    IdpMetadataContent string
    KeyCloak IDP metadata content (string)
    RancherApiHost string
    Rancher URL. URL scheme needs to be specified, https://<RANCHER_API_HOST> (string)
    SpCert string
    KeyCloak SP cert (string)
    SpKey string
    KeyCloak SP key (string)
    UidField string
    KeyCloak UID field (string)
    UserNameField string
    KeyCloak user name field (string)
    AccessMode string
    Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
    AllowedPrincipalIds []string
    Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: keycloak_user://<USER_ID> keycloak_group://<GROUP_ID> (list)
    Annotations map[string]string
    Annotations of the resource (map)
    Enabled bool
    Enable auth config provider. Default true (bool)
    EntityId string
    KeyCloak Client ID field (string)
    Labels map[string]string
    Labels of the resource (map)
    displayNameField String
    KeyCloak display name field (string)
    groupsField String
    KeyCloak group field (string)
    idpMetadataContent String
    KeyCloak IDP metadata content (string)
    rancherApiHost String
    Rancher URL. URL scheme needs to be specified, https://<RANCHER_API_HOST> (string)
    spCert String
    KeyCloak SP cert (string)
    spKey String
    KeyCloak SP key (string)
    uidField String
    KeyCloak UID field (string)
    userNameField String
    KeyCloak user name field (string)
    accessMode String
    Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
    allowedPrincipalIds List<String>
    Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: keycloak_user://<USER_ID> keycloak_group://<GROUP_ID> (list)
    annotations Map<String,String>
    Annotations of the resource (map)
    enabled Boolean
    Enable auth config provider. Default true (bool)
    entityId String
    KeyCloak Client ID field (string)
    labels Map<String,String>
    Labels of the resource (map)
    displayNameField string
    KeyCloak display name field (string)
    groupsField string
    KeyCloak group field (string)
    idpMetadataContent string
    KeyCloak IDP metadata content (string)
    rancherApiHost string
    Rancher URL. URL scheme needs to be specified, https://<RANCHER_API_HOST> (string)
    spCert string
    KeyCloak SP cert (string)
    spKey string
    KeyCloak SP key (string)
    uidField string
    KeyCloak UID field (string)
    userNameField string
    KeyCloak user name field (string)
    accessMode string
    Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
    allowedPrincipalIds string[]
    Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: keycloak_user://<USER_ID> keycloak_group://<GROUP_ID> (list)
    annotations {[key: string]: string}
    Annotations of the resource (map)
    enabled boolean
    Enable auth config provider. Default true (bool)
    entityId string
    KeyCloak Client ID field (string)
    labels {[key: string]: string}
    Labels of the resource (map)
    display_name_field str
    KeyCloak display name field (string)
    groups_field str
    KeyCloak group field (string)
    idp_metadata_content str
    KeyCloak IDP metadata content (string)
    rancher_api_host str
    Rancher URL. URL scheme needs to be specified, https://<RANCHER_API_HOST> (string)
    sp_cert str
    KeyCloak SP cert (string)
    sp_key str
    KeyCloak SP key (string)
    uid_field str
    KeyCloak UID field (string)
    user_name_field str
    KeyCloak user name field (string)
    access_mode str
    Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
    allowed_principal_ids Sequence[str]
    Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: keycloak_user://<USER_ID> keycloak_group://<GROUP_ID> (list)
    annotations Mapping[str, str]
    Annotations of the resource (map)
    enabled bool
    Enable auth config provider. Default true (bool)
    entity_id str
    KeyCloak Client ID field (string)
    labels Mapping[str, str]
    Labels of the resource (map)
    displayNameField String
    KeyCloak display name field (string)
    groupsField String
    KeyCloak group field (string)
    idpMetadataContent String
    KeyCloak IDP metadata content (string)
    rancherApiHost String
    Rancher URL. URL scheme needs to be specified, https://<RANCHER_API_HOST> (string)
    spCert String
    KeyCloak SP cert (string)
    spKey String
    KeyCloak SP key (string)
    uidField String
    KeyCloak UID field (string)
    userNameField String
    KeyCloak user name field (string)
    accessMode String
    Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
    allowedPrincipalIds List<String>
    Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: keycloak_user://<USER_ID> keycloak_group://<GROUP_ID> (list)
    annotations Map<String>
    Annotations of the resource (map)
    enabled Boolean
    Enable auth config provider. Default true (bool)
    entityId String
    KeyCloak Client ID field (string)
    labels Map<String>
    Labels of the resource (map)

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (Computed) The name of the resource (string)
    Type string
    (Computed) The type of the resource (string)
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (Computed) The name of the resource (string)
    Type string
    (Computed) The type of the resource (string)
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (Computed) The name of the resource (string)
    type String
    (Computed) The type of the resource (string)
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    (Computed) The name of the resource (string)
    type string
    (Computed) The type of the resource (string)
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    (Computed) The name of the resource (string)
    type str
    (Computed) The type of the resource (string)
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (Computed) The name of the resource (string)
    type String
    (Computed) The type of the resource (string)

    Look up Existing AuthConfigKeycloak Resource

    Get an existing AuthConfigKeycloak resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AuthConfigKeycloakState, opts?: CustomResourceOptions): AuthConfigKeycloak
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_mode: Optional[str] = None,
        allowed_principal_ids: Optional[Sequence[str]] = None,
        annotations: Optional[Mapping[str, str]] = None,
        display_name_field: Optional[str] = None,
        enabled: Optional[bool] = None,
        entity_id: Optional[str] = None,
        groups_field: Optional[str] = None,
        idp_metadata_content: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        rancher_api_host: Optional[str] = None,
        sp_cert: Optional[str] = None,
        sp_key: Optional[str] = None,
        type: Optional[str] = None,
        uid_field: Optional[str] = None,
        user_name_field: Optional[str] = None) -> AuthConfigKeycloak
    func GetAuthConfigKeycloak(ctx *Context, name string, id IDInput, state *AuthConfigKeycloakState, opts ...ResourceOption) (*AuthConfigKeycloak, error)
    public static AuthConfigKeycloak Get(string name, Input<string> id, AuthConfigKeycloakState? state, CustomResourceOptions? opts = null)
    public static AuthConfigKeycloak get(String name, Output<String> id, AuthConfigKeycloakState state, CustomResourceOptions options)
    resources:  _:    type: rancher2:AuthConfigKeycloak    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccessMode string
    Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
    AllowedPrincipalIds List<string>
    Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: keycloak_user://<USER_ID> keycloak_group://<GROUP_ID> (list)
    Annotations Dictionary<string, string>
    Annotations of the resource (map)
    DisplayNameField string
    KeyCloak display name field (string)
    Enabled bool
    Enable auth config provider. Default true (bool)
    EntityId string
    KeyCloak Client ID field (string)
    GroupsField string
    KeyCloak group field (string)
    IdpMetadataContent string
    KeyCloak IDP metadata content (string)
    Labels Dictionary<string, string>
    Labels of the resource (map)
    Name string
    (Computed) The name of the resource (string)
    RancherApiHost string
    Rancher URL. URL scheme needs to be specified, https://<RANCHER_API_HOST> (string)
    SpCert string
    KeyCloak SP cert (string)
    SpKey string
    KeyCloak SP key (string)
    Type string
    (Computed) The type of the resource (string)
    UidField string
    KeyCloak UID field (string)
    UserNameField string
    KeyCloak user name field (string)
    AccessMode string
    Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
    AllowedPrincipalIds []string
    Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: keycloak_user://<USER_ID> keycloak_group://<GROUP_ID> (list)
    Annotations map[string]string
    Annotations of the resource (map)
    DisplayNameField string
    KeyCloak display name field (string)
    Enabled bool
    Enable auth config provider. Default true (bool)
    EntityId string
    KeyCloak Client ID field (string)
    GroupsField string
    KeyCloak group field (string)
    IdpMetadataContent string
    KeyCloak IDP metadata content (string)
    Labels map[string]string
    Labels of the resource (map)
    Name string
    (Computed) The name of the resource (string)
    RancherApiHost string
    Rancher URL. URL scheme needs to be specified, https://<RANCHER_API_HOST> (string)
    SpCert string
    KeyCloak SP cert (string)
    SpKey string
    KeyCloak SP key (string)
    Type string
    (Computed) The type of the resource (string)
    UidField string
    KeyCloak UID field (string)
    UserNameField string
    KeyCloak user name field (string)
    accessMode String
    Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
    allowedPrincipalIds List<String>
    Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: keycloak_user://<USER_ID> keycloak_group://<GROUP_ID> (list)
    annotations Map<String,String>
    Annotations of the resource (map)
    displayNameField String
    KeyCloak display name field (string)
    enabled Boolean
    Enable auth config provider. Default true (bool)
    entityId String
    KeyCloak Client ID field (string)
    groupsField String
    KeyCloak group field (string)
    idpMetadataContent String
    KeyCloak IDP metadata content (string)
    labels Map<String,String>
    Labels of the resource (map)
    name String
    (Computed) The name of the resource (string)
    rancherApiHost String
    Rancher URL. URL scheme needs to be specified, https://<RANCHER_API_HOST> (string)
    spCert String
    KeyCloak SP cert (string)
    spKey String
    KeyCloak SP key (string)
    type String
    (Computed) The type of the resource (string)
    uidField String
    KeyCloak UID field (string)
    userNameField String
    KeyCloak user name field (string)
    accessMode string
    Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
    allowedPrincipalIds string[]
    Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: keycloak_user://<USER_ID> keycloak_group://<GROUP_ID> (list)
    annotations {[key: string]: string}
    Annotations of the resource (map)
    displayNameField string
    KeyCloak display name field (string)
    enabled boolean
    Enable auth config provider. Default true (bool)
    entityId string
    KeyCloak Client ID field (string)
    groupsField string
    KeyCloak group field (string)
    idpMetadataContent string
    KeyCloak IDP metadata content (string)
    labels {[key: string]: string}
    Labels of the resource (map)
    name string
    (Computed) The name of the resource (string)
    rancherApiHost string
    Rancher URL. URL scheme needs to be specified, https://<RANCHER_API_HOST> (string)
    spCert string
    KeyCloak SP cert (string)
    spKey string
    KeyCloak SP key (string)
    type string
    (Computed) The type of the resource (string)
    uidField string
    KeyCloak UID field (string)
    userNameField string
    KeyCloak user name field (string)
    access_mode str
    Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
    allowed_principal_ids Sequence[str]
    Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: keycloak_user://<USER_ID> keycloak_group://<GROUP_ID> (list)
    annotations Mapping[str, str]
    Annotations of the resource (map)
    display_name_field str
    KeyCloak display name field (string)
    enabled bool
    Enable auth config provider. Default true (bool)
    entity_id str
    KeyCloak Client ID field (string)
    groups_field str
    KeyCloak group field (string)
    idp_metadata_content str
    KeyCloak IDP metadata content (string)
    labels Mapping[str, str]
    Labels of the resource (map)
    name str
    (Computed) The name of the resource (string)
    rancher_api_host str
    Rancher URL. URL scheme needs to be specified, https://<RANCHER_API_HOST> (string)
    sp_cert str
    KeyCloak SP cert (string)
    sp_key str
    KeyCloak SP key (string)
    type str
    (Computed) The type of the resource (string)
    uid_field str
    KeyCloak UID field (string)
    user_name_field str
    KeyCloak user name field (string)
    accessMode String
    Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
    allowedPrincipalIds List<String>
    Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: keycloak_user://<USER_ID> keycloak_group://<GROUP_ID> (list)
    annotations Map<String>
    Annotations of the resource (map)
    displayNameField String
    KeyCloak display name field (string)
    enabled Boolean
    Enable auth config provider. Default true (bool)
    entityId String
    KeyCloak Client ID field (string)
    groupsField String
    KeyCloak group field (string)
    idpMetadataContent String
    KeyCloak IDP metadata content (string)
    labels Map<String>
    Labels of the resource (map)
    name String
    (Computed) The name of the resource (string)
    rancherApiHost String
    Rancher URL. URL scheme needs to be specified, https://<RANCHER_API_HOST> (string)
    spCert String
    KeyCloak SP cert (string)
    spKey String
    KeyCloak SP key (string)
    type String
    (Computed) The type of the resource (string)
    uidField String
    KeyCloak UID field (string)
    userNameField String
    KeyCloak user name field (string)

    Package Details

    Repository
    Rancher2 pulumi/pulumi-rancher2
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rancher2 Terraform Provider.
    rancher2 logo
    Rancher 2 v8.1.2 published on Thursday, Mar 13, 2025 by Pulumi
    pulumi/pulumi-rancher2