@pulumi/vault
Version:
A Pulumi package for creating and managing HashiCorp Vault cloud resources.
189 lines (188 loc) • 5.19 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Resource for configuring the okta MFA method.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as vault from "@pulumi/vault";
*
* const example = new vault.identity.MfaOkta("example", {
* orgName: "org1",
* apiToken: "token1",
* baseUrl: "qux.baz.com",
* });
* ```
*
* ## Import
*
* Resource can be imported using its `uuid` field, e.g.
*
* ```sh
* $ pulumi import vault:identity/mfaOkta:MfaOkta example 0d89c36a-4ff5-4d70-8749-bb6a5598aeec
* ```
*/
export declare class MfaOkta extends pulumi.CustomResource {
/**
* Get an existing MfaOkta 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?: MfaOktaState, opts?: pulumi.CustomResourceOptions): MfaOkta;
/**
* Returns true if the given object is an instance of MfaOkta. 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 MfaOkta;
/**
* Okta API token.
*/
readonly apiToken: pulumi.Output<string>;
/**
* The base domain to use for API requests.
*/
readonly baseUrl: pulumi.Output<string | undefined>;
/**
* Method ID.
*/
readonly methodId: pulumi.Output<string>;
/**
* Mount accessor.
*/
readonly mountAccessor: pulumi.Output<string>;
/**
* Method name.
*/
readonly name: pulumi.Output<string>;
/**
* Target namespace. (requires Enterprise)
*/
readonly namespace: pulumi.Output<string | undefined>;
/**
* Method's namespace ID.
*/
readonly namespaceId: pulumi.Output<string>;
/**
* Method's namespace path.
*/
readonly namespacePath: pulumi.Output<string>;
/**
* Name of the organization to be used in the Okta API.
*/
readonly orgName: pulumi.Output<string>;
/**
* Only match the primary email for the account.
*/
readonly primaryEmail: pulumi.Output<boolean | undefined>;
/**
* MFA type.
*/
readonly type: pulumi.Output<string>;
/**
* A template string for mapping Identity names to MFA methods.
*/
readonly usernameFormat: pulumi.Output<string | undefined>;
/**
* Resource UUID.
*/
readonly uuid: pulumi.Output<string>;
/**
* Create a MfaOkta 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: MfaOktaArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering MfaOkta resources.
*/
export interface MfaOktaState {
/**
* Okta API token.
*/
apiToken?: pulumi.Input<string>;
/**
* The base domain to use for API requests.
*/
baseUrl?: pulumi.Input<string>;
/**
* Method ID.
*/
methodId?: pulumi.Input<string>;
/**
* Mount accessor.
*/
mountAccessor?: pulumi.Input<string>;
/**
* Method name.
*/
name?: pulumi.Input<string>;
/**
* Target namespace. (requires Enterprise)
*/
namespace?: pulumi.Input<string>;
/**
* Method's namespace ID.
*/
namespaceId?: pulumi.Input<string>;
/**
* Method's namespace path.
*/
namespacePath?: pulumi.Input<string>;
/**
* Name of the organization to be used in the Okta API.
*/
orgName?: pulumi.Input<string>;
/**
* Only match the primary email for the account.
*/
primaryEmail?: pulumi.Input<boolean>;
/**
* MFA type.
*/
type?: pulumi.Input<string>;
/**
* A template string for mapping Identity names to MFA methods.
*/
usernameFormat?: pulumi.Input<string>;
/**
* Resource UUID.
*/
uuid?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a MfaOkta resource.
*/
export interface MfaOktaArgs {
/**
* Okta API token.
*/
apiToken: pulumi.Input<string>;
/**
* The base domain to use for API requests.
*/
baseUrl?: pulumi.Input<string>;
/**
* Target namespace. (requires Enterprise)
*/
namespace?: pulumi.Input<string>;
/**
* Name of the organization to be used in the Okta API.
*/
orgName: pulumi.Input<string>;
/**
* Only match the primary email for the account.
*/
primaryEmail?: pulumi.Input<boolean>;
/**
* A template string for mapping Identity names to MFA methods.
*/
usernameFormat?: pulumi.Input<string>;
}