1. Packages
  2. Selectel Provider
  3. API Docs
  4. IamSamlFederationV1
selectel 6.4.0 published on Monday, Apr 14, 2025 by selectel

selectel.IamSamlFederationV1

Explore with Pulumi AI

selectel logo
selectel 6.4.0 published on Monday, Apr 14, 2025 by selectel

    Manages SAML Federation for Selectel products using public API v1. Selectel products support Identity and Access Management (IAM). For more information about federations, see the official Selectel documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as selectel from "@pulumi/selectel";
    
    const federation1 = new selectel.IamSamlFederationV1("federation1", {
        description: "simple description",
        issuer: "http://localhost:8080/realms/master",
        sessionMaxAgeHours: 24,
        ssoUrl: "http://localhost:8080/realms/master/protocol/saml",
    });
    
    import pulumi
    import pulumi_selectel as selectel
    
    federation1 = selectel.IamSamlFederationV1("federation1",
        description="simple description",
        issuer="http://localhost:8080/realms/master",
        session_max_age_hours=24,
        sso_url="http://localhost:8080/realms/master/protocol/saml")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/selectel/v6/selectel"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := selectel.NewIamSamlFederationV1(ctx, "federation1", &selectel.IamSamlFederationV1Args{
    			Description:        pulumi.String("simple description"),
    			Issuer:             pulumi.String("http://localhost:8080/realms/master"),
    			SessionMaxAgeHours: pulumi.Float64(24),
    			SsoUrl:             pulumi.String("http://localhost:8080/realms/master/protocol/saml"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Selectel = Pulumi.Selectel;
    
    return await Deployment.RunAsync(() => 
    {
        var federation1 = new Selectel.IamSamlFederationV1("federation1", new()
        {
            Description = "simple description",
            Issuer = "http://localhost:8080/realms/master",
            SessionMaxAgeHours = 24,
            SsoUrl = "http://localhost:8080/realms/master/protocol/saml",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.selectel.IamSamlFederationV1;
    import com.pulumi.selectel.IamSamlFederationV1Args;
    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 federation1 = new IamSamlFederationV1("federation1", IamSamlFederationV1Args.builder()
                .description("simple description")
                .issuer("http://localhost:8080/realms/master")
                .sessionMaxAgeHours(24)
                .ssoUrl("http://localhost:8080/realms/master/protocol/saml")
                .build());
    
        }
    }
    
    resources:
      federation1:
        type: selectel:IamSamlFederationV1
        properties:
          description: simple description
          issuer: http://localhost:8080/realms/master
          sessionMaxAgeHours: 24
          ssoUrl: http://localhost:8080/realms/master/protocol/saml
    

    Create IamSamlFederationV1 Resource

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

    Constructor syntax

    new IamSamlFederationV1(name: string, args: IamSamlFederationV1Args, opts?: CustomResourceOptions);
    @overload
    def IamSamlFederationV1(resource_name: str,
                            args: IamSamlFederationV1Args,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def IamSamlFederationV1(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            issuer: Optional[str] = None,
                            session_max_age_hours: Optional[float] = None,
                            sso_url: Optional[str] = None,
                            description: Optional[str] = None,
                            force_authn: Optional[bool] = None,
                            iam_saml_federation_v1_id: Optional[str] = None,
                            name: Optional[str] = None,
                            sign_authn_requests: Optional[bool] = None)
    func NewIamSamlFederationV1(ctx *Context, name string, args IamSamlFederationV1Args, opts ...ResourceOption) (*IamSamlFederationV1, error)
    public IamSamlFederationV1(string name, IamSamlFederationV1Args args, CustomResourceOptions? opts = null)
    public IamSamlFederationV1(String name, IamSamlFederationV1Args args)
    public IamSamlFederationV1(String name, IamSamlFederationV1Args args, CustomResourceOptions options)
    
    type: selectel:IamSamlFederationV1
    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 IamSamlFederationV1Args
    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 IamSamlFederationV1Args
    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 IamSamlFederationV1Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IamSamlFederationV1Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IamSamlFederationV1Args
    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 iamSamlFederationV1Resource = new Selectel.IamSamlFederationV1("iamSamlFederationV1Resource", new()
    {
        Issuer = "string",
        SessionMaxAgeHours = 0,
        SsoUrl = "string",
        Description = "string",
        ForceAuthn = false,
        IamSamlFederationV1Id = "string",
        Name = "string",
        SignAuthnRequests = false,
    });
    
    example, err := selectel.NewIamSamlFederationV1(ctx, "iamSamlFederationV1Resource", &selectel.IamSamlFederationV1Args{
    	Issuer:                pulumi.String("string"),
    	SessionMaxAgeHours:    pulumi.Float64(0),
    	SsoUrl:                pulumi.String("string"),
    	Description:           pulumi.String("string"),
    	ForceAuthn:            pulumi.Bool(false),
    	IamSamlFederationV1Id: pulumi.String("string"),
    	Name:                  pulumi.String("string"),
    	SignAuthnRequests:     pulumi.Bool(false),
    })
    
    var iamSamlFederationV1Resource = new IamSamlFederationV1("iamSamlFederationV1Resource", IamSamlFederationV1Args.builder()
        .issuer("string")
        .sessionMaxAgeHours(0)
        .ssoUrl("string")
        .description("string")
        .forceAuthn(false)
        .iamSamlFederationV1Id("string")
        .name("string")
        .signAuthnRequests(false)
        .build());
    
    iam_saml_federation_v1_resource = selectel.IamSamlFederationV1("iamSamlFederationV1Resource",
        issuer="string",
        session_max_age_hours=0,
        sso_url="string",
        description="string",
        force_authn=False,
        iam_saml_federation_v1_id="string",
        name="string",
        sign_authn_requests=False)
    
    const iamSamlFederationV1Resource = new selectel.IamSamlFederationV1("iamSamlFederationV1Resource", {
        issuer: "string",
        sessionMaxAgeHours: 0,
        ssoUrl: "string",
        description: "string",
        forceAuthn: false,
        iamSamlFederationV1Id: "string",
        name: "string",
        signAuthnRequests: false,
    });
    
    type: selectel:IamSamlFederationV1
    properties:
        description: string
        forceAuthn: false
        iamSamlFederationV1Id: string
        issuer: string
        name: string
        sessionMaxAgeHours: 0
        signAuthnRequests: false
        ssoUrl: string
    

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

    Issuer string
    Identifier of the credential provider.
    SessionMaxAgeHours double
    Session lifetime.
    SsoUrl string
    Link to the credential provider login page.
    Description string
    Federation description.
    ForceAuthn bool
    Requires users to authenticate via SSO every time they log in.
    IamSamlFederationV1Id string
    Name string
    Federation name.
    SignAuthnRequests bool
    Enables signing of authentication requests.
    Issuer string
    Identifier of the credential provider.
    SessionMaxAgeHours float64
    Session lifetime.
    SsoUrl string
    Link to the credential provider login page.
    Description string
    Federation description.
    ForceAuthn bool
    Requires users to authenticate via SSO every time they log in.
    IamSamlFederationV1Id string
    Name string
    Federation name.
    SignAuthnRequests bool
    Enables signing of authentication requests.
    issuer String
    Identifier of the credential provider.
    sessionMaxAgeHours Double
    Session lifetime.
    ssoUrl String
    Link to the credential provider login page.
    description String
    Federation description.
    forceAuthn Boolean
    Requires users to authenticate via SSO every time they log in.
    iamSamlFederationV1Id String
    name String
    Federation name.
    signAuthnRequests Boolean
    Enables signing of authentication requests.
    issuer string
    Identifier of the credential provider.
    sessionMaxAgeHours number
    Session lifetime.
    ssoUrl string
    Link to the credential provider login page.
    description string
    Federation description.
    forceAuthn boolean
    Requires users to authenticate via SSO every time they log in.
    iamSamlFederationV1Id string
    name string
    Federation name.
    signAuthnRequests boolean
    Enables signing of authentication requests.
    issuer str
    Identifier of the credential provider.
    session_max_age_hours float
    Session lifetime.
    sso_url str
    Link to the credential provider login page.
    description str
    Federation description.
    force_authn bool
    Requires users to authenticate via SSO every time they log in.
    iam_saml_federation_v1_id str
    name str
    Federation name.
    sign_authn_requests bool
    Enables signing of authentication requests.
    issuer String
    Identifier of the credential provider.
    sessionMaxAgeHours Number
    Session lifetime.
    ssoUrl String
    Link to the credential provider login page.
    description String
    Federation description.
    forceAuthn Boolean
    Requires users to authenticate via SSO every time they log in.
    iamSamlFederationV1Id String
    name String
    Federation name.
    signAuthnRequests Boolean
    Enables signing of authentication requests.

    Outputs

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

    AccountId string
    Selectel account ID. The account ID is in the top right corner of the Control panel. Learn more about Registration.
    Id string
    The provider-assigned unique ID for this managed resource.
    AccountId string
    Selectel account ID. The account ID is in the top right corner of the Control panel. Learn more about Registration.
    Id string
    The provider-assigned unique ID for this managed resource.
    accountId String
    Selectel account ID. The account ID is in the top right corner of the Control panel. Learn more about Registration.
    id String
    The provider-assigned unique ID for this managed resource.
    accountId string
    Selectel account ID. The account ID is in the top right corner of the Control panel. Learn more about Registration.
    id string
    The provider-assigned unique ID for this managed resource.
    account_id str
    Selectel account ID. The account ID is in the top right corner of the Control panel. Learn more about Registration.
    id str
    The provider-assigned unique ID for this managed resource.
    accountId String
    Selectel account ID. The account ID is in the top right corner of the Control panel. Learn more about Registration.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing IamSamlFederationV1 Resource

    Get an existing IamSamlFederationV1 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?: IamSamlFederationV1State, opts?: CustomResourceOptions): IamSamlFederationV1
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            description: Optional[str] = None,
            force_authn: Optional[bool] = None,
            iam_saml_federation_v1_id: Optional[str] = None,
            issuer: Optional[str] = None,
            name: Optional[str] = None,
            session_max_age_hours: Optional[float] = None,
            sign_authn_requests: Optional[bool] = None,
            sso_url: Optional[str] = None) -> IamSamlFederationV1
    func GetIamSamlFederationV1(ctx *Context, name string, id IDInput, state *IamSamlFederationV1State, opts ...ResourceOption) (*IamSamlFederationV1, error)
    public static IamSamlFederationV1 Get(string name, Input<string> id, IamSamlFederationV1State? state, CustomResourceOptions? opts = null)
    public static IamSamlFederationV1 get(String name, Output<String> id, IamSamlFederationV1State state, CustomResourceOptions options)
    resources:  _:    type: selectel:IamSamlFederationV1    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:
    AccountId string
    Selectel account ID. The account ID is in the top right corner of the Control panel. Learn more about Registration.
    Description string
    Federation description.
    ForceAuthn bool
    Requires users to authenticate via SSO every time they log in.
    IamSamlFederationV1Id string
    Issuer string
    Identifier of the credential provider.
    Name string
    Federation name.
    SessionMaxAgeHours double
    Session lifetime.
    SignAuthnRequests bool
    Enables signing of authentication requests.
    SsoUrl string
    Link to the credential provider login page.
    AccountId string
    Selectel account ID. The account ID is in the top right corner of the Control panel. Learn more about Registration.
    Description string
    Federation description.
    ForceAuthn bool
    Requires users to authenticate via SSO every time they log in.
    IamSamlFederationV1Id string
    Issuer string
    Identifier of the credential provider.
    Name string
    Federation name.
    SessionMaxAgeHours float64
    Session lifetime.
    SignAuthnRequests bool
    Enables signing of authentication requests.
    SsoUrl string
    Link to the credential provider login page.
    accountId String
    Selectel account ID. The account ID is in the top right corner of the Control panel. Learn more about Registration.
    description String
    Federation description.
    forceAuthn Boolean
    Requires users to authenticate via SSO every time they log in.
    iamSamlFederationV1Id String
    issuer String
    Identifier of the credential provider.
    name String
    Federation name.
    sessionMaxAgeHours Double
    Session lifetime.
    signAuthnRequests Boolean
    Enables signing of authentication requests.
    ssoUrl String
    Link to the credential provider login page.
    accountId string
    Selectel account ID. The account ID is in the top right corner of the Control panel. Learn more about Registration.
    description string
    Federation description.
    forceAuthn boolean
    Requires users to authenticate via SSO every time they log in.
    iamSamlFederationV1Id string
    issuer string
    Identifier of the credential provider.
    name string
    Federation name.
    sessionMaxAgeHours number
    Session lifetime.
    signAuthnRequests boolean
    Enables signing of authentication requests.
    ssoUrl string
    Link to the credential provider login page.
    account_id str
    Selectel account ID. The account ID is in the top right corner of the Control panel. Learn more about Registration.
    description str
    Federation description.
    force_authn bool
    Requires users to authenticate via SSO every time they log in.
    iam_saml_federation_v1_id str
    issuer str
    Identifier of the credential provider.
    name str
    Federation name.
    session_max_age_hours float
    Session lifetime.
    sign_authn_requests bool
    Enables signing of authentication requests.
    sso_url str
    Link to the credential provider login page.
    accountId String
    Selectel account ID. The account ID is in the top right corner of the Control panel. Learn more about Registration.
    description String
    Federation description.
    forceAuthn Boolean
    Requires users to authenticate via SSO every time they log in.
    iamSamlFederationV1Id String
    issuer String
    Identifier of the credential provider.
    name String
    Federation name.
    sessionMaxAgeHours Number
    Session lifetime.
    signAuthnRequests Boolean
    Enables signing of authentication requests.
    ssoUrl String
    Link to the credential provider login page.

    Import

    You can import a federation:

    export OS_DOMAIN_NAME=<account_id>

    export OS_USERNAME=

    export OS_PASSWORD=

    $ pulumi import selectel:index/iamSamlFederationV1:IamSamlFederationV1 federation_1 <federation_id>
    

    where:

    • <account_id> — Selectel account ID. The account ID is in the top right corner of the Control panel. Learn more about Registration.

    • <username> — Name of the service user. To get the name, in the Control panel, go to Identity & Access ManagementUser management ⟶ the Service users tab ⟶ copy the name of the required user. Learn more about Service Users.

    • <password> — Password of the service user.

    • <federation_id> — Unique identifier of the federation, for example, abc1bb378ac84e1234b869b77aadd2ab. To get the federation ID, use either Control Panel or IAM API.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    selectel selectel/terraform-provider-selectel
    License
    Notes
    This Pulumi package is based on the selectel Terraform Provider.
    selectel logo
    selectel 6.4.0 published on Monday, Apr 14, 2025 by selectel