Package com.oracle.bmc.identitydomains.model

Class UserPasswordResetter

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.identitydomains.model.UserPasswordResetter

@Generated(value="OracleSDKGenerator",
           comments="API Version: v1")
public final class UserPasswordResetter
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The schema used to handle a user password reset by an administrator.
Note: Objects should always be created or deserialized using the UserPasswordResetter.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 UserPasswordResetter.Builder, which maintain a set of all explicitly set fields called UserPasswordResetter.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UserPasswordResetter.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor

Description

UserPasswordResetter(String id, String ocid, List<String> schemas, Meta meta, IdcsCreatedBy idcsCreatedBy, IdcsLastModifiedBy idcsLastModifiedBy, List<IdcsPreventedOperations> idcsPreventedOperations, List<Tags> tags, Boolean deleteInProgress, String idcsLastUpgradedInRelease, String domainOcid, String compartmentOcid, String tenancyOcid, String externalId, Boolean bypassNotification, Boolean userFlowControlledByExternalClient, UserPasswordResetterUserToken userToken, String notificationEmailTemplateId, String oneTimePassword, ExtensionSelfChangeUser urnIetfParamsScimSchemasOracleIdcsExtensionSelfChangeUser)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static UserPasswordResetter.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Boolean	getBypassNotification()	Indicates whether to send an email notification after resetting the user’s password.
String	getCompartmentOcid()	OCI Compartment Id (ocid) in which the resource lives.
Boolean	getDeleteInProgress()	A boolean flag indicating this resource in the process of being deleted.
String	getDomainOcid()	OCI Domain Id (ocid) in which the resource lives.
String	getExternalId()	An identifier for the Resource as defined by the Service Consumer.
String	getId()	Unique identifier for the SCIM Resource as defined by the Service Provider.
IdcsCreatedBy	getIdcsCreatedBy()
IdcsLastModifiedBy	getIdcsLastModifiedBy()
String	getIdcsLastUpgradedInRelease()	The release number when the resource was upgraded.
List<IdcsPreventedOperations>	getIdcsPreventedOperations()	Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
Meta	getMeta()
String	getNotificationEmailTemplateId()	Specifies the EmailTemplate to be used when sending notifications to the user.
String	getOcid()	Unique OCI identifier for the SCIM Resource.
String	getOneTimePassword()	A one time password will be returned when the user doesn’t have a primary email address.
List<String>	getSchemas()	REQUIRED.
List<Tags>	getTags()	A list of tags on this resource.
String	getTenancyOcid()	OCI Tenant Id (ocid) in which the resource lives.
ExtensionSelfChangeUser	getUrnIetfParamsScimSchemasOracleIdcsExtensionSelfChangeUser()
Boolean	getUserFlowControlledByExternalClient()	A Boolean value indicating whether to bypass notification and return user token to be used by an external client to control the user flow.
UserPasswordResetterUserToken	getUserToken()
int	hashCode()
UserPasswordResetter.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

UserPasswordResetter

@Deprecated
@ConstructorProperties({"id","ocid","schemas","meta","idcsCreatedBy","idcsLastModifiedBy","idcsPreventedOperations","tags","deleteInProgress","idcsLastUpgradedInRelease","domainOcid","compartmentOcid","tenancyOcid","externalId","bypassNotification","userFlowControlledByExternalClient","userToken","notificationEmailTemplateId","oneTimePassword","urnIetfParamsScimSchemasOracleIdcsExtensionSelfChangeUser"})
public UserPasswordResetter(String id,
                            String ocid,
                            List<String> schemas,
                            Meta meta,
                            IdcsCreatedBy idcsCreatedBy,
                            IdcsLastModifiedBy idcsLastModifiedBy,
                            List<IdcsPreventedOperations> idcsPreventedOperations,
                            List<Tags> tags,
                            Boolean deleteInProgress,
                            String idcsLastUpgradedInRelease,
                            String domainOcid,
                            String compartmentOcid,
                            String tenancyOcid,
                            String externalId,
                            Boolean bypassNotification,
                            Boolean userFlowControlledByExternalClient,
                            UserPasswordResetterUserToken userToken,
                            String notificationEmailTemplateId,
                            String oneTimePassword,
                            ExtensionSelfChangeUser urnIetfParamsScimSchemasOracleIdcsExtensionSelfChangeUser)

Deprecated.

Method Detail

builder

public static UserPasswordResetter.Builder builder()

Create a new builder.

toBuilder

public UserPasswordResetter.Builder toBuilder()

getId

public String getId()

Unique identifier for the SCIM Resource as defined by the Service Provider.

Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider’s entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: always - type: string - uniqueness: global

Returns:

the value

getOcid

public String getOcid()

Unique OCI identifier for the SCIM Resource.

*SCIM++ Properties:** - caseExact: true - idcsSearchable: true - multiValued: false - mutability: immutable - required: false - returned: default - type: string - uniqueness: global

Returns:

the value

getSchemas

public List<String> getSchemas()

REQUIRED.

The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \“enterprise\” extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: true - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

Returns:

the value

getMeta

public Meta getMeta()

getIdcsCreatedBy

public IdcsCreatedBy getIdcsCreatedBy()

getIdcsLastModifiedBy

public IdcsLastModifiedBy getIdcsLastModifiedBy()

getIdcsPreventedOperations

public List<IdcsPreventedOperations> getIdcsPreventedOperations()

Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

*SCIM++ Properties:** - idcsSearchable: false - multiValued: true - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

Returns:

the value

getTags

public List<Tags> getTags()

A list of tags on this resource.

*SCIM++ Properties:** - idcsCompositeKey: [key, value] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: request - type: complex - uniqueness: none

Returns:

the value

getDeleteInProgress

public Boolean getDeleteInProgress()

A boolean flag indicating this resource in the process of being deleted.

Usually set to true when synchronous deletion of the resource would take too long.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none

Returns:

the value

getIdcsLastUpgradedInRelease

public String getIdcsLastUpgradedInRelease()

The release number when the resource was upgraded.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

Returns:

the value

getDomainOcid

public String getDomainOcid()

OCI Domain Id (ocid) in which the resource lives.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

the value

getCompartmentOcid

public String getCompartmentOcid()

OCI Compartment Id (ocid) in which the resource lives.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

the value

getTenancyOcid

public String getTenancyOcid()

OCI Tenant Id (ocid) in which the resource lives.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

the value

getExternalId

public String getExternalId()

An identifier for the Resource as defined by the Service Consumer.

The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer’s tenant.

*SCIM++ Properties:** - type: string - multiValued: false - required: false - mutability: readWrite - returned: default - uniqueness: none

Returns:

the value

getBypassNotification

public Boolean getBypassNotification()

Indicates whether to send an email notification after resetting the user’s password.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: immutable - required: false - returned: never - type: boolean - uniqueness: none

Returns:

the value

getUserFlowControlledByExternalClient

public Boolean getUserFlowControlledByExternalClient()

A Boolean value indicating whether to bypass notification and return user token to be used by an external client to control the user flow.

*SCIM++ Properties:** - type: boolean - caseExact: false - idcsSearchable: false - multiValued: false - mutability: immutable - required: false - returned: never - uniqueness: none

Returns:

the value

getUserToken

public UserPasswordResetterUserToken getUserToken()

getNotificationEmailTemplateId

public String getNotificationEmailTemplateId()

Specifies the EmailTemplate to be used when sending notifications to the user.

If specified, it overrides the default EmailTemplate.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: writeOnly - required: false - returned: never - type: string - uniqueness: none

Returns:

the value

getOneTimePassword

public String getOneTimePassword()

A one time password will be returned when the user doesn’t have a primary email address.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

Returns:

the value

getUrnIetfParamsScimSchemasOracleIdcsExtensionSelfChangeUser

public ExtensionSelfChangeUser getUrnIetfParamsScimSchemasOracleIdcsExtensionSelfChangeUser()

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