Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace BrandingSetting

Brand Settings schema

Enumerations

Properties

Functions

Properties

Optional companyNames

companyNames: Array<BrandingSettingsCompanyNames>

Name of the company in different locales

*SCIM++ Properties:** - idcsCompositeKey: [locale] - multiValued: true - mutability: readOnly - required: false - returned: default - type: complex

Optional compartmentOcid

compartmentOcid: undefined | string

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

Optional customBranding

customBranding: undefined | false | true

Indicates if the branding is default or is custom branding

*SCIM++ Properties:** - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean

Optional customCssLocation

customCssLocation: undefined | string

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

Optional customHtmlLocation

customHtmlLocation: undefined | string

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

Optional customTranslation

customTranslation: undefined | string

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

Optional defaultCompanyNames

defaultCompanyNames: Array<BrandingSettingsDefaultCompanyNames>

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

Optional defaultImages

defaultImages: Array<BrandingSettingsDefaultImages>

References to various images

*Added In:** 18.2.2

*SCIM++ Properties:** - idcsCompositeKey: [type] - multiValued: true - mutability: readOnly - required: false - returned: default - type: complex

Optional defaultLoginTexts

defaultLoginTexts: Array<BrandingSettingsDefaultLoginTexts>

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

Optional deleteInProgress

deleteInProgress: undefined | false | true

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

Optional domainOcid

domainOcid: undefined | string

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

Optional enableTermsOfUse

enableTermsOfUse: undefined | false | true

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

Optional externalId

externalId: undefined | 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.

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

Optional id

id: undefined | 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.

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

Optional idcsCreatedBy

idcsCreatedBy: model.IdcsCreatedBy

Optional idcsLastModifiedBy

idcsLastModifiedBy: model.IdcsLastModifiedBy

Optional idcsLastUpgradedInRelease

idcsLastUpgradedInRelease: undefined | string

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

Optional idcsPreventedOperations

idcsPreventedOperations: Array<IdcsPreventedOperations>

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

Optional images

images: Array<BrandingSettingsImages>

References to various images

*SCIM++ Properties:** - idcsCompositeKey: [type] - multiValued: true - mutability: readOnly - required: false - returned: default - type: complex

Optional isHostedPage

isHostedPage: undefined | false | true

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

Optional locale

locale: undefined | string

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

Optional loginTexts

loginTexts: Array<BrandingSettingsLoginTexts>

Login text in different locales

*SCIM++ Properties:** - idcsCompositeKey: [locale] - multiValued: true - mutability: readOnly - required: false - returned: default - type: complex

Optional meta

meta: model.Meta

Optional ocid

ocid: undefined | string

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

Optional preferredLanguage

preferredLanguage: undefined | string

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

Optional privacyPolicyUrl

privacyPolicyUrl: undefined | string

Privacy Policy URL

*Added In:** 18.2.4

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

schemas

schemas: Array<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.

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

Optional tags

tags: Array<Tags>

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

Optional tenancyOcid

tenancyOcid: undefined | string

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

Optional termsOfUseUrl

termsOfUseUrl: undefined | string

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

Optional timezone

timezone: undefined | string

User's timezone

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

Functions

getDeserializedJsonObj

getJsonObj