Package com.oracle.bmc.identity.model

Class User

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class User
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    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](https://docs.oracle.com/iaas/Content/Identity/Concepts/federation.htm).

    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](https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).

    *Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
    Note: Objects should always be created or deserialized using the User.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the User.Builder, which maintain a set of all explicitly set fields called User.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • builder

        public static User.Builder builder()
        Create a new builder.

      • getId

        public String getId()
        The OCID of the user.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the tenancy containing the user.
        Returns:
        the value

      • getName

        public String getName()
        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 value

      • getDescription

        public String getDescription()
        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 value

      • getEmail

        public String getEmail()
        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 value

      • getEmailVerified

        public Boolean getEmailVerified()
        Whether the email address has been validated.
        Returns:
        the value

      • getDbUserName

        public String getDbUserName()
        DB username of the DB credential.

        Has to be unique across the tenancy.

        Returns:
        the value

      • getIdentityProviderId

        public String getIdentityProviderId()
        The OCID of the IdentityProvider this user belongs to.
        Returns:
        the value

      • getExternalIdentifier

        public String getExternalIdentifier()
        Identifier of the user in the identity provider
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        Date and time the user was created, in the format defined by RFC3339.

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

        Returns:
        the value

      • getLifecycleState

        public User.LifecycleState getLifecycleState()
        The user’s current state.

        After creating a user, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

        Returns:
        the value

      • getInactiveStatus

        public Long getInactiveStatus()
        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 value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        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 value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        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 value

      • getIsMfaActivated

        public Boolean getIsMfaActivated()
        Flag indicates if MFA has been activated for the user.
        Returns:
        the value

      • getLastSuccessfulLoginTime

        public Date getLastSuccessfulLoginTime()
        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 value

      • getPreviousSuccessfulLoginTime

        public Date getPreviousSuccessfulLoginTime()
        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 value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel