The Automation API is now available. No CLI. No human-in-the-loop. Just your code. Learn More

This page documents the language specification for the okta package. If you're looking for help working with the inputs, outputs, or functions of okta resources in a Pulumi program, please see the resource documentation for examples and API reference.

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.

class pulumi_okta.EventHook(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, auth: Union[EventHookAuthArgs, Mapping[str, Any], Awaitable[Union[EventHookAuthArgs, Mapping[str, Any]]], Output[T], None] = None, channel: Union[EventHookChannelArgs, Mapping[str, Any], Awaitable[Union[EventHookChannelArgs, Mapping[str, Any]]], Output[T], None] = None, events: Union[Sequence[Union[str, Awaitable[str], Output[T]]], Awaitable[Sequence[Union[str, Awaitable[str], Output[T]]]], Output[T], None] = None, headers: Union[Sequence[Union[EventHookHeaderArgs, Mapping[str, Any], Awaitable[Union[EventHookHeaderArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[EventHookHeaderArgs, Mapping[str, Any], Awaitable[Union[EventHookHeaderArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, name: Union[str, Awaitable[str], Output[T], None] = None, status: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

Creates an event hook.

This resource allows you to create and configure an event hook.

import pulumi
import pulumi_okta as okta

example = okta.EventHook("example",
    auth=okta.EventHookAuthArgs(
        key="Authorization",
        type="HEADER",
        value="123",
    ),
    channel=okta.EventHookChannelArgs(
        type="HTTP",
        uri="https://example.com/test",
        version="1.0.0",
    ),
    events=[
        "user.lifecycle.create",
        "user.lifecycle.delete.initiated",
    ])
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • auth (pulumi.Input[pulumi.InputType['EventHookAuthArgs']]) – Authentication required for event hook request.

  • channel (pulumi.Input[pulumi.InputType['EventHookChannelArgs']]) – Details of the endpoint the event hook will hit.

  • events (pulumi.Input[Sequence[pulumi.Input[str]]]) – The events that will be delivered to this hook. See here for a list of supported events.

  • headers (pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['EventHookHeaderArgs']]]]) – Map of headers to send along in event hook request.

  • name (pulumi.Input[str]) – The event hook display name.

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, auth: Union[EventHookAuthArgs, Mapping[str, Any], Awaitable[Union[EventHookAuthArgs, Mapping[str, Any]]], Output[T], None] = None, channel: Union[EventHookChannelArgs, Mapping[str, Any], Awaitable[Union[EventHookChannelArgs, Mapping[str, Any]]], Output[T], None] = None, events: Union[Sequence[Union[str, Awaitable[str], Output[T]]], Awaitable[Sequence[Union[str, Awaitable[str], Output[T]]]], Output[T], None] = None, headers: Union[Sequence[Union[EventHookHeaderArgs, Mapping[str, Any], Awaitable[Union[EventHookHeaderArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[EventHookHeaderArgs, Mapping[str, Any], Awaitable[Union[EventHookHeaderArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, name: Union[str, Awaitable[str], Output[T], None] = None, status: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_okta.event_hook.EventHook

Get an existing EventHook resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • auth (pulumi.Input[pulumi.InputType['EventHookAuthArgs']]) – Authentication required for event hook request.

  • channel (pulumi.Input[pulumi.InputType['EventHookChannelArgs']]) – Details of the endpoint the event hook will hit.

  • events (pulumi.Input[Sequence[pulumi.Input[str]]]) –

    The events that will be delivered to this hook. See here for a list of supported events.

  • headers (pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['EventHookHeaderArgs']]]]) – Map of headers to send along in event hook request.

  • name (pulumi.Input[str]) – The event hook display name.

property auth

Authentication required for event hook request.

property channel

Details of the endpoint the event hook will hit.

property events

The events that will be delivered to this hook. See here for a list of supported events.

property headers

Map of headers to send along in event hook request.

property name

The event hook display name.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_okta.Provider(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, api_token: Union[str, Awaitable[str], Output[T], None] = None, backoff: Union[bool, Awaitable[bool], Output[T], None] = None, base_url: Union[str, Awaitable[str], Output[T], None] = None, max_retries: Union[int, Awaitable[int], Output[T], None] = None, max_wait_seconds: Union[int, Awaitable[int], Output[T], None] = None, min_wait_seconds: Union[int, Awaitable[int], Output[T], None] = None, org_name: Union[str, Awaitable[str], Output[T], None] = None, parallelism: Union[int, Awaitable[int], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

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.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • api_token (pulumi.Input[str]) – API Token granting privileges to Okta API.

  • backoff (pulumi.Input[bool]) – Use exponential back off strategy for rate limits.

  • base_url (pulumi.Input[str]) – The Okta url. (Use ‘oktapreview.com’ for Okta testing)

  • max_retries (pulumi.Input[int]) – maximum number of retries to attempt before erroring out.

  • max_wait_seconds (pulumi.Input[int]) – maximum seconds to wait when rate limit is hit. We use exponential backoffs when backoff is enabled.

  • min_wait_seconds (pulumi.Input[int]) – minimum seconds to wait when rate limit is hit. We use exponential backoffs when backoff is enabled.

  • org_name (pulumi.Input[str]) – The organization to manage in Okta.

  • parallelism (pulumi.Input[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.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_okta.TemplateSms(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, template: Union[str, Awaitable[str], Output[T], None] = None, translations: Union[Sequence[Union[TemplateSmsTranslationArgs, Mapping[str, Any], Awaitable[Union[TemplateSmsTranslationArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[TemplateSmsTranslationArgs, Mapping[str, Any], Awaitable[Union[TemplateSmsTranslationArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, type: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

Creates an Okta SMS Template.

This resource allows you to create and configure an Okta SMS Template.

import pulumi
import pulumi_okta as okta

example = okta.TemplateSms("example",
    template=f"Your {org['name']} code is: {code}",
    translations=[
        okta.TemplateSmsTranslationArgs(
            language="en",
            template=f"Your {org['name']} code is: {code}",
        ),
        okta.TemplateSmsTranslationArgs(
            language="es",
            template=f"Tu código de {org['name']} es: {code}.",
        ),
    ],
    type="SMS_VERIFY_CODE")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • template (pulumi.Input[str]) – The SMS message.

  • translations (pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['TemplateSmsTranslationArgs']]]]) – Set of translations for particular template.

  • type (pulumi.Input[str]) – SMS template type

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, template: Union[str, Awaitable[str], Output[T], None] = None, translations: Union[Sequence[Union[TemplateSmsTranslationArgs, Mapping[str, Any], Awaitable[Union[TemplateSmsTranslationArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[TemplateSmsTranslationArgs, Mapping[str, Any], Awaitable[Union[TemplateSmsTranslationArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, type: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_okta.template_sms.TemplateSms

Get an existing TemplateSms resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • template (pulumi.Input[str]) – The SMS message.

  • translations (pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['TemplateSmsTranslationArgs']]]]) – Set of translations for particular template.

  • type (pulumi.Input[str]) – SMS template type

property template

The SMS message.

property translations

Set of translations for particular template.

property type

SMS template type

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str