1. Docs
  2. Reference
  3. API
  4. @pulumi/okta

Package @pulumi/okta

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-okta repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-okta repo.

var okta = require("@pulumi/okta");

import * as okta from "@pulumi/okta";

Modules

Resources

Others

Resources

Resource Provider

class Provider extends ProviderResource

The provider type for the okta package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

constructor

new Provider(name: string, args?: ProviderArgs, opts?: pulumi.ResourceOptions)

Create a Provider resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Provider

Returns true if the given object is an instance of Provider. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

method register

static register(provider: ProviderResource | undefined): Promise<string | undefined>

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

function getEnv

getEnv(vars: string[]): string | undefined

function getEnvBoolean

getEnvBoolean(vars: string[]): boolean | undefined

function getEnvNumber

getEnvNumber(vars: string[]): number | undefined

function getVersion

getVersion(): string

interface ProviderArgs

interface ProviderArgs

The set of arguments for constructing a Provider resource.

property apiToken

apiToken?: pulumi.Input<string>;

API Token granting privileges to Okta API.

property backoff

backoff?: pulumi.Input<boolean>;

Use exponential back off strategy for rate limits.

property baseUrl

baseUrl?: pulumi.Input<string>;

The Okta url. (Use ‘oktapreview.com’ for Okta testing)

property maxRetries

maxRetries?: pulumi.Input<number>;

maximum number of retries to attempt before erroring out.

property maxWaitSeconds

maxWaitSeconds?: pulumi.Input<number>;

maximum seconds to wait when rate limit is hit. We use exponential backoffs when backoff is enabled.

property minWaitSeconds

minWaitSeconds?: pulumi.Input<number>;

minimum seconds to wait when rate limit is hit. We use exponential backoffs when backoff is enabled.

property orgName

orgName?: pulumi.Input<string>;

The organization to manage in Okta.

property parallelism

parallelism?: pulumi.Input<number>;

Number of concurrent requests to make within a resource where bulk operations are not possible. Take note of https://developer.okta.com/docs/api/getting_started/rate-limits.