Okta v4.15.0 published on Friday, Mar 7, 2025 by Pulumi
okta.user.getUserType
Explore with Pulumi AI
Get a user type from Okta.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";
const example = okta.user.getUserType({
    name: "example",
});
import pulumi
import pulumi_okta as okta
example = okta.user.get_user_type(name="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.LookupUserType(ctx, &user.LookupUserTypeArgs{
			Name: pulumi.StringRef("example"),
		}, nil)
		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 = Okta.User.GetUserType.Invoke(new()
    {
        Name = "example",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.user.UserFunctions;
import com.pulumi.okta.user.inputs.GetUserTypeArgs;
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) {
        final var example = UserFunctions.getUserType(GetUserTypeArgs.builder()
            .name("example")
            .build());
    }
}
variables:
  example:
    fn::invoke:
      function: okta:user:getUserType
      arguments:
        name: example
Using getUserType
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getUserType(args: GetUserTypeArgs, opts?: InvokeOptions): Promise<GetUserTypeResult>
function getUserTypeOutput(args: GetUserTypeOutputArgs, opts?: InvokeOptions): Output<GetUserTypeResult>def get_user_type(id: Optional[str] = None,
                  name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetUserTypeResult
def get_user_type_output(id: Optional[pulumi.Input[str]] = None,
                  name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetUserTypeResult]func LookupUserType(ctx *Context, args *LookupUserTypeArgs, opts ...InvokeOption) (*LookupUserTypeResult, error)
func LookupUserTypeOutput(ctx *Context, args *LookupUserTypeOutputArgs, opts ...InvokeOption) LookupUserTypeResultOutput> Note: This function is named LookupUserType in the Go SDK.
public static class GetUserType 
{
    public static Task<GetUserTypeResult> InvokeAsync(GetUserTypeArgs args, InvokeOptions? opts = null)
    public static Output<GetUserTypeResult> Invoke(GetUserTypeInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetUserTypeResult> getUserType(GetUserTypeArgs args, InvokeOptions options)
public static Output<GetUserTypeResult> getUserType(GetUserTypeArgs args, InvokeOptions options)
fn::invoke:
  function: okta:user/getUserType:getUserType
  arguments:
    # arguments dictionaryThe following arguments are supported:
getUserType Result
The following output properties are available:
- Description string
- Description of user type.
- DisplayName string
- Display name of user type.
- Id string
- ID of the user type to retrieve, conflicts with name.
- Name string
- Name of user type to retrieve, conflicts with id.
- Description string
- Description of user type.
- DisplayName string
- Display name of user type.
- Id string
- ID of the user type to retrieve, conflicts with name.
- Name string
- Name of user type to retrieve, conflicts with id.
- description String
- Description of user type.
- displayName String
- Display name of user type.
- id String
- ID of the user type to retrieve, conflicts with name.
- name String
- Name of user type to retrieve, conflicts with id.
- description string
- Description of user type.
- displayName string
- Display name of user type.
- id string
- ID of the user type to retrieve, conflicts with name.
- name string
- Name of user type to retrieve, conflicts with id.
- description str
- Description of user type.
- display_name str
- Display name of user type.
- id str
- ID of the user type to retrieve, conflicts with name.
- name str
- Name of user type to retrieve, conflicts with id.
- description String
- Description of user type.
- displayName String
- Display name of user type.
- id String
- ID of the user type to retrieve, conflicts with name.
- name String
- Name of user type to retrieve, conflicts with id.
Package Details
- Repository
- Okta pulumi/pulumi-okta
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the oktaTerraform Provider.