@pulumi/yandex/organizationmanagerSamlFederation.d.ts

A Pulumi package for creating and managing yandex cloud resources.

import * as pulumi from "@pulumi/pulumi";
import { input as inputs, output as outputs } from "./types";
/**
 * Allows management of a single SAML Federation within an existing Yandex.Cloud Organization.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as yandex from "@pulumi/yandex";
 *
 * const federation = new yandex.OrganizationmanagerSamlFederation("federation", {
 *     description: "My new SAML federation",
 *     issuer: "my-issuer",
 *     organizationId: "sdf4*********3fr",
 *     ssoBinding: "POST",
 *     ssoUrl: "https://my-sso.url",
 * });
 * ```
 *
 * ## Import
 *
 * A Yandex SAML Federation can be imported using the `id` of the resource, e.g.
 *
 * ```sh
 *  $ pulumi import yandex:index/organizationmanagerSamlFederation:OrganizationmanagerSamlFederation federation "federation_id"
 * ```
 */
export declare class OrganizationmanagerSamlFederation extends pulumi.CustomResource {
    /**
     * Get an existing OrganizationmanagerSamlFederation resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: OrganizationmanagerSamlFederationState, opts?: pulumi.CustomResourceOptions): OrganizationmanagerSamlFederation;
    /**
     * Returns true if the given object is an instance of OrganizationmanagerSamlFederation.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is OrganizationmanagerSamlFederation;
    /**
     * Add new users automatically on successful authentication. The user will get the `resource-manager.clouds.member` role automatically, but you need to grant other roles to them. If the value is `false`, users who aren't added to the cloud can't log in, even if they have authenticated on your server.
     */
    readonly autoCreateAccountOnLogin: pulumi.Output<boolean>;
    /**
     * Use case-insensitive name ids.
     */
    readonly caseInsensitiveNameIds: pulumi.Output<boolean>;
    /**
     * The lifetime of a Browser cookie in seconds. If the cookie is still valid, the management console authenticates the user immediately and redirects them to the home page. The default value is `8h`.
     */
    readonly cookieMaxAge: pulumi.Output<string>;
    /**
     * (Computed) The SAML Federation creation timestamp.
     */
    readonly createdAt: pulumi.Output<string>;
    /**
     * The description of the SAML Federation.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * The ID of the IdP server to be used for authentication. The IdP server also responds to IAM with this ID after the user authenticates.
     */
    readonly issuer: pulumi.Output<string>;
    /**
     * A set of key/value label pairs assigned to the SAML Federation.
     */
    readonly labels: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * The name of the SAML Federation.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The organization to attach this SAML Federation to.
     */
    readonly organizationId: pulumi.Output<string>;
    /**
     * Federation security settings, structure is documented below.
     */
    readonly securitySettings: pulumi.Output<outputs.OrganizationmanagerSamlFederationSecuritySettings>;
    /**
     * Single sign-on endpoint binding type. Most Identity Providers support the `POST` binding type. SAML Binding is a mapping of a SAML protocol message onto standard messaging formats and/or communications protocols.
     */
    readonly ssoBinding: pulumi.Output<string>;
    /**
     * Single sign-on endpoint URL. Specify the link to the IdP login page here.
     */
    readonly ssoUrl: pulumi.Output<string>;
    /**
     * Create a OrganizationmanagerSamlFederation resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: OrganizationmanagerSamlFederationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering OrganizationmanagerSamlFederation resources.
 */
export interface OrganizationmanagerSamlFederationState {
    /**
     * Add new users automatically on successful authentication. The user will get the `resource-manager.clouds.member` role automatically, but you need to grant other roles to them. If the value is `false`, users who aren't added to the cloud can't log in, even if they have authenticated on your server.
     */
    autoCreateAccountOnLogin?: pulumi.Input<boolean>;
    /**
     * Use case-insensitive name ids.
     */
    caseInsensitiveNameIds?: pulumi.Input<boolean>;
    /**
     * The lifetime of a Browser cookie in seconds. If the cookie is still valid, the management console authenticates the user immediately and redirects them to the home page. The default value is `8h`.
     */
    cookieMaxAge?: pulumi.Input<string>;
    /**
     * (Computed) The SAML Federation creation timestamp.
     */
    createdAt?: pulumi.Input<string>;
    /**
     * The description of the SAML Federation.
     */
    description?: pulumi.Input<string>;
    /**
     * The ID of the IdP server to be used for authentication. The IdP server also responds to IAM with this ID after the user authenticates.
     */
    issuer?: pulumi.Input<string>;
    /**
     * A set of key/value label pairs assigned to the SAML Federation.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * The name of the SAML Federation.
     */
    name?: pulumi.Input<string>;
    /**
     * The organization to attach this SAML Federation to.
     */
    organizationId?: pulumi.Input<string>;
    /**
     * Federation security settings, structure is documented below.
     */
    securitySettings?: pulumi.Input<inputs.OrganizationmanagerSamlFederationSecuritySettings>;
    /**
     * Single sign-on endpoint binding type. Most Identity Providers support the `POST` binding type. SAML Binding is a mapping of a SAML protocol message onto standard messaging formats and/or communications protocols.
     */
    ssoBinding?: pulumi.Input<string>;
    /**
     * Single sign-on endpoint URL. Specify the link to the IdP login page here.
     */
    ssoUrl?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a OrganizationmanagerSamlFederation resource.
 */
export interface OrganizationmanagerSamlFederationArgs {
    /**
     * Add new users automatically on successful authentication. The user will get the `resource-manager.clouds.member` role automatically, but you need to grant other roles to them. If the value is `false`, users who aren't added to the cloud can't log in, even if they have authenticated on your server.
     */
    autoCreateAccountOnLogin?: pulumi.Input<boolean>;
    /**
     * Use case-insensitive name ids.
     */
    caseInsensitiveNameIds?: pulumi.Input<boolean>;
    /**
     * The lifetime of a Browser cookie in seconds. If the cookie is still valid, the management console authenticates the user immediately and redirects them to the home page. The default value is `8h`.
     */
    cookieMaxAge?: pulumi.Input<string>;
    /**
     * The description of the SAML Federation.
     */
    description?: pulumi.Input<string>;
    /**
     * The ID of the IdP server to be used for authentication. The IdP server also responds to IAM with this ID after the user authenticates.
     */
    issuer: pulumi.Input<string>;
    /**
     * A set of key/value label pairs assigned to the SAML Federation.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * The name of the SAML Federation.
     */
    name?: pulumi.Input<string>;
    /**
     * The organization to attach this SAML Federation to.
     */
    organizationId: pulumi.Input<string>;
    /**
     * Federation security settings, structure is documented below.
     */
    securitySettings?: pulumi.Input<inputs.OrganizationmanagerSamlFederationSecuritySettings>;
    /**
     * Single sign-on endpoint binding type. Most Identity Providers support the `POST` binding type. SAML Binding is a mapping of a SAML protocol message onto standard messaging formats and/or communications protocols.
     */
    ssoBinding: pulumi.Input<string>;
    /**
     * Single sign-on endpoint URL. Specify the link to the IdP login page here.
     */
    ssoUrl: pulumi.Input<string>;
}