profile

package
v4.14.0 Latest Latest
Warning

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

 Go to latest Published: Feb 12, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Mapping 

type Mapping struct {
	pulumi.CustomResourceState

	// Whether apply the changes to all users with this profile after updating or creating the these mappings.
	// > **WARNING:**: 'always*apply' is incompatible with OAuth 2.0 authentication and will be ignored when using that type of authentication.
	// **WARNING:** 'always*apply' makes use of an internal/private Okta API endpoint that could change without notice rendering this resource inoperable.
	AlwaysApply pulumi.BoolPtrOutput `pulumi:"alwaysApply"`
	// When turned on this flag will trigger the provider to delete mapping properties that are not defined in config. By default, we do not delete missing properties.
	DeleteWhenAbsent pulumi.BoolPtrOutput      `pulumi:"deleteWhenAbsent"`
	Mappings         MappingMappingArrayOutput `pulumi:"mappings"`
	// The source id of the mapping to manage.
	SourceId pulumi.StringOutput `pulumi:"sourceId"`
	// Name of the mapping source.
	SourceName pulumi.StringOutput `pulumi:"sourceName"`
	// ID of the mapping source.
	SourceType pulumi.StringOutput `pulumi:"sourceType"`
	// The target id of the mapping to manage.
	TargetId pulumi.StringOutput `pulumi:"targetId"`
	// Name of the mapping target.
	TargetName pulumi.StringOutput `pulumi:"targetName"`
	// ID of the mapping target.
	TargetType pulumi.StringOutput `pulumi:"targetType"`
}

Manages a profile mapping. This resource allows you to manage a profile mapping by source and target IDs. > **NOTE:** If using this resource with OAuth2 scopes, this resource requires `okta.profileMappings.manage` scope.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/profile"
"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/user"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		user, err := user.GetUserProfileMappingSource(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		_, err = profile.NewMapping(ctx, "example", &profile.MappingArgs{
			SourceId:         pulumi.String("<source id>"),
			TargetId:         pulumi.String(user.Id),
			DeleteWhenAbsent: pulumi.Bool(true),
			Mappings: profile.MappingMappingArray{
				&profile.MappingMappingArgs{
					Id:         pulumi.String("firstName"),
					Expression: pulumi.String("appuser.firstName"),
				},
				&profile.MappingMappingArgs{
					Id:         pulumi.String("lastName"),
					Expression: pulumi.String("appuser.lastName"),
				},
				&profile.MappingMappingArgs{
					Id:         pulumi.String("email"),
					Expression: pulumi.String("appuser.email"),
				},
				&profile.MappingMappingArgs{
					Id:         pulumi.String("login"),
					Expression: pulumi.String("appuser.email"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetMapping 

func GetMapping(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *MappingState, opts ...pulumi.ResourceOption) (*Mapping, error)

GetMapping gets an existing Mapping 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 NewMapping 

func NewMapping(ctx *pulumi.Context,
	name string, args *MappingArgs, opts ...pulumi.ResourceOption) (*Mapping, error)

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

func (*Mapping) ElementType 

func (*Mapping) ElementType() reflect.Type

func (*Mapping) ToMappingOutput 

func (i *Mapping) ToMappingOutput() MappingOutput

func (*Mapping) ToMappingOutputWithContext 

func (i *Mapping) ToMappingOutputWithContext(ctx context.Context) MappingOutput

type MappingArgs 

type MappingArgs struct {
	// Whether apply the changes to all users with this profile after updating or creating the these mappings.
	// > **WARNING:**: 'always*apply' is incompatible with OAuth 2.0 authentication and will be ignored when using that type of authentication.
	// **WARNING:** 'always*apply' makes use of an internal/private Okta API endpoint that could change without notice rendering this resource inoperable.
	AlwaysApply pulumi.BoolPtrInput
	// When turned on this flag will trigger the provider to delete mapping properties that are not defined in config. By default, we do not delete missing properties.
	DeleteWhenAbsent pulumi.BoolPtrInput
	Mappings         MappingMappingArrayInput
	// The source id of the mapping to manage.
	SourceId pulumi.StringInput
	// The target id of the mapping to manage.
	TargetId pulumi.StringInput
}

The set of arguments for constructing a Mapping resource.

func (MappingArgs) ElementType 

func (MappingArgs) ElementType() reflect.Type

type MappingArray 

type MappingArray []MappingInput

func (MappingArray) ElementType 

func (MappingArray) ElementType() reflect.Type

func (MappingArray) ToMappingArrayOutput 

func (i MappingArray) ToMappingArrayOutput() MappingArrayOutput

func (MappingArray) ToMappingArrayOutputWithContext 

func (i MappingArray) ToMappingArrayOutputWithContext(ctx context.Context) MappingArrayOutput

type MappingArrayInput 

type MappingArrayInput interface {
	pulumi.Input

	ToMappingArrayOutput() MappingArrayOutput
	ToMappingArrayOutputWithContext(context.Context) MappingArrayOutput
}

MappingArrayInput is an input type that accepts MappingArray and MappingArrayOutput values. You can construct a concrete instance of `MappingArrayInput` via: 

MappingArray{ MappingArgs{...} }

type MappingArrayOutput 

type MappingArrayOutput struct{ *pulumi.OutputState }

func (MappingArrayOutput) ElementType 

func (MappingArrayOutput) ElementType() reflect.Type

func (MappingArrayOutput) Index 

func (o MappingArrayOutput) Index(i pulumi.IntInput) MappingOutput

func (MappingArrayOutput) ToMappingArrayOutput 

func (o MappingArrayOutput) ToMappingArrayOutput() MappingArrayOutput

func (MappingArrayOutput) ToMappingArrayOutputWithContext 

func (o MappingArrayOutput) ToMappingArrayOutputWithContext(ctx context.Context) MappingArrayOutput

type MappingInput 

type MappingInput interface {
	pulumi.Input

	ToMappingOutput() MappingOutput
	ToMappingOutputWithContext(ctx context.Context) MappingOutput
}

type MappingMap 

type MappingMap map[string]MappingInput

func (MappingMap) ElementType 

func (MappingMap) ElementType() reflect.Type

func (MappingMap) ToMappingMapOutput 

func (i MappingMap) ToMappingMapOutput() MappingMapOutput

func (MappingMap) ToMappingMapOutputWithContext 

func (i MappingMap) ToMappingMapOutputWithContext(ctx context.Context) MappingMapOutput

type MappingMapInput 

type MappingMapInput interface {
	pulumi.Input

	ToMappingMapOutput() MappingMapOutput
	ToMappingMapOutputWithContext(context.Context) MappingMapOutput
}

MappingMapInput is an input type that accepts MappingMap and MappingMapOutput values. You can construct a concrete instance of `MappingMapInput` via: 

MappingMap{ "key": MappingArgs{...} }

type MappingMapOutput 

type MappingMapOutput struct{ *pulumi.OutputState }

func (MappingMapOutput) ElementType 

func (MappingMapOutput) ElementType() reflect.Type

func (MappingMapOutput) MapIndex 

func (o MappingMapOutput) MapIndex(k pulumi.StringInput) MappingOutput

func (MappingMapOutput) ToMappingMapOutput 

func (o MappingMapOutput) ToMappingMapOutput() MappingMapOutput

func (MappingMapOutput) ToMappingMapOutputWithContext 

func (o MappingMapOutput) ToMappingMapOutputWithContext(ctx context.Context) MappingMapOutput

type MappingMapping 

type MappingMapping struct {
	Expression string `pulumi:"expression"`
	// The mapping property key.
	Id         string  `pulumi:"id"`
	PushStatus *string `pulumi:"pushStatus"`
}

type MappingMappingArgs 

type MappingMappingArgs struct {
	Expression pulumi.StringInput `pulumi:"expression"`
	// The mapping property key.
	Id         pulumi.StringInput    `pulumi:"id"`
	PushStatus pulumi.StringPtrInput `pulumi:"pushStatus"`
}

func (MappingMappingArgs) ElementType 

func (MappingMappingArgs) ElementType() reflect.Type

func (MappingMappingArgs) ToMappingMappingOutput 

func (i MappingMappingArgs) ToMappingMappingOutput() MappingMappingOutput

func (MappingMappingArgs) ToMappingMappingOutputWithContext 

func (i MappingMappingArgs) ToMappingMappingOutputWithContext(ctx context.Context) MappingMappingOutput

type MappingMappingArray 

type MappingMappingArray []MappingMappingInput

func (MappingMappingArray) ElementType 

func (MappingMappingArray) ElementType() reflect.Type

func (MappingMappingArray) ToMappingMappingArrayOutput 

func (i MappingMappingArray) ToMappingMappingArrayOutput() MappingMappingArrayOutput

func (MappingMappingArray) ToMappingMappingArrayOutputWithContext 

func (i MappingMappingArray) ToMappingMappingArrayOutputWithContext(ctx context.Context) MappingMappingArrayOutput

type MappingMappingArrayInput 

type MappingMappingArrayInput interface {
	pulumi.Input

	ToMappingMappingArrayOutput() MappingMappingArrayOutput
	ToMappingMappingArrayOutputWithContext(context.Context) MappingMappingArrayOutput
}

MappingMappingArrayInput is an input type that accepts MappingMappingArray and MappingMappingArrayOutput values. You can construct a concrete instance of `MappingMappingArrayInput` via: 

MappingMappingArray{ MappingMappingArgs{...} }

type MappingMappingArrayOutput 

type MappingMappingArrayOutput struct{ *pulumi.OutputState }

func (MappingMappingArrayOutput) ElementType 

func (MappingMappingArrayOutput) ElementType() reflect.Type

func (MappingMappingArrayOutput) Index 

func (o MappingMappingArrayOutput) Index(i pulumi.IntInput) MappingMappingOutput

func (MappingMappingArrayOutput) ToMappingMappingArrayOutput 

func (o MappingMappingArrayOutput) ToMappingMappingArrayOutput() MappingMappingArrayOutput

func (MappingMappingArrayOutput) ToMappingMappingArrayOutputWithContext 

func (o MappingMappingArrayOutput) ToMappingMappingArrayOutputWithContext(ctx context.Context) MappingMappingArrayOutput

type MappingMappingInput 

type MappingMappingInput interface {
	pulumi.Input

	ToMappingMappingOutput() MappingMappingOutput
	ToMappingMappingOutputWithContext(context.Context) MappingMappingOutput
}

MappingMappingInput is an input type that accepts MappingMappingArgs and MappingMappingOutput values. You can construct a concrete instance of `MappingMappingInput` via: 

MappingMappingArgs{...}

type MappingMappingOutput 

type MappingMappingOutput struct{ *pulumi.OutputState }

func (MappingMappingOutput) ElementType 

func (MappingMappingOutput) ElementType() reflect.Type

func (MappingMappingOutput) Expression 

func (o MappingMappingOutput) Expression() pulumi.StringOutput

func (MappingMappingOutput) Id 

func (o MappingMappingOutput) Id() pulumi.StringOutput

The mapping property key.

func (MappingMappingOutput) PushStatus 

func (o MappingMappingOutput) PushStatus() pulumi.StringPtrOutput

func (MappingMappingOutput) ToMappingMappingOutput 

func (o MappingMappingOutput) ToMappingMappingOutput() MappingMappingOutput

func (MappingMappingOutput) ToMappingMappingOutputWithContext 

func (o MappingMappingOutput) ToMappingMappingOutputWithContext(ctx context.Context) MappingMappingOutput

type MappingOutput 

type MappingOutput struct{ *pulumi.OutputState }

func (MappingOutput) AlwaysApply 

func (o MappingOutput) AlwaysApply() pulumi.BoolPtrOutput

Whether apply the changes to all users with this profile after updating or creating the these mappings. > **WARNING:**: 'always*apply' is incompatible with OAuth 2.0 authentication and will be ignored when using that type of authentication. **WARNING:** 'always*apply' makes use of an internal/private Okta API endpoint that could change without notice rendering this resource inoperable.

func (MappingOutput) DeleteWhenAbsent 

func (o MappingOutput) DeleteWhenAbsent() pulumi.BoolPtrOutput

When turned on this flag will trigger the provider to delete mapping properties that are not defined in config. By default, we do not delete missing properties.

func (MappingOutput) ElementType 

func (MappingOutput) ElementType() reflect.Type

func (MappingOutput) Mappings 

func (o MappingOutput) Mappings() MappingMappingArrayOutput

func (MappingOutput) SourceId 

func (o MappingOutput) SourceId() pulumi.StringOutput

The source id of the mapping to manage.

func (MappingOutput) SourceName 

func (o MappingOutput) SourceName() pulumi.StringOutput

Name of the mapping source.

func (MappingOutput) SourceType 

func (o MappingOutput) SourceType() pulumi.StringOutput

ID of the mapping source.

func (MappingOutput) TargetId 

func (o MappingOutput) TargetId() pulumi.StringOutput

The target id of the mapping to manage.

func (MappingOutput) TargetName 

func (o MappingOutput) TargetName() pulumi.StringOutput

Name of the mapping target.

func (MappingOutput) TargetType 

func (o MappingOutput) TargetType() pulumi.StringOutput

ID of the mapping target.

func (MappingOutput) ToMappingOutput 

func (o MappingOutput) ToMappingOutput() MappingOutput

func (MappingOutput) ToMappingOutputWithContext 

func (o MappingOutput) ToMappingOutputWithContext(ctx context.Context) MappingOutput

type MappingState 

type MappingState struct {
	// Whether apply the changes to all users with this profile after updating or creating the these mappings.
	// > **WARNING:**: 'always*apply' is incompatible with OAuth 2.0 authentication and will be ignored when using that type of authentication.
	// **WARNING:** 'always*apply' makes use of an internal/private Okta API endpoint that could change without notice rendering this resource inoperable.
	AlwaysApply pulumi.BoolPtrInput
	// When turned on this flag will trigger the provider to delete mapping properties that are not defined in config. By default, we do not delete missing properties.
	DeleteWhenAbsent pulumi.BoolPtrInput
	Mappings         MappingMappingArrayInput
	// The source id of the mapping to manage.
	SourceId pulumi.StringPtrInput
	// Name of the mapping source.
	SourceName pulumi.StringPtrInput
	// ID of the mapping source.
	SourceType pulumi.StringPtrInput
	// The target id of the mapping to manage.
	TargetId pulumi.StringPtrInput
	// Name of the mapping target.
	TargetName pulumi.StringPtrInput
	// ID of the mapping target.
	TargetType pulumi.StringPtrInput
}

func (MappingState) ElementType 

func (MappingState) ElementType() reflect.Type

Source Files

View all Source files

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.