User#

class User(username=None, user_type=None, idp_id=None, display_name=None, first_name=None, middle_initial=None, last_name=None, email_id=None, locale=None, region=None, password=None, force_reset_password=None, additional_attributes=None, status=None, last_login_time=None, created_time=None, last_updated_time=None, created_by=None, ext_id=None, links=None, tenant_id=None, *args, **kwargs)[source]#

Bases: ExternalizableAbstractModel

Information of the user

Parameters:

  • username (required) – (username) Identifier for the user in the form an email address

  • user_type (required) – (user_type)

  • idp_id – (idp_id) Identifier of the IDP for the user

  • display_name – (display_name) Display name for the user

  • first_name – (first_name) First name for the user

  • middle_initial – (middle_initial) Middle name for the user

  • last_name – (last_name) Last name for the user

  • email_id – (email_id) Email Id for the user

  • locale – (locale) Default locale for the user

  • region – (region) Default region for the user

  • password – (password) Password for the user

  • force_reset_password – (force_reset_password) Flag to force the user to reset password

  • additional_attributes – (additional_attributes) Any additional attribute for the user

  • status – (status)

  • last_login_time – (last_login_time) Last successful logged in time for the user

  • created_time – (created_time) Creation time of the user

  • last_updated_time – (last_updated_time) Last updated time of the user

  • created_by – (created_by) User or service who created the user

property additional_attributes#

Any additional attribute for the user

Type:

list[ KVPair ]

property created_by#

User or service who created the user

Type:

str

property created_time#

Creation time of the user

Type:

datetime

property display_name#

Display name for the user

Type:

str

property email_id#

Email Id for the user

Type:

str

property first_name#

First name for the user

Type:

str

property force_reset_password#

Flag to force the user to reset password

Type:

bool

property idp_id#

Identifier of the IDP for the user

Type:

str

property last_login_time#

Last successful logged in time for the user

Type:

datetime

property last_name#

Last name for the user

Type:

str

property last_updated_time#

Last updated time of the user

Type:

datetime

property locale#

Default locale for the user

Type:

str

property middle_initial#

Middle name for the user

Type:

str

property password#

Password for the user

Type:

str

property region#

Default region for the user

Type:

str

property status#
Type:

UserStatusType

to_dict()[source]#

Returns the model properties as a dictionary

to_str()[source]#

Returns the string representation of the model

property user_type#
Type:

UserType

property username#

Identifier for the user in the form an email address

Type:

str