@pulumiverse/scaleway/iam/saml.d.ts

A Pulumi package for creating and managing Scaleway cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * Manages SAML activation for an organization. SAML (Security Assertion Markup Language) is an open standard for exchanging authentication and authorization data between parties, specifically between an identity provider and a service provider. This resource allows you to enable and disable SAML-based single sign-on for your Scaleway organization.
 *
 * For configuring SAML parameters (`entityId` and `singleSignOnUrl`), use the `scalewayIamUpdateSamlConfiguration` action.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * //## Enable IAM SAML for an organization
 * const main = new scaleway.iam.Saml("main", {organizationId: "11111111-1111-1111-1111-111111111111"});
 * ```
 */
export declare class Saml extends pulumi.CustomResource {
    /**
     * Get an existing Saml 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?: SamlState, opts?: pulumi.CustomResourceOptions): Saml;
    /**
     * Returns true if the given object is an instance of Saml.  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 Saml;
    /**
     * (Computed) The entity ID of the Service Provider.
     */
    readonly entityId: pulumi.Output<string>;
    /**
     * The organization ID. If not provided, the default organization ID will be used.
     */
    readonly organizationId: pulumi.Output<string>;
    /**
     * (Computed) The Service Provider information. It contains:
     */
    readonly serviceProvider: pulumi.Output<outputs.iam.SamlServiceProvider>;
    /**
     * (Computed) The single sign-on URL of the SAML Identity Provider.
     */
    readonly singleSignOnUrl: pulumi.Output<string>;
    /**
     * (Computed) The status of the SAML configuration.
     */
    readonly status: pulumi.Output<string>;
    /**
     * Create a Saml 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?: SamlArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Saml resources.
 */
export interface SamlState {
    /**
     * (Computed) The entity ID of the Service Provider.
     */
    entityId?: pulumi.Input<string | undefined>;
    /**
     * The organization ID. If not provided, the default organization ID will be used.
     */
    organizationId?: pulumi.Input<string | undefined>;
    /**
     * (Computed) The Service Provider information. It contains:
     */
    serviceProvider?: pulumi.Input<inputs.iam.SamlServiceProvider | undefined>;
    /**
     * (Computed) The single sign-on URL of the SAML Identity Provider.
     */
    singleSignOnUrl?: pulumi.Input<string | undefined>;
    /**
     * (Computed) The status of the SAML configuration.
     */
    status?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a Saml resource.
 */
export interface SamlArgs {
    /**
     * The organization ID. If not provided, the default organization ID will be used.
     */
    organizationId?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=saml.d.ts.map