SelfRegistrationProfile¶
- class oci.identity_domains.models.SelfRegistrationProfile(**kwargs)¶
Bases:
objectSelf Registration Profile
Attributes:
A constant which can be used with the idcs_prevented_operations property of a SelfRegistrationProfile.
A constant which can be used with the idcs_prevented_operations property of a SelfRegistrationProfile.
A constant which can be used with the idcs_prevented_operations property of a SelfRegistrationProfile.
[Required] Gets the activation_email_required of this SelfRegistrationProfile.
Gets the active of this SelfRegistrationProfile.
Gets the after_submit_text of this SelfRegistrationProfile.
Gets the allowed_email_domains of this SelfRegistrationProfile.
Gets the compartment_ocid of this SelfRegistrationProfile.
Gets the consent_text of this SelfRegistrationProfile.
[Required] Gets the consent_text_present of this SelfRegistrationProfile.
Gets the default_groups of this SelfRegistrationProfile.
Gets the delete_in_progress of this SelfRegistrationProfile.
Gets the disallowed_email_domains of this SelfRegistrationProfile.
[Required] Gets the display_name of this SelfRegistrationProfile.
Gets the domain_ocid of this SelfRegistrationProfile.
[Required] Gets the email_template of this SelfRegistrationProfile.
Gets the external_id of this SelfRegistrationProfile.
Gets the footer_logo of this SelfRegistrationProfile.
Gets the footer_text of this SelfRegistrationProfile.
Gets the header_logo of this SelfRegistrationProfile.
Gets the header_text of this SelfRegistrationProfile.
Gets the id of this SelfRegistrationProfile.
Gets the idcs_created_by of this SelfRegistrationProfile.
Gets the idcs_last_modified_by of this SelfRegistrationProfile.
Gets the idcs_last_upgraded_in_release of this SelfRegistrationProfile.
Gets the idcs_prevented_operations of this SelfRegistrationProfile.
Gets the meta of this SelfRegistrationProfile.
[Required] Gets the name of this SelfRegistrationProfile.
[Required] Gets the number_of_days_redirect_url_is_valid of this SelfRegistrationProfile.
Gets the ocid of this SelfRegistrationProfile.
[Required] Gets the redirect_url of this SelfRegistrationProfile.
[Required] Gets the schemas of this SelfRegistrationProfile.
[Required] Gets the show_on_login_page of this SelfRegistrationProfile.
Gets the tags of this SelfRegistrationProfile.
Gets the tenancy_ocid of this SelfRegistrationProfile.
Gets the user_attributes of this SelfRegistrationProfile.
Methods:
__init__(**kwargs)Initializes a new SelfRegistrationProfile object with values from keyword arguments.
- IDCS_PREVENTED_OPERATIONS_DELETE = 'delete'¶
A constant which can be used with the idcs_prevented_operations property of a SelfRegistrationProfile. This constant has a value of “delete”
- IDCS_PREVENTED_OPERATIONS_REPLACE = 'replace'¶
A constant which can be used with the idcs_prevented_operations property of a SelfRegistrationProfile. This constant has a value of “replace”
- IDCS_PREVENTED_OPERATIONS_UPDATE = 'update'¶
A constant which can be used with the idcs_prevented_operations property of a SelfRegistrationProfile. This constant has a value of “update”
- __init__(**kwargs)¶
Initializes a new SelfRegistrationProfile object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
id (str) – The value to assign to the id property of this SelfRegistrationProfile.
ocid (str) – The value to assign to the ocid property of this SelfRegistrationProfile.
schemas (list[str]) – The value to assign to the schemas property of this SelfRegistrationProfile.
meta (oci.identity_domains.models.Meta) – The value to assign to the meta property of this SelfRegistrationProfile.
idcs_created_by (oci.identity_domains.models.IdcsCreatedBy) – The value to assign to the idcs_created_by property of this SelfRegistrationProfile.
idcs_last_modified_by (oci.identity_domains.models.IdcsLastModifiedBy) – The value to assign to the idcs_last_modified_by property of this SelfRegistrationProfile.
idcs_prevented_operations (list[str]) – The value to assign to the idcs_prevented_operations property of this SelfRegistrationProfile. Allowed values for items in this list are: “replace”, “update”, “delete”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
tags (list[oci.identity_domains.models.Tags]) – The value to assign to the tags property of this SelfRegistrationProfile.
delete_in_progress (bool) – The value to assign to the delete_in_progress property of this SelfRegistrationProfile.
idcs_last_upgraded_in_release (str) – The value to assign to the idcs_last_upgraded_in_release property of this SelfRegistrationProfile.
domain_ocid (str) – The value to assign to the domain_ocid property of this SelfRegistrationProfile.
compartment_ocid (str) – The value to assign to the compartment_ocid property of this SelfRegistrationProfile.
tenancy_ocid (str) – The value to assign to the tenancy_ocid property of this SelfRegistrationProfile.
external_id (str) – The value to assign to the external_id property of this SelfRegistrationProfile.
name (str) – The value to assign to the name property of this SelfRegistrationProfile.
activation_email_required (bool) – The value to assign to the activation_email_required property of this SelfRegistrationProfile.
number_of_days_redirect_url_is_valid (int) – The value to assign to the number_of_days_redirect_url_is_valid property of this SelfRegistrationProfile.
active (bool) – The value to assign to the active property of this SelfRegistrationProfile.
show_on_login_page (bool) – The value to assign to the show_on_login_page property of this SelfRegistrationProfile.
allowed_email_domains (list[str]) – The value to assign to the allowed_email_domains property of this SelfRegistrationProfile.
disallowed_email_domains (list[str]) – The value to assign to the disallowed_email_domains property of this SelfRegistrationProfile.
header_logo (str) – The value to assign to the header_logo property of this SelfRegistrationProfile.
footer_logo (str) – The value to assign to the footer_logo property of this SelfRegistrationProfile.
redirect_url (str) – The value to assign to the redirect_url property of this SelfRegistrationProfile.
consent_text_present (bool) – The value to assign to the consent_text_present property of this SelfRegistrationProfile.
display_name (list[oci.identity_domains.models.SelfRegistrationProfileDisplayName]) – The value to assign to the display_name property of this SelfRegistrationProfile.
after_submit_text (list[oci.identity_domains.models.SelfRegistrationProfileAfterSubmitText]) – The value to assign to the after_submit_text property of this SelfRegistrationProfile.
user_attributes (list[oci.identity_domains.models.SelfRegistrationProfileUserAttributes]) – The value to assign to the user_attributes property of this SelfRegistrationProfile.
email_template (oci.identity_domains.models.SelfRegistrationProfileEmailTemplate) – The value to assign to the email_template property of this SelfRegistrationProfile.
default_groups (list[oci.identity_domains.models.SelfRegistrationProfileDefaultGroups]) – The value to assign to the default_groups property of this SelfRegistrationProfile.
header_text (list[oci.identity_domains.models.SelfRegistrationProfileHeaderText]) – The value to assign to the header_text property of this SelfRegistrationProfile.
footer_text (list[oci.identity_domains.models.SelfRegistrationProfileFooterText]) – The value to assign to the footer_text property of this SelfRegistrationProfile.
consent_text (list[oci.identity_domains.models.SelfRegistrationProfileConsentText]) – The value to assign to the consent_text property of this SelfRegistrationProfile.
- property activation_email_required¶
[Required] Gets the activation_email_required of this SelfRegistrationProfile. 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
- Returns
The activation_email_required of this SelfRegistrationProfile.
- Return type
bool
- property active¶
Gets the active of this SelfRegistrationProfile. 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
- Returns
The active of this SelfRegistrationProfile.
- Return type
bool
- property after_submit_text¶
Gets the after_submit_text of this SelfRegistrationProfile. 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
- Returns
The after_submit_text of this SelfRegistrationProfile.
- Return type
list[oci.identity_domains.models.SelfRegistrationProfileAfterSubmitText]
- property allowed_email_domains¶
Gets the allowed_email_domains of this SelfRegistrationProfile. 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
- Returns
The allowed_email_domains of this SelfRegistrationProfile.
- Return type
list[str]
- property compartment_ocid¶
Gets the compartment_ocid of this SelfRegistrationProfile. 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 compartment_ocid of this SelfRegistrationProfile.
- Return type
str
- property consent_text¶
Gets the consent_text of this SelfRegistrationProfile. Consent text
- SCIM++ Properties:
idcsCompositeKey: [locale]
idcsMultiLanguage: true
idcsSearchable: true
multiValued: true
mutability: readWrite
required: false
returned: default
type: complex
uniqueness: none
- Returns
The consent_text of this SelfRegistrationProfile.
- Return type
list[oci.identity_domains.models.SelfRegistrationProfileConsentText]
- property consent_text_present¶
[Required] Gets the consent_text_present of this SelfRegistrationProfile. 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
- Returns
The consent_text_present of this SelfRegistrationProfile.
- Return type
bool
- property default_groups¶
Gets the default_groups of this SelfRegistrationProfile. Default groups assigned to the user
- SCIM++ Properties:
idcsCompositeKey: [value]
idcsSearchable: true
multiValued: true
mutability: readWrite
required: false
returned: request
type: complex
- Returns
The default_groups of this SelfRegistrationProfile.
- Return type
list[oci.identity_domains.models.SelfRegistrationProfileDefaultGroups]
- property delete_in_progress¶
Gets the delete_in_progress of this SelfRegistrationProfile. 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 delete_in_progress of this SelfRegistrationProfile.
- Return type
bool
- property disallowed_email_domains¶
Gets the disallowed_email_domains of this SelfRegistrationProfile. 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
- Returns
The disallowed_email_domains of this SelfRegistrationProfile.
- Return type
list[str]
- property display_name¶
[Required] Gets the display_name of this SelfRegistrationProfile. Registration page name
- SCIM++ Properties:
idcsCompositeKey: [locale]
idcsMultiLanguage: true
idcsSearchable: true
multiValued: true
mutability: readWrite
required: true
returned: default
type: complex
uniqueness: none
- Returns
The display_name of this SelfRegistrationProfile.
- Return type
list[oci.identity_domains.models.SelfRegistrationProfileDisplayName]
- property domain_ocid¶
Gets the domain_ocid of this SelfRegistrationProfile. 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 domain_ocid of this SelfRegistrationProfile.
- Return type
str
- property email_template¶
[Required] Gets the email_template of this SelfRegistrationProfile.
- Returns
The email_template of this SelfRegistrationProfile.
- Return type
oci.identity_domains.models.SelfRegistrationProfileEmailTemplate
- property external_id¶
Gets the external_id of this SelfRegistrationProfile. 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
- Returns
The external_id of this SelfRegistrationProfile.
- Return type
str
Gets the footer_logo of this SelfRegistrationProfile. References to footer logo
- SCIM++ Properties:
idcsSearchable: true
multiValued: false
mutability: readWrite
required: false
returned: default
type: reference
- Returns
The footer_logo of this SelfRegistrationProfile.
- Return type
str
Gets the footer_text of this SelfRegistrationProfile. Footer text
- SCIM++ Properties:
idcsCompositeKey: [locale]
idcsMultiLanguage: true
idcsSearchable: true
multiValued: true
mutability: readWrite
required: false
returned: default
type: complex
uniqueness: none
- Returns
The footer_text of this SelfRegistrationProfile.
- Return type
list[oci.identity_domains.models.SelfRegistrationProfileFooterText]
- property header_logo¶
Gets the header_logo of this SelfRegistrationProfile. Reference to header logo
- SCIM++ Properties:
idcsSearchable: true
multiValued: false
mutability: readWrite
required: false
returned: default
type: reference
- Returns
The header_logo of this SelfRegistrationProfile.
- Return type
str
- property header_text¶
Gets the header_text of this SelfRegistrationProfile. Header text
- SCIM++ Properties:
idcsCompositeKey: [locale]
idcsMultiLanguage: true
idcsSearchable: true
multiValued: true
mutability: readWrite
required: false
returned: default
type: complex
uniqueness: none
- Returns
The header_text of this SelfRegistrationProfile.
- Return type
list[oci.identity_domains.models.SelfRegistrationProfileHeaderText]
- property id¶
Gets the id of this SelfRegistrationProfile. 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 id of this SelfRegistrationProfile.
- Return type
str
- property idcs_created_by¶
Gets the idcs_created_by of this SelfRegistrationProfile.
- Returns
The idcs_created_by of this SelfRegistrationProfile.
- Return type
- property idcs_last_modified_by¶
Gets the idcs_last_modified_by of this SelfRegistrationProfile.
- Returns
The idcs_last_modified_by of this SelfRegistrationProfile.
- Return type
- property idcs_last_upgraded_in_release¶
Gets the idcs_last_upgraded_in_release of this SelfRegistrationProfile. 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 idcs_last_upgraded_in_release of this SelfRegistrationProfile.
- Return type
str
- property idcs_prevented_operations¶
Gets the idcs_prevented_operations of this SelfRegistrationProfile. 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
Allowed values for items in this list are: “replace”, “update”, “delete”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The idcs_prevented_operations of this SelfRegistrationProfile.
- Return type
list[str]
- property meta¶
Gets the meta of this SelfRegistrationProfile.
- Returns
The meta of this SelfRegistrationProfile.
- Return type
- property name¶
[Required] Gets the name of this SelfRegistrationProfile. Name of the profile
- SCIM++ Properties:
caseExact: false
idcsSearchable: true
multiValued: false
mutability: readWrite
required: true
returned: always
type: string
uniqueness: global
- Returns
The name of this SelfRegistrationProfile.
- Return type
str
- property number_of_days_redirect_url_is_valid¶
[Required] Gets the number_of_days_redirect_url_is_valid of this SelfRegistrationProfile. Number of days redirect URL is valid
- SCIM++ Properties:
idcsSearchable: true
multiValued: false
mutability: readWrite
required: true
returned: default
type: integer
uniqueness: none
- Returns
The number_of_days_redirect_url_is_valid of this SelfRegistrationProfile.
- Return type
int
- property ocid¶
Gets the ocid of this SelfRegistrationProfile. 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 ocid of this SelfRegistrationProfile.
- Return type
str
- property redirect_url¶
[Required] Gets the redirect_url of this SelfRegistrationProfile. 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
- Returns
The redirect_url of this SelfRegistrationProfile.
- Return type
str
- property schemas¶
[Required] Gets the schemas of this SelfRegistrationProfile. 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 schemas of this SelfRegistrationProfile.
- Return type
list[str]
- property show_on_login_page¶
[Required] Gets the show_on_login_page of this SelfRegistrationProfile. 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
- Returns
The show_on_login_page of this SelfRegistrationProfile.
- Return type
bool
- property tags¶
Gets the tags of this SelfRegistrationProfile. 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 tags of this SelfRegistrationProfile.
- Return type
- property tenancy_ocid¶
Gets the tenancy_ocid of this SelfRegistrationProfile. 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 tenancy_ocid of this SelfRegistrationProfile.
- Return type
str
- property user_attributes¶
Gets the user_attributes of this SelfRegistrationProfile. SCIM++ Properties: - idcsCompositeKey: [value] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none User Attributes
- Returns
The user_attributes of this SelfRegistrationProfile.
- Return type
list[oci.identity_domains.models.SelfRegistrationProfileUserAttributes]