User¶

class oci.identity.models.User(**kwargs)¶

Bases: object

An individual employee or system that needs to manage or use your company’s Oracle Cloud Infrastructure resources. Users might need to launch instances, manage remote disks, work with your cloud network, etc. Users have one or more IAM Service credentials (ApiKey, UIPassword, SwiftPassword and AuthToken). For more information, see User Credentials). End users of your application are not typically IAM Service users, but for tenancies that have identity domains, they might be. For conceptual information about users and other IAM Service components, see Overview of IAM.

These users are created directly within the Oracle Cloud Infrastructure system, via the IAM service. They are different from federated users, who authenticate themselves to the Oracle Cloud Infrastructure Console via an identity provider. For more information, see Identity Providers and Federation.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Get Started with Policies.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a User.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a User.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a User.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a User.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a User.
`capabilities`	Gets the capabilities of this User.
`compartment_id`	[Required] Gets the compartment_id of this User.
`db_user_name`	Gets the db_user_name of this User.
`defined_tags`	Gets the defined_tags of this User.
`description`	[Required] Gets the description of this User.
`email`	Gets the email of this User.
`email_verified`	Gets the email_verified of this User.
`external_identifier`	Gets the external_identifier of this User.
`freeform_tags`	Gets the freeform_tags of this User.
`id`	[Required] Gets the id of this User.
`identity_provider_id`	Gets the identity_provider_id of this User.
`inactive_status`	Gets the inactive_status of this User.
`is_mfa_activated`	[Required] Gets the is_mfa_activated of this User.
`last_successful_login_time`	Gets the last_successful_login_time of this User.
`lifecycle_state`	[Required] Gets the lifecycle_state of this User.
`name`	[Required] Gets the name of this User.
`previous_successful_login_time`	Gets the previous_successful_login_time of this User.
`time_created`	[Required] Gets the time_created of this User.

Methods

__init__(**kwargs) Initializes a new User object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a User. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a User. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a User. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a User. This constant has a value of “DELETING”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a User. This constant has a value of “INACTIVE”

__init__(**kwargs)¶

Initializes a new User object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this User.
compartment_id (str) – The value to assign to the compartment_id property of this User.
name (str) – The value to assign to the name property of this User.
description (str) – The value to assign to the description property of this User.
email (str) – The value to assign to the email property of this User.
email_verified (bool) – The value to assign to the email_verified property of this User.
db_user_name (str) – The value to assign to the db_user_name property of this User.
identity_provider_id (str) – The value to assign to the identity_provider_id property of this User.
external_identifier (str) – The value to assign to the external_identifier property of this User.
time_created (datetime) – The value to assign to the time_created property of this User.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this User. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
inactive_status (int) – The value to assign to the inactive_status property of this User.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this User.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this User.
capabilities (oci.identity.models.UserCapabilities) – The value to assign to the capabilities property of this User.
is_mfa_activated (bool) – The value to assign to the is_mfa_activated property of this User.
last_successful_login_time (datetime) – The value to assign to the last_successful_login_time property of this User.
previous_successful_login_time (datetime) – The value to assign to the previous_successful_login_time property of this User.

capabilities¶

Gets the capabilities of this User.

Returns:	The capabilities of this User.
Return type:	oci.identity.models.UserCapabilities

compartment_id¶

[Required] Gets the compartment_id of this User. The OCID of the tenancy containing the user.

Returns:	The compartment_id of this User.
Return type:	str

db_user_name¶

Gets the db_user_name of this User. DB username of the DB credential. Has to be unique across the tenancy.

Returns:	The db_user_name of this User.
Return type:	str

defined_tags¶

Gets the defined_tags of this User. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this User.
Return type:	dict(str, dict(str, object))

description¶

[Required] Gets the description of this User. The description you assign to the user. Does not have to be unique, and it’s changeable.

(For tenancies that support identity domains) You can have an empty description.

Returns:	The description of this User.
Return type:	str

email¶

Gets the email of this User. The email address you assign to the user. The email address must be unique across all users in the tenancy.

(For tenancies that support identity domains) The email address is required unless the requirement is disabled at the tenancy level.

Returns:	The email of this User.
Return type:	str

email_verified¶

Gets the email_verified of this User. Whether the email address has been validated.

Returns:	The email_verified of this User.
Return type:	bool

external_identifier¶

Gets the external_identifier of this User. Identifier of the user in the identity provider

Returns:	The external_identifier of this User.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this User. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this User.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this User. The OCID of the user.

Returns:	The id of this User.
Return type:	str

identity_provider_id¶

Gets the identity_provider_id of this User. The OCID of the IdentityProvider this user belongs to.

Returns:	The identity_provider_id of this User.
Return type:	str

inactive_status¶

Gets the inactive_status of this User. Returned only if the user’s lifecycleState is INACTIVE. A 16-bit value showing the reason why the user is inactive:

bit 0: SUSPENDED (reserved for future use)
bit 1: DISABLED (reserved for future use)
bit 2: BLOCKED (the user has exceeded the maximum number of failed login attempts for the Console)

Returns:	The inactive_status of this User.
Return type:	int

is_mfa_activated¶

[Required] Gets the is_mfa_activated of this User. Flag indicates if MFA has been activated for the user.

Returns:	The is_mfa_activated of this User.
Return type:	bool

last_successful_login_time¶

Gets the last_successful_login_time of this User. The date and time of when the user most recently logged in the format defined by RFC3339 (ex. 2016-08-25T21:10:29.600Z). If there is no login history, this field is null.

For illustrative purposes, suppose we have a user who has logged in at July 1st, 2020 at 1200 PST and logged out 30 minutes later. They then login again on July 2nd, 2020 at 1500 PST.

Their previousSuccessfulLoginTime would be 2020-07-01:19:00.000Z.

Their lastSuccessfulLoginTime would be 2020-07-02:22:00.000Z.

Returns:	The last_successful_login_time of this User.
Return type:	datetime

lifecycle_state¶

[Required] Gets the lifecycle_state of this User. The user’s current state. After creating a user, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this User.
Return type:	str

name¶

[Required] Gets the name of this User. The name you assign to the user during creation. This is the user’s login for the Console. The name must be unique across all users in the tenancy and cannot be changed.

Returns:	The name of this User.
Return type:	str

previous_successful_login_time¶

Gets the previous_successful_login_time of this User. The date and time of when the user most recently logged in the format defined by RFC3339 (ex. 2016-08-25T21:10:29.600Z). If there is no login history, this field is null.

For illustrative purposes, suppose we have a user who has logged in at July 1st, 2020 at 1200 PST and logged out 30 minutes later. They then login again on July 2nd, 2020 at 1500 PST.

Their previousSuccessfulLoginTime would be 2020-07-01:19:00.000Z.

Their lastSuccessfulLoginTime would be 2020-07-02:22:00.000Z.

Returns:	The previous_successful_login_time of this User.
Return type:	datetime

time_created¶

[Required] Gets the time_created of this User. Date and time the user was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_created of this User.
Return type:	datetime