Class SelfRegistrationProfile
Self Registration Profile
Inherited Members
Namespace: Oci.IdentitydomainsService.Models
Assembly: OCI.DotNetSDK.Identitydomains.dll
Syntax
public class SelfRegistrationProfile
Properties
ActivationEmailRequired
Declaration
[Required(ErrorMessage = "ActivationEmailRequired is required.")]
[JsonProperty(PropertyName = "activationEmailRequired")]
public bool? ActivationEmailRequired { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? | SCIM++ Properties:
|
Remarks
Required
Active
Declaration
[JsonProperty(PropertyName = "active")]
public bool? Active { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? | A Boolean value that indicates whether the profile is enabled or not
|
AfterSubmitText
Declaration
[JsonProperty(PropertyName = "afterSubmitText")]
public List<SelfRegistrationProfileAfterSubmitText> AfterSubmitText { get; set; }
Property Value
| Type | Description |
|---|---|
| List<SelfRegistrationProfileAfterSubmitText> | Text to be displayed on UI after doing self registration
|
AllowedEmailDomains
Declaration
[JsonProperty(PropertyName = "allowedEmailDomains")]
public List<string> AllowedEmailDomains { get; set; }
Property Value
| Type | Description |
|---|---|
| List<string> | A Multivalue String value for Email domains which are valid for this profile
|
CompartmentOcid
Declaration
[JsonProperty(PropertyName = "compartmentOcid")]
public string CompartmentOcid { get; set; }
Property Value
| Type | Description |
|---|---|
| string | OCI Compartment Id (ocid) in which the resource lives.
|
ConsentText
Declaration
[JsonProperty(PropertyName = "consentText")]
public List<SelfRegistrationProfileConsentText> ConsentText { get; set; }
Property Value
| Type | Description |
|---|---|
| List<SelfRegistrationProfileConsentText> | Consent text
|
ConsentTextPresent
Declaration
[Required(ErrorMessage = "ConsentTextPresent is required.")]
[JsonProperty(PropertyName = "consentTextPresent")]
public bool? ConsentTextPresent { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? | A boolean value that indicates whether the consent text is present.
|
Remarks
Required
DefaultGroups
Declaration
[JsonProperty(PropertyName = "defaultGroups")]
public List<SelfRegistrationProfileDefaultGroups> DefaultGroups { get; set; }
Property Value
| Type | Description |
|---|---|
| List<SelfRegistrationProfileDefaultGroups> | Default groups assigned to the user
|
DeleteInProgress
Declaration
[JsonProperty(PropertyName = "deleteInProgress")]
public bool? DeleteInProgress { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? | 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.
|
DisallowedEmailDomains
Declaration
[JsonProperty(PropertyName = "disallowedEmailDomains")]
public List<string> DisallowedEmailDomains { get; set; }
Property Value
| Type | Description |
|---|---|
| List<string> | A Multivalue String Value for Email domains to be handled as exceptions
|
DisplayName
Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public List<SelfRegistrationProfileDisplayName> DisplayName { get; set; }
Property Value
| Type | Description |
|---|---|
| List<SelfRegistrationProfileDisplayName> | Registration page name
|
Remarks
Required
DomainOcid
Declaration
[JsonProperty(PropertyName = "domainOcid")]
public string DomainOcid { get; set; }
Property Value
| Type | Description |
|---|---|
| string | OCI Domain Id (ocid) in which the resource lives.
|
EmailTemplate
Declaration
[Required(ErrorMessage = "EmailTemplate is required.")]
[JsonProperty(PropertyName = "emailTemplate")]
public SelfRegistrationProfileEmailTemplate EmailTemplate { get; set; }
Property Value
| Type | Description |
|---|---|
| SelfRegistrationProfileEmailTemplate |
Remarks
Required
ExternalId
Declaration
[JsonProperty(PropertyName = "externalId")]
public string ExternalId { get; set; }
Property Value
| Type | Description |
|---|---|
| string | 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.
|
FooterLogo
Declaration
[JsonProperty(PropertyName = "footerLogo")]
public string FooterLogo { get; set; }
Property Value
| Type | Description |
|---|---|
| string | References to footer logo
|
FooterText
Declaration
[JsonProperty(PropertyName = "footerText")]
public List<SelfRegistrationProfileFooterText> FooterText { get; set; }
Property Value
| Type | Description |
|---|---|
| List<SelfRegistrationProfileFooterText> | Footer text
|
HeaderLogo
Declaration
[JsonProperty(PropertyName = "headerLogo")]
public string HeaderLogo { get; set; }
Property Value
| Type | Description |
|---|---|
| string | Reference to header logo
|
HeaderText
Declaration
[JsonProperty(PropertyName = "headerText")]
public List<SelfRegistrationProfileHeaderText> HeaderText { get; set; }
Property Value
| Type | Description |
|---|---|
| List<SelfRegistrationProfileHeaderText> | Header text
|
Id
Declaration
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
| Type | Description |
|---|---|
| string | 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.
|
IdcsCreatedBy
Declaration
[JsonProperty(PropertyName = "idcsCreatedBy")]
public IdcsCreatedBy IdcsCreatedBy { get; set; }
Property Value
| Type | Description |
|---|---|
| IdcsCreatedBy |
IdcsLastModifiedBy
Declaration
[JsonProperty(PropertyName = "idcsLastModifiedBy")]
public IdcsLastModifiedBy IdcsLastModifiedBy { get; set; }
Property Value
| Type | Description |
|---|---|
| IdcsLastModifiedBy |
IdcsLastUpgradedInRelease
Declaration
[JsonProperty(PropertyName = "idcsLastUpgradedInRelease")]
public string IdcsLastUpgradedInRelease { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The release number when the resource was upgraded.
|
IdcsPreventedOperations
Declaration
[JsonProperty(PropertyName = "idcsPreventedOperations", ItemConverterType = typeof(ResponseEnumConverter))]
public List<IdcsPreventedOperations> IdcsPreventedOperations { get; set; }
Property Value
| Type | Description |
|---|---|
| List<IdcsPreventedOperations> | Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
|
Meta
Declaration
[JsonProperty(PropertyName = "meta")]
public Meta Meta { get; set; }
Property Value
| Type | Description |
|---|---|
| Meta |
Name
Declaration
[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }
Property Value
| Type | Description |
|---|---|
| string | Name of the profile
|
Remarks
Required
NumberOfDaysRedirectUrlIsValid
Declaration
[Required(ErrorMessage = "NumberOfDaysRedirectUrlIsValid is required.")]
[JsonProperty(PropertyName = "numberOfDaysRedirectUrlIsValid")]
public int? NumberOfDaysRedirectUrlIsValid { get; set; }
Property Value
| Type | Description |
|---|---|
| int? | Number of days redirect URL is valid
|
Remarks
Required
Ocid
Declaration
[JsonProperty(PropertyName = "ocid")]
public string Ocid { get; set; }
Property Value
| Type | Description |
|---|---|
| string | Unique OCI identifier for the SCIM Resource.
|
RedirectUrl
Declaration
[Required(ErrorMessage = "RedirectUrl is required.")]
[JsonProperty(PropertyName = "redirectUrl")]
public string RedirectUrl { get; set; }
Property Value
| Type | Description |
|---|---|
| string | 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.
|
Remarks
Required
Schemas
Declaration
[Required(ErrorMessage = "Schemas is required.")]
[JsonProperty(PropertyName = "schemas")]
public List<string> Schemas { get; set; }
Property Value
| Type | Description |
|---|---|
| List<string> | 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.
|
Remarks
Required
ShowOnLoginPage
Declaration
[Required(ErrorMessage = "ShowOnLoginPage is required.")]
[JsonProperty(PropertyName = "showOnLoginPage")]
public bool? ShowOnLoginPage { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? | A Boolean value that indicates whether the profile should be displayed on login page
|
Remarks
Required
Tags
Declaration
[JsonProperty(PropertyName = "tags")]
public List<Tags> Tags { get; set; }
Property Value
| Type | Description |
|---|---|
| List<Tags> | A list of tags on this resource.
|
TenancyOcid
Declaration
[JsonProperty(PropertyName = "tenancyOcid")]
public string TenancyOcid { get; set; }
Property Value
| Type | Description |
|---|---|
| string | OCI Tenant Id (ocid) in which the resource lives.
|
UserAttributes
Declaration
[JsonProperty(PropertyName = "userAttributes")]
public List<SelfRegistrationProfileUserAttributes> UserAttributes { get; set; }
Property Value
| Type | Description |
|---|---|
| List<SelfRegistrationProfileUserAttributes> | SCIM++ Properties:
|