@pulumi/pulumiservice
Version:
[](https://slack.pulumi.com) [](https://www.npmjs.com/package/@pulumi/pulumiservice) [![Python version](https://badge.fury.io
72 lines • 2.86 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Updates the SAML configuration for a SAML-backed organization, including the identity provider SSO descriptor, attribute mappings, and other SAML settings. The new IDP SSO descriptor is required in the update request.
*/
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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, 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;
/**
* The following fields can be empty if the metadata (IDPSSODescriptor)
* itself is empty for the organization.
*/
readonly entityId: pulumi.Output<string | undefined>;
/**
* The SAML Identity Provider SSO descriptor XML.
*/
readonly idpSsoDescriptor: pulumi.Output<string>;
/**
* The SAML NameID format used by the identity provider.
*/
readonly nameIdFormat: pulumi.Output<string | undefined>;
/**
* The Pulumi organization.
*/
readonly organization: pulumi.Output<any>;
/**
* The SSO URL for the identity provider.
*/
readonly ssoUrl: pulumi.Output<string | undefined>;
/**
* ValidUntil is the date until which the X.509 Certificate
* issued to the organization by the identity provider is valid.
*/
readonly validUntil: pulumi.Output<string | undefined>;
/**
* ValidationError will be set only if there is an error validating the SAML org's metadata XML.
*/
readonly validationError: pulumi.Output<string | undefined>;
/**
* 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);
}
/**
* The set of arguments for constructing a SAML resource.
*/
export interface SAMLArgs {
/**
* The new IDP SSO descriptor XML for the SAML configuration.
*/
newIdpSsoDescriptor?: pulumi.Input<string | undefined>;
/**
* The organization name
*/
orgName: pulumi.Input<string>;
}
//# sourceMappingURL=saml.d.ts.map