Class BrandingSetting

Brand Settings schema

Inheritance
object
BrandingSetting
Inherited Members
Namespace: Oci.IdentitydomainsService.Models
Assembly: OCI.DotNetSDK.Identitydomains.dll
Syntax
public class BrandingSetting

Properties

CompanyNames

Declaration
[JsonProperty(PropertyName = "companyNames")]
public List<BrandingSettingsCompanyNames> CompanyNames { get; set; }
Property Value
Type Description
List<BrandingSettingsCompanyNames>

Name of the company in different locales
SCIM++ Properties:

  • idcsCompositeKey: [locale]
  • multiValued: true
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex

CompartmentOcid

Declaration
[JsonProperty(PropertyName = "compartmentOcid")]
public string CompartmentOcid { get; set; }
Property Value
Type Description
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

CustomBranding

Declaration
[JsonProperty(PropertyName = "customBranding")]
public bool? CustomBranding { get; set; }
Property Value
Type Description
bool?

Indicates if the branding is default or is custom branding
SCIM++ Properties:

  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: default
  • type: boolean

CustomCssLocation

Declaration
[JsonProperty(PropertyName = "customCssLocation")]
public string CustomCssLocation { get; set; }
Property Value
Type Description
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

CustomHtmlLocation

Declaration
[JsonProperty(PropertyName = "customHtmlLocation")]
public string CustomHtmlLocation { get; set; }
Property Value
Type Description
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

CustomTranslation

Declaration
[JsonProperty(PropertyName = "customTranslation")]
public string CustomTranslation { get; set; }
Property Value
Type Description
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

DefaultCompanyNames

Declaration
[JsonProperty(PropertyName = "defaultCompanyNames")]
public List<BrandingSettingsDefaultCompanyNames> DefaultCompanyNames { get; set; }
Property Value
Type Description
List<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

DefaultImages

Declaration
[JsonProperty(PropertyName = "defaultImages")]
public List<BrandingSettingsDefaultImages> DefaultImages { get; set; }
Property Value
Type Description
List<BrandingSettingsDefaultImages>

References to various images
Added In: 18.2.2
SCIM++ Properties:

  • idcsCompositeKey: [type]
  • multiValued: true
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex

DefaultLoginTexts

Declaration
[JsonProperty(PropertyName = "defaultLoginTexts")]
public List<BrandingSettingsDefaultLoginTexts> DefaultLoginTexts { get; set; }
Property Value
Type Description
List<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

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.
SCIM++ Properties:

  • caseExact: false
  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: default
  • type: boolean
  • uniqueness: none

DomainOcid

Declaration
[JsonProperty(PropertyName = "domainOcid")]
public string DomainOcid { get; set; }
Property Value
Type Description
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

EnableTermsOfUse

Declaration
[JsonProperty(PropertyName = "enableTermsOfUse")]
public bool? EnableTermsOfUse { get; set; }
Property Value
Type Description
bool?

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

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.
SCIM++ Properties:

  • caseExact: false
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
  • uniqueness: none

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.
SCIM++ Properties:

  • caseExact: false
  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: always
  • type: string
  • uniqueness: global

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.
SCIM++ Properties:

  • caseExact: false
  • idcsSearchable: false
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: request
  • type: string
  • uniqueness: none

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.
SCIM++ Properties:

  • idcsSearchable: false
  • multiValued: true
  • mutability: readOnly
  • required: false
  • returned: request
  • type: string
  • uniqueness: none

Images

Declaration
[JsonProperty(PropertyName = "images")]
public List<BrandingSettingsImages> Images { get; set; }
Property Value
Type Description
List<BrandingSettingsImages>

References to various images
SCIM++ Properties:

  • idcsCompositeKey: [type]
  • multiValued: true
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex

IsHostedPage

Declaration
[JsonProperty(PropertyName = "isHostedPage")]
public bool? IsHostedPage { get; set; }
Property Value
Type Description
bool?

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

Locale

Declaration
[JsonProperty(PropertyName = "locale")]
public string Locale { get; set; }
Property Value
Type Description
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

LoginTexts

Declaration
[JsonProperty(PropertyName = "loginTexts")]
public List<BrandingSettingsLoginTexts> LoginTexts { get; set; }
Property Value
Type Description
List<BrandingSettingsLoginTexts>

Login text in different locales
SCIM++ Properties:

  • idcsCompositeKey: [locale]
  • multiValued: true
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex

Meta

Declaration
[JsonProperty(PropertyName = "meta")]
public Meta Meta { get; set; }
Property Value
Type Description
Meta

Ocid

Declaration
[JsonProperty(PropertyName = "ocid")]
public string Ocid { get; set; }
Property Value
Type Description
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

PreferredLanguage

Declaration
[JsonProperty(PropertyName = "preferredLanguage")]
public string PreferredLanguage { get; set; }
Property Value
Type Description
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

PrivacyPolicyUrl

Declaration
[JsonProperty(PropertyName = "privacyPolicyUrl")]
public string PrivacyPolicyUrl { get; set; }
Property Value
Type Description
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

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.
SCIM++ Properties:

  • caseExact: false
  • idcsSearchable: false
  • multiValued: true
  • mutability: readWrite
  • required: true
  • returned: default
  • type: string
  • uniqueness: none
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.
SCIM++ Properties:

  • idcsCompositeKey: [key, value]
  • idcsSearchable: true
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: request
  • type: complex
  • uniqueness: none

TenancyOcid

Declaration
[JsonProperty(PropertyName = "tenancyOcid")]
public string TenancyOcid { get; set; }
Property Value
Type Description
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

TermsOfUseUrl

Declaration
[JsonProperty(PropertyName = "termsOfUseUrl")]
public string TermsOfUseUrl { get; set; }
Property Value
Type Description
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

Timezone

Declaration
[JsonProperty(PropertyName = "timezone")]
public string Timezone { get; set; }
Property Value
Type Description
string

User's timezone
SCIM++ Properties:

  • caseExact: false
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: default
  • type: string
  • uniqueness: none