BrandingSetting

class oci.identity_domains.models.BrandingSetting(**kwargs)

Bases: object

Brand Settings schema

Attributes:

IDCS_PREVENTED_OPERATIONS_DELETE

A constant which can be used with the idcs_prevented_operations property of a BrandingSetting.

IDCS_PREVENTED_OPERATIONS_REPLACE

A constant which can be used with the idcs_prevented_operations property of a BrandingSetting.

IDCS_PREVENTED_OPERATIONS_UPDATE

A constant which can be used with the idcs_prevented_operations property of a BrandingSetting.

company_names

Gets the company_names of this BrandingSetting.

compartment_ocid

Gets the compartment_ocid of this BrandingSetting.

custom_branding

Gets the custom_branding of this BrandingSetting.

custom_css_location

Gets the custom_css_location of this BrandingSetting.

custom_html_location

Gets the custom_html_location of this BrandingSetting.

custom_translation

Gets the custom_translation of this BrandingSetting.

default_company_names

Gets the default_company_names of this BrandingSetting.

default_images

Gets the default_images of this BrandingSetting.

default_login_texts

Gets the default_login_texts of this BrandingSetting.

delete_in_progress

Gets the delete_in_progress of this BrandingSetting.

domain_ocid

Gets the domain_ocid of this BrandingSetting.

enable_terms_of_use

Gets the enable_terms_of_use of this BrandingSetting.

external_id

Gets the external_id of this BrandingSetting.

id

Gets the id of this BrandingSetting.

idcs_created_by

Gets the idcs_created_by of this BrandingSetting.

idcs_last_modified_by

Gets the idcs_last_modified_by of this BrandingSetting.

idcs_last_upgraded_in_release

Gets the idcs_last_upgraded_in_release of this BrandingSetting.

idcs_prevented_operations

Gets the idcs_prevented_operations of this BrandingSetting.

images

Gets the images of this BrandingSetting.

is_hosted_page

Gets the is_hosted_page of this BrandingSetting.

locale

Gets the locale of this BrandingSetting.

login_texts

Gets the login_texts of this BrandingSetting.

meta

Gets the meta of this BrandingSetting.

ocid

Gets the ocid of this BrandingSetting.

preferred_language

Gets the preferred_language of this BrandingSetting.

privacy_policy_url

Gets the privacy_policy_url of this BrandingSetting.

schemas

[Required] Gets the schemas of this BrandingSetting.

tags

Gets the tags of this BrandingSetting.

tenancy_ocid

Gets the tenancy_ocid of this BrandingSetting.

terms_of_use_url

Gets the terms_of_use_url of this BrandingSetting.

timezone

Gets the timezone of this BrandingSetting.

Methods:

__init__(**kwargs)

Initializes a new BrandingSetting 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 BrandingSetting. 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 BrandingSetting. 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 BrandingSetting. This constant has a value of “update”

__init__(**kwargs)

Initializes a new BrandingSetting 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 BrandingSetting.

  • ocid (str) – The value to assign to the ocid property of this BrandingSetting.

  • schemas (list[str]) – The value to assign to the schemas property of this BrandingSetting.

  • meta (oci.identity_domains.models.Meta) – The value to assign to the meta property of this BrandingSetting.

  • idcs_created_by (oci.identity_domains.models.IdcsCreatedBy) – The value to assign to the idcs_created_by property of this BrandingSetting.

  • idcs_last_modified_by (oci.identity_domains.models.IdcsLastModifiedBy) – The value to assign to the idcs_last_modified_by property of this BrandingSetting.

  • idcs_prevented_operations (list[str]) – The value to assign to the idcs_prevented_operations property of this BrandingSetting. 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 BrandingSetting.

  • delete_in_progress (bool) – The value to assign to the delete_in_progress property of this BrandingSetting.

  • idcs_last_upgraded_in_release (str) – The value to assign to the idcs_last_upgraded_in_release property of this BrandingSetting.

  • domain_ocid (str) – The value to assign to the domain_ocid property of this BrandingSetting.

  • compartment_ocid (str) – The value to assign to the compartment_ocid property of this BrandingSetting.

  • tenancy_ocid (str) – The value to assign to the tenancy_ocid property of this BrandingSetting.

  • external_id (str) – The value to assign to the external_id property of this BrandingSetting.

  • custom_branding (bool) – The value to assign to the custom_branding property of this BrandingSetting.

  • preferred_language (str) – The value to assign to the preferred_language property of this BrandingSetting.

  • timezone (str) – The value to assign to the timezone property of this BrandingSetting.

  • locale (str) – The value to assign to the locale property of this BrandingSetting.

  • enable_terms_of_use (bool) – The value to assign to the enable_terms_of_use property of this BrandingSetting.

  • terms_of_use_url (str) – The value to assign to the terms_of_use_url property of this BrandingSetting.

  • privacy_policy_url (str) – The value to assign to the privacy_policy_url property of this BrandingSetting.

  • is_hosted_page (bool) – The value to assign to the is_hosted_page property of this BrandingSetting.

  • custom_html_location (str) – The value to assign to the custom_html_location property of this BrandingSetting.

  • custom_css_location (str) – The value to assign to the custom_css_location property of this BrandingSetting.

  • custom_translation (str) – The value to assign to the custom_translation property of this BrandingSetting.

  • default_company_names (list[oci.identity_domains.models.BrandingSettingsDefaultCompanyNames]) – The value to assign to the default_company_names property of this BrandingSetting.

  • default_login_texts (list[oci.identity_domains.models.BrandingSettingsDefaultLoginTexts]) – The value to assign to the default_login_texts property of this BrandingSetting.

  • default_images (list[oci.identity_domains.models.BrandingSettingsDefaultImages]) – The value to assign to the default_images property of this BrandingSetting.

  • company_names (list[oci.identity_domains.models.BrandingSettingsCompanyNames]) – The value to assign to the company_names property of this BrandingSetting.

  • login_texts (list[oci.identity_domains.models.BrandingSettingsLoginTexts]) – The value to assign to the login_texts property of this BrandingSetting.

  • images (list[oci.identity_domains.models.BrandingSettingsImages]) – The value to assign to the images property of this BrandingSetting.

property company_names

Gets the company_names of this BrandingSetting. Name of the company in different locales

SCIM++ Properties:
  • idcsCompositeKey: [locale]

  • multiValued: true

  • mutability: readOnly

  • required: false

  • returned: default

  • type: complex

Returns

The company_names of this BrandingSetting.

Return type

list[oci.identity_domains.models.BrandingSettingsCompanyNames]

property compartment_ocid

Gets the compartment_ocid of this BrandingSetting. 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 BrandingSetting.

Return type

str

property custom_branding

Gets the custom_branding of this BrandingSetting. Indicates if the branding is default or is custom branding

SCIM++ Properties:
  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: boolean

Returns

The custom_branding of this BrandingSetting.

Return type

bool

property custom_css_location

Gets the custom_css_location of this BrandingSetting. Storage URL location where the sanitized custom css is located

Added In: 20.1.3

SCIM++ Properties:
  • caseExact: false

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The custom_css_location of this BrandingSetting.

Return type

str

property custom_html_location

Gets the custom_html_location of this BrandingSetting. Storage URL location where the sanitized custom html is located

Added In: 20.1.3

SCIM++ Properties:
  • caseExact: false

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The custom_html_location of this BrandingSetting.

Return type

str

property custom_translation

Gets the custom_translation of this BrandingSetting. Custom translations (JSON String)

Added In: 20.1.3

SCIM++ Properties:
  • caseExact: false

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The custom_translation of this BrandingSetting.

Return type

str

property default_company_names

Gets the default_company_names of this BrandingSetting. Default name of the Company in different locales

Added In: 18.2.2

SCIM++ Properties:
  • idcsCompositeKey: [locale]

  • multiValued: true

  • mutability: readOnly

  • required: false

  • returned: default

  • type: complex

Returns

The default_company_names of this BrandingSetting.

Return type

list[oci.identity_domains.models.BrandingSettingsDefaultCompanyNames]

property default_images

Gets the default_images of this BrandingSetting. References to various images

Added In: 18.2.2

SCIM++ Properties:
  • idcsCompositeKey: [type]

  • multiValued: true

  • mutability: readOnly

  • required: false

  • returned: default

  • type: complex

Returns

The default_images of this BrandingSetting.

Return type

list[oci.identity_domains.models.BrandingSettingsDefaultImages]

property default_login_texts

Gets the default_login_texts of this BrandingSetting. Default Login text in different locales

Added In: 18.2.2

SCIM++ Properties:
  • idcsCompositeKey: [locale]

  • multiValued: true

  • mutability: readOnly

  • required: false

  • returned: default

  • type: complex

Returns

The default_login_texts of this BrandingSetting.

Return type

list[oci.identity_domains.models.BrandingSettingsDefaultLoginTexts]

property delete_in_progress

Gets the delete_in_progress of this BrandingSetting. 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 BrandingSetting.

Return type

bool

property domain_ocid

Gets the domain_ocid of this BrandingSetting. 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 BrandingSetting.

Return type

str

property enable_terms_of_use

Gets the enable_terms_of_use of this BrandingSetting. Indicates if Terms of Use is enabled in UI

Added In: 18.2.4

SCIM++ Properties:
  • caseExact: false

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The enable_terms_of_use of this BrandingSetting.

Return type

bool

property external_id

Gets the external_id of this BrandingSetting. 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:
  • caseExact: false

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The external_id of this BrandingSetting.

Return type

str

property id

Gets the id of this BrandingSetting. 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 BrandingSetting.

Return type

str

property idcs_created_by

Gets the idcs_created_by of this BrandingSetting.

Returns

The idcs_created_by of this BrandingSetting.

Return type

oci.identity_domains.models.IdcsCreatedBy

property idcs_last_modified_by

Gets the idcs_last_modified_by of this BrandingSetting.

Returns

The idcs_last_modified_by of this BrandingSetting.

Return type

oci.identity_domains.models.IdcsLastModifiedBy

property idcs_last_upgraded_in_release

Gets the idcs_last_upgraded_in_release of this BrandingSetting. 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 BrandingSetting.

Return type

str

property idcs_prevented_operations

Gets the idcs_prevented_operations of this BrandingSetting. 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 BrandingSetting.

Return type

list[str]

property images

Gets the images of this BrandingSetting. References to various images

SCIM++ Properties:
  • idcsCompositeKey: [type]

  • multiValued: true

  • mutability: readOnly

  • required: false

  • returned: default

  • type: complex

Returns

The images of this BrandingSetting.

Return type

list[oci.identity_domains.models.BrandingSettingsImages]

property is_hosted_page

Gets the is_hosted_page of this BrandingSetting. Indicates if ‘hosted’ option was selected

Added In: 20.1.3

SCIM++ Properties:
  • caseExact: false

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The is_hosted_page of this BrandingSetting.

Return type

bool

property locale

Gets the locale of this BrandingSetting. Default location for purposes of localizing items such as currency, date and time format, numerical representations, and so on

SCIM++ Properties:
  • caseExact: false

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The locale of this BrandingSetting.

Return type

str

property login_texts

Gets the login_texts of this BrandingSetting. Login text in different locales

SCIM++ Properties:
  • idcsCompositeKey: [locale]

  • multiValued: true

  • mutability: readOnly

  • required: false

  • returned: default

  • type: complex

Returns

The login_texts of this BrandingSetting.

Return type

list[oci.identity_domains.models.BrandingSettingsLoginTexts]

property meta

Gets the meta of this BrandingSetting.

Returns

The meta of this BrandingSetting.

Return type

oci.identity_domains.models.Meta

property ocid

Gets the ocid of this BrandingSetting. 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 BrandingSetting.

Return type

str

property preferred_language

Gets the preferred_language of this BrandingSetting. Preferred written or spoken language used for localized user interfaces

SCIM++ Properties:
  • caseExact: false

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The preferred_language of this BrandingSetting.

Return type

str

property privacy_policy_url

Gets the privacy_policy_url of this BrandingSetting. Privacy Policy URL

Added In: 18.2.4

SCIM++ Properties:
  • caseExact: false

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The privacy_policy_url of this BrandingSetting.

Return type

str

property schemas

[Required] Gets the schemas of this BrandingSetting. 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 BrandingSetting.

Return type

list[str]

property tags

Gets the tags of this BrandingSetting. 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 BrandingSetting.

Return type

list[oci.identity_domains.models.Tags]

property tenancy_ocid

Gets the tenancy_ocid of this BrandingSetting. 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 BrandingSetting.

Return type

str

property terms_of_use_url

Gets the terms_of_use_url of this BrandingSetting. Terms of Use URL

Added In: 18.2.4

SCIM++ Properties:
  • caseExact: false

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The terms_of_use_url of this BrandingSetting.

Return type

str

property timezone

Gets the timezone of this BrandingSetting. User’s timezone

SCIM++ Properties:
  • caseExact: false

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The timezone of this BrandingSetting.

Return type

str