User

class openapi_client.models.user.User(**data)[source]

Bases: BaseModel

user_name: Optional[StrictStr]
email_id: Optional[StrictStr]
user_id: Optional[StrictStr]
user_creation_date: Optional[StrictStr]
last_modified: Optional[StrictStr]
last_modified_by: Optional[StrictStr]
is_active: Optional[StrictStr]
default_role: Optional[StrictStr]
name: Optional[StrictStr]
mfa_status: Optional[StrictStr]
roles_attached: Optional[Dict[str, Any]]
groups: Optional[List[StrictStr]]
email_subscription: Optional[StrictStr]
preferences: Optional[UserPreferences]
tn_c: Optional[Dict[str, Any]]
tn_c_action_pending: Optional[StrictBool]
system_alerts_info: Optional[SystemAlertsInfo]
mail_server: Optional[StrictStr]
mail_server_status: Optional[StrictStr]
iam_role: Optional[StrictStr]
user_devices: Optional[List[UserDevice]]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_str()[source]

Returns the string representation of the model using alias

Return type:

str

to_json()[source]

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)[source]

Create an instance of User from a JSON string

Return type:

Optional[Self]

to_dict()[source]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)[source]

Create an instance of User from a dict

Return type:

Optional[Self]

model_fields: ClassVar[dict[str, FieldInfo]] = {'default_role': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DefaultRole', alias_priority=2), 'email_id': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='EmailId', alias_priority=2), 'email_subscription': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='EmailSubscription', alias_priority=2), 'groups': FieldInfo(annotation=Union[List[Annotated[str, Strict(strict=True)]], NoneType], required=False, alias='Groups', alias_priority=2), 'iam_role': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='IAMRole', alias_priority=2), 'is_active': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='IsActive', alias_priority=2), 'last_modified': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='LastModified', alias_priority=2), 'last_modified_by': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='LastModifiedBy', alias_priority=2), 'mail_server': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='MailServer', alias_priority=2), 'mail_server_status': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='MailServerStatus', alias_priority=2), 'mfa_status': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='MfaStatus', alias_priority=2), 'name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='Name', alias_priority=2), 'preferences': FieldInfo(annotation=Union[UserPreferences, NoneType], required=False, alias='Preferences', alias_priority=2), 'roles_attached': FieldInfo(annotation=Union[Dict[str, Any], NoneType], required=False, alias='RolesAttached', alias_priority=2), 'system_alerts_info': FieldInfo(annotation=Union[SystemAlertsInfo, NoneType], required=False, alias='SystemAlertsInfo', alias_priority=2), 'tn_c': FieldInfo(annotation=Union[Dict[str, Any], NoneType], required=False, alias='TnC', alias_priority=2), 'tn_c_action_pending': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='TnCActionPending', alias_priority=2), 'user_creation_date': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='UserCreationDate', alias_priority=2), 'user_devices': FieldInfo(annotation=Union[List[UserDevice], NoneType], required=False, alias='UserDevices', alias_priority=2), 'user_id': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='UserId', alias_priority=2), 'user_name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='UserName', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

model_post_init(__context)

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:
  • self (BaseModel) – The BaseModel instance.

  • __context (Any) – The context.

Return type:

None