Okta v4.8.0, Mar 2 24

Okta v4.8.0 published on Saturday, Mar 2, 2024 by Pulumi

okta.Provider

Explore with Pulumi AI

Okta v4.8.0 published on Saturday, Mar 2, 2024 by Pulumi

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 Provider Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);

@overload
def Provider(resource_name: str,
             args: Optional[ProviderArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             access_token: Optional[str] = None,
             api_token: Optional[str] = None,
             backoff: Optional[bool] = None,
             base_url: Optional[str] = None,
             client_id: Optional[str] = None,
             http_proxy: Optional[str] = None,
             log_level: Optional[int] = None,
             max_api_capacity: 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,
             private_key_id: 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)

public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

type: pulumi:providers:okta
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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.
args ProviderArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control 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.

name String: The unique name of the resource.
args ProviderArgs: The arguments to resource properties.
options 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 Architecture and Concepts docs.

Inputs

The Provider resource accepts the following input properties:

AccessToken string: Bearer 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.
HttpProxy string: Alternate HTTP proxy of scheme://hostname or scheme://hostname:port format
LogLevel int: providers log level. Minimum is 1 (TRACE), and maximum is 5 (ERROR)
MaxApiCapacity int: (Experimental) sets what percentage of capacity the provider can use of the total rate limit capacity while making calls to the Okta management API endpoints. Okta API operates in one minute buckets. See Okta Management API Rate Limits: https://developer.okta.com/docs/reference/rl-global-mgmt/
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.
PrivateKeyId string: API Token Id 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 300.
Scopes List<string>: API Token granting privileges to Okta API.

AccessToken string: Bearer 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.
HttpProxy string: Alternate HTTP proxy of scheme://hostname or scheme://hostname:port format
LogLevel int: providers log level. Minimum is 1 (TRACE), and maximum is 5 (ERROR)
MaxApiCapacity int: (Experimental) sets what percentage of capacity the provider can use of the total rate limit capacity while making calls to the Okta management API endpoints. Okta API operates in one minute buckets. See Okta Management API Rate Limits: https://developer.okta.com/docs/reference/rl-global-mgmt/
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.
PrivateKeyId string: API Token Id 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 300.
Scopes []string: API Token granting privileges to Okta API.

accessToken String: Bearer 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.
httpProxy String: Alternate HTTP proxy of scheme://hostname or scheme://hostname:port format
logLevel Integer: providers log level. Minimum is 1 (TRACE), and maximum is 5 (ERROR)
maxApiCapacity Integer: (Experimental) sets what percentage of capacity the provider can use of the total rate limit capacity while making calls to the Okta management API endpoints. Okta API operates in one minute buckets. See Okta Management API Rate Limits: https://developer.okta.com/docs/reference/rl-global-mgmt/
maxRetries Integer: maximum number of retries to attempt before erroring out.
maxWaitSeconds Integer: maximum seconds to wait when rate limit is hit. We use exponential backoffs when backoff is enabled.
minWaitSeconds Integer: 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 Integer: 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.
privateKeyId String: API Token Id granting privileges to Okta API.
requestTimeout Integer: 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 300.
scopes List<String>: API Token granting privileges to Okta API.

accessToken string: Bearer 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.
httpProxy string: Alternate HTTP proxy of scheme://hostname or scheme://hostname:port format
logLevel number: providers log level. Minimum is 1 (TRACE), and maximum is 5 (ERROR)
maxApiCapacity number: (Experimental) sets what percentage of capacity the provider can use of the total rate limit capacity while making calls to the Okta management API endpoints. Okta API operates in one minute buckets. See Okta Management API Rate Limits: https://developer.okta.com/docs/reference/rl-global-mgmt/
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.
privateKeyId string: API Token Id 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 300.
scopes string[]: API Token granting privileges to Okta API.

access_token str: Bearer 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.
http_proxy str: Alternate HTTP proxy of scheme://hostname or scheme://hostname:port format
log_level int: providers log level. Minimum is 1 (TRACE), and maximum is 5 (ERROR)
max_api_capacity int: (Experimental) sets what percentage of capacity the provider can use of the total rate limit capacity while making calls to the Okta management API endpoints. Okta API operates in one minute buckets. See Okta Management API Rate Limits: https://developer.okta.com/docs/reference/rl-global-mgmt/
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.
private_key_id str: API Token Id 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 300.
scopes Sequence[str]: API Token granting privileges to Okta API.

accessToken String: Bearer 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.
httpProxy String: Alternate HTTP proxy of scheme://hostname or scheme://hostname:port format
logLevel Number: providers log level. Minimum is 1 (TRACE), and maximum is 5 (ERROR)
maxApiCapacity Number: (Experimental) sets what percentage of capacity the provider can use of the total rate limit capacity while making calls to the Okta management API endpoints. Okta API operates in one minute buckets. See Okta Management API Rate Limits: https://developer.okta.com/docs/reference/rl-global-mgmt/
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.
privateKeyId String: API Token Id 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 300.
scopes List<String>: 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 string: The provider-assigned unique ID for this managed resource.

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

id String: The provider-assigned unique ID for this managed resource.

Package Details

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

Okta v4.8.0 published on Saturday, Mar 2, 2024 by Pulumi

pulumi/pulumi-okta

okta.Provider

On this page

On this page

Create Provider Resource

Constructor syntax

Parameters

Provider Resource Properties

Inputs

Outputs

Package Details

On this page

On this page