import * as pulumi from "@pulumi/pulumi"; import * as outputs from "./types/output"; /** * Data source to retrieve a specific Auth0 connection by `connectionId` or `name`. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as auth0 from "@pulumi/auth0"; * * // An Auth0 Connection loaded using its name. * const some_connection_by_name = auth0.getConnection({ * name: "Acceptance-Test-Connection-{{.testName}}", * }); * // An Auth0 Connection loaded using its ID. * const some_connection_by_id = auth0.getConnection({ * connectionId: "con_abcdefghkijklmnopqrstuvwxyz0123456789", * }); * ``` */ export declare function getConnection(args?: GetConnectionArgs, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking getConnection. */ export interface GetConnectionArgs { /** * The ID of the connection. If not provided, `name` must be set. */ connectionId?: string; /** * Set this to avoid persisting the sensitive `options.client_secret` value in state; it will be stored as an empty string. */ hideClientSecret?: boolean; /** * The name of the connection. If not provided, `connectionId` must be set. */ name?: string; /** * Whether to skip enabled clients for this connection. Setting this to `true` will skip additional paginated API calls to /api/v2/connections/{id}/clients. Default: `false`. */ skipEnabledClients?: boolean; } /** * A collection of values returned by getConnection. */ export interface GetConnectionResult { /** * Configure the purpose of a connection to be used for authentication during login.**Note:** Once configured, removing this block from your configuration is a no-op and will not disable the purpose on the connection; set `active` to `false` explicitly to deactivate it. */ readonly authentications: outputs.GetConnectionAuthentication[]; /** * Configure the purpose of a connection to be used for connected accounts and Token Vault.**Note:** Once configured, removing this block from your configuration is a no-op and will not disable the purpose on the connection; set `active` to `false` explicitly to deactivate it. */ readonly connectedAccounts: outputs.GetConnectionConnectedAccount[]; /** * The ID of the connection. If not provided, `name` must be set. */ readonly connectionId?: string; /** * Configure the purpose of a connection to be used as a requesting application authorization server for Cross-App Access (XAA). This is an Early Access feature and requires the `tokenVaultXaa` flag to be enabled on your tenant. Only supported on `oidc` and `okta` strategy connections. **Note:** Once configured, removing this block from your configuration is a no-op and will not disable the purpose on the connection; set `active` to `false` explicitly to deactivate it. (EA Only) */ readonly crossAppAccessRequestingApps: outputs.GetConnectionCrossAppAccessRequestingApp[]; /** * Resource App settings that apply to this connection. (EA only) */ readonly crossAppAccessResourceApps: outputs.GetConnectionCrossAppAccessResourceApp[]; /** * Name used in login screen. */ readonly displayName: string; /** * IDs of the clients for which the connection is enabled. Skips populating if `skipEnabledClients` is `true`. */ readonly enabledClients: string[]; /** * Set this to avoid persisting the sensitive `options.client_secret` value in state; it will be stored as an empty string. */ readonly hideClientSecret?: boolean; /** * The provider-assigned unique ID for this managed resource. */ readonly id: string; /** * Indicates whether the connection is domain level. */ readonly isDomainConnection: boolean; /** * Metadata associated with the connection, in the form of a map of string values (max 255 chars). */ readonly metadata: { [key: string]: string; }; /** * The name of the connection. If not provided, `connectionId` must be set. */ readonly name?: string; /** * Configuration settings for connection options. */ readonly options: outputs.GetConnectionOption[]; /** * Defines the realms for which the connection will be used (e.g., email domains). If not specified, the connection name is added as the realm. */ readonly realms: string[]; /** * Display connection as a button. Only available on enterprise connections. */ readonly showAsButton: boolean; /** * Whether to skip enabled clients for this connection. Setting this to `true` will skip additional paginated API calls to /api/v2/connections/{id}/clients. Default: `false`. */ readonly skipEnabledClients?: boolean; /** * Type of the connection, which indicates the identity provider. */ readonly strategy: string; } /** * Data source to retrieve a specific Auth0 connection by `connectionId` or `name`. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as auth0 from "@pulumi/auth0"; * * // An Auth0 Connection loaded using its name. * const some_connection_by_name = auth0.getConnection({ * name: "Acceptance-Test-Connection-{{.testName}}", * }); * // An Auth0 Connection loaded using its ID. * const some_connection_by_id = auth0.getConnection({ * connectionId: "con_abcdefghkijklmnopqrstuvwxyz0123456789", * }); * ``` */ export declare function getConnectionOutput(args?: GetConnectionOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output; /** * A collection of arguments for invoking getConnection. */ export interface GetConnectionOutputArgs { /** * The ID of the connection. If not provided, `name` must be set. */ connectionId?: pulumi.Input; /** * Set this to avoid persisting the sensitive `options.client_secret` value in state; it will be stored as an empty string. */ hideClientSecret?: pulumi.Input; /** * The name of the connection. If not provided, `connectionId` must be set. */ name?: pulumi.Input; /** * Whether to skip enabled clients for this connection. Setting this to `true` will skip additional paginated API calls to /api/v2/connections/{id}/clients. Default: `false`. */ skipEnabledClients?: pulumi.Input; } //# sourceMappingURL=getConnection.d.ts.map