Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

Provider

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.

Create a Provider Resource

new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
def Provider(resource_name: str, opts: Optional[ResourceOptions] = None, api_token: Optional[str] = None, backoff: Optional[bool] = None, base_url: Optional[str] = None, client_id: Optional[str] = None, log_level: Optional[int] = None, max_retries: Optional[int] = None, max_wait_seconds: Optional[int] = None, min_wait_seconds: Optional[int] = None, org_name: Optional[str] = None, parallelism: Optional[int] = None, private_key: Optional[str] = None, request_timeout: Optional[int] = None, scopes: Optional[Sequence[str]] = None)
func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ProviderArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Provider Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Provider resource accepts the following input properties:

ApiToken string

API Token granting privileges to Okta API.

Backoff bool

Use exponential back off strategy for rate limits.

BaseUrl string

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

ClientId string

API Token granting privileges to Okta API.

LogLevel int

providers log level. Minimum is 1 (TRACE), and maximum is 5 (ERROR)

MaxRetries int

maximum number of retries to attempt before erroring out.

MaxWaitSeconds int

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

MinWaitSeconds int

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

OrgName string

The organization to manage in Okta.

Parallelism int

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.

PrivateKey string

API Token granting privileges to Okta API.

RequestTimeout int

Timeout for single request (in seconds) which is made to Okta, the default is 0 (means no limit is set). The maximum value can be 100.

Scopes List<string>

API Token granting privileges to Okta API.

ApiToken string

API Token granting privileges to Okta API.

Backoff bool

Use exponential back off strategy for rate limits.

BaseUrl string

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

ClientId string

API Token granting privileges to Okta API.

LogLevel int

providers log level. Minimum is 1 (TRACE), and maximum is 5 (ERROR)

MaxRetries int

maximum number of retries to attempt before erroring out.

MaxWaitSeconds int

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

MinWaitSeconds int

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

OrgName string

The organization to manage in Okta.

Parallelism int

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.

PrivateKey string

API Token granting privileges to Okta API.

RequestTimeout int

Timeout for single request (in seconds) which is made to Okta, the default is 0 (means no limit is set). The maximum value can be 100.

Scopes []string

API Token granting privileges to Okta API.

apiToken string

API Token granting privileges to Okta API.

backoff boolean

Use exponential back off strategy for rate limits.

baseUrl string

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

clientId string

API Token granting privileges to Okta API.

logLevel number

providers log level. Minimum is 1 (TRACE), and maximum is 5 (ERROR)

maxRetries number

maximum number of retries to attempt before erroring out.

maxWaitSeconds number

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

minWaitSeconds number

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

orgName string

The organization to manage in Okta.

parallelism 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.

privateKey string

API Token granting privileges to Okta API.

requestTimeout number

Timeout for single request (in seconds) which is made to Okta, the default is 0 (means no limit is set). The maximum value can be 100.

scopes string[]

API Token granting privileges to Okta API.

api_token str

API Token granting privileges to Okta API.

backoff bool

Use exponential back off strategy for rate limits.

base_url str

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

client_id str

API Token granting privileges to Okta API.

log_level int

providers log level. Minimum is 1 (TRACE), and maximum is 5 (ERROR)

max_retries int

maximum number of retries to attempt before erroring out.

max_wait_seconds int

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

min_wait_seconds int

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

org_name str

The organization to manage in Okta.

parallelism int

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.

private_key str

API Token granting privileges to Okta API.

request_timeout int

Timeout for single request (in seconds) which is made to Okta, the default is 0 (means no limit is set). The maximum value can be 100.

scopes Sequence[str]

API Token granting privileges to Okta API.

Outputs

All input properties are implicitly available as output properties. Additionally, the Provider resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Package Details

Repository
https://github.com/pulumi/pulumi-okta
License
Apache-2.0
Notes
This Pulumi package is based on the okta Terraform Provider.