1. Packages
  2. Packages
  3. Rancher2 Provider
  4. API Docs
  5. AuthConfigKeycloakOidc
Viewing docs for Rancher 2 v12.0.0
published on Tuesday, Apr 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-rancher2

rancher2.AuthConfigKeycloakOidc

rancher2 logo
Viewing docs for Rancher 2 v12.0.0
published on Tuesday, Apr 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-rancher2

    Create AuthConfigKeycloakOidc Resource

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

    Constructor syntax

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

@overload
def AuthConfigKeycloakOidc(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           client_id: Optional[str] = None,
                           rancher_url: Optional[str] = None,
                           issuer: Optional[str] = None,
                           client_secret: Optional[str] = None,
                           group_search_enabled: Optional[bool] = None,
                           jwks_url: Optional[str] = None,
                           auth_endpoint: Optional[str] = None,
                           email_claim: Optional[str] = None,
                           enabled: Optional[bool] = None,
                           end_session_endpoint: Optional[str] = None,
                           access_mode: Optional[str] = None,
                           groups_field: Optional[str] = None,
                           annotations: Optional[Mapping[str, str]] = None,
                           certificate: Optional[str] = None,
                           labels: Optional[Mapping[str, str]] = None,
                           logout_all_enabled: Optional[bool] = None,
                           logout_all_forced: Optional[bool] = None,
                           name_claim: Optional[str] = None,
                           private_key: Optional[str] = None,
                           allowed_principal_ids: Optional[Sequence[str]] = None,
                           scopes: Optional[str] = None,
                           token_endpoint: Optional[str] = None,
                           userinfo_endpoint: Optional[str] = None)
    func NewAuthConfigKeycloakOidc(ctx *Context, name string, args AuthConfigKeycloakOidcArgs, opts ...ResourceOption) (*AuthConfigKeycloakOidc, error)
    public AuthConfigKeycloakOidc(string name, AuthConfigKeycloakOidcArgs args, CustomResourceOptions? opts = null)
    public AuthConfigKeycloakOidc(String name, AuthConfigKeycloakOidcArgs args)
public AuthConfigKeycloakOidc(String name, AuthConfigKeycloakOidcArgs args, CustomResourceOptions options)

    type: rancher2:AuthConfigKeycloakOidc
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 AuthConfigKeycloakOidcArgs
    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 AuthConfigKeycloakOidcArgs
    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 AuthConfigKeycloakOidcArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthConfigKeycloakOidcArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthConfigKeycloakOidcArgs
    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 authConfigKeycloakOidcResource = new Rancher2.AuthConfigKeycloakOidc("authConfigKeycloakOidcResource", new()
{
    ClientId = "string",
    RancherUrl = "string",
    Issuer = "string",
    ClientSecret = "string",
    GroupSearchEnabled = false,
    JwksUrl = "string",
    AuthEndpoint = "string",
    EmailClaim = "string",
    Enabled = false,
    EndSessionEndpoint = "string",
    AccessMode = "string",
    GroupsField = "string",
    Annotations = 
    {
        { "string", "string" },
    },
    Certificate = "string",
    Labels = 
    {
        { "string", "string" },
    },
    LogoutAllEnabled = false,
    LogoutAllForced = false,
    NameClaim = "string",
    PrivateKey = "string",
    AllowedPrincipalIds = new[]
    {
        "string",
    },
    Scopes = "string",
    TokenEndpoint = "string",
    UserinfoEndpoint = "string",
});

    example, err := rancher2.NewAuthConfigKeycloakOidc(ctx, "authConfigKeycloakOidcResource", &rancher2.AuthConfigKeycloakOidcArgs{
	ClientId:           pulumi.String("string"),
	RancherUrl:         pulumi.String("string"),
	Issuer:             pulumi.String("string"),
	ClientSecret:       pulumi.String("string"),
	GroupSearchEnabled: pulumi.Bool(false),
	JwksUrl:            pulumi.String("string"),
	AuthEndpoint:       pulumi.String("string"),
	EmailClaim:         pulumi.String("string"),
	Enabled:            pulumi.Bool(false),
	EndSessionEndpoint: pulumi.String("string"),
	AccessMode:         pulumi.String("string"),
	GroupsField:        pulumi.String("string"),
	Annotations: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Certificate: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	LogoutAllEnabled: pulumi.Bool(false),
	LogoutAllForced:  pulumi.Bool(false),
	NameClaim:        pulumi.String("string"),
	PrivateKey:       pulumi.String("string"),
	AllowedPrincipalIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Scopes:           pulumi.String("string"),
	TokenEndpoint:    pulumi.String("string"),
	UserinfoEndpoint: pulumi.String("string"),
})

    var authConfigKeycloakOidcResource = new AuthConfigKeycloakOidc("authConfigKeycloakOidcResource", AuthConfigKeycloakOidcArgs.builder()
    .clientId("string")
    .rancherUrl("string")
    .issuer("string")
    .clientSecret("string")
    .groupSearchEnabled(false)
    .jwksUrl("string")
    .authEndpoint("string")
    .emailClaim("string")
    .enabled(false)
    .endSessionEndpoint("string")
    .accessMode("string")
    .groupsField("string")
    .annotations(Map.of("string", "string"))
    .certificate("string")
    .labels(Map.of("string", "string"))
    .logoutAllEnabled(false)
    .logoutAllForced(false)
    .nameClaim("string")
    .privateKey("string")
    .allowedPrincipalIds("string")
    .scopes("string")
    .tokenEndpoint("string")
    .userinfoEndpoint("string")
    .build());

    auth_config_keycloak_oidc_resource = rancher2.AuthConfigKeycloakOidc("authConfigKeycloakOidcResource",
    client_id="string",
    rancher_url="string",
    issuer="string",
    client_secret="string",
    group_search_enabled=False,
    jwks_url="string",
    auth_endpoint="string",
    email_claim="string",
    enabled=False,
    end_session_endpoint="string",
    access_mode="string",
    groups_field="string",
    annotations={
        "string": "string",
    },
    certificate="string",
    labels={
        "string": "string",
    },
    logout_all_enabled=False,
    logout_all_forced=False,
    name_claim="string",
    private_key="string",
    allowed_principal_ids=["string"],
    scopes="string",
    token_endpoint="string",
    userinfo_endpoint="string")

    const authConfigKeycloakOidcResource = new rancher2.AuthConfigKeycloakOidc("authConfigKeycloakOidcResource", {
    clientId: "string",
    rancherUrl: "string",
    issuer: "string",
    clientSecret: "string",
    groupSearchEnabled: false,
    jwksUrl: "string",
    authEndpoint: "string",
    emailClaim: "string",
    enabled: false,
    endSessionEndpoint: "string",
    accessMode: "string",
    groupsField: "string",
    annotations: {
        string: "string",
    },
    certificate: "string",
    labels: {
        string: "string",
    },
    logoutAllEnabled: false,
    logoutAllForced: false,
    nameClaim: "string",
    privateKey: "string",
    allowedPrincipalIds: ["string"],
    scopes: "string",
    tokenEndpoint: "string",
    userinfoEndpoint: "string",
});

    type: rancher2:AuthConfigKeycloakOidc
properties:
    accessMode: string
    allowedPrincipalIds:
        - string
    annotations:
        string: string
    authEndpoint: string
    certificate: string
    clientId: string
    clientSecret: string
    emailClaim: string
    enabled: false
    endSessionEndpoint: string
    groupSearchEnabled: false
    groupsField: string
    issuer: string
    jwksUrl: string
    labels:
        string: string
    logoutAllEnabled: false
    logoutAllForced: false
    nameClaim: string
    privateKey: string
    rancherUrl: string
    scopes: string
    tokenEndpoint: string
    userinfoEndpoint: string

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

    ClientId string
    The OIDC Client ID.
    ClientSecret string
    The OIDC Client Secret.
    Issuer string
    The OIDC issuer URL.
    RancherUrl string
    The URL of the Rancher server. This is used as the redirect URI for the OIDC provider.
    AccessMode string
    AllowedPrincipalIds List<string>
    Annotations Dictionary<string, string>
    Annotations of the resource
    AuthEndpoint string
    The OIDC Auth Endpoint URL.
    Certificate string
    A PEM-encoded CA certificate for the OIDC provider.
    EmailClaim string
    The OIDC Claim to use for the user email.
    Enabled bool
    EndSessionEndpoint string
    The provider specific URL used for logging a user out of their session.
    GroupSearchEnabled bool
    Enable group search.
    GroupsField string
    The name of the OIDC claim to use for the user's group memberships.
    JwksUrl string
    The OIDC JWKS URL.
    Labels Dictionary<string, string>
    Labels of the resource
    LogoutAllEnabled bool
    Allow the user to choose whether or not to logout of their session with the IdP.
    LogoutAllForced bool
    Force the user to logout of their session with the IdP.
    NameClaim string
    The OIDC Claim to use for the user name.
    PrivateKey string
    A PEM-encoded private key for the OIDC provider.
    Scopes string
    The OIDC scopes to request. Defaults to openid profile email.
    TokenEndpoint string
    The OIDC Token Endpoint URL.
    UserinfoEndpoint string
    The OIDC User Info Endpoint URL.
    ClientId string
    The OIDC Client ID.
    ClientSecret string
    The OIDC Client Secret.
    Issuer string
    The OIDC issuer URL.
    RancherUrl string
    The URL of the Rancher server. This is used as the redirect URI for the OIDC provider.
    AccessMode string
    AllowedPrincipalIds []string
    Annotations map[string]string
    Annotations of the resource
    AuthEndpoint string
    The OIDC Auth Endpoint URL.
    Certificate string
    A PEM-encoded CA certificate for the OIDC provider.
    EmailClaim string
    The OIDC Claim to use for the user email.
    Enabled bool
    EndSessionEndpoint string
    The provider specific URL used for logging a user out of their session.
    GroupSearchEnabled bool
    Enable group search.
    GroupsField string
    The name of the OIDC claim to use for the user's group memberships.
    JwksUrl string
    The OIDC JWKS URL.
    Labels map[string]string
    Labels of the resource
    LogoutAllEnabled bool
    Allow the user to choose whether or not to logout of their session with the IdP.
    LogoutAllForced bool
    Force the user to logout of their session with the IdP.
    NameClaim string
    The OIDC Claim to use for the user name.
    PrivateKey string
    A PEM-encoded private key for the OIDC provider.
    Scopes string
    The OIDC scopes to request. Defaults to openid profile email.
    TokenEndpoint string
    The OIDC Token Endpoint URL.
    UserinfoEndpoint string
    The OIDC User Info Endpoint URL.
    clientId String
    The OIDC Client ID.
    clientSecret String
    The OIDC Client Secret.
    issuer String
    The OIDC issuer URL.
    rancherUrl String
    The URL of the Rancher server. This is used as the redirect URI for the OIDC provider.
    accessMode String
    allowedPrincipalIds List<String>
    annotations Map<String,String>
    Annotations of the resource
    authEndpoint String
    The OIDC Auth Endpoint URL.
    certificate String
    A PEM-encoded CA certificate for the OIDC provider.
    emailClaim String
    The OIDC Claim to use for the user email.
    enabled Boolean
    endSessionEndpoint String
    The provider specific URL used for logging a user out of their session.
    groupSearchEnabled Boolean
    Enable group search.
    groupsField String
    The name of the OIDC claim to use for the user's group memberships.
    jwksUrl String
    The OIDC JWKS URL.
    labels Map<String,String>
    Labels of the resource
    logoutAllEnabled Boolean
    Allow the user to choose whether or not to logout of their session with the IdP.
    logoutAllForced Boolean
    Force the user to logout of their session with the IdP.
    nameClaim String
    The OIDC Claim to use for the user name.
    privateKey String
    A PEM-encoded private key for the OIDC provider.
    scopes String
    The OIDC scopes to request. Defaults to openid profile email.
    tokenEndpoint String
    The OIDC Token Endpoint URL.
    userinfoEndpoint String
    The OIDC User Info Endpoint URL.
    clientId string
    The OIDC Client ID.
    clientSecret string
    The OIDC Client Secret.
    issuer string
    The OIDC issuer URL.
    rancherUrl string
    The URL of the Rancher server. This is used as the redirect URI for the OIDC provider.
    accessMode string
    allowedPrincipalIds string[]
    annotations {[key: string]: string}
    Annotations of the resource
    authEndpoint string
    The OIDC Auth Endpoint URL.
    certificate string
    A PEM-encoded CA certificate for the OIDC provider.
    emailClaim string
    The OIDC Claim to use for the user email.
    enabled boolean
    endSessionEndpoint string
    The provider specific URL used for logging a user out of their session.
    groupSearchEnabled boolean
    Enable group search.
    groupsField string
    The name of the OIDC claim to use for the user's group memberships.
    jwksUrl string
    The OIDC JWKS URL.
    labels {[key: string]: string}
    Labels of the resource
    logoutAllEnabled boolean
    Allow the user to choose whether or not to logout of their session with the IdP.
    logoutAllForced boolean
    Force the user to logout of their session with the IdP.
    nameClaim string
    The OIDC Claim to use for the user name.
    privateKey string
    A PEM-encoded private key for the OIDC provider.
    scopes string
    The OIDC scopes to request. Defaults to openid profile email.
    tokenEndpoint string
    The OIDC Token Endpoint URL.
    userinfoEndpoint string
    The OIDC User Info Endpoint URL.
    client_id str
    The OIDC Client ID.
    client_secret str
    The OIDC Client Secret.
    issuer str
    The OIDC issuer URL.
    rancher_url str
    The URL of the Rancher server. This is used as the redirect URI for the OIDC provider.
    access_mode str
    allowed_principal_ids Sequence[str]
    annotations Mapping[str, str]
    Annotations of the resource
    auth_endpoint str
    The OIDC Auth Endpoint URL.
    certificate str
    A PEM-encoded CA certificate for the OIDC provider.
    email_claim str
    The OIDC Claim to use for the user email.
    enabled bool
    end_session_endpoint str
    The provider specific URL used for logging a user out of their session.
    group_search_enabled bool
    Enable group search.
    groups_field str
    The name of the OIDC claim to use for the user's group memberships.
    jwks_url str
    The OIDC JWKS URL.
    labels Mapping[str, str]
    Labels of the resource
    logout_all_enabled bool
    Allow the user to choose whether or not to logout of their session with the IdP.
    logout_all_forced bool
    Force the user to logout of their session with the IdP.
    name_claim str
    The OIDC Claim to use for the user name.
    private_key str
    A PEM-encoded private key for the OIDC provider.
    scopes str
    The OIDC scopes to request. Defaults to openid profile email.
    token_endpoint str
    The OIDC Token Endpoint URL.
    userinfo_endpoint str
    The OIDC User Info Endpoint URL.
    clientId String
    The OIDC Client ID.
    clientSecret String
    The OIDC Client Secret.
    issuer String
    The OIDC issuer URL.
    rancherUrl String
    The URL of the Rancher server. This is used as the redirect URI for the OIDC provider.
    accessMode String
    allowedPrincipalIds List<String>
    annotations Map<String>
    Annotations of the resource
    authEndpoint String
    The OIDC Auth Endpoint URL.
    certificate String
    A PEM-encoded CA certificate for the OIDC provider.
    emailClaim String
    The OIDC Claim to use for the user email.
    enabled Boolean
    endSessionEndpoint String
    The provider specific URL used for logging a user out of their session.
    groupSearchEnabled Boolean
    Enable group search.
    groupsField String
    The name of the OIDC claim to use for the user's group memberships.
    jwksUrl String
    The OIDC JWKS URL.
    labels Map<String>
    Labels of the resource
    logoutAllEnabled Boolean
    Allow the user to choose whether or not to logout of their session with the IdP.
    logoutAllForced Boolean
    Force the user to logout of their session with the IdP.
    nameClaim String
    The OIDC Claim to use for the user name.
    privateKey String
    A PEM-encoded private key for the OIDC provider.
    scopes String
    The OIDC scopes to request. Defaults to openid profile email.
    tokenEndpoint String
    The OIDC Token Endpoint URL.
    userinfoEndpoint String
    The OIDC User Info Endpoint URL.

    Outputs

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

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

    Look up Existing AuthConfigKeycloakOidc Resource

    Get an existing AuthConfigKeycloakOidc 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?: AuthConfigKeycloakOidcState, opts?: CustomResourceOptions): AuthConfigKeycloakOidc
    @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,
        auth_endpoint: Optional[str] = None,
        certificate: Optional[str] = None,
        client_id: Optional[str] = None,
        client_secret: Optional[str] = None,
        email_claim: Optional[str] = None,
        enabled: Optional[bool] = None,
        end_session_endpoint: Optional[str] = None,
        group_search_enabled: Optional[bool] = None,
        groups_field: Optional[str] = None,
        issuer: Optional[str] = None,
        jwks_url: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        logout_all_enabled: Optional[bool] = None,
        logout_all_forced: Optional[bool] = None,
        name: Optional[str] = None,
        name_claim: Optional[str] = None,
        private_key: Optional[str] = None,
        rancher_url: Optional[str] = None,
        scopes: Optional[str] = None,
        token_endpoint: Optional[str] = None,
        type: Optional[str] = None,
        userinfo_endpoint: Optional[str] = None) -> AuthConfigKeycloakOidc
    func GetAuthConfigKeycloakOidc(ctx *Context, name string, id IDInput, state *AuthConfigKeycloakOidcState, opts ...ResourceOption) (*AuthConfigKeycloakOidc, error)
    public static AuthConfigKeycloakOidc Get(string name, Input<string> id, AuthConfigKeycloakOidcState? state, CustomResourceOptions? opts = null)
    public static AuthConfigKeycloakOidc get(String name, Output<String> id, AuthConfigKeycloakOidcState state, CustomResourceOptions options)
    resources:  _:    type: rancher2:AuthConfigKeycloakOidc    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
    AllowedPrincipalIds List<string>
    Annotations Dictionary<string, string>
    Annotations of the resource
    AuthEndpoint string
    The OIDC Auth Endpoint URL.
    Certificate string
    A PEM-encoded CA certificate for the OIDC provider.
    ClientId string
    The OIDC Client ID.
    ClientSecret string
    The OIDC Client Secret.
    EmailClaim string
    The OIDC Claim to use for the user email.
    Enabled bool
    EndSessionEndpoint string
    The provider specific URL used for logging a user out of their session.
    GroupSearchEnabled bool
    Enable group search.
    GroupsField string
    The name of the OIDC claim to use for the user's group memberships.
    Issuer string
    The OIDC issuer URL.
    JwksUrl string
    The OIDC JWKS URL.
    Labels Dictionary<string, string>
    Labels of the resource
    LogoutAllEnabled bool
    Allow the user to choose whether or not to logout of their session with the IdP.
    LogoutAllForced bool
    Force the user to logout of their session with the IdP.
    Name string
    NameClaim string
    The OIDC Claim to use for the user name.
    PrivateKey string
    A PEM-encoded private key for the OIDC provider.
    RancherUrl string
    The URL of the Rancher server. This is used as the redirect URI for the OIDC provider.
    Scopes string
    The OIDC scopes to request. Defaults to openid profile email.
    TokenEndpoint string
    The OIDC Token Endpoint URL.
    Type string
    UserinfoEndpoint string
    The OIDC User Info Endpoint URL.
    AccessMode string
    AllowedPrincipalIds []string
    Annotations map[string]string
    Annotations of the resource
    AuthEndpoint string
    The OIDC Auth Endpoint URL.
    Certificate string
    A PEM-encoded CA certificate for the OIDC provider.
    ClientId string
    The OIDC Client ID.
    ClientSecret string
    The OIDC Client Secret.
    EmailClaim string
    The OIDC Claim to use for the user email.
    Enabled bool
    EndSessionEndpoint string
    The provider specific URL used for logging a user out of their session.
    GroupSearchEnabled bool
    Enable group search.
    GroupsField string
    The name of the OIDC claim to use for the user's group memberships.
    Issuer string
    The OIDC issuer URL.
    JwksUrl string
    The OIDC JWKS URL.
    Labels map[string]string
    Labels of the resource
    LogoutAllEnabled bool
    Allow the user to choose whether or not to logout of their session with the IdP.
    LogoutAllForced bool
    Force the user to logout of their session with the IdP.
    Name string
    NameClaim string
    The OIDC Claim to use for the user name.
    PrivateKey string
    A PEM-encoded private key for the OIDC provider.
    RancherUrl string
    The URL of the Rancher server. This is used as the redirect URI for the OIDC provider.
    Scopes string
    The OIDC scopes to request. Defaults to openid profile email.
    TokenEndpoint string
    The OIDC Token Endpoint URL.
    Type string
    UserinfoEndpoint string
    The OIDC User Info Endpoint URL.
    accessMode String
    allowedPrincipalIds List<String>
    annotations Map<String,String>
    Annotations of the resource
    authEndpoint String
    The OIDC Auth Endpoint URL.
    certificate String
    A PEM-encoded CA certificate for the OIDC provider.
    clientId String
    The OIDC Client ID.
    clientSecret String
    The OIDC Client Secret.
    emailClaim String
    The OIDC Claim to use for the user email.
    enabled Boolean
    endSessionEndpoint String
    The provider specific URL used for logging a user out of their session.
    groupSearchEnabled Boolean
    Enable group search.
    groupsField String
    The name of the OIDC claim to use for the user's group memberships.
    issuer String
    The OIDC issuer URL.
    jwksUrl String
    The OIDC JWKS URL.
    labels Map<String,String>
    Labels of the resource
    logoutAllEnabled Boolean
    Allow the user to choose whether or not to logout of their session with the IdP.
    logoutAllForced Boolean
    Force the user to logout of their session with the IdP.
    name String
    nameClaim String
    The OIDC Claim to use for the user name.
    privateKey String
    A PEM-encoded private key for the OIDC provider.
    rancherUrl String
    The URL of the Rancher server. This is used as the redirect URI for the OIDC provider.
    scopes String
    The OIDC scopes to request. Defaults to openid profile email.
    tokenEndpoint String
    The OIDC Token Endpoint URL.
    type String
    userinfoEndpoint String
    The OIDC User Info Endpoint URL.
    accessMode string
    allowedPrincipalIds string[]
    annotations {[key: string]: string}
    Annotations of the resource
    authEndpoint string
    The OIDC Auth Endpoint URL.
    certificate string
    A PEM-encoded CA certificate for the OIDC provider.
    clientId string
    The OIDC Client ID.
    clientSecret string
    The OIDC Client Secret.
    emailClaim string
    The OIDC Claim to use for the user email.
    enabled boolean
    endSessionEndpoint string
    The provider specific URL used for logging a user out of their session.
    groupSearchEnabled boolean
    Enable group search.
    groupsField string
    The name of the OIDC claim to use for the user's group memberships.
    issuer string
    The OIDC issuer URL.
    jwksUrl string
    The OIDC JWKS URL.
    labels {[key: string]: string}
    Labels of the resource
    logoutAllEnabled boolean
    Allow the user to choose whether or not to logout of their session with the IdP.
    logoutAllForced boolean
    Force the user to logout of their session with the IdP.
    name string
    nameClaim string
    The OIDC Claim to use for the user name.
    privateKey string
    A PEM-encoded private key for the OIDC provider.
    rancherUrl string
    The URL of the Rancher server. This is used as the redirect URI for the OIDC provider.
    scopes string
    The OIDC scopes to request. Defaults to openid profile email.
    tokenEndpoint string
    The OIDC Token Endpoint URL.
    type string
    userinfoEndpoint string
    The OIDC User Info Endpoint URL.
    access_mode str
    allowed_principal_ids Sequence[str]
    annotations Mapping[str, str]
    Annotations of the resource
    auth_endpoint str
    The OIDC Auth Endpoint URL.
    certificate str
    A PEM-encoded CA certificate for the OIDC provider.
    client_id str
    The OIDC Client ID.
    client_secret str
    The OIDC Client Secret.
    email_claim str
    The OIDC Claim to use for the user email.
    enabled bool
    end_session_endpoint str
    The provider specific URL used for logging a user out of their session.
    group_search_enabled bool
    Enable group search.
    groups_field str
    The name of the OIDC claim to use for the user's group memberships.
    issuer str
    The OIDC issuer URL.
    jwks_url str
    The OIDC JWKS URL.
    labels Mapping[str, str]
    Labels of the resource
    logout_all_enabled bool
    Allow the user to choose whether or not to logout of their session with the IdP.
    logout_all_forced bool
    Force the user to logout of their session with the IdP.
    name str
    name_claim str
    The OIDC Claim to use for the user name.
    private_key str
    A PEM-encoded private key for the OIDC provider.
    rancher_url str
    The URL of the Rancher server. This is used as the redirect URI for the OIDC provider.
    scopes str
    The OIDC scopes to request. Defaults to openid profile email.
    token_endpoint str
    The OIDC Token Endpoint URL.
    type str
    userinfo_endpoint str
    The OIDC User Info Endpoint URL.
    accessMode String
    allowedPrincipalIds List<String>
    annotations Map<String>
    Annotations of the resource
    authEndpoint String
    The OIDC Auth Endpoint URL.
    certificate String
    A PEM-encoded CA certificate for the OIDC provider.
    clientId String
    The OIDC Client ID.
    clientSecret String
    The OIDC Client Secret.
    emailClaim String
    The OIDC Claim to use for the user email.
    enabled Boolean
    endSessionEndpoint String
    The provider specific URL used for logging a user out of their session.
    groupSearchEnabled Boolean
    Enable group search.
    groupsField String
    The name of the OIDC claim to use for the user's group memberships.
    issuer String
    The OIDC issuer URL.
    jwksUrl String
    The OIDC JWKS URL.
    labels Map<String>
    Labels of the resource
    logoutAllEnabled Boolean
    Allow the user to choose whether or not to logout of their session with the IdP.
    logoutAllForced Boolean
    Force the user to logout of their session with the IdP.
    name String
    nameClaim String
    The OIDC Claim to use for the user name.
    privateKey String
    A PEM-encoded private key for the OIDC provider.
    rancherUrl String
    The URL of the Rancher server. This is used as the redirect URI for the OIDC provider.
    scopes String
    The OIDC scopes to request. Defaults to openid profile email.
    tokenEndpoint String
    The OIDC Token Endpoint URL.
    type String
    userinfoEndpoint String
    The OIDC User Info Endpoint URL.

    Package Details

    Repository
    Rancher2 pulumi/pulumi-rancher2
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rancher2 Terraform Provider.
    rancher2 logo
    Viewing docs for Rancher 2 v12.0.0
    published on Tuesday, Apr 21, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-rancher2
      Try Pulumi Cloud free. Your team will thank you.