1. Pulumi Registry
  2. Rancher2
  3. API Docs
  4. AuthConfigAdfs
rancher2 logo
Rancher 2 v3.9.0, Jan 18 23

rancher2.AuthConfigAdfs

Provides a Rancher v2 Auth Config ADFS resource. This can be used to configure and enable Auth Config ADFS 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

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

return await Deployment.RunAsync(() => 
{
    // Create a new rancher2 Auth Config ADFS
    var adfs = new Rancher2.AuthConfigAdfs("adfs", 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 main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rancher2.NewAuthConfigAdfs(ctx, "adfs", &rancher2.AuthConfigAdfsArgs{
			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
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.rancher2.AuthConfigAdfs;
import com.pulumi.rancher2.AuthConfigAdfsArgs;
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) {
        var adfs = new AuthConfigAdfs("adfs", AuthConfigAdfsArgs.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());

    }
}

import pulumi
import pulumi_rancher2 as rancher2

# Create a new rancher2 Auth Config ADFS
adfs = rancher2.AuthConfigAdfs("adfs",
    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>")

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

// Create a new rancher2 Auth Config ADFS
const adfs = new rancher2.AuthConfigAdfs("adfs", {
    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>",
});

resources:
  # Create a new rancher2 Auth Config ADFS
  adfs:
    type: rancher2:AuthConfigAdfs
    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 AuthConfigAdfs Resource

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

type: rancher2:AuthConfigAdfs
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AuthConfigAdfsArgs
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 AuthConfigAdfsArgs
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 AuthConfigAdfsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AuthConfigAdfsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AuthConfigAdfsArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

AuthConfigAdfs Resource Properties

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

Inputs

The AuthConfigAdfs resource accepts the following input properties:

DisplayNameField string

ADFS display name field (string)

GroupsField string

ADFS group field (string)

IdpMetadataContent string

ADFS IDP metadata content (string)

RancherApiHost string

Rancher URL. URL scheme needs to be specified, https://<RANCHER_API_HOST> (string)

SpCert string

ADFS SP cert (string)

SpKey string

ADFS SP key (string)

UidField string

ADFS UID field (string)

UserNameField string

ADFS 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: adfs_user://<USER_ID> adfs_group://<GROUP_ID> (list)

Annotations Dictionary<string, object>

Annotations of the resource (map)

Enabled bool

Enable auth config provider. Default true (bool)

Labels Dictionary<string, object>

Labels of the resource (map)

DisplayNameField string

ADFS display name field (string)

GroupsField string

ADFS group field (string)

IdpMetadataContent string

ADFS IDP metadata content (string)

RancherApiHost string

Rancher URL. URL scheme needs to be specified, https://<RANCHER_API_HOST> (string)

SpCert string

ADFS SP cert (string)

SpKey string

ADFS SP key (string)

UidField string

ADFS UID field (string)

UserNameField string

ADFS 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: adfs_user://<USER_ID> adfs_group://<GROUP_ID> (list)

Annotations map[string]interface{}

Annotations of the resource (map)

Enabled bool

Enable auth config provider. Default true (bool)

Labels map[string]interface{}

Labels of the resource (map)

displayNameField String

ADFS display name field (string)

groupsField String

ADFS group field (string)

idpMetadataContent String

ADFS IDP metadata content (string)

rancherApiHost String

Rancher URL. URL scheme needs to be specified, https://<RANCHER_API_HOST> (string)

spCert String

ADFS SP cert (string)

spKey String

ADFS SP key (string)

uidField String

ADFS UID field (string)

userNameField String

ADFS 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: adfs_user://<USER_ID> adfs_group://<GROUP_ID> (list)

annotations Map<String,Object>

Annotations of the resource (map)

enabled Boolean

Enable auth config provider. Default true (bool)

labels Map<String,Object>

Labels of the resource (map)

displayNameField string

ADFS display name field (string)

groupsField string

ADFS group field (string)

idpMetadataContent string

ADFS IDP metadata content (string)

rancherApiHost string

Rancher URL. URL scheme needs to be specified, https://<RANCHER_API_HOST> (string)

spCert string

ADFS SP cert (string)

spKey string

ADFS SP key (string)

uidField string

ADFS UID field (string)

userNameField string

ADFS 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: adfs_user://<USER_ID> adfs_group://<GROUP_ID> (list)

annotations {[key: string]: any}

Annotations of the resource (map)

enabled boolean

Enable auth config provider. Default true (bool)

labels {[key: string]: any}

Labels of the resource (map)

display_name_field str

ADFS display name field (string)

groups_field str

ADFS group field (string)

idp_metadata_content str

ADFS IDP metadata content (string)

rancher_api_host str

Rancher URL. URL scheme needs to be specified, https://<RANCHER_API_HOST> (string)

sp_cert str

ADFS SP cert (string)

sp_key str

ADFS SP key (string)

uid_field str

ADFS UID field (string)

user_name_field str

ADFS 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: adfs_user://<USER_ID> adfs_group://<GROUP_ID> (list)

annotations Mapping[str, Any]

Annotations of the resource (map)

enabled bool

Enable auth config provider. Default true (bool)

labels Mapping[str, Any]

Labels of the resource (map)

displayNameField String

ADFS display name field (string)

groupsField String

ADFS group field (string)

idpMetadataContent String

ADFS IDP metadata content (string)

rancherApiHost String

Rancher URL. URL scheme needs to be specified, https://<RANCHER_API_HOST> (string)

spCert String

ADFS SP cert (string)

spKey String

ADFS SP key (string)

uidField String

ADFS UID field (string)

userNameField String

ADFS 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: adfs_user://<USER_ID> adfs_group://<GROUP_ID> (list)

annotations Map<Any>

Annotations of the resource (map)

enabled Boolean

Enable auth config provider. Default true (bool)

labels Map<Any>

Labels of the resource (map)

Outputs

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

Get an existing AuthConfigAdfs 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?: AuthConfigAdfsState, opts?: CustomResourceOptions): AuthConfigAdfs
@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, Any]] = None,
        display_name_field: Optional[str] = None,
        enabled: Optional[bool] = None,
        groups_field: Optional[str] = None,
        idp_metadata_content: Optional[str] = None,
        labels: Optional[Mapping[str, Any]] = 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) -> AuthConfigAdfs
func GetAuthConfigAdfs(ctx *Context, name string, id IDInput, state *AuthConfigAdfsState, opts ...ResourceOption) (*AuthConfigAdfs, error)
public static AuthConfigAdfs Get(string name, Input<string> id, AuthConfigAdfsState? state, CustomResourceOptions? opts = null)
public static AuthConfigAdfs get(String name, Output<String> id, AuthConfigAdfsState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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: adfs_user://<USER_ID> adfs_group://<GROUP_ID> (list)

Annotations Dictionary<string, object>

Annotations of the resource (map)

DisplayNameField string

ADFS display name field (string)

Enabled bool

Enable auth config provider. Default true (bool)

GroupsField string

ADFS group field (string)

IdpMetadataContent string

ADFS IDP metadata content (string)

Labels Dictionary<string, object>

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

ADFS SP cert (string)

SpKey string

ADFS SP key (string)

Type string

(Computed) The type of the resource (string)

UidField string

ADFS UID field (string)

UserNameField string

ADFS 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: adfs_user://<USER_ID> adfs_group://<GROUP_ID> (list)

Annotations map[string]interface{}

Annotations of the resource (map)

DisplayNameField string

ADFS display name field (string)

Enabled bool

Enable auth config provider. Default true (bool)

GroupsField string

ADFS group field (string)

IdpMetadataContent string

ADFS IDP metadata content (string)

Labels map[string]interface{}

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

ADFS SP cert (string)

SpKey string

ADFS SP key (string)

Type string

(Computed) The type of the resource (string)

UidField string

ADFS UID field (string)

UserNameField string

ADFS 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: adfs_user://<USER_ID> adfs_group://<GROUP_ID> (list)

annotations Map<String,Object>

Annotations of the resource (map)

displayNameField String

ADFS display name field (string)

enabled Boolean

Enable auth config provider. Default true (bool)

groupsField String

ADFS group field (string)

idpMetadataContent String

ADFS IDP metadata content (string)

labels Map<String,Object>

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

ADFS SP cert (string)

spKey String

ADFS SP key (string)

type String

(Computed) The type of the resource (string)

uidField String

ADFS UID field (string)

userNameField String

ADFS 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: adfs_user://<USER_ID> adfs_group://<GROUP_ID> (list)

annotations {[key: string]: any}

Annotations of the resource (map)

displayNameField string

ADFS display name field (string)

enabled boolean

Enable auth config provider. Default true (bool)

groupsField string

ADFS group field (string)

idpMetadataContent string

ADFS IDP metadata content (string)

labels {[key: string]: any}

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

ADFS SP cert (string)

spKey string

ADFS SP key (string)

type string

(Computed) The type of the resource (string)

uidField string

ADFS UID field (string)

userNameField string

ADFS 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: adfs_user://<USER_ID> adfs_group://<GROUP_ID> (list)

annotations Mapping[str, Any]

Annotations of the resource (map)

display_name_field str

ADFS display name field (string)

enabled bool

Enable auth config provider. Default true (bool)

groups_field str

ADFS group field (string)

idp_metadata_content str

ADFS IDP metadata content (string)

labels Mapping[str, Any]

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

ADFS SP cert (string)

sp_key str

ADFS SP key (string)

type str

(Computed) The type of the resource (string)

uid_field str

ADFS UID field (string)

user_name_field str

ADFS 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: adfs_user://<USER_ID> adfs_group://<GROUP_ID> (list)

annotations Map<Any>

Annotations of the resource (map)

displayNameField String

ADFS display name field (string)

enabled Boolean

Enable auth config provider. Default true (bool)

groupsField String

ADFS group field (string)

idpMetadataContent String

ADFS IDP metadata content (string)

labels Map<Any>

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

ADFS SP cert (string)

spKey String

ADFS SP key (string)

type String

(Computed) The type of the resource (string)

uidField String

ADFS UID field (string)

userNameField String

ADFS 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.