okta

package
v2.12.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 16, 2021 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

A Pulumi package for creating and managing okta resources.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PkgVersion added in v2.8.0 

func PkgVersion() (semver.Version, error)

PkgVersion uses reflection to determine the version of the current package.

Types

type AdminRoleTargets added in v2.10.0 

type AdminRoleTargets struct {
	pulumi.CustomResourceState

	// List of app names (name represents set of app instances) or a combination of app name and app instance ID (like 'salesforce' or 'facebook.0oapsqQ6dv19pqyEo0g3').
	Apps pulumi.StringArrayOutput `pulumi:"apps"`
	// List of group IDs. Conflicts with `apps`.
	Groups pulumi.StringArrayOutput `pulumi:"groups"`
	// Role ID.
	RoleId pulumi.StringOutput `pulumi:"roleId"`
	// Name of the role associated with the user.
	RoleType pulumi.StringOutput `pulumi:"roleType"`
	// ID of the user.
	UserId pulumi.StringOutput `pulumi:"userId"`
}

Manages targets for administrator roles.

This resource allows you to define permissions for admin roles into a smaller subset of Groups or Apps within your org. You can define admin roles to target Groups, Applications, and Application Instances.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-okta/sdk/v2/go/okta"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := okta.NewAdminRoleTargets(ctx, "example", &okta.AdminRoleTargetsArgs{
			Apps: pulumi.StringArray{
				pulumi.String("oidc_client.<app_id>"),
				pulumi.String("facebook"),
			},
			RoleType: pulumi.String("APP_ADMIN"),
			UserId:   pulumi.String("<user_id>"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Okta Admin Role Targets can be imported via the Okta ID.

```sh 

$ pulumi import okta:index/adminRoleTargets:AdminRoleTargets example <user id>/<role type>

```

func GetAdminRoleTargets added in v2.10.0 

func GetAdminRoleTargets(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AdminRoleTargetsState, opts ...pulumi.ResourceOption) (*AdminRoleTargets, error)

GetAdminRoleTargets gets an existing AdminRoleTargets resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAdminRoleTargets added in v2.10.0 

func NewAdminRoleTargets(ctx *pulumi.Context,
	name string, args *AdminRoleTargetsArgs, opts ...pulumi.ResourceOption) (*AdminRoleTargets, error)

NewAdminRoleTargets registers a new resource with the given unique name, arguments, and options.

func (*AdminRoleTargets) ElementType added in v2.10.0 

func (*AdminRoleTargets) ElementType() reflect.Type

func (*AdminRoleTargets) ToAdminRoleTargetsOutput added in v2.10.0 

func (i *AdminRoleTargets) ToAdminRoleTargetsOutput() AdminRoleTargetsOutput

func (*AdminRoleTargets) ToAdminRoleTargetsOutputWithContext added in v2.10.0 

func (i *AdminRoleTargets) ToAdminRoleTargetsOutputWithContext(ctx context.Context) AdminRoleTargetsOutput

func (*AdminRoleTargets) ToAdminRoleTargetsPtrOutput added in v2.10.1 

func (i *AdminRoleTargets) ToAdminRoleTargetsPtrOutput() AdminRoleTargetsPtrOutput

func (*AdminRoleTargets) ToAdminRoleTargetsPtrOutputWithContext added in v2.10.1 

func (i *AdminRoleTargets) ToAdminRoleTargetsPtrOutputWithContext(ctx context.Context) AdminRoleTargetsPtrOutput

type AdminRoleTargetsArgs added in v2.10.0 

type AdminRoleTargetsArgs struct {
	// List of app names (name represents set of app instances) or a combination of app name and app instance ID (like 'salesforce' or 'facebook.0oapsqQ6dv19pqyEo0g3').
	Apps pulumi.StringArrayInput
	// List of group IDs. Conflicts with `apps`.
	Groups pulumi.StringArrayInput
	// Name of the role associated with the user.
	RoleType pulumi.StringInput
	// ID of the user.
	UserId pulumi.StringInput
}

The set of arguments for constructing a AdminRoleTargets resource.

func (AdminRoleTargetsArgs) ElementType added in v2.10.0 

func (AdminRoleTargetsArgs) ElementType() reflect.Type

type AdminRoleTargetsArray added in v2.10.1 

type AdminRoleTargetsArray []AdminRoleTargetsInput

func (AdminRoleTargetsArray) ElementType added in v2.10.1 

func (AdminRoleTargetsArray) ElementType() reflect.Type

func (AdminRoleTargetsArray) ToAdminRoleTargetsArrayOutput added in v2.10.1 

func (i AdminRoleTargetsArray) ToAdminRoleTargetsArrayOutput() AdminRoleTargetsArrayOutput

func (AdminRoleTargetsArray) ToAdminRoleTargetsArrayOutputWithContext added in v2.10.1 

func (i AdminRoleTargetsArray) ToAdminRoleTargetsArrayOutputWithContext(ctx context.Context) AdminRoleTargetsArrayOutput

type AdminRoleTargetsArrayInput added in v2.10.1 

type AdminRoleTargetsArrayInput interface {
	pulumi.Input

	ToAdminRoleTargetsArrayOutput() AdminRoleTargetsArrayOutput
	ToAdminRoleTargetsArrayOutputWithContext(context.Context) AdminRoleTargetsArrayOutput
}

AdminRoleTargetsArrayInput is an input type that accepts AdminRoleTargetsArray and AdminRoleTargetsArrayOutput values. You can construct a concrete instance of `AdminRoleTargetsArrayInput` via: 

AdminRoleTargetsArray{ AdminRoleTargetsArgs{...} }

type AdminRoleTargetsArrayOutput added in v2.10.1 

type AdminRoleTargetsArrayOutput struct{ *pulumi.OutputState }

func (AdminRoleTargetsArrayOutput) ElementType added in v2.10.1 

func (AdminRoleTargetsArrayOutput) ElementType() reflect.Type

func (AdminRoleTargetsArrayOutput) Index added in v2.10.1 

func (o AdminRoleTargetsArrayOutput) Index(i pulumi.IntInput) AdminRoleTargetsOutput

func (AdminRoleTargetsArrayOutput) ToAdminRoleTargetsArrayOutput added in v2.10.1 

func (o AdminRoleTargetsArrayOutput) ToAdminRoleTargetsArrayOutput() AdminRoleTargetsArrayOutput

func (AdminRoleTargetsArrayOutput) ToAdminRoleTargetsArrayOutputWithContext added in v2.10.1 

func (o AdminRoleTargetsArrayOutput) ToAdminRoleTargetsArrayOutputWithContext(ctx context.Context) AdminRoleTargetsArrayOutput

type AdminRoleTargetsInput added in v2.10.0 

type AdminRoleTargetsInput interface {
	pulumi.Input

	ToAdminRoleTargetsOutput() AdminRoleTargetsOutput
	ToAdminRoleTargetsOutputWithContext(ctx context.Context) AdminRoleTargetsOutput
}

type AdminRoleTargetsMap added in v2.10.1 

type AdminRoleTargetsMap map[string]AdminRoleTargetsInput

func (AdminRoleTargetsMap) ElementType added in v2.10.1 

func (AdminRoleTargetsMap) ElementType() reflect.Type

func (AdminRoleTargetsMap) ToAdminRoleTargetsMapOutput added in v2.10.1 

func (i AdminRoleTargetsMap) ToAdminRoleTargetsMapOutput() AdminRoleTargetsMapOutput

func (AdminRoleTargetsMap) ToAdminRoleTargetsMapOutputWithContext added in v2.10.1 

func (i AdminRoleTargetsMap) ToAdminRoleTargetsMapOutputWithContext(ctx context.Context) AdminRoleTargetsMapOutput

type AdminRoleTargetsMapInput added in v2.10.1 

type AdminRoleTargetsMapInput interface {
	pulumi.Input

	ToAdminRoleTargetsMapOutput() AdminRoleTargetsMapOutput
	ToAdminRoleTargetsMapOutputWithContext(context.Context) AdminRoleTargetsMapOutput
}

AdminRoleTargetsMapInput is an input type that accepts AdminRoleTargetsMap and AdminRoleTargetsMapOutput values. You can construct a concrete instance of `AdminRoleTargetsMapInput` via: 

AdminRoleTargetsMap{ "key": AdminRoleTargetsArgs{...} }

type AdminRoleTargetsMapOutput added in v2.10.1 

type AdminRoleTargetsMapOutput struct{ *pulumi.OutputState }

func (AdminRoleTargetsMapOutput) ElementType added in v2.10.1 

func (AdminRoleTargetsMapOutput) ElementType() reflect.Type

func (AdminRoleTargetsMapOutput) MapIndex added in v2.10.1 

func (o AdminRoleTargetsMapOutput) MapIndex(k pulumi.StringInput) AdminRoleTargetsOutput

func (AdminRoleTargetsMapOutput) ToAdminRoleTargetsMapOutput added in v2.10.1 

func (o AdminRoleTargetsMapOutput) ToAdminRoleTargetsMapOutput() AdminRoleTargetsMapOutput

func (AdminRoleTargetsMapOutput) ToAdminRoleTargetsMapOutputWithContext added in v2.10.1 

func (o AdminRoleTargetsMapOutput) ToAdminRoleTargetsMapOutputWithContext(ctx context.Context) AdminRoleTargetsMapOutput

type AdminRoleTargetsOutput added in v2.10.0 

type AdminRoleTargetsOutput struct {
	*pulumi.OutputState
}

func (AdminRoleTargetsOutput) ElementType added in v2.10.0 

func (AdminRoleTargetsOutput) ElementType() reflect.Type

func (AdminRoleTargetsOutput) ToAdminRoleTargetsOutput added in v2.10.0 

func (o AdminRoleTargetsOutput) ToAdminRoleTargetsOutput() AdminRoleTargetsOutput

func (AdminRoleTargetsOutput) ToAdminRoleTargetsOutputWithContext added in v2.10.0 

func (o AdminRoleTargetsOutput) ToAdminRoleTargetsOutputWithContext(ctx context.Context) AdminRoleTargetsOutput

func (AdminRoleTargetsOutput) ToAdminRoleTargetsPtrOutput added in v2.10.1 

func (o AdminRoleTargetsOutput) ToAdminRoleTargetsPtrOutput() AdminRoleTargetsPtrOutput

func (AdminRoleTargetsOutput) ToAdminRoleTargetsPtrOutputWithContext added in v2.10.1 

func (o AdminRoleTargetsOutput) ToAdminRoleTargetsPtrOutputWithContext(ctx context.Context) AdminRoleTargetsPtrOutput

type AdminRoleTargetsPtrInput added in v2.10.1 

type AdminRoleTargetsPtrInput interface {
	pulumi.Input

	ToAdminRoleTargetsPtrOutput() AdminRoleTargetsPtrOutput
	ToAdminRoleTargetsPtrOutputWithContext(ctx context.Context) AdminRoleTargetsPtrOutput
}

type AdminRoleTargetsPtrOutput added in v2.10.1 

type AdminRoleTargetsPtrOutput struct {
	*pulumi.OutputState
}

func (AdminRoleTargetsPtrOutput) ElementType added in v2.10.1 

func (AdminRoleTargetsPtrOutput) ElementType() reflect.Type

func (AdminRoleTargetsPtrOutput) ToAdminRoleTargetsPtrOutput added in v2.10.1 

func (o AdminRoleTargetsPtrOutput) ToAdminRoleTargetsPtrOutput() AdminRoleTargetsPtrOutput

func (AdminRoleTargetsPtrOutput) ToAdminRoleTargetsPtrOutputWithContext added in v2.10.1 

func (o AdminRoleTargetsPtrOutput) ToAdminRoleTargetsPtrOutputWithContext(ctx context.Context) AdminRoleTargetsPtrOutput

type AdminRoleTargetsState added in v2.10.0 

type AdminRoleTargetsState struct {
	// List of app names (name represents set of app instances) or a combination of app name and app instance ID (like 'salesforce' or 'facebook.0oapsqQ6dv19pqyEo0g3').
	Apps pulumi.StringArrayInput
	// List of group IDs. Conflicts with `apps`.
	Groups pulumi.StringArrayInput
	// Role ID.
	RoleId pulumi.StringPtrInput
	// Name of the role associated with the user.
	RoleType pulumi.StringPtrInput
	// ID of the user.
	UserId pulumi.StringPtrInput
}

func (AdminRoleTargetsState) ElementType added in v2.10.0 

func (AdminRoleTargetsState) ElementType() reflect.Type

type EventHook added in v2.4.0 

type EventHook struct {
	pulumi.CustomResourceState

	// Authentication required for event hook request.
	Auth pulumi.StringMapOutput `pulumi:"auth"`
	// Details of the endpoint the event hook will hit.
	Channel pulumi.StringMapOutput `pulumi:"channel"`
	// The events that will be delivered to this hook. [See here for a list of supported events](https://developer.okta.com/docs/reference/api/event-types/?q=event-hook-eligible).
	Events pulumi.StringArrayOutput `pulumi:"events"`
	// Map of headers to send along in event hook request.
	Headers EventHookHeaderArrayOutput `pulumi:"headers"`
	// The event hook display name.
	Name   pulumi.StringOutput    `pulumi:"name"`
	Status pulumi.StringPtrOutput `pulumi:"status"`
}

Creates an event hook.

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

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-okta/sdk/v2/go/okta"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := okta.NewEventHook(ctx, "example", &okta.EventHookArgs{
			Auth: pulumi.StringMap{
				"key":   pulumi.String("Authorization"),
				"type":  pulumi.String("HEADER"),
				"value": pulumi.String("123"),
			},
			Channel: pulumi.StringMap{
				"type":    pulumi.String("HTTP"),
				"uri":     pulumi.String("https://example.com/test"),
				"version": pulumi.String("1.0.0"),
			},
			Events: pulumi.StringArray{
				pulumi.String("user.lifecycle.create"),
				pulumi.String("user.lifecycle.delete.initiated"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

An event hook can be imported via the Okta ID.

```sh 

$ pulumi import okta:index/eventHook:EventHook example <hook id>

```

func GetEventHook added in v2.4.0 

func GetEventHook(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *EventHookState, opts ...pulumi.ResourceOption) (*EventHook, error)

GetEventHook gets an existing EventHook resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewEventHook added in v2.4.0 

func NewEventHook(ctx *pulumi.Context,
	name string, args *EventHookArgs, opts ...pulumi.ResourceOption) (*EventHook, error)

NewEventHook registers a new resource with the given unique name, arguments, and options.

func (*EventHook) ElementType added in v2.6.2 

func (*EventHook) ElementType() reflect.Type

func (*EventHook) ToEventHookOutput added in v2.6.2 

func (i *EventHook) ToEventHookOutput() EventHookOutput

func (*EventHook) ToEventHookOutputWithContext added in v2.6.2 

func (i *EventHook) ToEventHookOutputWithContext(ctx context.Context) EventHookOutput

func (*EventHook) ToEventHookPtrOutput added in v2.10.1 

func (i *EventHook) ToEventHookPtrOutput() EventHookPtrOutput

func (*EventHook) ToEventHookPtrOutputWithContext added in v2.10.1 

func (i *EventHook) ToEventHookPtrOutputWithContext(ctx context.Context) EventHookPtrOutput

type EventHookArgs added in v2.4.0 

type EventHookArgs struct {
	// Authentication required for event hook request.
	Auth pulumi.StringMapInput
	// Details of the endpoint the event hook will hit.
	Channel pulumi.StringMapInput
	// The events that will be delivered to this hook. [See here for a list of supported events](https://developer.okta.com/docs/reference/api/event-types/?q=event-hook-eligible).
	Events pulumi.StringArrayInput
	// Map of headers to send along in event hook request.
	Headers EventHookHeaderArrayInput
	// The event hook display name.
	Name   pulumi.StringPtrInput
	Status pulumi.StringPtrInput
}

The set of arguments for constructing a EventHook resource.

func (EventHookArgs) ElementType added in v2.4.0 

func (EventHookArgs) ElementType() reflect.Type

type EventHookArray added in v2.10.1 

type EventHookArray []EventHookInput

func (EventHookArray) ElementType added in v2.10.1 

func (EventHookArray) ElementType() reflect.Type

func (EventHookArray) ToEventHookArrayOutput added in v2.10.1 

func (i EventHookArray) ToEventHookArrayOutput() EventHookArrayOutput

func (EventHookArray) ToEventHookArrayOutputWithContext added in v2.10.1 

func (i EventHookArray) ToEventHookArrayOutputWithContext(ctx context.Context) EventHookArrayOutput

type EventHookArrayInput added in v2.10.1 

type EventHookArrayInput interface {
	pulumi.Input

	ToEventHookArrayOutput() EventHookArrayOutput
	ToEventHookArrayOutputWithContext(context.Context) EventHookArrayOutput
}

EventHookArrayInput is an input type that accepts EventHookArray and EventHookArrayOutput values. You can construct a concrete instance of `EventHookArrayInput` via: 

EventHookArray{ EventHookArgs{...} }

type EventHookArrayOutput added in v2.10.1 

type EventHookArrayOutput struct{ *pulumi.OutputState }

func (EventHookArrayOutput) ElementType added in v2.10.1 

func (EventHookArrayOutput) ElementType() reflect.Type

func (EventHookArrayOutput) Index added in v2.10.1 

func (o EventHookArrayOutput) Index(i pulumi.IntInput) EventHookOutput

func (EventHookArrayOutput) ToEventHookArrayOutput added in v2.10.1 

func (o EventHookArrayOutput) ToEventHookArrayOutput() EventHookArrayOutput

func (EventHookArrayOutput) ToEventHookArrayOutputWithContext added in v2.10.1 

func (o EventHookArrayOutput) ToEventHookArrayOutputWithContext(ctx context.Context) EventHookArrayOutput

type EventHookHeader added in v2.4.0 

type EventHookHeader struct {
	// Key to use for authentication, usually the header name, for example `"Authorization"`.
	Key *string `pulumi:"key"`
	// Authentication secret.
	Value *string `pulumi:"value"`
}

type EventHookHeaderArgs added in v2.4.0 

type EventHookHeaderArgs struct {
	// Key to use for authentication, usually the header name, for example `"Authorization"`.
	Key pulumi.StringPtrInput `pulumi:"key"`
	// Authentication secret.
	Value pulumi.StringPtrInput `pulumi:"value"`
}

func (EventHookHeaderArgs) ElementType added in v2.4.0 

func (EventHookHeaderArgs) ElementType() reflect.Type

func (EventHookHeaderArgs) ToEventHookHeaderOutput added in v2.4.0 

func (i EventHookHeaderArgs) ToEventHookHeaderOutput() EventHookHeaderOutput

func (EventHookHeaderArgs) ToEventHookHeaderOutputWithContext added in v2.4.0 

func (i EventHookHeaderArgs) ToEventHookHeaderOutputWithContext(ctx context.Context) EventHookHeaderOutput

type EventHookHeaderArray added in v2.4.0 

type EventHookHeaderArray []EventHookHeaderInput

func (EventHookHeaderArray) ElementType added in v2.4.0 

func (EventHookHeaderArray) ElementType() reflect.Type

func (EventHookHeaderArray) ToEventHookHeaderArrayOutput added in v2.4.0 

func (i EventHookHeaderArray) ToEventHookHeaderArrayOutput() EventHookHeaderArrayOutput

func (EventHookHeaderArray) ToEventHookHeaderArrayOutputWithContext added in v2.4.0 

func (i EventHookHeaderArray) ToEventHookHeaderArrayOutputWithContext(ctx context.Context) EventHookHeaderArrayOutput

type EventHookHeaderArrayInput added in v2.4.0 

type EventHookHeaderArrayInput interface {
	pulumi.Input

	ToEventHookHeaderArrayOutput() EventHookHeaderArrayOutput
	ToEventHookHeaderArrayOutputWithContext(context.Context) EventHookHeaderArrayOutput
}

EventHookHeaderArrayInput is an input type that accepts EventHookHeaderArray and EventHookHeaderArrayOutput values. You can construct a concrete instance of `EventHookHeaderArrayInput` via: 

EventHookHeaderArray{ EventHookHeaderArgs{...} }

type EventHookHeaderArrayOutput added in v2.4.0 

type EventHookHeaderArrayOutput struct{ *pulumi.OutputState }

func (EventHookHeaderArrayOutput) ElementType added in v2.4.0 

func (EventHookHeaderArrayOutput) ElementType() reflect.Type

func (EventHookHeaderArrayOutput) Index added in v2.4.0 

func (o EventHookHeaderArrayOutput) Index(i pulumi.IntInput) EventHookHeaderOutput

func (EventHookHeaderArrayOutput) ToEventHookHeaderArrayOutput added in v2.4.0 

func (o EventHookHeaderArrayOutput) ToEventHookHeaderArrayOutput() EventHookHeaderArrayOutput

func (EventHookHeaderArrayOutput) ToEventHookHeaderArrayOutputWithContext added in v2.4.0 

func (o EventHookHeaderArrayOutput) ToEventHookHeaderArrayOutputWithContext(ctx context.Context) EventHookHeaderArrayOutput

type EventHookHeaderInput added in v2.4.0 

type EventHookHeaderInput interface {
	pulumi.Input

	ToEventHookHeaderOutput() EventHookHeaderOutput
	ToEventHookHeaderOutputWithContext(context.Context) EventHookHeaderOutput
}

EventHookHeaderInput is an input type that accepts EventHookHeaderArgs and EventHookHeaderOutput values. You can construct a concrete instance of `EventHookHeaderInput` via: 

EventHookHeaderArgs{...}

type EventHookHeaderOutput added in v2.4.0 

type EventHookHeaderOutput struct{ *pulumi.OutputState }

func (EventHookHeaderOutput) ElementType added in v2.4.0 

func (EventHookHeaderOutput) ElementType() reflect.Type

func (EventHookHeaderOutput) Key added in v2.4.0 

func (o EventHookHeaderOutput) Key() pulumi.StringPtrOutput

Key to use for authentication, usually the header name, for example `"Authorization"`.

func (EventHookHeaderOutput) ToEventHookHeaderOutput added in v2.4.0 

func (o EventHookHeaderOutput) ToEventHookHeaderOutput() EventHookHeaderOutput

func (EventHookHeaderOutput) ToEventHookHeaderOutputWithContext added in v2.4.0 

func (o EventHookHeaderOutput) ToEventHookHeaderOutputWithContext(ctx context.Context) EventHookHeaderOutput

func (EventHookHeaderOutput) Value added in v2.4.0 

func (o EventHookHeaderOutput) Value() pulumi.StringPtrOutput

Authentication secret.

type EventHookInput added in v2.6.2 

type EventHookInput interface {
	pulumi.Input

	ToEventHookOutput() EventHookOutput
	ToEventHookOutputWithContext(ctx context.Context) EventHookOutput
}

type EventHookMap added in v2.10.1 

type EventHookMap map[string]EventHookInput

func (EventHookMap) ElementType added in v2.10.1 

func (EventHookMap) ElementType() reflect.Type

func (EventHookMap) ToEventHookMapOutput added in v2.10.1 

func (i EventHookMap) ToEventHookMapOutput() EventHookMapOutput

func (EventHookMap) ToEventHookMapOutputWithContext added in v2.10.1 

func (i EventHookMap) ToEventHookMapOutputWithContext(ctx context.Context) EventHookMapOutput

type EventHookMapInput added in v2.10.1 

type EventHookMapInput interface {
	pulumi.Input

	ToEventHookMapOutput() EventHookMapOutput
	ToEventHookMapOutputWithContext(context.Context) EventHookMapOutput
}

EventHookMapInput is an input type that accepts EventHookMap and EventHookMapOutput values. You can construct a concrete instance of `EventHookMapInput` via: 

EventHookMap{ "key": EventHookArgs{...} }

type EventHookMapOutput added in v2.10.1 

type EventHookMapOutput struct{ *pulumi.OutputState }

func (EventHookMapOutput) ElementType added in v2.10.1 

func (EventHookMapOutput) ElementType() reflect.Type

func (EventHookMapOutput) MapIndex added in v2.10.1 

func (o EventHookMapOutput) MapIndex(k pulumi.StringInput) EventHookOutput

func (EventHookMapOutput) ToEventHookMapOutput added in v2.10.1 

func (o EventHookMapOutput) ToEventHookMapOutput() EventHookMapOutput

func (EventHookMapOutput) ToEventHookMapOutputWithContext added in v2.10.1 

func (o EventHookMapOutput) ToEventHookMapOutputWithContext(ctx context.Context) EventHookMapOutput

type EventHookOutput added in v2.6.2 

type EventHookOutput struct {
	*pulumi.OutputState
}

func (EventHookOutput) ElementType added in v2.6.2 

func (EventHookOutput) ElementType() reflect.Type

func (EventHookOutput) ToEventHookOutput added in v2.6.2 

func (o EventHookOutput) ToEventHookOutput() EventHookOutput

func (EventHookOutput) ToEventHookOutputWithContext added in v2.6.2 

func (o EventHookOutput) ToEventHookOutputWithContext(ctx context.Context) EventHookOutput

func (EventHookOutput) ToEventHookPtrOutput added in v2.10.1 

func (o EventHookOutput) ToEventHookPtrOutput() EventHookPtrOutput

func (EventHookOutput) ToEventHookPtrOutputWithContext added in v2.10.1 

func (o EventHookOutput) ToEventHookPtrOutputWithContext(ctx context.Context) EventHookPtrOutput

type EventHookPtrInput added in v2.10.1 

type EventHookPtrInput interface {
	pulumi.Input

	ToEventHookPtrOutput() EventHookPtrOutput
	ToEventHookPtrOutputWithContext(ctx context.Context) EventHookPtrOutput
}

type EventHookPtrOutput added in v2.10.1 

type EventHookPtrOutput struct {
	*pulumi.OutputState
}

func (EventHookPtrOutput) ElementType added in v2.10.1 

func (EventHookPtrOutput) ElementType() reflect.Type

func (EventHookPtrOutput) ToEventHookPtrOutput added in v2.10.1 

func (o EventHookPtrOutput) ToEventHookPtrOutput() EventHookPtrOutput

func (EventHookPtrOutput) ToEventHookPtrOutputWithContext added in v2.10.1 

func (o EventHookPtrOutput) ToEventHookPtrOutputWithContext(ctx context.Context) EventHookPtrOutput

type EventHookState added in v2.4.0 

type EventHookState struct {
	// Authentication required for event hook request.
	Auth pulumi.StringMapInput
	// Details of the endpoint the event hook will hit.
	Channel pulumi.StringMapInput
	// The events that will be delivered to this hook. [See here for a list of supported events](https://developer.okta.com/docs/reference/api/event-types/?q=event-hook-eligible).
	Events pulumi.StringArrayInput
	// Map of headers to send along in event hook request.
	Headers EventHookHeaderArrayInput
	// The event hook display name.
	Name   pulumi.StringPtrInput
	Status pulumi.StringPtrInput
}

func (EventHookState) ElementType added in v2.4.0 

func (EventHookState) ElementType() reflect.Type

type Provider 

type Provider struct {
	pulumi.ProviderResourceState
}

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](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.

func NewProvider 

func NewProvider(ctx *pulumi.Context,
	name string, args *ProviderArgs, opts ...pulumi.ResourceOption) (*Provider, error)

NewProvider registers a new resource with the given unique name, arguments, and options.

func (*Provider) ElementType added in v2.6.2 

func (*Provider) ElementType() reflect.Type

func (*Provider) ToProviderOutput added in v2.6.2 

func (i *Provider) ToProviderOutput() ProviderOutput

func (*Provider) ToProviderOutputWithContext added in v2.6.2 

func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

func (*Provider) ToProviderPtrOutput added in v2.10.1 

func (i *Provider) ToProviderPtrOutput() ProviderPtrOutput

func (*Provider) ToProviderPtrOutputWithContext added in v2.10.1 

func (i *Provider) ToProviderPtrOutputWithContext(ctx context.Context) ProviderPtrOutput

type ProviderArgs 

type ProviderArgs struct {
	// API Token granting privileges to Okta API.
	ApiToken pulumi.StringPtrInput
	// Use exponential back off strategy for rate limits.
	Backoff pulumi.BoolPtrInput
	// The Okta url. (Use 'oktapreview.com' for Okta testing)
	BaseUrl pulumi.StringPtrInput
	// API Token granting privileges to Okta API.
	ClientId pulumi.StringPtrInput
	// providers log level. Minimum is 1 (TRACE), and maximum is 5 (ERROR)
	LogLevel pulumi.IntPtrInput
	// maximum number of retries to attempt before erroring out.
	MaxRetries pulumi.IntPtrInput
	// maximum seconds to wait when rate limit is hit. We use exponential backoffs when backoff is enabled.
	MaxWaitSeconds pulumi.IntPtrInput
	// minimum seconds to wait when rate limit is hit. We use exponential backoffs when backoff is enabled.
	MinWaitSeconds pulumi.IntPtrInput
	// The organization to manage in Okta.
	OrgName pulumi.StringPtrInput
	// 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.
	Parallelism pulumi.IntPtrInput
	// API Token granting privileges to Okta API.
	PrivateKey pulumi.StringPtrInput
	// 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`.
	RequestTimeout pulumi.IntPtrInput
	// API Token granting privileges to Okta API.
	Scopes pulumi.StringArrayInput
}

The set of arguments for constructing a Provider resource.

func (ProviderArgs) ElementType 

func (ProviderArgs) ElementType() reflect.Type

type ProviderInput added in v2.6.2 

type ProviderInput interface {
	pulumi.Input

	ToProviderOutput() ProviderOutput
	ToProviderOutputWithContext(ctx context.Context) ProviderOutput
}

type ProviderOutput added in v2.6.2 

type ProviderOutput struct {
	*pulumi.OutputState
}

func (ProviderOutput) ElementType added in v2.6.2 

func (ProviderOutput) ElementType() reflect.Type

func (ProviderOutput) ToProviderOutput added in v2.6.2 

func (o ProviderOutput) ToProviderOutput() ProviderOutput

func (ProviderOutput) ToProviderOutputWithContext added in v2.6.2 

func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

func (ProviderOutput) ToProviderPtrOutput added in v2.10.1 

func (o ProviderOutput) ToProviderPtrOutput() ProviderPtrOutput

func (ProviderOutput) ToProviderPtrOutputWithContext added in v2.10.1 

func (o ProviderOutput) ToProviderPtrOutputWithContext(ctx context.Context) ProviderPtrOutput

type ProviderPtrInput added in v2.10.1 

type ProviderPtrInput interface {
	pulumi.Input

	ToProviderPtrOutput() ProviderPtrOutput
	ToProviderPtrOutputWithContext(ctx context.Context) ProviderPtrOutput
}

type ProviderPtrOutput added in v2.10.1 

type ProviderPtrOutput struct {
	*pulumi.OutputState
}

func (ProviderPtrOutput) ElementType added in v2.10.1 

func (ProviderPtrOutput) ElementType() reflect.Type

func (ProviderPtrOutput) ToProviderPtrOutput added in v2.10.1 

func (o ProviderPtrOutput) ToProviderPtrOutput() ProviderPtrOutput

func (ProviderPtrOutput) ToProviderPtrOutputWithContext added in v2.10.1 

func (o ProviderPtrOutput) ToProviderPtrOutputWithContext(ctx context.Context) ProviderPtrOutput

type TemplateSms added in v2.4.0 

type TemplateSms struct {
	pulumi.CustomResourceState

	// The SMS message.
	Template pulumi.StringOutput `pulumi:"template"`
	// Set of translations for a particular template.
	Translations TemplateSmsTranslationArrayOutput `pulumi:"translations"`
	// SMS template type
	Type pulumi.StringOutput `pulumi:"type"`
}

Creates an Okta SMS Template.

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

## Example Usage

```go package main

import ( 

"fmt"

"github.com/pulumi/pulumi-okta/sdk/v2/go/okta"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := okta.NewTemplateSms(ctx, "example", &okta.TemplateSmsArgs{
			Template: pulumi.String(fmt.Sprintf("%v%v%v%v", "Your ", org.Name, " code is: ", code)),
			Translations: okta.TemplateSmsTranslationArray{
				&okta.TemplateSmsTranslationArgs{
					Language: pulumi.String("en"),
					Template: pulumi.String(fmt.Sprintf("%v%v%v%v", "Your ", org.Name, " code is: ", code)),
				},
				&okta.TemplateSmsTranslationArgs{
					Language: pulumi.String("es"),
					Template: pulumi.String(fmt.Sprintf("%v%v%v%v%v", "Tu código de ", org.Name, " es: ", code, ".")),
				},
			},
			Type: pulumi.String("SMS_VERIFY_CODE"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

An Okta SMS Template can be imported via the template type.

```sh 

$ pulumi import okta:index/templateSms:TemplateSms example <template type>

```

func GetTemplateSms added in v2.4.0 

func GetTemplateSms(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *TemplateSmsState, opts ...pulumi.ResourceOption) (*TemplateSms, error)

GetTemplateSms gets an existing TemplateSms resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewTemplateSms added in v2.4.0 

func NewTemplateSms(ctx *pulumi.Context,
	name string, args *TemplateSmsArgs, opts ...pulumi.ResourceOption) (*TemplateSms, error)

NewTemplateSms registers a new resource with the given unique name, arguments, and options.

func (*TemplateSms) ElementType added in v2.6.2 

func (*TemplateSms) ElementType() reflect.Type

func (*TemplateSms) ToTemplateSmsOutput added in v2.6.2 

func (i *TemplateSms) ToTemplateSmsOutput() TemplateSmsOutput

func (*TemplateSms) ToTemplateSmsOutputWithContext added in v2.6.2 

func (i *TemplateSms) ToTemplateSmsOutputWithContext(ctx context.Context) TemplateSmsOutput

func (*TemplateSms) ToTemplateSmsPtrOutput added in v2.10.1 

func (i *TemplateSms) ToTemplateSmsPtrOutput() TemplateSmsPtrOutput

func (*TemplateSms) ToTemplateSmsPtrOutputWithContext added in v2.10.1 

func (i *TemplateSms) ToTemplateSmsPtrOutputWithContext(ctx context.Context) TemplateSmsPtrOutput

type TemplateSmsArgs added in v2.4.0 

type TemplateSmsArgs struct {
	// The SMS message.
	Template pulumi.StringInput
	// Set of translations for a particular template.
	Translations TemplateSmsTranslationArrayInput
	// SMS template type
	Type pulumi.StringInput
}

The set of arguments for constructing a TemplateSms resource.

func (TemplateSmsArgs) ElementType added in v2.4.0 

func (TemplateSmsArgs) ElementType() reflect.Type

type TemplateSmsArray added in v2.10.1 

type TemplateSmsArray []TemplateSmsInput

func (TemplateSmsArray) ElementType added in v2.10.1 

func (TemplateSmsArray) ElementType() reflect.Type

func (TemplateSmsArray) ToTemplateSmsArrayOutput added in v2.10.1 

func (i TemplateSmsArray) ToTemplateSmsArrayOutput() TemplateSmsArrayOutput

func (TemplateSmsArray) ToTemplateSmsArrayOutputWithContext added in v2.10.1 

func (i TemplateSmsArray) ToTemplateSmsArrayOutputWithContext(ctx context.Context) TemplateSmsArrayOutput

type TemplateSmsArrayInput added in v2.10.1 

type TemplateSmsArrayInput interface {
	pulumi.Input

	ToTemplateSmsArrayOutput() TemplateSmsArrayOutput
	ToTemplateSmsArrayOutputWithContext(context.Context) TemplateSmsArrayOutput
}

TemplateSmsArrayInput is an input type that accepts TemplateSmsArray and TemplateSmsArrayOutput values. You can construct a concrete instance of `TemplateSmsArrayInput` via: 

TemplateSmsArray{ TemplateSmsArgs{...} }

type TemplateSmsArrayOutput added in v2.10.1 

type TemplateSmsArrayOutput struct{ *pulumi.OutputState }

func (TemplateSmsArrayOutput) ElementType added in v2.10.1 

func (TemplateSmsArrayOutput) ElementType() reflect.Type

func (TemplateSmsArrayOutput) Index added in v2.10.1 

func (o TemplateSmsArrayOutput) Index(i pulumi.IntInput) TemplateSmsOutput

func (TemplateSmsArrayOutput) ToTemplateSmsArrayOutput added in v2.10.1 

func (o TemplateSmsArrayOutput) ToTemplateSmsArrayOutput() TemplateSmsArrayOutput

func (TemplateSmsArrayOutput) ToTemplateSmsArrayOutputWithContext added in v2.10.1 

func (o TemplateSmsArrayOutput) ToTemplateSmsArrayOutputWithContext(ctx context.Context) TemplateSmsArrayOutput

type TemplateSmsInput added in v2.6.2 

type TemplateSmsInput interface {
	pulumi.Input

	ToTemplateSmsOutput() TemplateSmsOutput
	ToTemplateSmsOutputWithContext(ctx context.Context) TemplateSmsOutput
}

type TemplateSmsMap added in v2.10.1 

type TemplateSmsMap map[string]TemplateSmsInput

func (TemplateSmsMap) ElementType added in v2.10.1 

func (TemplateSmsMap) ElementType() reflect.Type

func (TemplateSmsMap) ToTemplateSmsMapOutput added in v2.10.1 

func (i TemplateSmsMap) ToTemplateSmsMapOutput() TemplateSmsMapOutput

func (TemplateSmsMap) ToTemplateSmsMapOutputWithContext added in v2.10.1 

func (i TemplateSmsMap) ToTemplateSmsMapOutputWithContext(ctx context.Context) TemplateSmsMapOutput

type TemplateSmsMapInput added in v2.10.1 

type TemplateSmsMapInput interface {
	pulumi.Input

	ToTemplateSmsMapOutput() TemplateSmsMapOutput
	ToTemplateSmsMapOutputWithContext(context.Context) TemplateSmsMapOutput
}

TemplateSmsMapInput is an input type that accepts TemplateSmsMap and TemplateSmsMapOutput values. You can construct a concrete instance of `TemplateSmsMapInput` via: 

TemplateSmsMap{ "key": TemplateSmsArgs{...} }

type TemplateSmsMapOutput added in v2.10.1 

type TemplateSmsMapOutput struct{ *pulumi.OutputState }

func (TemplateSmsMapOutput) ElementType added in v2.10.1 

func (TemplateSmsMapOutput) ElementType() reflect.Type

func (TemplateSmsMapOutput) MapIndex added in v2.10.1 

func (o TemplateSmsMapOutput) MapIndex(k pulumi.StringInput) TemplateSmsOutput

func (TemplateSmsMapOutput) ToTemplateSmsMapOutput added in v2.10.1 

func (o TemplateSmsMapOutput) ToTemplateSmsMapOutput() TemplateSmsMapOutput

func (TemplateSmsMapOutput) ToTemplateSmsMapOutputWithContext added in v2.10.1 

func (o TemplateSmsMapOutput) ToTemplateSmsMapOutputWithContext(ctx context.Context) TemplateSmsMapOutput

type TemplateSmsOutput added in v2.6.2 

type TemplateSmsOutput struct {
	*pulumi.OutputState
}

func (TemplateSmsOutput) ElementType added in v2.6.2 

func (TemplateSmsOutput) ElementType() reflect.Type

func (TemplateSmsOutput) ToTemplateSmsOutput added in v2.6.2 

func (o TemplateSmsOutput) ToTemplateSmsOutput() TemplateSmsOutput

func (TemplateSmsOutput) ToTemplateSmsOutputWithContext added in v2.6.2 

func (o TemplateSmsOutput) ToTemplateSmsOutputWithContext(ctx context.Context) TemplateSmsOutput

func (TemplateSmsOutput) ToTemplateSmsPtrOutput added in v2.10.1 

func (o TemplateSmsOutput) ToTemplateSmsPtrOutput() TemplateSmsPtrOutput

func (TemplateSmsOutput) ToTemplateSmsPtrOutputWithContext added in v2.10.1 

func (o TemplateSmsOutput) ToTemplateSmsPtrOutputWithContext(ctx context.Context) TemplateSmsPtrOutput

type TemplateSmsPtrInput added in v2.10.1 

type TemplateSmsPtrInput interface {
	pulumi.Input

	ToTemplateSmsPtrOutput() TemplateSmsPtrOutput
	ToTemplateSmsPtrOutputWithContext(ctx context.Context) TemplateSmsPtrOutput
}

type TemplateSmsPtrOutput added in v2.10.1 

type TemplateSmsPtrOutput struct {
	*pulumi.OutputState
}

func (TemplateSmsPtrOutput) ElementType added in v2.10.1 

func (TemplateSmsPtrOutput) ElementType() reflect.Type

func (TemplateSmsPtrOutput) ToTemplateSmsPtrOutput added in v2.10.1 

func (o TemplateSmsPtrOutput) ToTemplateSmsPtrOutput() TemplateSmsPtrOutput

func (TemplateSmsPtrOutput) ToTemplateSmsPtrOutputWithContext added in v2.10.1 

func (o TemplateSmsPtrOutput) ToTemplateSmsPtrOutputWithContext(ctx context.Context) TemplateSmsPtrOutput

type TemplateSmsState added in v2.4.0 

type TemplateSmsState struct {
	// The SMS message.
	Template pulumi.StringPtrInput
	// Set of translations for a particular template.
	Translations TemplateSmsTranslationArrayInput
	// SMS template type
	Type pulumi.StringPtrInput
}

func (TemplateSmsState) ElementType added in v2.4.0 

func (TemplateSmsState) ElementType() reflect.Type

type TemplateSmsTranslation added in v2.4.0 

type TemplateSmsTranslation struct {
	// The language to map the template to.
	Language string `pulumi:"language"`
	// The SMS message.
	Template string `pulumi:"template"`
}

type TemplateSmsTranslationArgs added in v2.4.0 

type TemplateSmsTranslationArgs struct {
	// The language to map the template to.
	Language pulumi.StringInput `pulumi:"language"`
	// The SMS message.
	Template pulumi.StringInput `pulumi:"template"`
}

func (TemplateSmsTranslationArgs) ElementType added in v2.4.0 

func (TemplateSmsTranslationArgs) ElementType() reflect.Type

func (TemplateSmsTranslationArgs) ToTemplateSmsTranslationOutput added in v2.4.0 

func (i TemplateSmsTranslationArgs) ToTemplateSmsTranslationOutput() TemplateSmsTranslationOutput

func (TemplateSmsTranslationArgs) ToTemplateSmsTranslationOutputWithContext added in v2.4.0 

func (i TemplateSmsTranslationArgs) ToTemplateSmsTranslationOutputWithContext(ctx context.Context) TemplateSmsTranslationOutput

type TemplateSmsTranslationArray added in v2.4.0 

type TemplateSmsTranslationArray []TemplateSmsTranslationInput

func (TemplateSmsTranslationArray) ElementType added in v2.4.0 

func (TemplateSmsTranslationArray) ElementType() reflect.Type

func (TemplateSmsTranslationArray) ToTemplateSmsTranslationArrayOutput added in v2.4.0 

func (i TemplateSmsTranslationArray) ToTemplateSmsTranslationArrayOutput() TemplateSmsTranslationArrayOutput

func (TemplateSmsTranslationArray) ToTemplateSmsTranslationArrayOutputWithContext added in v2.4.0 

func (i TemplateSmsTranslationArray) ToTemplateSmsTranslationArrayOutputWithContext(ctx context.Context) TemplateSmsTranslationArrayOutput

type TemplateSmsTranslationArrayInput added in v2.4.0 

type TemplateSmsTranslationArrayInput interface {
	pulumi.Input

	ToTemplateSmsTranslationArrayOutput() TemplateSmsTranslationArrayOutput
	ToTemplateSmsTranslationArrayOutputWithContext(context.Context) TemplateSmsTranslationArrayOutput
}

TemplateSmsTranslationArrayInput is an input type that accepts TemplateSmsTranslationArray and TemplateSmsTranslationArrayOutput values. You can construct a concrete instance of `TemplateSmsTranslationArrayInput` via: 

TemplateSmsTranslationArray{ TemplateSmsTranslationArgs{...} }

type TemplateSmsTranslationArrayOutput added in v2.4.0 

type TemplateSmsTranslationArrayOutput struct{ *pulumi.OutputState }

func (TemplateSmsTranslationArrayOutput) ElementType added in v2.4.0 

func (TemplateSmsTranslationArrayOutput) ElementType() reflect.Type

func (TemplateSmsTranslationArrayOutput) Index added in v2.4.0 

func (o TemplateSmsTranslationArrayOutput) Index(i pulumi.IntInput) TemplateSmsTranslationOutput

func (TemplateSmsTranslationArrayOutput) ToTemplateSmsTranslationArrayOutput added in v2.4.0 

func (o TemplateSmsTranslationArrayOutput) ToTemplateSmsTranslationArrayOutput() TemplateSmsTranslationArrayOutput

func (TemplateSmsTranslationArrayOutput) ToTemplateSmsTranslationArrayOutputWithContext added in v2.4.0 

func (o TemplateSmsTranslationArrayOutput) ToTemplateSmsTranslationArrayOutputWithContext(ctx context.Context) TemplateSmsTranslationArrayOutput

type TemplateSmsTranslationInput added in v2.4.0 

type TemplateSmsTranslationInput interface {
	pulumi.Input

	ToTemplateSmsTranslationOutput() TemplateSmsTranslationOutput
	ToTemplateSmsTranslationOutputWithContext(context.Context) TemplateSmsTranslationOutput
}

TemplateSmsTranslationInput is an input type that accepts TemplateSmsTranslationArgs and TemplateSmsTranslationOutput values. You can construct a concrete instance of `TemplateSmsTranslationInput` via: 

TemplateSmsTranslationArgs{...}

type TemplateSmsTranslationOutput added in v2.4.0 

type TemplateSmsTranslationOutput struct{ *pulumi.OutputState }

func (TemplateSmsTranslationOutput) ElementType added in v2.4.0 

func (TemplateSmsTranslationOutput) ElementType() reflect.Type

func (TemplateSmsTranslationOutput) Language added in v2.4.0 

func (o TemplateSmsTranslationOutput) Language() pulumi.StringOutput

The language to map the template to.

func (TemplateSmsTranslationOutput) Template added in v2.4.0 

func (o TemplateSmsTranslationOutput) Template() pulumi.StringOutput

The SMS message.

func (TemplateSmsTranslationOutput) ToTemplateSmsTranslationOutput added in v2.4.0 

func (o TemplateSmsTranslationOutput) ToTemplateSmsTranslationOutput() TemplateSmsTranslationOutput

func (TemplateSmsTranslationOutput) ToTemplateSmsTranslationOutputWithContext added in v2.4.0 

func (o TemplateSmsTranslationOutput) ToTemplateSmsTranslationOutputWithContext(ctx context.Context) TemplateSmsTranslationOutput

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.