Update a Setting

patch

/admin/v1/Settings/{id}

Request

Supported Media Types
Path Parameters
Query Parameters
  • A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If "attributes" query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive.
    Allowed Values: [ "all", "always", "never", "request", "default" ]
  • A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.
Header Parameters
  • The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
  • Media Type
  • An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.
Body ()
Update the Settings with SCIM Patch schema.

Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute.

  • Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable:

    • The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly.
    • The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly.
    • Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below:

  • Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always:

    • If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always.
    • If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always.
    • The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

Root Schema : PatchOp
Type: object
See Section 3.5.2. HTTP PATCH is an OPTIONAL server function that enables clients to update one or more attributes of a SCIM resource using a sequence of operations to "add", "remove", or "replace" values. Clients may discover service provider support for PATCH by querying the service provider configuration. The general form of the SCIM patch request is based on JavaScript Object Notation (JSON) Patch [RFC6902]. One difference between SCIM patch and JSON patch is that SCIM servers do not support array indexing and do not support [RFC6902] operation types relating to array element manipulation such as "move". A patch request, regardless of the number of operations, SHALL be treated as atomic. If a single operation encounters an error condition, the original SCIM resource MUST be restored, and a failure status SHALL be returned.
Show Source
  • Operations
    The body of an HTTP PATCH request MUST contain the attribute "Operations", whose value is an array of one or more patch operations.
  • Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ]
    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. 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. REQUIRED.
Nested Schema : Operations
Type: array
The body of an HTTP PATCH request MUST contain the attribute "Operations", whose value is an array of one or more patch operations.
Show Source
  • Operations
    Each patch operation object MUST have exactly one "op" member, whose value indicates the operation to perform and MAY be one of "add", "remove", or "replace". See Section 3.5.2 for details.
Nested Schema : Operations
Type: object
Each patch operation object MUST have exactly one "op" member, whose value indicates the operation to perform and MAY be one of "add", "remove", or "replace". See Section 3.5.2 for details.
Show Source
  • Allowed Values: [ "add", "remove", "replace" ]
    Defines the operation to be performed for this Patch. If op=remove, value is not required.
  • String containing an attribute path describing the target of the operation. The "path" attribute is OPTIONAL for "add" and "replace" and is REQUIRED for "remove" operations. See Section 3.5.2 for details
  • String or map of the attribute to be added or replaced.
Back to Top

Response

Supported Media Types

200 Response

The request was successful. We updated the resource.
Body ()
Root Schema : Settings
Type: object
Settings schema
Show Source
  • Added In: 18.1.6

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Indicates whether all the Apps in this customer tenancy should trust each other. A value of true overrides the 'defaultTrustScope' attribute here in Settings, as well as any App-specific 'trustScope' attribute, to force in effect 'trustScope=Account' for every App in this customer tenancy.
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    One or more email domains allowed in a user's email field. If unassigned, any domain is allowed.
  • Allowed Values: [ "30", "60", "90" ]
    Added In: 19.2.1

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    Audit Event retention period. If set, overrides default of 30 days after which Audit Events will be purged
  • companyNames
    SCIM++ Properties:
    • idcsCompositeKey: [locale]
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    Name of the company in different locales
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Contact emails used to notify tenants. Can be one or more user or group alias emails.
  • Allowed Values: [ "readOnly", "readWrite", "none" ]
    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    This value indicates whether Customer Service Representatives can login and have readOnly or readWrite access. A value of 'none' means CSR cannot login to the services.
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Indicates if the branding is default or custom
  • defaultCompanyNames
    Added In: 18.2.2

    SCIM++ Properties:
    • idcsCompositeKey: [locale]
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    Default name of the Company in different locales
  • defaultImages
    Added In: 18.2.2

    SCIM++ Properties:
    • idcsCompositeKey: [type]
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    References to various images
  • defaultLoginTexts
    Added In: 18.2.2

    SCIM++ Properties:
    • idcsCompositeKey: [locale]
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    Default Login text in different locales
  • Allowed Values: [ "Explicit", "Account", "Tags" ]
    Deprecated Since: 18.3.6

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Indicates the default trust scope for all apps
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    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: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    • uniqueness: none
    The level of diagnostic logging that is currently in effect. A level of 0 (zero) indicates that diagnostic logging is disabled. A level of 1 (one) indicates that diagnostic logging is enabled.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none
    The end time up to which diagnostic recording is switched on
  • Added In: 18.2.4

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Indicates if Terms of Use is enabled in UI
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    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
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: always
    • type: string
    • uniqueness: global
    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
    SCIM++ Properties:
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: complex
    The User or App who created the Resource
  • idcsLastModifiedBy
    SCIM++ Properties:
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    The User or App who modified the Resource
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    The release number when the resource was upgraded.
  • Allowed Values: [ "replace", "update", "delete" ]
    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
  • images
    SCIM++ Properties:
    • idcsCompositeKey: [type]
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    References to various images
  • Maximum Length: 50
    SCIM++ Properties:
    • caseExact: false
    • idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(locale)"
    • idcsCanonicalValueSourceResourceType: AllowedValue
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Default location for purposes of localizing items such as currency, date and time format, numerical representations, and so on.
  • loginTexts
    SCIM++ Properties:
    • idcsCompositeKey: [locale]
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    Login text in different locales
  • meta
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]
    • type: complex
    A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
  • Maximum Length: 200
    Added In: 19.2.1

    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Database Migration Status
  • Added In: 19.2.1

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    On-Premises provisioning feature toggle.
  • Maximum Length: 50
    SCIM++ Properties:
    • caseExact: false
    • idcsCanonicalValueSourceFilter: attrName eq "languages" and attrValues.value eq "$(preferredLanguage)"
    • idcsCanonicalValueSourceResourceType: AllowedValue
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Preferred written or spoken language used for localized user interfaces
  • Added In: 18.2.4

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Privacy Policy URL
  • purgeConfigs
    Deprecated Since: 19.1.6

    SCIM++ Properties:
    • idcsCompositeKey: [resourceName]
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    Purge Configs for different Resource Types
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: true
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    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.
  • Added In: 17.3.4

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Indicates if access on SigningCert is allowed to public or not
  • tags
    SCIM++ Properties:
    • idcsCompositeKey: [key, value]
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: request
    • type: complex
    • uniqueness: none
    A list of tags on this resource.
  • tenantCustomClaims
    Added In: 18.4.2

    SCIM++ Properties:
    • idcsCompositeKey: [name]
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    Custom claims associated with the specific tenant
  • Added In: 18.2.4

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Terms of Use URL
  • Maximum Length: 50
    SCIM++ Properties:
    • caseExact: false
    • idcsCanonicalValueSourceFilter: attrName eq "timezones" and attrValues.value eq "$(timezone)"
    • idcsCanonicalValueSourceResourceType: AllowedValue
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    User's timezone
Nested Schema : companyNames
Type: array
SCIM++ Properties:
  • idcsCompositeKey: [locale]
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
Name of the company in different locales
Show Source
Nested Schema : defaultCompanyNames
Type: array
Added In: 18.2.2

SCIM++ Properties:
  • idcsCompositeKey: [locale]
  • multiValued: true
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex
Default name of the Company in different locales
Show Source
Nested Schema : defaultImages
Type: array
Added In: 18.2.2

SCIM++ Properties:
  • idcsCompositeKey: [type]
  • multiValued: true
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex
References to various images
Show Source
Nested Schema : defaultLoginTexts
Type: array
Added In: 18.2.2

SCIM++ Properties:
  • idcsCompositeKey: [locale]
  • multiValued: true
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex
Default Login text in different locales
Show Source
Nested Schema : idcsCreatedBy
Type: object
SCIM++ Properties:
  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: true
  • returned: default
  • type: complex
The User or App who created the Resource
Show Source
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    The URI of the SCIM resource that represents the User or App who created this Resource
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The displayName of the User or App who created this Resource
  • Allowed Values: [ "User", "App" ]
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The type of resource, User or App, that created this Resource
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    The ID of the SCIM resource that represents the User or App who created this Resource
Nested Schema : idcsLastModifiedBy
Type: object
SCIM++ Properties:
  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex
The User or App who modified the Resource
Show Source
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    The URI of the SCIM resource that represents the User or App who modified this Resource
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The displayName of the User or App who modified this Resource
  • Allowed Values: [ "User", "App" ]
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The type of resource, User or App, that modified this Resource
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    The ID of the SCIM resource that represents the User or App who modified this Resource
Nested Schema : images
Type: array
SCIM++ Properties:
  • idcsCompositeKey: [type]
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
References to various images
Show Source
Nested Schema : loginTexts
Type: array
SCIM++ Properties:
  • idcsCompositeKey: [locale]
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
Login text in different locales
Show Source
Nested Schema : meta
Type: object
SCIM++ Properties:
  • caseExact: false
  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: default
  • idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]
  • type: complex
A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
Show Source
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none
    The DateTime the Resource was added to the Service Provider
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none
    The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Name of the resource type of the resource--for example, Users or Groups
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The version of the Resource being returned. This value must be the same as the ETag HTTP response header.
Nested Schema : purgeConfigs
Type: array
Deprecated Since: 19.1.6

SCIM++ Properties:
  • idcsCompositeKey: [resourceName]
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
Purge Configs for different Resource Types
Show Source
Nested Schema : tags
Type: array
SCIM++ Properties:
  • idcsCompositeKey: [key, value]
  • idcsSearchable: true
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: request
  • type: complex
  • uniqueness: none
A list of tags on this resource.
Show Source
Nested Schema : tenantCustomClaims
Type: array
Added In: 18.4.2

SCIM++ Properties:
  • idcsCompositeKey: [name]
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
Custom claims associated with the specific tenant
Show Source
Nested Schema : companyNames
Type: object
Name of the company in different locales
Show Source
  • SCIM++ Properties:
    • idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(companyNames.locale)"
    • idcsCanonicalValueSourceResourceType: AllowedValue
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    Locale
  • Maximum Length: 50
    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    Company name
Nested Schema : defaultCompanyNames
Type: object
Default name of the Company in different locales
Show Source
  • Added In: 18.2.2

    SCIM++ Properties:
    • idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(companyNames.locale)"
    • idcsCanonicalValueSourceResourceType: AllowedValue
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    Locale
  • Maximum Length: 50
    Added In: 18.2.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    Company name
Nested Schema : defaultImages
Type: object
References to various images
Show Source
  • Added In: 18.2.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    A human-readable name, primarily used for display purposes
  • Allowed Values: [ "desktop logo", "mobile logo", "desktop portal header", "mobile portal header", "email header", "email footer", "self registration profile header logo", "self registration profile footer logo" ]
    Added In: 18.2.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    Indicates the image type
  • Added In: 18.2.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: reference
    Image URI
Nested Schema : defaultLoginTexts
Type: object
Default Login text in different locales
Show Source
  • Added In: 18.2.2

    SCIM++ Properties:
    • idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(loginTexts.locale)"
    • idcsCanonicalValueSourceResourceType: AllowedValue
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    Locale
  • Maximum Length: 250
    Added In: 18.2.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    Login text
Nested Schema : images
Type: object
References to various images
Show Source
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    A human-readable name, primarily used for display purposes
  • Allowed Values: [ "desktop logo", "mobile logo", "desktop portal header", "mobile portal header", "email header", "email footer", "self registration profile header logo", "self registration profile footer logo" ]
    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    Indicates the image type
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: reference
    Image URI
Nested Schema : loginTexts
Type: object
Login text in different locales
Show Source
  • SCIM++ Properties:
    • idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(loginTexts.locale)"
    • idcsCanonicalValueSourceResourceType: AllowedValue
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    Locale
  • Maximum Length: 250
    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    Login text
Nested Schema : purgeConfigs
Type: object
Purge Configs for different Resource Types
Show Source
  • Deprecated Since: 19.1.6

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    Resource Name
  • Allowed Values: [ "30", "60", "90" ]
    Deprecated Since: 19.1.6

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: integer
    Retention Period
Nested Schema : tags
Type: object
A list of tags on this resource.
Show Source
  • Maximum Length: 256
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Key or name of the tag.
  • Maximum Length: 256
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Value of the tag.
Nested Schema : tenantCustomClaims
Type: object
Custom claims associated with the specific tenant
Show Source
  • Added In: 18.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: boolean
    • uniqueness: none
    Indicates if the custom claim is associated with all scopes
  • Added In: 18.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: boolean
    • uniqueness: none
    Indicates if the custom claim is an expression
  • Allowed Values: [ "always", "request", "never" ]
    Added In: 18.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Indicates under what scenario the custom claim will be return
  • Maximum Length: 100
    Added In: 18.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: server
    Custom claim name
  • Added In: 18.4.2

    SCIM++ Properties:
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Scopes associated with a specific custom claim
  • Allowed Values: [ "AT", "IT", "BOTH" ]
    Added In: 18.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Indicates what type of token the custom claim will be embedded
  • Maximum Length: 100
    Added In: 18.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Custom claim value

400 Response

Bad or invalid request
Body ()
Root Schema : Error
Type: object
The SCIM Protocol uses the HTTP status response status codes defined in Section 6 [RFC7231] to indicate operation success or failure. Refer the available status codes here : Status Codes.
In addition to returning a HTTP response code implementers MUST return the errors in the body of the response in the client requested format containing the error response and, per the HTTP specification, human- readable explanations.
Show Source
  • A detailed, human readable message. OPTIONAL
  • Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:Error", "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error" ]
    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 SCIM specified Error and Extn Error Schema. 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. REQUIRED.
  • The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
  • urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
    Extension schema for error messages providing more details with the exception status.
    Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type: object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Show Source
Nested Schema : additionalData
Type: object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.

401 Response

The supplied credentials, if any, are not sufficient to access the resource.
Body ()
Root Schema : Error
Type: object
The SCIM Protocol uses the HTTP status response status codes defined in Section 6 [RFC7231] to indicate operation success or failure. Refer the available status codes here : Status Codes.
In addition to returning a HTTP response code implementers MUST return the errors in the body of the response in the client requested format containing the error response and, per the HTTP specification, human- readable explanations.
Show Source
  • A detailed, human readable message. OPTIONAL
  • Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:Error", "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error" ]
    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 SCIM specified Error and Extn Error Schema. 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. REQUIRED.
  • The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
  • urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
    Extension schema for error messages providing more details with the exception status.
    Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type: object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Show Source
Nested Schema : additionalData
Type: object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.

404 Response

The requested resource was not found.
Body ()
Root Schema : Error
Type: object
The SCIM Protocol uses the HTTP status response status codes defined in Section 6 [RFC7231] to indicate operation success or failure. Refer the available status codes here : Status Codes.
In addition to returning a HTTP response code implementers MUST return the errors in the body of the response in the client requested format containing the error response and, per the HTTP specification, human- readable explanations.
Show Source
  • A detailed, human readable message. OPTIONAL
  • Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:Error", "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error" ]
    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 SCIM specified Error and Extn Error Schema. 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. REQUIRED.
  • The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
  • urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
    Extension schema for error messages providing more details with the exception status.
    Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type: object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Show Source
Nested Schema : additionalData
Type: object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.

500 Response

We couldn't return the representation due to an internal server error.
Body ()
Root Schema : Error
Type: object
The SCIM Protocol uses the HTTP status response status codes defined in Section 6 [RFC7231] to indicate operation success or failure. Refer the available status codes here : Status Codes.
In addition to returning a HTTP response code implementers MUST return the errors in the body of the response in the client requested format containing the error response and, per the HTTP specification, human- readable explanations.
Show Source
  • A detailed, human readable message. OPTIONAL
  • Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:Error", "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error" ]
    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 SCIM specified Error and Extn Error Schema. 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. REQUIRED.
  • The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
  • urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
    Extension schema for error messages providing more details with the exception status.
    Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type: object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Show Source
Nested Schema : additionalData
Type: object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
Back to Top

Examples

The following example shows how to update values for settings by submitting a PATCH request on the REST resource using cURL. For more information about cURL, see Use cURL.

cURL Command

Note:

The command in this example uses the URL structure https://tenant-base-url/resource-path, where tenant-base-url represents the Identity Service URL, and the resource path represents the Identity Service API. See Send Requests for the appropriate URL structure to use.
curl
-X PATCH
-H "Content-Type:application/scim+json"
-H "Authorization: Bearer <Access Token Value>"
https://tenant-base-url/admin/v1/Settings/{id}

Example of Request Body

The following shows an example of the request body in JSON format:

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ],
    "Operations": [
        {
            "op": "replace",
            "path": "customBranding",
            "value": true
        }
    ]
}

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:oracle:idcs:Settings"
    ],
    "id": "Settings",
    "customBranding": true,
    "timezone": "America/Chicago",
    "locale": "en",
    "preferredLanguage": "en",
    "csrAccess": "none",
    "signingCertPublicAccess": false,
    "accountAlwaysTrustScope": false,
    "defaultTrustScope": "Explicit",
    "diagnosticLevel": 0,
    "purgeConfigs": [
        {
            "resourceName": "AuditEvent",
            "retentionPeriod": 90
        }
    ],
    "defaultCompanyNames": [
        {
            "value": "INTEGTENANT",
            "locale": "de"
        },
        {
            "value": "INTEGTENANT",
            "locale": "en"
        },
        {
            "value": "INTEGTENANT",
            "locale": "es"
        },
        {
            "value": "INTEGTENANT",
            "locale": "fr"
        },
        {
            "value": "INTEGTENANT",
            "locale": "it"
        },
        {
            "value": "INTEGTENANT",
            "locale": "pt"
        },
        {
            "value": "INTEGTENANT",
            "locale": "zh-Hans"
        },
        {
            "value": "INTEGTENANT",
            "locale": "zh-Hant"
        },
        {
            "value": "INTEGTENANT",
            "locale": "ja"
        },
        {
            "value": "INTEGTENANT",
            "locale": "ko"
        },
        {
            "value": "INTEGTENANT",
            "locale": "no"
        }
    ],
    "defaultLoginTexts": [
        {
            "value": "Oracle Cloud-Accountanmeldung",
            "locale": "de"
        },
        {
            "value": "Oracle Cloud Account Sign In",
            "locale": "en"
        },
        {
            "value": "Conexi??n a la cuenta de Oracle Cloud",
            "locale": "es"
        },
        {
            "value": "Connexion ?? un compte Oracle Cloud",
            "locale": "fr"
        },
        {
            "value": "Collegamento all'account Oracle Cloud",
            "locale": "it"
        },
        {
            "value": "Entrada em Sess??o na Conta Oracle Cloud",
            "locale": "pt"
        },
        {
            "value": "Oracle Cloud ????",
            "locale": "zh-Hans"
        },
        {
            "value": "Oracle Cloud ????",
            "locale": "zh-Hant"
        },
        {
            "value": "Oracle Cloud???????????",
            "locale": "ja"
        },
        {
            "value": "Oracle Cloud ?? ???",
            "locale": "ko"
        },
        {
            "value": "P??logging for Oracle Cloud-konto",
            "locale": "no"
        }
    ],
    "companyNames": [
        {
            "value": "INTEGTENANT",
            "locale": "de"
        },
        {
            "value": "INTEGTENANT",
            "locale": "en"
        },
        {
            "value": "INTEGTENANT",
            "locale": "es"
        },
        {
            "value": "INTEGTENANT",
            "locale": "fr"
        },
        {
            "value": "INTEGTENANT",
            "locale": "it"
        },
        {
            "value": "INTEGTENANT",
            "locale": "pt"
        },
        {
            "value": "INTEGTENANT",
            "locale": "zh-Hans"
        },
        {
            "value": "INTEGTENANT",
            "locale": "zh-Hant"
        },
        {
            "value": "INTEGTENANT",
            "locale": "ja"
        },
        {
            "value": "INTEGTENANT",
            "locale": "ko"
        },
        {
            "value": "INTEGTENANT",
            "locale": "no"
        }
    ],
    "loginTexts": [
        {
            "locale": "de",
            "value": "Oracle Cloud-Accountanmeldung"
        },
        {
            "locale": "en",
            "value": "Oracle Cloud Account Sign In"
        },
        {
            "locale": "es",
            "value": "Conexi??n a la cuenta de Oracle Cloud"
        },
        {
            "locale": "fr",
            "value": "Connexion ?? un compte Oracle Cloud"
        },
        {
            "locale": "it",
            "value": "Collegamento all'account Oracle Cloud"
        },
        {
            "locale": "pt",
            "value": "Entrada em Sess??o na Conta Oracle Cloud"
        },
        {
            "locale": "zh-Hans",
            "value": "Oracle Cloud ????"
        },
        {
            "locale": "zh-Hant",
            "value": "Oracle Cloud ????"
        },
        {
            "locale": "ja",
            "value": "Oracle Cloud???????????"
        },
        {
            "locale": "ko",
            "value": "Oracle Cloud ?? ???"
        },
        {
            "locale": "no",
            "value": "P??logging for Oracle Cloud-konto"
        }
    ],
    "contactEmails": [
        "admin@oracle.com"
    ],
    "images": [
        {
            "value": "https://tenant-base-url/ui/v1/public/common/asset/defaultBranding/oracle-desktop-logo.gif",
            "type": "desktop logo"
        },
        {
            "value": "https://tenant-base-url/ui/v1/public/common/asset/defaultBranding/oracle-mobile-logo.gif",
            "type": "mobile logo"
        },
        {
            "value": "https://tenant-base-url/ui/v1/public/common/asset/defaultBranding/oracle-desktop-portal-header.png",
            "type": "desktop portal header"
        },
        {
            "value": "https://tenant-base-url/ui/v1/public/common/asset/defaultBranding/oracle-mobile-portal-header.png",
            "type": "mobile portal header"
        },
        {
            "value": "https://tenant-base-url/ui/v1/public/common/asset/defaultBranding/oracle-email-header.png",
            "type": "email header"
        },
        {
            "value": "https://tenant-base-url/ui/v1/public/common/asset/defaultBranding/oracle-self-registration-profile-header-logo.png",
            "type": "self registration profile header logo"
        },
        {
            "value": "https://tenant-base-url/ui/v1/public/common/asset/defaultBranding/oracle-self-registration-profile-footer-logo.png",
            "type": "self registration profile footer logo"
        }
    ],
    "defaultImages": [
        {
            "value": "https://tenant-base-url/ui/v1/public/common/asset/defaultBranding/oracle-desktop-logo.gif",
            "type": "desktop logo"
        },
        {
            "value": "https://tenant-base-url/ui/v1/public/common/asset/defaultBranding/oracle-mobile-logo.gif",
            "type": "mobile logo"
        },
        {
            "value": "https://tenant-base-url/ui/v1/public/common/asset/defaultBranding/oracle-desktop-portal-header.png",
            "type": "desktop portal header"
        },
        {
            "value": "https://tenant-base-url/ui/v1/public/common/asset/defaultBranding/oracle-mobile-portal-header.png",
            "type": "mobile portal header"
        },
        {
            "value": "https://tenant-base-url/ui/v1/public/common/asset/defaultBranding/oracle-email-header.png",
            "type": "email header"
        },
        {
            "value": "https://tenant-base-url/ui/v1/public/common/asset/defaultBranding/oracle-self-registration-profile-header-logo.png",
            "type": "self registration profile header logo"
        },
        {
            "value": "https://tenant-base-url/ui/v1/public/common/asset/defaultBranding/oracle-self-registration-profile-footer-logo.png",
            "type": "self registration profile footer logo"
        }
    ],
    "diagnosticTracingUpto": "2018-04-09T12:58:37.404Z",
    "meta": {
        "lastModified": "2018-04-11T06:19:53.722Z",
        "resourceType": "Settings",
        "created": "2018-04-09T12:58:34.037Z",
        "location": "https://tenant-base-url/admin/v1/Settings/Settings"
    },
    "idcsLastModifiedBy": {
        "value": "b2e4000e3b6e4fd89bb521e10d294d18",
        "type": "App",
        "display": "admin",
        "$ref": "https://tenant-base-url/admin/v1/Apps/b2e4000e3b6e4fd89bb521e10d294d18"
    },
    "idcsCreatedBy": {
        "value": "b2e4000e3b6e4fd89bb521e10d294d18",
        "type": "App",
        "display": "idcssm",
        "$ref": "https://tenant-base-url/admin/v1/Apps/b2e4000e3b6e4fd89bb521e10d294d18"
    }
}
Back to Top