@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public final class User extends 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](https://docs.cloud.oracle.com/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.cloud.oracle.com/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
__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take
__explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
User.Builder |
static class |
User.LifecycleState
The user’s current state.
|
| Constructor and Description |
|---|
User(String id,
String compartmentId,
String name,
String description,
String email,
Boolean emailVerified,
String dbUserName,
String identityProviderId,
String externalIdentifier,
Date timeCreated,
User.LifecycleState lifecycleState,
Long inactiveStatus,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
UserCapabilities capabilities,
Boolean isMfaActivated,
Date lastSuccessfulLoginTime,
Date previousSuccessfulLoginTime)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static User.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
UserCapabilities |
getCapabilities() |
String |
getCompartmentId()
The OCID of the tenancy containing the user.
|
String |
getDbUserName()
DB username of the DB credential.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
The description you assign to the user.
|
String |
getEmail()
The email address you assign to the user.
|
Boolean |
getEmailVerified()
Whether the email address has been validated.
|
String |
getExternalIdentifier()
Identifier of the user in the identity provider
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of the user.
|
String |
getIdentityProviderId()
The OCID of the
IdentityProvider this user belongs to. |
Long |
getInactiveStatus()
Returned only if the user’s
lifecycleState is INACTIVE. |
Boolean |
getIsMfaActivated()
Flag indicates if MFA has been activated for the user.
|
Date |
getLastSuccessfulLoginTime()
The date and time of when the user most recently logged in the
format defined by RFC3339 (ex.
|
User.LifecycleState |
getLifecycleState()
The user’s current state.
|
String |
getName()
The name you assign to the user during creation.
|
Date |
getPreviousSuccessfulLoginTime()
The date and time of when the user most recently logged in the
format defined by RFC3339 (ex.
|
Date |
getTimeCreated()
Date and time the user was created, in the format defined by RFC3339.
|
int |
hashCode() |
User.Builder |
toBuilder() |
String |
toString() |
@ConstructorProperties(value={"id","compartmentId","name","description","email","emailVerified","dbUserName","identityProviderId","externalIdentifier","timeCreated","lifecycleState","inactiveStatus","freeformTags","definedTags","capabilities","isMfaActivated","lastSuccessfulLoginTime","previousSuccessfulLoginTime"}) @Deprecated public User(String id, String compartmentId, String name, String description, String email, Boolean emailVerified, String dbUserName, String identityProviderId, String externalIdentifier, Date timeCreated, User.LifecycleState lifecycleState, Long inactiveStatus, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, UserCapabilities capabilities, Boolean isMfaActivated, Date lastSuccessfulLoginTime, Date previousSuccessfulLoginTime)
public static User.Builder builder()
Create a new builder.
public User.Builder toBuilder()
public String getId()
The OCID of the user.
public String getCompartmentId()
The OCID of the tenancy containing the user.
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.
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.
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.
public Boolean getEmailVerified()
Whether the email address has been validated.
public String getDbUserName()
DB username of the DB credential. Has to be unique across the tenancy.
public String getIdentityProviderId()
The OCID of the IdentityProvider this user belongs to.
public String getExternalIdentifier()
Identifier of the user in the identity provider
public Date getTimeCreated()
Date and time the user was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
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.
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)
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"}
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"}}
public UserCapabilities getCapabilities()
public Boolean getIsMfaActivated()
Flag indicates if MFA has been activated for the user.
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.
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.
Copyright © 2016–2022. All rights reserved.