import * as pulumi from "@pulumi/pulumi"; import * as inputs from "./types/input"; import * as outputs from "./types/output"; /** * With this resource, you can manage a Universal Portal. (EA only) * * > When the portal has a component type that this resource does not support, such as a V1 sidebar link added * through the Management API, every refresh of the portal fails. So `pulumi preview` and `terraform destroy` fail too. * To overwrite the unsupported component, change the `navigation` or `pages` block that contains it, * and then run `pulumi up -refresh=false`. To destroy the portal, run `terraform destroy -refresh=false`. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as auth0 from "@pulumi/auth0"; * * // Early Access only. The Management API client needs the create, read, update and delete * // `portals` scopes. * // The portal signs users in with a regular web application. * const portal = new auth0.Client("portal", { * name: "My Portal Client", * appType: "regular_web", * callbacks: ["https://{yourDomain}/portals/auth/callback"], * grantTypes: [ * "authorization_code", * "refresh_token", * ], * }); * const portalClientCredentials = new auth0.ClientCredentials("portal", { * clientId: portal.id, * authenticationMethod: "client_secret_post", * }); * // Full example. * const full = new auth0.Portal("full", { * client: { * clientSecretPost: { * clientId: portal.clientId, * clientSecretWo: portalClientCredentials.clientSecret, * clientSecretWoVersion: 1, * }, * }, * customCode: { * head: "", * }, * navigation: { * sidebar: { * components: [ * { * internalLinkV2: { * label: "Account", * pageSlug: "account", * icon: "user", * }, * }, * { * externalLinkV2: { * label: "Help", * href: "https://help.example.com", * icon: "circle-help", * }, * }, * ], * }, * }, * pages: { * standards: [ * { * components: [ * { * typographyHeading: { * title: "Your account", * description: "Manage how you sign in.", * }, * }, * { * mediaImage: { * src: "https://example.com/banner.png", * position: "center", * height: 120, * }, * }, * { * myAccountMfaManagement: {}, * }, * { * structureSection: { * children: [{ * form: { * formId: "ap_XXXXXXXXXXXXXXXXXXXXXX", * completionMessage: "Your profile is saved.", * }, * }], * variant: "card", * title: "Profile", * description: "Update your details.", * }, * }, * ], * title: "Account", * slug: "account", * }, * { * components: [{ * myOrganizationMemberManagement: {}, * }], * title: "Organization", * slug: "organization", * }, * ], * "default": "account", * }, * name: "My Portal", * slug: "my-portal", * }); * ``` * * ## Import * * This resource can be imported by specifying the portal ID. * * Example: * * ```sh * $ pulumi import auth0:index/portal:Portal my_portal "up_XXXXXXXXXXXXXXXXXXXXXX" * ``` */ export declare class Portal extends pulumi.CustomResource { /** * Get an existing Portal 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, state?: PortalState, opts?: pulumi.CustomResourceOptions): Portal; /** * Check whether an existing Portal resource with the given ID exists. * * @param id The _unique_ provider ID of the resource to check. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static exists(id: pulumi.Input, state?: PortalState, opts?: pulumi.CustomResourceOptions): pulumi.Output; /** * Returns true if the given object is an instance of Portal. 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 Portal; /** * The client used by the portal. */ readonly client: pulumi.Output; /** * The date and time when the portal was created. */ readonly createdAt: pulumi.Output; /** * Custom code for the portal. */ readonly customCode: pulumi.Output; /** * The name of the portal. */ readonly name: pulumi.Output; /** * Navigation for the portal. */ readonly navigation: pulumi.Output; /** * Pages of the portal. */ readonly pages: pulumi.Output; /** * The unique slug of the portal. */ readonly slug: pulumi.Output; /** * The date and time when the portal was last updated. */ readonly updatedAt: pulumi.Output; /** * Create a Portal 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: PortalArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Portal resources. */ export interface PortalState { /** * The client used by the portal. */ client?: pulumi.Input; /** * The date and time when the portal was created. */ createdAt?: pulumi.Input; /** * Custom code for the portal. */ customCode?: pulumi.Input; /** * The name of the portal. */ name?: pulumi.Input; /** * Navigation for the portal. */ navigation?: pulumi.Input; /** * Pages of the portal. */ pages?: pulumi.Input; /** * The unique slug of the portal. */ slug?: pulumi.Input; /** * The date and time when the portal was last updated. */ updatedAt?: pulumi.Input; } /** * The set of arguments for constructing a Portal resource. */ export interface PortalArgs { /** * The client used by the portal. */ client: pulumi.Input; /** * Custom code for the portal. */ customCode?: pulumi.Input; /** * The name of the portal. */ name?: pulumi.Input; /** * Navigation for the portal. */ navigation?: pulumi.Input; /** * Pages of the portal. */ pages?: pulumi.Input; /** * The unique slug of the portal. */ slug: pulumi.Input; } //# sourceMappingURL=portal.d.ts.map