Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Okta Provider
  3. API Docs
  4. user
  5. UserType
Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi
pulumi/pulumi-okta

okta.user.UserType

Explore with Pulumi AI

okta logo
Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi
pulumi/pulumi-okta

    Creates a User type. This resource allows you to create and configure a User Type.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";

const example = new okta.user.UserType("example", {
    name: "example",
    displayName: "example",
    description: "example",
});

    import pulumi
import pulumi_okta as okta

example = okta.user.UserType("example",
    name="example",
    display_name="example",
    description="example")

    package main

import (
	"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 {
		_, err := user.NewUserType(ctx, "example", &user.UserTypeArgs{
			Name:        pulumi.String("example"),
			DisplayName: pulumi.String("example"),
			Description: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Okta = Pulumi.Okta;

return await Deployment.RunAsync(() => 
{
    var example = new Okta.User.UserType("example", new()
    {
        Name = "example",
        DisplayName = "example",
        Description = "example",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.user.UserType;
import com.pulumi.okta.user.UserTypeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new UserType("example", UserTypeArgs.builder()
            .name("example")
            .displayName("example")
            .description("example")
            .build());

    }
}

    resources:
  example:
    type: okta:user:UserType
    properties:
      name: example
      displayName: example
      description: example

    Create UserType Resource

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

    Constructor syntax

    new UserType(name: string, args: UserTypeArgs, opts?: CustomResourceOptions);
    @overload
def UserType(resource_name: str,
             args: UserTypeArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def UserType(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             description: Optional[str] = None,
             display_name: Optional[str] = None,
             name: Optional[str] = None)
    func NewUserType(ctx *Context, name string, args UserTypeArgs, opts ...ResourceOption) (*UserType, error)
    public UserType(string name, UserTypeArgs args, CustomResourceOptions? opts = null)
    public UserType(String name, UserTypeArgs args)
public UserType(String name, UserTypeArgs args, CustomResourceOptions options)

    type: okta:user:UserType
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 UserTypeArgs
    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 UserTypeArgs
    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 UserTypeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserTypeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserTypeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var userTypeResource = new Okta.User.UserType("userTypeResource", new()
{
    Description = "string",
    DisplayName = "string",
    Name = "string",
});

    example, err := user.NewUserType(ctx, "userTypeResource", &user.UserTypeArgs{
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	Name:        pulumi.String("string"),
})

    var userTypeResource = new UserType("userTypeResource", UserTypeArgs.builder()
    .description("string")
    .displayName("string")
    .name("string")
    .build());

    user_type_resource = okta.user.UserType("userTypeResource",
    description="string",
    display_name="string",
    name="string")

    const userTypeResource = new okta.user.UserType("userTypeResource", {
    description: "string",
    displayName: "string",
    name: "string",
});

    type: okta:user:UserType
properties:
    description: string
    displayName: string
    name: string

    UserType Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The UserType resource accepts the following input properties:

    Description string
    Description of the User Type.
    DisplayName string
    Display Name of the User Type.
    Name string
    Name of the User Type.
    Description string
    Description of the User Type.
    DisplayName string
    Display Name of the User Type.
    Name string
    Name of the User Type.
    description String
    Description of the User Type.
    displayName String
    Display Name of the User Type.
    name String
    Name of the User Type.
    description string
    Description of the User Type.
    displayName string
    Display Name of the User Type.
    name string
    Name of the User Type.
    description str
    Description of the User Type.
    display_name str
    Display Name of the User Type.
    name str
    Name of the User Type.
    description String
    Description of the User Type.
    displayName String
    Display Name of the User Type.
    name String
    Name of the User Type.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the UserType 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.

    Look up Existing UserType Resource

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

    public static get(name: string, id: Input<ID>, state?: UserTypeState, opts?: CustomResourceOptions): UserType
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        name: Optional[str] = None) -> UserType
    func GetUserType(ctx *Context, name string, id IDInput, state *UserTypeState, opts ...ResourceOption) (*UserType, error)
    public static UserType Get(string name, Input<string> id, UserTypeState? state, CustomResourceOptions? opts = null)
    public static UserType get(String name, Output<String> id, UserTypeState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    Description of the User Type.
    DisplayName string
    Display Name of the User Type.
    Name string
    Name of the User Type.
    Description string
    Description of the User Type.
    DisplayName string
    Display Name of the User Type.
    Name string
    Name of the User Type.
    description String
    Description of the User Type.
    displayName String
    Display Name of the User Type.
    name String
    Name of the User Type.
    description string
    Description of the User Type.
    displayName string
    Display Name of the User Type.
    name string
    Name of the User Type.
    description str
    Description of the User Type.
    display_name str
    Display Name of the User Type.
    name str
    Name of the User Type.
    description String
    Description of the User Type.
    displayName String
    Display Name of the User Type.
    name String
    Name of the User Type.

    Import

    $ pulumi import okta:user/userType:UserType example <user_type_id>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi
    pulumi/pulumi-okta