com.oracle.bmc.identity.model

Class OAuth2ClientCredential

java.lang.Object

com.oracle.bmc.identity.model.OAuth2ClientCredential

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class OAuth2ClientCredential
extends Object

User can define Oauth clients in IAM, then use it to generate a token to grant access to app resources.

Note: Objects should always be created or deserialized using the OAuth2ClientCredential.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 OAuth2ClientCredential.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OAuth2ClientCredential.Builder
static class	OAuth2ClientCredential.LifecycleState The credential’s current state.

Constructor Summary

Constructors

Constructor and Description
OAuth2ClientCredential(List<FullyQualifiedScope> scopes, String password, String userId, Date expiresOn, String id, String compartmentId, String name, String description, OAuth2ClientCredential.LifecycleState lifecycleState, Date timeCreated) Deprecated.

Method Summary

Modifier and Type	Method and Description
static OAuth2ClientCredential.Builder	builder() Create a new builder.
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
String	getCompartmentId() The OCID of the compartment containing the Oauth credential.
String	getDescription() The description of the Oauth credential.
Date	getExpiresOn() Date and time when this credential will expire, in the format defined by RFC3339.
String	getId() The OCID of the Oauth credential.
OAuth2ClientCredential.LifecycleState	getLifecycleState() The credential’s current state.
String	getName() The name of the Oauth credential.
String	getPassword() Returned during create and update with password reset requests.
List<FullyQualifiedScope>	getScopes() Allowed scopes for the given oauth credential.
Date	getTimeCreated() Date and time the OAuth2ClientCredential object was created, in the format defined by RFC3339.
String	getUserId() The OCID of the user the Oauth credential belongs to.
int	hashCode()
OAuth2ClientCredential.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OAuth2ClientCredential

@ConstructorProperties(value={"scopes","password","userId","expiresOn","id","compartmentId","name","description","lifecycleState","timeCreated"})
 @Deprecated
public OAuth2ClientCredential(List<FullyQualifiedScope> scopes,
                                                                                                                                                                                             String password,
                                                                                                                                                                                             String userId,
                                                                                                                                                                                             Date expiresOn,
                                                                                                                                                                                             String id,
                                                                                                                                                                                             String compartmentId,
                                                                                                                                                                                             String name,
                                                                                                                                                                                             String description,
                                                                                                                                                                                             OAuth2ClientCredential.LifecycleState lifecycleState,
                                                                                                                                                                                             Date timeCreated)

Deprecated.

Method Detail

builder

public static OAuth2ClientCredential.Builder builder()

Create a new builder.

toBuilder

public OAuth2ClientCredential.Builder toBuilder()

getScopes

public List<FullyQualifiedScope> getScopes()

Allowed scopes for the given oauth credential.

getPassword

public String getPassword()

Returned during create and update with password reset requests.

getUserId

public String getUserId()

The OCID of the user the Oauth credential belongs to.

getExpiresOn

public Date getExpiresOn()

Date and time when this credential will expire, in the format defined by RFC3339. Null if it never expires.

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

getId

public String getId()

The OCID of the Oauth credential.

getCompartmentId

public String getCompartmentId()

The OCID of the compartment containing the Oauth credential.

getName

public String getName()

The name of the Oauth credential.

getDescription

public String getDescription()

The description of the Oauth credential.

getLifecycleState

public OAuth2ClientCredential.LifecycleState getLifecycleState()

The credential’s current state. After creating a Oauth credential, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

getTimeCreated

public Date getTimeCreated()

Date and time the OAuth2ClientCredential object was created, in the format defined by RFC3339.

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

get__explicitlySet__

public Set<String> get__explicitlySet__()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object