user

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.user.AwaitableGetUserProfileMappingSourceResult(name=None, type=None, id=None)
class pulumi_okta.user.AwaitableGetUserResult(admin_roles=None, city=None, cost_center=None, country_code=None, custom_profile_attributes=None, department=None, display_name=None, division=None, email=None, employee_number=None, first_name=None, group_memberships=None, honorific_prefix=None, honorific_suffix=None, last_name=None, locale=None, login=None, manager=None, manager_id=None, middle_name=None, mobile_phone=None, nick_name=None, organization=None, postal_address=None, preferred_language=None, primary_phone=None, profile_url=None, searches=None, second_email=None, state=None, status=None, street_address=None, timezone=None, title=None, user_type=None, zip_code=None, id=None)
class pulumi_okta.user.AwaitableGetUsersResult(searches=None, users=None, id=None)
class pulumi_okta.user.BaseSchema(resource_name, opts=None, index=None, master=None, permissions=None, required=None, title=None, type=None, __props__=None, __name__=None, __opts__=None)

Manages a User Base Schema property.

This resource allows you to configure a base user schema property.

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

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

  • index (pulumi.Input[str]) – The property name.

  • master (pulumi.Input[str]) – Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".

  • permissions (pulumi.Input[str]) – Access control permissions for the property. It can be set to "READ_WRITE", "READ_ONLY", "HIDE".

  • required (pulumi.Input[bool]) – Whether the property is required for this application’s users.

  • title (pulumi.Input[str]) – The property display name.

  • type (pulumi.Input[str]) – The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".

index = None

The property name.

master = None

Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".

permissions = None

Access control permissions for the property. It can be set to "READ_WRITE", "READ_ONLY", "HIDE".

required = None

Whether the property is required for this application’s users.

title = None

The property display name.

type = None

The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".

static get(resource_name, id, opts=None, index=None, master=None, permissions=None, required=None, title=None, type=None)

Get an existing BaseSchema 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 (str) – The unique provider ID of the resource to lookup.

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

  • index (pulumi.Input[str]) – The property name.

  • master (pulumi.Input[str]) – Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".

  • permissions (pulumi.Input[str]) – Access control permissions for the property. It can be set to "READ_WRITE", "READ_ONLY", "HIDE".

  • required (pulumi.Input[bool]) – Whether the property is required for this application’s users.

  • title (pulumi.Input[str]) – The property display name.

  • type (pulumi.Input[str]) – The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".

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.user.GetUserProfileMappingSourceResult(name=None, type=None, id=None)

A collection of values returned by getUserProfileMappingSource.

name = None

name of source.

type = None

type of source.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_okta.user.GetUserResult(admin_roles=None, city=None, cost_center=None, country_code=None, custom_profile_attributes=None, department=None, display_name=None, division=None, email=None, employee_number=None, first_name=None, group_memberships=None, honorific_prefix=None, honorific_suffix=None, last_name=None, locale=None, login=None, manager=None, manager_id=None, middle_name=None, mobile_phone=None, nick_name=None, organization=None, postal_address=None, preferred_language=None, primary_phone=None, profile_url=None, searches=None, second_email=None, state=None, status=None, street_address=None, timezone=None, title=None, user_type=None, zip_code=None, id=None)

A collection of values returned by getUser.

admin_roles = None

Administrator roles assigned to user.

city = None

user profile property.

cost_center = None

user profile property.

country_code = None

user profile property.

custom_profile_attributes = None

raw JSON containing all custom profile attributes.

department = None

user profile property.

display_name = None

user profile property.

division = None

user profile property.

email = None

user profile property.

employee_number = None

user profile property.

first_name = None

user profile property.

group_memberships = None

user profile property.

honorific_prefix = None

user profile property.

honorific_suffix = None

user profile property.

last_name = None

user profile property.

locale = None

user profile property.

login = None

user profile property.

manager = None

user profile property.

manager_id = None

user profile property.

middle_name = None

user profile property.

mobile_phone = None

user profile property.

nick_name = None

user profile property.

organization = None

user profile property.

postal_address = None

user profile property.

preferred_language = None

user profile property.

primary_phone = None

user profile property.

profile_url = None

user profile property.

second_email = None

user profile property.

state = None

user profile property.

status = None

user profile property.

street_address = None

user profile property.

timezone = None

user profile property.

title = None

user profile property.

user_type = None

user profile property.

zip_code = None

user profile property.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_okta.user.GetUsersResult(searches=None, users=None, id=None)

A collection of values returned by getUsers.

users = None

collection of users retrieved from Okta with the following properties.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_okta.user.Schema(resource_name, opts=None, array_enums=None, array_one_ofs=None, array_type=None, description=None, enums=None, external_name=None, index=None, master=None, max_length=None, min_length=None, one_ofs=None, permissions=None, required=None, scope=None, title=None, type=None, __props__=None, __name__=None, __opts__=None)

Creates a User Schema property.

This resource allows you to create and configure a custom user schema property.

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

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

  • array_enums (pulumi.Input[list]) – Array of values that an array property’s items can be set to.

  • array_one_ofs (pulumi.Input[list]) – Display name and value an enum array can be set to.

  • array_type (pulumi.Input[str]) – The type of the array elements if type is set to "array".

  • description (pulumi.Input[str]) – The description of the user schema property.

  • enums (pulumi.Input[list]) – Array of values a primitive property can be set to. See array_enum for arrays.

  • external_name (pulumi.Input[str]) – External name of the user schema property.

  • index (pulumi.Input[str]) – The property name.

  • master (pulumi.Input[str]) – Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".

  • max_length (pulumi.Input[float]) – The maximum length of the user property value. Only applies to type "string".

  • min_length (pulumi.Input[float]) – The minimum length of the user property value. Only applies to type "string".

  • one_ofs (pulumi.Input[list]) – Array of maps containing a mapping for display name to enum value.

  • permissions (pulumi.Input[str]) – Access control permissions for the property. It can be set to "READ_WRITE", "READ_ONLY", "HIDE".

  • required (pulumi.Input[bool]) – Whether the property is required for this application’s users.

  • scope (pulumi.Input[str]) – determines whether an app user attribute can be set at the Individual or Group Level.

  • title (pulumi.Input[str]) – display name for the enum value.

  • type (pulumi.Input[str]) – The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".

The array_one_ofs object supports the following:

  • const (pulumi.Input[str]) - value mapping to member of enum.

  • title (pulumi.Input[str]) - display name for the enum value.

The one_ofs object supports the following:

  • const (pulumi.Input[str]) - value mapping to member of enum.

  • title (pulumi.Input[str]) - display name for the enum value.

array_enums = None

Array of values that an array property’s items can be set to.

array_one_ofs = None

Display name and value an enum array can be set to.

  • const (str) - value mapping to member of enum.

  • title (str) - display name for the enum value.

array_type = None

The type of the array elements if type is set to "array".

description = None

The description of the user schema property.

enums = None

Array of values a primitive property can be set to. See array_enum for arrays.

external_name = None

External name of the user schema property.

index = None

The property name.

master = None

Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".

max_length = None

The maximum length of the user property value. Only applies to type "string".

min_length = None

The minimum length of the user property value. Only applies to type "string".

one_ofs = None

Array of maps containing a mapping for display name to enum value.

  • const (str) - value mapping to member of enum.

  • title (str) - display name for the enum value.

permissions = None

Access control permissions for the property. It can be set to "READ_WRITE", "READ_ONLY", "HIDE".

required = None

Whether the property is required for this application’s users.

scope = None

determines whether an app user attribute can be set at the Individual or Group Level.

title = None

display name for the enum value.

type = None

The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".

static get(resource_name, id, opts=None, array_enums=None, array_one_ofs=None, array_type=None, description=None, enums=None, external_name=None, index=None, master=None, max_length=None, min_length=None, one_ofs=None, permissions=None, required=None, scope=None, title=None, type=None)

Get an existing Schema 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 (str) – The unique provider ID of the resource to lookup.

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

  • array_enums (pulumi.Input[list]) – Array of values that an array property’s items can be set to.

  • array_one_ofs (pulumi.Input[list]) – Display name and value an enum array can be set to.

  • array_type (pulumi.Input[str]) – The type of the array elements if type is set to "array".

  • description (pulumi.Input[str]) – The description of the user schema property.

  • enums (pulumi.Input[list]) – Array of values a primitive property can be set to. See array_enum for arrays.

  • external_name (pulumi.Input[str]) – External name of the user schema property.

  • index (pulumi.Input[str]) – The property name.

  • master (pulumi.Input[str]) – Master priority for the user schema property. It can be set to "PROFILE_MASTER" or "OKTA".

  • max_length (pulumi.Input[float]) – The maximum length of the user property value. Only applies to type "string".

  • min_length (pulumi.Input[float]) – The minimum length of the user property value. Only applies to type "string".

  • one_ofs (pulumi.Input[list]) – Array of maps containing a mapping for display name to enum value.

  • permissions (pulumi.Input[str]) – Access control permissions for the property. It can be set to "READ_WRITE", "READ_ONLY", "HIDE".

  • required (pulumi.Input[bool]) – Whether the property is required for this application’s users.

  • scope (pulumi.Input[str]) – determines whether an app user attribute can be set at the Individual or Group Level.

  • title (pulumi.Input[str]) – display name for the enum value.

  • type (pulumi.Input[str]) – The type of the schema property. It can be "string", "boolean", "number", "integer", "array", or "object".

The array_one_ofs object supports the following:

  • const (pulumi.Input[str]) - value mapping to member of enum.

  • title (pulumi.Input[str]) - display name for the enum value.

The one_ofs object supports the following:

  • const (pulumi.Input[str]) - value mapping to member of enum.

  • title (pulumi.Input[str]) - display name for the enum value.

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.user.User(resource_name, opts=None, admin_roles=None, city=None, cost_center=None, country_code=None, custom_profile_attributes=None, department=None, display_name=None, division=None, email=None, employee_number=None, first_name=None, group_memberships=None, honorific_prefix=None, honorific_suffix=None, last_name=None, locale=None, login=None, manager=None, manager_id=None, middle_name=None, mobile_phone=None, nick_name=None, organization=None, password=None, postal_address=None, preferred_language=None, primary_phone=None, profile_url=None, recovery_answer=None, recovery_question=None, second_email=None, state=None, status=None, street_address=None, timezone=None, title=None, user_type=None, zip_code=None, __props__=None, __name__=None, __opts__=None)

Creates an Okta User.

This resource allows you to create and configure an Okta User.

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

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

  • admin_roles (pulumi.Input[list]) – Administrator roles assigned to User.

  • city (pulumi.Input[str]) – User profile property.

  • cost_center (pulumi.Input[str]) – User profile property.

  • country_code (pulumi.Input[str]) – User profile property.

  • custom_profile_attributes (pulumi.Input[str]) – raw JSON containing all custom profile attributes.

  • department (pulumi.Input[str]) – User profile property.

  • display_name (pulumi.Input[str]) – User profile property.

  • division (pulumi.Input[str]) – User profile property.

  • email (pulumi.Input[str]) – User profile property.

  • employee_number (pulumi.Input[str]) – User profile property.

  • first_name (pulumi.Input[str]) – User’s First Name, required by default.

  • group_memberships (pulumi.Input[list]) – User profile property.

  • honorific_prefix (pulumi.Input[str]) – User profile property.

  • honorific_suffix (pulumi.Input[str]) – User profile property.

  • last_name (pulumi.Input[str]) – User’s Last Name, required by default.

  • locale (pulumi.Input[str]) – User profile property.

  • login (pulumi.Input[str]) – User profile property.

  • manager (pulumi.Input[str]) – User profile property.

  • manager_id (pulumi.Input[str]) – User profile property.

  • middle_name (pulumi.Input[str]) – User profile property.

  • mobile_phone (pulumi.Input[str]) – User profile property.

  • nick_name (pulumi.Input[str]) – User profile property.

  • organization (pulumi.Input[str]) – User profile property.

  • password (pulumi.Input[str]) – User password.

  • postal_address (pulumi.Input[str]) – User profile property.

  • preferred_language (pulumi.Input[str]) – User profile property.

  • primary_phone (pulumi.Input[str]) – User profile property.

  • profile_url (pulumi.Input[str]) – User profile property.

  • recovery_answer (pulumi.Input[str]) – User password recovery answer.

  • recovery_question (pulumi.Input[str]) – User password recovery question.

  • second_email (pulumi.Input[str]) – User profile property.

  • state (pulumi.Input[str]) – User profile property.

  • status (pulumi.Input[str]) – User profile property.

  • street_address (pulumi.Input[str]) – User profile property.

  • timezone (pulumi.Input[str]) – User profile property.

  • title (pulumi.Input[str]) – User profile property.

  • user_type (pulumi.Input[str]) – User profile property.

  • zip_code (pulumi.Input[str]) – User profile property.

admin_roles = None

Administrator roles assigned to User.

city = None

User profile property.

cost_center = None

User profile property.

country_code = None

User profile property.

custom_profile_attributes = None

raw JSON containing all custom profile attributes.

department = None

User profile property.

display_name = None

User profile property.

division = None

User profile property.

email = None

User profile property.

employee_number = None

User profile property.

first_name = None

User’s First Name, required by default.

group_memberships = None

User profile property.

honorific_prefix = None

User profile property.

honorific_suffix = None

User profile property.

last_name = None

User’s Last Name, required by default.

locale = None

User profile property.

login = None

User profile property.

manager = None

User profile property.

manager_id = None

User profile property.

middle_name = None

User profile property.

mobile_phone = None

User profile property.

nick_name = None

User profile property.

organization = None

User profile property.

password = None

User password.

postal_address = None

User profile property.

preferred_language = None

User profile property.

primary_phone = None

User profile property.

profile_url = None

User profile property.

recovery_answer = None

User password recovery answer.

recovery_question = None

User password recovery question.

second_email = None

User profile property.

state = None

User profile property.

status = None

User profile property.

street_address = None

User profile property.

timezone = None

User profile property.

title = None

User profile property.

user_type = None

User profile property.

zip_code = None

User profile property.

static get(resource_name, id, opts=None, admin_roles=None, city=None, cost_center=None, country_code=None, custom_profile_attributes=None, department=None, display_name=None, division=None, email=None, employee_number=None, first_name=None, group_memberships=None, honorific_prefix=None, honorific_suffix=None, last_name=None, locale=None, login=None, manager=None, manager_id=None, middle_name=None, mobile_phone=None, nick_name=None, organization=None, password=None, postal_address=None, preferred_language=None, primary_phone=None, profile_url=None, raw_status=None, recovery_answer=None, recovery_question=None, second_email=None, state=None, status=None, street_address=None, timezone=None, title=None, user_type=None, zip_code=None)

Get an existing User 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 (str) – The unique provider ID of the resource to lookup.

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

  • admin_roles (pulumi.Input[list]) – Administrator roles assigned to User.

  • city (pulumi.Input[str]) – User profile property.

  • cost_center (pulumi.Input[str]) – User profile property.

  • country_code (pulumi.Input[str]) – User profile property.

  • custom_profile_attributes (pulumi.Input[str]) – raw JSON containing all custom profile attributes.

  • department (pulumi.Input[str]) – User profile property.

  • display_name (pulumi.Input[str]) – User profile property.

  • division (pulumi.Input[str]) – User profile property.

  • email (pulumi.Input[str]) – User profile property.

  • employee_number (pulumi.Input[str]) – User profile property.

  • first_name (pulumi.Input[str]) – User’s First Name, required by default.

  • group_memberships (pulumi.Input[list]) – User profile property.

  • honorific_prefix (pulumi.Input[str]) – User profile property.

  • honorific_suffix (pulumi.Input[str]) – User profile property.

  • last_name (pulumi.Input[str]) – User’s Last Name, required by default.

  • locale (pulumi.Input[str]) – User profile property.

  • login (pulumi.Input[str]) – User profile property.

  • manager (pulumi.Input[str]) – User profile property.

  • manager_id (pulumi.Input[str]) – User profile property.

  • middle_name (pulumi.Input[str]) – User profile property.

  • mobile_phone (pulumi.Input[str]) – User profile property.

  • nick_name (pulumi.Input[str]) – User profile property.

  • organization (pulumi.Input[str]) – User profile property.

  • password (pulumi.Input[str]) – User password.

  • postal_address (pulumi.Input[str]) – User profile property.

  • preferred_language (pulumi.Input[str]) – User profile property.

  • primary_phone (pulumi.Input[str]) – User profile property.

  • profile_url (pulumi.Input[str]) – User profile property.

  • recovery_answer (pulumi.Input[str]) – User password recovery answer.

  • recovery_question (pulumi.Input[str]) – User password recovery question.

  • second_email (pulumi.Input[str]) – User profile property.

  • state (pulumi.Input[str]) – User profile property.

  • status (pulumi.Input[str]) – User profile property.

  • street_address (pulumi.Input[str]) – User profile property.

  • timezone (pulumi.Input[str]) – User profile property.

  • title (pulumi.Input[str]) – User profile property.

  • user_type (pulumi.Input[str]) – User profile property.

  • zip_code (pulumi.Input[str]) – User profile property.

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

pulumi_okta.user.get_user(searches=None, opts=None)

Use this data source to retrieve a users from Okta.

Parameters

searches (list) – Map of search criteria. It supports the following properties.

The searches object supports the following:

  • comparison (str) - Comparison to use.

  • name (str) - Name of property to search against.

  • value (str) - Value to compare with.

pulumi_okta.user.get_user_profile_mapping_source(opts=None)

Use this data source to retrieve the base user Profile Mapping source or target from Okta.

pulumi_okta.user.get_users(searches=None, users=None, opts=None)

Use this data source to retrieve a list of users from Okta.

Parameters

searches (list) – Map of search criteria to use to find users. It supports the following properties.

The searches object supports the following:

  • comparison (str) - Comparison to use.

  • name (str) - Name of property to search against.

  • value (str) - Value to compare with.

The users object supports the following:

  • admin_roles (list) - Administrator roles assigned to user.

  • city (str) - user profile property.

  • cost_center (str) - user profile property.

  • country_code (str) - user profile property.

  • custom_profile_attributes (str) - raw JSON containing all custom profile attributes.

  • department (str) - user profile property.

  • display_name (str) - user profile property.

  • division (str) - user profile property.

  • email (str) - user profile property.

  • employee_number (str) - user profile property.

  • first_name (str) - user profile property.

  • group_memberships (list) - user profile property.

  • honorific_prefix (str) - user profile property.

  • honorific_suffix (str) - user profile property.

  • last_name (str) - user profile property.

  • locale (str) - user profile property.

  • login (str) - user profile property.

  • manager (str) - user profile property.

  • manager_id (str) - user profile property.

  • middle_name (str) - user profile property.

  • mobile_phone (str) - user profile property.

  • nick_name (str) - user profile property.

  • organization (str) - user profile property.

  • postal_address (str) - user profile property.

  • preferred_language (str) - user profile property.

  • primary_phone (str) - user profile property.

  • profile_url (str) - user profile property.

  • second_email (str) - user profile property.

  • state (str) - user profile property.

  • status (str) - user profile property.

  • street_address (str) - user profile property.

  • timezone (str) - user profile property.

  • title (str) - user profile property.

  • user_type (str) - user profile property.

  • zip_code (str) - user profile property.