Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Rancher2 Provider
  3. API Docs
  4. AuthConfigPing
Rancher 2 v8.1.5 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-rancher2

rancher2.AuthConfigPing

Explore with Pulumi AI

Rancher 2 v8.1.5 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-rancher2

Provides a Rancher v2 Auth Config Ping resource. This can be used to configure and enable Auth Config Ping 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 Ping
const ping = new rancher2.AuthConfigPing("ping", {
    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>",
});
Copy
import pulumi
import pulumi_rancher2 as rancher2

# Create a new rancher2 Auth Config Ping
ping = rancher2.AuthConfigPing("ping",
    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>")
Copy
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 Ping
		_, err := rancher2.NewAuthConfigPing(ctx, "ping", &rancher2.AuthConfigPingArgs{
			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
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Rancher2 = Pulumi.Rancher2;

return await Deployment.RunAsync(() => 
{
    // Create a new rancher2 Auth Config Ping
    var ping = new Rancher2.AuthConfigPing("ping", 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>",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.rancher2.AuthConfigPing;
import com.pulumi.rancher2.AuthConfigPingArgs;
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 Ping
        var ping = new AuthConfigPing("ping", AuthConfigPingArgs.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());

    }
}
Copy
resources:
  # Create a new rancher2 Auth Config Ping
  ping:
    type: rancher2:AuthConfigPing
    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>
Copy

Create AuthConfigPing Resource

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

Constructor syntax

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

@overload
def AuthConfigPing(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_field: Optional[str] = None,
                   enabled: Optional[bool] = None,
                   annotations: Optional[Mapping[str, str]] = None)
func NewAuthConfigPing(ctx *Context, name string, args AuthConfigPingArgs, opts ...ResourceOption) (*AuthConfigPing, error)
public AuthConfigPing(string name, AuthConfigPingArgs args, CustomResourceOptions? opts = null)
public AuthConfigPing(String name, AuthConfigPingArgs args)
public AuthConfigPing(String name, AuthConfigPingArgs args, CustomResourceOptions options)

type: rancher2:AuthConfigPing
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. AuthConfigPingArgs
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. AuthConfigPingArgs
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. AuthConfigPingArgs
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. AuthConfigPingArgs
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. AuthConfigPingArgs
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 authConfigPingResource = new Rancher2.AuthConfigPing("authConfigPingResource", 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" },
    },
    EntityIdField = "string",
    Enabled = false,
    Annotations = 
    {
        { "string", "string" },
    },
});
Copy
example, err := rancher2.NewAuthConfigPing(ctx, "authConfigPingResource", &rancher2.AuthConfigPingArgs{
	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"),
	},
	EntityIdField: pulumi.String("string"),
	Enabled:       pulumi.Bool(false),
	Annotations: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var authConfigPingResource = new AuthConfigPing("authConfigPingResource", AuthConfigPingArgs.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"))
    .entityIdField("string")
    .enabled(false)
    .annotations(Map.of("string", "string"))
    .build());
Copy
auth_config_ping_resource = rancher2.AuthConfigPing("authConfigPingResource",
    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_field="string",
    enabled=False,
    annotations={
        "string": "string",
    })
Copy
const authConfigPingResource = new rancher2.AuthConfigPing("authConfigPingResource", {
    groupsField: "string",
    spCert: "string",
    userNameField: "string",
    displayNameField: "string",
    uidField: "string",
    spKey: "string",
    rancherApiHost: "string",
    idpMetadataContent: "string",
    accessMode: "string",
    allowedPrincipalIds: ["string"],
    labels: {
        string: "string",
    },
    entityIdField: "string",
    enabled: false,
    annotations: {
        string: "string",
    },
});
Copy
type: rancher2:AuthConfigPing
properties:
    accessMode: string
    allowedPrincipalIds:
        - string
    annotations:
        string: string
    displayNameField: string
    enabled: false
    entityIdField: string
    groupsField: string
    idpMetadataContent: string
    labels:
        string: string
    rancherApiHost: string
    spCert: string
    spKey: string
    uidField: string
    userNameField: string
Copy

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

DisplayNameField This property is required. string
Ping display name field (string)
GroupsField This property is required. string
Ping group field (string)
IdpMetadataContent This property is required. string
Ping IDP metadata content (string)
RancherApiHost This property is required. string
Rancher URL. URL scheme needs to be specified, https://<RANCHER_API_HOST> (string)
SpCert This property is required. string
Ping SP cert (string)
SpKey This property is required. string
Ping SP key (string)
UidField This property is required. string
Ping UID field (string)
UserNameField This property is required. string
Ping 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: ping_user://<USER_ID> ping_group://<GROUP_ID> (list)
Annotations Dictionary<string, string>
Annotations of the resource (map)
Enabled bool
Enable auth config provider. Default true (bool)
EntityIdField string
Ping entity ID field (string)
Labels Dictionary<string, string>
Labels of the resource (map)
DisplayNameField This property is required. string
Ping display name field (string)
GroupsField This property is required. string
Ping group field (string)
IdpMetadataContent This property is required. string
Ping IDP metadata content (string)
RancherApiHost This property is required. string
Rancher URL. URL scheme needs to be specified, https://<RANCHER_API_HOST> (string)
SpCert This property is required. string
Ping SP cert (string)
SpKey This property is required. string
Ping SP key (string)
UidField This property is required. string
Ping UID field (string)
UserNameField This property is required. string
Ping 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: ping_user://<USER_ID> ping_group://<GROUP_ID> (list)
Annotations map[string]string
Annotations of the resource (map)
Enabled bool
Enable auth config provider. Default true (bool)
EntityIdField string
Ping entity ID field (string)
Labels map[string]string
Labels of the resource (map)
displayNameField This property is required. String
Ping display name field (string)
groupsField This property is required. String
Ping group field (string)
idpMetadataContent This property is required. String
Ping IDP metadata content (string)
rancherApiHost This property is required. String
Rancher URL. URL scheme needs to be specified, https://<RANCHER_API_HOST> (string)
spCert This property is required. String
Ping SP cert (string)
spKey This property is required. String
Ping SP key (string)
uidField This property is required. String
Ping UID field (string)
userNameField This property is required. String
Ping 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: ping_user://<USER_ID> ping_group://<GROUP_ID> (list)
annotations Map<String,String>
Annotations of the resource (map)
enabled Boolean
Enable auth config provider. Default true (bool)
entityIdField String
Ping entity ID field (string)
labels Map<String,String>
Labels of the resource (map)
displayNameField This property is required. string
Ping display name field (string)
groupsField This property is required. string
Ping group field (string)
idpMetadataContent This property is required. string
Ping IDP metadata content (string)
rancherApiHost This property is required. string
Rancher URL. URL scheme needs to be specified, https://<RANCHER_API_HOST> (string)
spCert This property is required. string
Ping SP cert (string)
spKey This property is required. string
Ping SP key (string)
uidField This property is required. string
Ping UID field (string)
userNameField This property is required. string
Ping 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: ping_user://<USER_ID> ping_group://<GROUP_ID> (list)
annotations {[key: string]: string}
Annotations of the resource (map)
enabled boolean
Enable auth config provider. Default true (bool)
entityIdField string
Ping entity ID field (string)
labels {[key: string]: string}
Labels of the resource (map)
display_name_field This property is required. str
Ping display name field (string)
groups_field This property is required. str
Ping group field (string)
idp_metadata_content This property is required. str
Ping IDP metadata content (string)
rancher_api_host This property is required. str
Rancher URL. URL scheme needs to be specified, https://<RANCHER_API_HOST> (string)
sp_cert This property is required. str
Ping SP cert (string)
sp_key This property is required. str
Ping SP key (string)
uid_field This property is required. str
Ping UID field (string)
user_name_field This property is required. str
Ping 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: ping_user://<USER_ID> ping_group://<GROUP_ID> (list)
annotations Mapping[str, str]
Annotations of the resource (map)
enabled bool
Enable auth config provider. Default true (bool)
entity_id_field str
Ping entity ID field (string)
labels Mapping[str, str]
Labels of the resource (map)
displayNameField This property is required. String
Ping display name field (string)
groupsField This property is required. String
Ping group field (string)
idpMetadataContent This property is required. String
Ping IDP metadata content (string)
rancherApiHost This property is required. String
Rancher URL. URL scheme needs to be specified, https://<RANCHER_API_HOST> (string)
spCert This property is required. String
Ping SP cert (string)
spKey This property is required. String
Ping SP key (string)
uidField This property is required. String
Ping UID field (string)
userNameField This property is required. String
Ping 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: ping_user://<USER_ID> ping_group://<GROUP_ID> (list)
annotations Map<String>
Annotations of the resource (map)
enabled Boolean
Enable auth config provider. Default true (bool)
entityIdField String
Ping entity ID field (string)
labels Map<String>
Labels of the resource (map)

Outputs

All input properties are implicitly available as output properties. Additionally, the AuthConfigPing 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 AuthConfigPing Resource

Get an existing AuthConfigPing 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?: AuthConfigPingState, opts?: CustomResourceOptions): AuthConfigPing
@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_field: 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) -> AuthConfigPing
func GetAuthConfigPing(ctx *Context, name string, id IDInput, state *AuthConfigPingState, opts ...ResourceOption) (*AuthConfigPing, error)
public static AuthConfigPing Get(string name, Input<string> id, AuthConfigPingState? state, CustomResourceOptions? opts = null)
public static AuthConfigPing get(String name, Output<String> id, AuthConfigPingState state, CustomResourceOptions options)
resources:  _:    type: rancher2:AuthConfigPing    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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: ping_user://<USER_ID> ping_group://<GROUP_ID> (list)
Annotations Dictionary<string, string>
Annotations of the resource (map)
DisplayNameField string
Ping display name field (string)
Enabled bool
Enable auth config provider. Default true (bool)
EntityIdField string
Ping entity ID field (string)
GroupsField string
Ping group field (string)
IdpMetadataContent string
Ping 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
Ping SP cert (string)
SpKey string
Ping SP key (string)
Type string
(Computed) The type of the resource (string)
UidField string
Ping UID field (string)
UserNameField string
Ping 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: ping_user://<USER_ID> ping_group://<GROUP_ID> (list)
Annotations map[string]string
Annotations of the resource (map)
DisplayNameField string
Ping display name field (string)
Enabled bool
Enable auth config provider. Default true (bool)
EntityIdField string
Ping entity ID field (string)
GroupsField string
Ping group field (string)
IdpMetadataContent string
Ping 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
Ping SP cert (string)
SpKey string
Ping SP key (string)
Type string
(Computed) The type of the resource (string)
UidField string
Ping UID field (string)
UserNameField string
Ping 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: ping_user://<USER_ID> ping_group://<GROUP_ID> (list)
annotations Map<String,String>
Annotations of the resource (map)
displayNameField String
Ping display name field (string)
enabled Boolean
Enable auth config provider. Default true (bool)
entityIdField String
Ping entity ID field (string)
groupsField String
Ping group field (string)
idpMetadataContent String
Ping 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
Ping SP cert (string)
spKey String
Ping SP key (string)
type String
(Computed) The type of the resource (string)
uidField String
Ping UID field (string)
userNameField String
Ping 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: ping_user://<USER_ID> ping_group://<GROUP_ID> (list)
annotations {[key: string]: string}
Annotations of the resource (map)
displayNameField string
Ping display name field (string)
enabled boolean
Enable auth config provider. Default true (bool)
entityIdField string
Ping entity ID field (string)
groupsField string
Ping group field (string)
idpMetadataContent string
Ping 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
Ping SP cert (string)
spKey string
Ping SP key (string)
type string
(Computed) The type of the resource (string)
uidField string
Ping UID field (string)
userNameField string
Ping 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: ping_user://<USER_ID> ping_group://<GROUP_ID> (list)
annotations Mapping[str, str]
Annotations of the resource (map)
display_name_field str
Ping display name field (string)
enabled bool
Enable auth config provider. Default true (bool)
entity_id_field str
Ping entity ID field (string)
groups_field str
Ping group field (string)
idp_metadata_content str
Ping 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
Ping SP cert (string)
sp_key str
Ping SP key (string)
type str
(Computed) The type of the resource (string)
uid_field str
Ping UID field (string)
user_name_field str
Ping 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: ping_user://<USER_ID> ping_group://<GROUP_ID> (list)
annotations Map<String>
Annotations of the resource (map)
displayNameField String
Ping display name field (string)
enabled Boolean
Enable auth config provider. Default true (bool)
entityIdField String
Ping entity ID field (string)
groupsField String
Ping group field (string)
idpMetadataContent String
Ping 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
Ping SP cert (string)
spKey String
Ping SP key (string)
type String
(Computed) The type of the resource (string)
uidField String
Ping UID field (string)
userNameField String
Ping 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.
Rancher 2 v8.1.5 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-rancher2