@Generated(value="OracleSDKGenerator",
comments="API Version: v1")
public final class SelfRegistrationProfile
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Self Registration Profile
Note: Objects should always be created or deserialized using the SelfRegistrationProfile.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 SelfRegistrationProfile.Builder, which maintain a
set of all explicitly set fields called SelfRegistrationProfile.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).
| Modifier and Type | Class and Description |
|---|---|
static class |
SelfRegistrationProfile.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
SelfRegistrationProfile(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,
String name,
Boolean activationEmailRequired,
Integer numberOfDaysRedirectUrlIsValid,
Boolean active,
Boolean showOnLoginPage,
List<String> allowedEmailDomains,
List<String> disallowedEmailDomains,
String headerLogo,
String footerLogo,
String redirectUrl,
Boolean consentTextPresent,
List<SelfRegistrationProfileDisplayName> displayName,
List<SelfRegistrationProfileAfterSubmitText> afterSubmitText,
List<SelfRegistrationProfileUserAttributes> userAttributes,
SelfRegistrationProfileEmailTemplate emailTemplate,
List<SelfRegistrationProfileDefaultGroups> defaultGroups,
List<SelfRegistrationProfileHeaderText> headerText,
List<SelfRegistrationProfileFooterText> footerText,
List<SelfRegistrationProfileConsentText> consentText)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static SelfRegistrationProfile.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Boolean |
getActivationEmailRequired()
SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false -
mutability: readWrite - required: true - returned: default - type: boolean - uniqueness: none
A Boolean value that indicates whether Account verification email is required to be sent
before login or not
|
Boolean |
getActive()
A Boolean value that indicates whether the profile is enabled or not
|
List<SelfRegistrationProfileAfterSubmitText> |
getAfterSubmitText()
Text to be displayed on UI after doing self registration
|
List<String> |
getAllowedEmailDomains()
A Multivalue String value for Email domains which are valid for this profile
|
String |
getCompartmentOcid()
OCI Compartment Id (ocid) in which the resource lives.
|
List<SelfRegistrationProfileConsentText> |
getConsentText()
Consent text
|
Boolean |
getConsentTextPresent()
A boolean value that indicates whether the consent text is present.
|
List<SelfRegistrationProfileDefaultGroups> |
getDefaultGroups()
Default groups assigned to the user
|
Boolean |
getDeleteInProgress()
A boolean flag indicating this resource in the process of being deleted.
|
List<String> |
getDisallowedEmailDomains()
A Multivalue String Value for Email domains to be handled as exceptions
|
List<SelfRegistrationProfileDisplayName> |
getDisplayName()
Registration page name
|
String |
getDomainOcid()
OCI Domain Id (ocid) in which the resource lives.
|
SelfRegistrationProfileEmailTemplate |
getEmailTemplate() |
String |
getExternalId()
An identifier for the Resource as defined by the Service Consumer.
|
String |
getFooterLogo()
References to footer logo
|
List<SelfRegistrationProfileFooterText> |
getFooterText()
Footer text
|
String |
getHeaderLogo()
Reference to header logo
|
List<SelfRegistrationProfileHeaderText> |
getHeaderText()
Header text
|
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 |
getName()
Name of the profile
|
Integer |
getNumberOfDaysRedirectUrlIsValid()
Number of days redirect URL is valid
|
String |
getOcid()
Unique OCI identifier for the SCIM Resource.
|
String |
getRedirectUrl()
This URL will be replaced in email notification sent to user.
|
List<String> |
getSchemas()
REQUIRED.
|
Boolean |
getShowOnLoginPage()
A Boolean value that indicates whether the profile should be displayed on login page
|
List<Tags> |
getTags()
A list of tags on this resource.
|
String |
getTenancyOcid()
OCI Tenant Id (ocid) in which the resource lives.
|
List<SelfRegistrationProfileUserAttributes> |
getUserAttributes()
SCIM++ Properties: - idcsCompositeKey: [value] - idcsSearchable: true - multiValued: true
|
int |
hashCode() |
SelfRegistrationProfile.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","ocid","schemas","meta","idcsCreatedBy","idcsLastModifiedBy","idcsPreventedOperations","tags","deleteInProgress","idcsLastUpgradedInRelease","domainOcid","compartmentOcid","tenancyOcid","externalId","name","activationEmailRequired","numberOfDaysRedirectUrlIsValid","active","showOnLoginPage","allowedEmailDomains","disallowedEmailDomains","headerLogo","footerLogo","redirectUrl","consentTextPresent","displayName","afterSubmitText","userAttributes","emailTemplate","defaultGroups","headerText","footerText","consentText"}) public SelfRegistrationProfile(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, String name, Boolean activationEmailRequired, Integer numberOfDaysRedirectUrlIsValid, Boolean active, Boolean showOnLoginPage, List<String> allowedEmailDomains, List<String> disallowedEmailDomains, String headerLogo, String footerLogo, String redirectUrl, Boolean consentTextPresent, List<SelfRegistrationProfileDisplayName> displayName, List<SelfRegistrationProfileAfterSubmitText> afterSubmitText, List<SelfRegistrationProfileUserAttributes> userAttributes, SelfRegistrationProfileEmailTemplate emailTemplate, List<SelfRegistrationProfileDefaultGroups> defaultGroups, List<SelfRegistrationProfileHeaderText> headerText, List<SelfRegistrationProfileFooterText> footerText, List<SelfRegistrationProfileConsentText> consentText)
public static SelfRegistrationProfile.Builder builder()
Create a new builder.
public SelfRegistrationProfile.Builder toBuilder()
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
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
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
public Meta getMeta()
public IdcsCreatedBy getIdcsCreatedBy()
public IdcsLastModifiedBy getIdcsLastModifiedBy()
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
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
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
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
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
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
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
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:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
public String getName()
Name of the profile
*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: true - returned: always - type: string - uniqueness: global
public Boolean getActivationEmailRequired()
SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: true - returned: default - type: boolean - uniqueness: none A Boolean value that indicates whether Account verification email is required to be sent before login or not
public Integer getNumberOfDaysRedirectUrlIsValid()
Number of days redirect URL is valid
*SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readWrite - required: true - returned: default - type: integer - uniqueness: none
public Boolean getActive()
A Boolean value that indicates whether the profile is enabled or not
*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none
public Boolean getShowOnLoginPage()
A Boolean value that indicates whether the profile should be displayed on login page
*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: true - returned: default - type: boolean - uniqueness: none
public List<String> getAllowedEmailDomains()
A Multivalue String value for Email domains which are valid for this profile
*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
public List<String> getDisallowedEmailDomains()
A Multivalue String Value for Email domains to be handled as exceptions
*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
public String getHeaderLogo()
Reference to header logo
*SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: reference
public String getFooterLogo()
References to footer logo
*SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: reference
public String getRedirectUrl()
This URL will be replaced in email notification sent to user. When activation email required is set to true, user is created in \“pending verification\” state, upon clicking this link user will be able to activate himself. When activation email required is set to false, user is created in \“verified\” state, this link will be used to verify user’s email.
*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none
public Boolean getConsentTextPresent()
A boolean value that indicates whether the consent text is present.
*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: true - returned: default - type: boolean - uniqueness: none
public List<SelfRegistrationProfileDisplayName> getDisplayName()
Registration page name
*SCIM++ Properties:** - idcsCompositeKey: [locale] - idcsMultiLanguage: true - idcsSearchable: true - multiValued: true - mutability: readWrite - required: true - returned: default - type: complex - uniqueness: none
public List<SelfRegistrationProfileAfterSubmitText> getAfterSubmitText()
Text to be displayed on UI after doing self registration
*SCIM++ Properties:** - idcsCompositeKey: [locale] - idcsMultiLanguage: true - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none
public List<SelfRegistrationProfileUserAttributes> getUserAttributes()
SCIM++ Properties: - idcsCompositeKey: [value] - idcsSearchable: true - multiValued: true
public SelfRegistrationProfileEmailTemplate getEmailTemplate()
public List<SelfRegistrationProfileDefaultGroups> getDefaultGroups()
Default groups assigned to the user
*SCIM++ Properties:** - idcsCompositeKey: [value] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: request - type: complex
public List<SelfRegistrationProfileHeaderText> getHeaderText()
Header text
*SCIM++ Properties:** - idcsCompositeKey: [locale] - idcsMultiLanguage: true - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none
public List<SelfRegistrationProfileFooterText> getFooterText()
Footer text
*SCIM++ Properties:** - idcsCompositeKey: [locale] - idcsMultiLanguage: true - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none
public List<SelfRegistrationProfileConsentText> getConsentText()
Consent text
*SCIM++ Properties:** - idcsCompositeKey: [locale] - idcsMultiLanguage: true - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.