@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. For conceptual information about users and other IAM Service components, see Overview of the IAM Service.
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 Getting Started with Policies.
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,
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)
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()
Properties indicating how the user is allowed to authenticate.
|
String |
getCompartmentId()
The OCID of the tenancy containing the user.
|
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.
|
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.
|
User.LifecycleState |
getLifecycleState()
The user’s current state.
|
String |
getName()
The name you assign to the user during creation.
|
Date |
getTimeCreated()
Date and time the user was created, in the format defined by RFC3339.
|
int |
hashCode() |
String |
toString() |
@ConstructorProperties(value={"id","compartmentId","name","description","email","identityProviderId","externalIdentifier","timeCreated","lifecycleState","inactiveStatus","freeformTags","definedTags","capabilities","isMfaActivated"}) @Deprecated public User(String id, String compartmentId, String name, String description, String email, 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)
public static User.Builder builder()
Create a new builder.
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.
public String getEmail()
The email address you assign to the user. The email address must be unique across all users in 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()
Properties indicating how the user is allowed to authenticate.
public Boolean getIsMfaActivated()
Flag indicates if MFA has been activated for the user.
Copyright © 2016–2019. All rights reserved.