UNPKG

@pulumiverse/scaleway

Version:

A Pulumi package for creating and managing Scaleway cloud resources.

86 lines 2.83 kB
import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../types/output"; /** * Retrieves SAML configuration for an organization. This data source enables you to retrieve the SAML-based single sign-on (SSO) configuration for your Scaleway 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. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as scaleway from "@pulumiverse/scaleway"; * * //## Get information about an organization's SAML configuration * const main = scaleway.iam.getSaml({ * organizationId: "11111111-1111-1111-1111-111111111111", * }); * ``` */ export declare function getSaml(args?: GetSamlArgs, opts?: pulumi.InvokeOptions): Promise<GetSamlResult>; /** * A collection of arguments for invoking getSaml. */ export interface GetSamlArgs { /** * The organization ID */ organizationId?: string; } /** * A collection of values returned by getSaml. */ export interface GetSamlResult { /** * The entity ID of the SAML Identity Provider */ readonly entityId: string; /** * The ID of the SAML configuration */ readonly id: string; /** * The organization ID */ readonly organizationId: string; /** * The Service Provider information */ readonly serviceProvider: outputs.iam.GetSamlServiceProvider; /** * The single sign-on URL of the SAML Identity Provider */ readonly singleSignOnUrl: string; /** * The status of the SAML configuration */ readonly status: string; } /** * Retrieves SAML configuration for an organization. This data source enables you to retrieve the SAML-based single sign-on (SSO) configuration for your Scaleway 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. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as scaleway from "@pulumiverse/scaleway"; * * //## Get information about an organization's SAML configuration * const main = scaleway.iam.getSaml({ * organizationId: "11111111-1111-1111-1111-111111111111", * }); * ``` */ export declare function getSamlOutput(args?: GetSamlOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetSamlResult>; /** * A collection of arguments for invoking getSaml. */ export interface GetSamlOutputArgs { /** * The organization ID */ organizationId?: pulumi.Input<string | undefined>; } //# sourceMappingURL=getSaml.d.ts.map