Replace a Schema Def

put

/admin/v1/Schemas/{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 ()
Replace the current instance of Schema with provided payload.

Before you specify an attribute-value in a request to replace 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 : Schema
Type: object
SCIM schema
Show Source
  • attributes
    SCIM++ Properties:
    • idcsCompositeKey: []
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    A complex type that specifies the set of Resource attributes
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Schema's human-readable description
  • 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.
  • Added In: 17.3.4

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies whether the attribute is cacheable. True by default for all attributes. If attribute with idcsAttributeCachable = false, is present \"attributesToGet\" while executing GET/SEARCH on cacheable resource, Cache is missed and data is fetched from Data Provider.
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: boolean
    • uniqueness: none
    Specifies if the attributes in this schema can be used for mapping with external identity sources such as AD or LDAP
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Resource types defs this resource refers to
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Schema's human-readable name
Nested Schema : attributes
Type: array
SCIM++ Properties:
  • idcsCompositeKey: []
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
A complex type that specifies the set of Resource attributes
Show Source
Nested Schema : attributes
Type: object
A complex type that specifies the set of Resource attributes
Show Source
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    A collection of canonical values. Applicable Service Providers MUST specify the canonical types specified in the core schema specification--for example, \"work\", \"home\".
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies if the String attribute is case-sensitive
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The attribute's human-readable description
  • Added In: 17.3.4

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Indicates that the schema has been added since this release number
  • Deprecated Since: 19.3.3

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    Indicates that the schema has been added since version
  • Added In: 17.3.4

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies whether the attribute is cacheable. True by default for all attributes. If attribute with idcsAttributeCachable = false, is present \"attributesToGet\" while executing GET/SEARCH on cacheable resource, Cache is missed and data is fetched from Data Provider.
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    Specifies if the attribute can be used for mapping with external identity sources such as AD or LDAP. If isSchemaMappable: false for the schema in which this attribute is defined, then this flag is ignored
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies whether changes to this attribute value are audited
  • Maximum Length: 8
    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Sequence tracking ID name for the attribute
  • Added In: 17.4.6

    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Display name for the canonical value attribute name.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Filter to use when getting canonical values for this schema attribute
  • Added In: 17.4.6

    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Source key attribute for the canonical value.
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the Resource type to read from for dynamic canonical values
  • Added In: 17.4.6

    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the Resource type ID to read from for dynamic canonical values
  • Allowed Values: [ "dynamic", "static" ]
    Added In: 17.4.6

    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Type of the canonical value.
  • SCIM++ Properties:
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    Specifies the mapping between external identity source attributes and IDCS complex attributes (e.g. email => emails[work].value)
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The set of one or more sub attributes' names of a CMVA, whose values uniquely identify an instance of a CMVA
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The attribute defining the CSV header name for import/export
  • SCIM++ Properties:
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    Csv meta data for those resource type attributes which can be imported / exported from / to csv.
  • Added In: 18.1.6

    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the default value for an attribute. The value must be one from canonicalValues if defined.
  • Added In: 17.3.4

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Indicates that the schema has been deprecated since this release number
  • Deprecated Since: 19.3.3

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    Indicates that the schema has been deprecated since version
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the user-friendly displayable attribute name or catalog key used for localization
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Localized schema attribute display name for use by UI client for displaying attribute labels
  • Allowed Values: [ "optionalPii", "mfa", "social", "schemaCustomization" ]
    Deprecated Since: 19.1.6

    SCIM++ Properties:
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    The list of features that require this attribute
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Whether the CMVA attribute will be fetched or not for current resource in AbstractResourceManager update operation before calling data provider update. Default is true.
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the mapper to use when mapping this attribute value from DataProvider-specific semantics
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies whether this attribute value was generated
  • Allowed Values: [ "string", "long", "char", "double", "float", "integer", "boolean", "bytes", "bigdecimal", "biginteger", "guardedbytes", "guardedstring" ]
    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Maps to ICF data type
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Maps to ICF target attribute name
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Metadata to identify the ICF required attribute
  • SCIM++ Properties:
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Specifies the indirectly referenced Resources
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies whether the schema attribute is for internal use only. Internal attributes are not exposed via REST. This attribute overrides mutability for create/update if the request is internal and the attribute internalflag is set to True. This attribute overrides the return attribute while building SCIM response attributes when both the request is internal and the schema attribute is internal.
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    Specifies the maximum length of the attribute
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: integer
    Specifies the maximum value of the integer attribute
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    Specifies the minimum length of the attribute
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: integer
    Specifies the minimum value of the integer attribute
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    If true, specifies that the attribute can have multiple language values set for the attribute on which this is set.
  • Deprecated Since: 19.1.6

    SCIM++ Properties:
    • caseExact: true
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    A subset of \"canonicalValues\" that are not supported when the \"optionalPii\" feature is disabled in GlobalConfig.
  • Added In: 18.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    Specifies whether the attribute is PII (personal information). False by default for all attributes. If attribute with idcsPii = true, it's value must be obfuscated before it's written to the IDCS system logs.
  • Deprecated Since: 17.3.4

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Specifies the referenced Resource attribute
  • SCIM++ Properties:
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Specifies the directly referenced Resources
  • Added In: 19.1.4

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Specifies if the attributes in this schema should be hidden externally
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    Indicates if the attribute is scim compliant, default is true
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies whether this attribute can be included in a search filter
  • Allowed Values: [ "encrypt", "hash", "none" ]
    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Flag to specify if the attribute should be encrypted or hashed
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Target attribute name that this attribute gets mapped to for persistence
  • Added In: 19.2.1

    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Old Target attribute name from child table for CSVA attribute prior to migration. This maintains this attribute used to get mapped to for persistence
  • Added In: 19.2.1

    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Target normalized attribute name that this normalized value of attribute gets mapped to for persistence. Only set for caseExact=false & searchable attributes. Do not use by default.
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Target index name created for this attribute for performance
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the mapper to use when mapping this attribute value to DataProvider-specific semantics
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Trims any leading and trailing blanks from String values. Default is True.
  • Added In: 17.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    Metadata used by IDCS UI to sequence the attributes displayed on the Account Form.
  • Added In: 17.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Metadata used by IDCS UI to validate the attribute values using regular expressions.
  • Added In: 17.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Metadata used by IDCS UI to decide whether the attribute must be displayed on the Account Form.
  • Allowed Values: [ "inputtext", "checkbox", "textarea", "combobox" ]
    Added In: 17.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Metadata used by IDCS UI to render a widget for this attribute on the Account Form.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Validate payload reference value during create, replace, and update. Default is True.
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies whether the value of the Resource attribute is persisted
  • Added In: 18.2.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    If true, ARM should not validate the value of the attribute since it will be converted/migrated to another attribute internally by the manager which will build valid post, put, or patch payload, depending on the client requested operation
  • SCIM++ Properties:
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    A collection of Localized canonical values.
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    Attribute's localized display name
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Indicates the attribute's plurality
  • Allowed Values: [ "readOnly", "readWrite", "immutable", "writeOnly" ]
    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies if the attribute is mutable
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Attribute's name
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The names of the Resource types that may be referenced--for example, User. This is only applicable for attributes that are of the \"reference\" data type.
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies if the attribute is required
  • Allowed Values: [ "always", "never", "default", "request" ]
    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    A single keyword that indicates when an attribute and associated values are returned in response to a GET request or in response to a PUT, POST, or PATCH request
  • SCIM++ Properties:
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    A list specifying the contained attributes
  • Allowed Values: [ "string", "complex", "boolean", "decimal", "integer", "dateTime", "reference", "binary" ]
    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The attribute's data type--for example, String
  • Allowed Values: [ "none", "server", "global" ]
    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    A single keyword value that specifies how the Service Provider enforces uniqueness of attribute values. A server MAY reject an invalid value based on uniqueness by returning an HTTP response code of 400 (Bad Request). A client MAY enforce uniqueness on the client side to a greater degree than the Service Provider enforces. For example, a client could make a value unique while the server has the uniqueness of \"none\".
Back to Top

Response

Supported Media Types

200 Response

The request was successful.
Body ()
Root Schema : Schema
Type: object
SCIM schema
Show Source
  • attributes
    SCIM++ Properties:
    • idcsCompositeKey: []
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    A complex type that specifies the set of Resource attributes
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Schema's human-readable description
  • 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.
  • Added In: 17.3.4

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies whether the attribute is cacheable. True by default for all attributes. If attribute with idcsAttributeCachable = false, is present \"attributesToGet\" while executing GET/SEARCH on cacheable resource, Cache is missed and data is fetched from Data Provider.
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: boolean
    • uniqueness: none
    Specifies if the attributes in this schema can be used for mapping with external identity sources such as AD or LDAP
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Resource types defs this resource refers to
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Schema's human-readable name
Nested Schema : attributes
Type: array
SCIM++ Properties:
  • idcsCompositeKey: []
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
A complex type that specifies the set of Resource attributes
Show Source
Nested Schema : attributes
Type: object
A complex type that specifies the set of Resource attributes
Show Source
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    A collection of canonical values. Applicable Service Providers MUST specify the canonical types specified in the core schema specification--for example, \"work\", \"home\".
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies if the String attribute is case-sensitive
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The attribute's human-readable description
  • Added In: 17.3.4

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Indicates that the schema has been added since this release number
  • Deprecated Since: 19.3.3

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    Indicates that the schema has been added since version
  • Added In: 17.3.4

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies whether the attribute is cacheable. True by default for all attributes. If attribute with idcsAttributeCachable = false, is present \"attributesToGet\" while executing GET/SEARCH on cacheable resource, Cache is missed and data is fetched from Data Provider.
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    Specifies if the attribute can be used for mapping with external identity sources such as AD or LDAP. If isSchemaMappable: false for the schema in which this attribute is defined, then this flag is ignored
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies whether changes to this attribute value are audited
  • Maximum Length: 8
    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Sequence tracking ID name for the attribute
  • Added In: 17.4.6

    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Display name for the canonical value attribute name.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Filter to use when getting canonical values for this schema attribute
  • Added In: 17.4.6

    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Source key attribute for the canonical value.
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the Resource type to read from for dynamic canonical values
  • Added In: 17.4.6

    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the Resource type ID to read from for dynamic canonical values
  • Allowed Values: [ "dynamic", "static" ]
    Added In: 17.4.6

    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Type of the canonical value.
  • SCIM++ Properties:
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    Specifies the mapping between external identity source attributes and IDCS complex attributes (e.g. email => emails[work].value)
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The set of one or more sub attributes' names of a CMVA, whose values uniquely identify an instance of a CMVA
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The attribute defining the CSV header name for import/export
  • SCIM++ Properties:
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    Csv meta data for those resource type attributes which can be imported / exported from / to csv.
  • Added In: 18.1.6

    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the default value for an attribute. The value must be one from canonicalValues if defined.
  • Added In: 17.3.4

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Indicates that the schema has been deprecated since this release number
  • Deprecated Since: 19.3.3

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    Indicates that the schema has been deprecated since version
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the user-friendly displayable attribute name or catalog key used for localization
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Localized schema attribute display name for use by UI client for displaying attribute labels
  • Allowed Values: [ "optionalPii", "mfa", "social", "schemaCustomization" ]
    Deprecated Since: 19.1.6

    SCIM++ Properties:
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    The list of features that require this attribute
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Whether the CMVA attribute will be fetched or not for current resource in AbstractResourceManager update operation before calling data provider update. Default is true.
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the mapper to use when mapping this attribute value from DataProvider-specific semantics
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies whether this attribute value was generated
  • Allowed Values: [ "string", "long", "char", "double", "float", "integer", "boolean", "bytes", "bigdecimal", "biginteger", "guardedbytes", "guardedstring" ]
    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Maps to ICF data type
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Maps to ICF target attribute name
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Metadata to identify the ICF required attribute
  • SCIM++ Properties:
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Specifies the indirectly referenced Resources
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies whether the schema attribute is for internal use only. Internal attributes are not exposed via REST. This attribute overrides mutability for create/update if the request is internal and the attribute internalflag is set to True. This attribute overrides the return attribute while building SCIM response attributes when both the request is internal and the schema attribute is internal.
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    Specifies the maximum length of the attribute
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: integer
    Specifies the maximum value of the integer attribute
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    Specifies the minimum length of the attribute
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: integer
    Specifies the minimum value of the integer attribute
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    If true, specifies that the attribute can have multiple language values set for the attribute on which this is set.
  • Deprecated Since: 19.1.6

    SCIM++ Properties:
    • caseExact: true
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    A subset of \"canonicalValues\" that are not supported when the \"optionalPii\" feature is disabled in GlobalConfig.
  • Added In: 18.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    Specifies whether the attribute is PII (personal information). False by default for all attributes. If attribute with idcsPii = true, it's value must be obfuscated before it's written to the IDCS system logs.
  • Deprecated Since: 17.3.4

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Specifies the referenced Resource attribute
  • SCIM++ Properties:
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Specifies the directly referenced Resources
  • Added In: 19.1.4

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Specifies if the attributes in this schema should be hidden externally
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    Indicates if the attribute is scim compliant, default is true
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies whether this attribute can be included in a search filter
  • Allowed Values: [ "encrypt", "hash", "none" ]
    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Flag to specify if the attribute should be encrypted or hashed
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Target attribute name that this attribute gets mapped to for persistence
  • Added In: 19.2.1

    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Old Target attribute name from child table for CSVA attribute prior to migration. This maintains this attribute used to get mapped to for persistence
  • Added In: 19.2.1

    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Target normalized attribute name that this normalized value of attribute gets mapped to for persistence. Only set for caseExact=false & searchable attributes. Do not use by default.
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Target index name created for this attribute for performance
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the mapper to use when mapping this attribute value to DataProvider-specific semantics
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Trims any leading and trailing blanks from String values. Default is True.
  • Added In: 17.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    Metadata used by IDCS UI to sequence the attributes displayed on the Account Form.
  • Added In: 17.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Metadata used by IDCS UI to validate the attribute values using regular expressions.
  • Added In: 17.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Metadata used by IDCS UI to decide whether the attribute must be displayed on the Account Form.
  • Allowed Values: [ "inputtext", "checkbox", "textarea", "combobox" ]
    Added In: 17.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Metadata used by IDCS UI to render a widget for this attribute on the Account Form.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Validate payload reference value during create, replace, and update. Default is True.
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies whether the value of the Resource attribute is persisted
  • Added In: 18.2.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    If true, ARM should not validate the value of the attribute since it will be converted/migrated to another attribute internally by the manager which will build valid post, put, or patch payload, depending on the client requested operation
  • SCIM++ Properties:
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    A collection of Localized canonical values.
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    Attribute's localized display name
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Indicates the attribute's plurality
  • Allowed Values: [ "readOnly", "readWrite", "immutable", "writeOnly" ]
    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies if the attribute is mutable
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Attribute's name
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The names of the Resource types that may be referenced--for example, User. This is only applicable for attributes that are of the \"reference\" data type.
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies if the attribute is required
  • Allowed Values: [ "always", "never", "default", "request" ]
    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    A single keyword that indicates when an attribute and associated values are returned in response to a GET request or in response to a PUT, POST, or PATCH request
  • SCIM++ Properties:
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    A list specifying the contained attributes
  • Allowed Values: [ "string", "complex", "boolean", "decimal", "integer", "dateTime", "reference", "binary" ]
    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The attribute's data type--for example, String
  • Allowed Values: [ "none", "server", "global" ]
    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    A single keyword value that specifies how the Service Provider enforces uniqueness of attribute values. A server MAY reject an invalid value based on uniqueness by returning an HTTP response code of 400 (Bad Request). A client MAY enforce uniqueness on the client side to a greater degree than the Service Provider enforces. For example, a client could make a value unique while the server has the uniqueness of \"none\".

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 could not be 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 all of the values for an existing schema by submitting a PUT 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 PUT
-H "Content-Type:application/scim+json"
-H "Authorization: Bearer <Access Token Value>"
https://tenant-base-url/admin/v1/Schemas/<ID>

Example of Request Body

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

{
    "name": "CustomUser",
    "description": "Custom User",
    "id": "urn:ietf:params:scim:schemas:idcs:extension:custom:User",
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Schema"
    ],
    "idcsResourceTypes": ["User"],
    "attributes": [
        {
            "name": "displayName",
            "idcsDisplayName": "displayName4",
            "description": "Display Name",
            "required": false,
            "type": "string",
            "idcsMinLength": 1,
            "idcsMaxLength": 1000,
            "idcsAuditable": true,
            "caseExact": true,
            "returned": "default",
            "idcsSearchable": true,
            "multiValued": false,
            "idcsICFBundleAttributeName": "Display Name",
            "idcsICFAttributeType": "string",
            "idcsICFRequired": false
        },
        {
            "name": "nickName",
            "idcsDisplayName": "nickName",
            "description": "Nick Name",
            "required": false,
            "type": "string",
            "idcsMinLength": 1,
            "idcsMaxLength": 1000,
            "idcsAuditable": true,
            "caseExact": true,
            "returned": "default",
            "idcsSearchable": true,
            "multiValued": false,
            "idcsICFBundleAttributeName": "Nick Name",
            "idcsICFAttributeType": "string",
            "idcsICFRequired": false
        },
        {
            "name": "nationality",
            "idcsDisplayName": "nationality",
            "description": "nationality",
            "required": true,
            "type": "string",
            "idcsMinLength": 1,
            "idcsMaxLength": 20,
            "idcsAuditable": true,
            "returned": "default",
            "idcsSearchable": true,
            "multiValued": false,
            "idcsICFBundleAttributeName": "Display Name",
            "idcsICFAttributeType": "string",
            "idcsICFRequired": false
        },        
        {
            "name": "email",
            "idcsDisplayName": "email4",
            "description": "Email",
            "required": false,
            "type": "string",
            "idcsMinLength": 1,
            "idcsMaxLength": 80,
            "returned": "default",
            "idcsValuePersisted": false,
            "multiValued": true,
            "idcsICFBundleAttributeName": "Email",
            "idcsICFAttributeType": "string",
            "idcsICFRequired": true
        },
        {
            "name": "deptcode",
            "idcsDisplayName": "deptCode",
            "description": "Dept code",
            "required": false,
            "type": "integer",
            "idcsAuditable": true,
            "returned": "default",
            "multiValued": false
        },
        {
            "name": "picture",
            "idcsDisplayName": "picture",
            "description": "picture jpg",
            "required": false,
            "type": "binary",
            "idcsAuditable": true,
            "idcsValuePersisted": true,
            "returned": "default",
            "multiValued": false,
            "idcsICFBundleAttributeName": "Display Name",
            "idcsICFAttributeType": "string",
            "idcsICFRequired": false
        },
        {
            "name": "salary",
            "idcsDisplayName": "salary",
            "description": "salary details",
            "required": false,
            "type": "decimal",
            "idcsAuditable": true,
            "returned": "default",
            "multiValued": false
        },
        {
            "name": "weight",
            "idcsDisplayName": "weight",
            "description": "weight details",
            "required": false,
            "type": "decimal",
            "idcsValuePersisted": false,
            "idcsAuditable": true,
            "returned": "default",
            "multiValued": false
        },
        {
            "name": "dateHired",
            "idcsDisplayName": "dateHired",
            "description": "date hired",
            "required": false,
            "type": "dateTime",
            "idcsSearchable": true,
            "idcsAuditable": true,
            "returned": "default",
            "multiValued": false
        }
    ]
}

Example of Response Body

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

{
    "name": "CustomUser",
    "description": "Custom User",
    "id": "urn:ietf:params:scim:schemas:idcs:extension:custom:User",
    "idcsResourceTypes": [
        "User"
    ],
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Schema"
    ],
    "attributes": [
        {
            "name": "displayName",
            "idcsDisplayName": "displayName4",
            "description": "Display Name",
            "required": false,
            "type": "string",
            "idcsMinLength": 1,
            "idcsMaxLength": 1000,
            "idcsAuditable": true,
            "caseExact": true,
            "returned": "default",
            "idcsSearchable": true,
            "multiValued": false,
            "idcsICFBundleAttributeName": "Display Name",
            "idcsICFAttributeType": "string",
            "idcsICFRequired": false,
            "uniqueness": "none",
            "idcsValuePersisted": true,
            "idcsTargetAttributeName": "I_VC_4K_IFLEX_1"
        },
        {
            "name": "nickName",
            "idcsDisplayName": "nickName",
            "description": "Nick Name",
            "required": false,
            "type": "string",
            "idcsMinLength": 1,
            "idcsMaxLength": 1000,
            "idcsAuditable": true,
            "caseExact": true,
            "returned": "default",
            "idcsSearchable": true,
            "multiValued": false,
            "idcsICFBundleAttributeName": "Nick Name",
            "idcsICFAttributeType": "string",
            "idcsICFRequired": false,
            "uniqueness": "none",
            "idcsValuePersisted": true,
            "idcsTargetAttributeName": "I_VC_4K_IFLEX_2"
        },
        {
            "name": "nationality",
            "idcsDisplayName": "nationality",
            "description": "nationality",
            "required": true,
            "type": "string",
            "idcsMinLength": 1,
            "idcsMaxLength": 20,
            "idcsAuditable": true,
            "returned": "default",
            "idcsSearchable": true,
            "multiValued": false,
            "idcsICFBundleAttributeName": "Display Name",
            "idcsICFAttributeType": "string",
            "idcsICFRequired": false,
            "uniqueness": "none",
            "idcsValuePersisted": true,
            "idcsTargetAttributeName": "I_VC_40_IFLEX_1"
        },
        {
            "name": "email",
            "idcsDisplayName": "email4",
            "description": "Email",
            "required": false,
            "type": "string",
            "idcsMinLength": 1,
            "idcsMaxLength": 80,
            "returned": "default",
            "idcsValuePersisted": false,
            "multiValued": true,
            "idcsICFBundleAttributeName": "Email",
            "idcsICFAttributeType": "string",
            "idcsICFRequired": true,
            "uniqueness": "none",
            "idcsSearchable": true
        },
        {
            "name": "deptcode",
            "idcsDisplayName": "deptCode",
            "description": "Dept code",
            "required": false,
            "type": "integer",
            "idcsAuditable": true,
            "returned": "default",
            "multiValued": false,
            "uniqueness": "none",
            "idcsSearchable": true,
            "idcsValuePersisted": true,
            "idcsTargetAttributeName": "I_IN_IFLEX_1"
        },
        {
            "name": "picture",
            "idcsDisplayName": "picture",
            "description": "picture jpg",
            "required": false,
            "type": "binary",
            "idcsAuditable": true,
            "idcsValuePersisted": true,
            "returned": "default",
            "multiValued": false,
            "idcsICFBundleAttributeName": "Display Name",
            "idcsICFAttributeType": "string",
            "idcsICFRequired": false,
            "uniqueness": "none",
            "idcsSearchable": true,
            "idcsTargetAttributeName": "U_BB_IFLEX_1"
        },
        {
            "name": "salary",
            "idcsDisplayName": "salary",
            "description": "salary details",
            "required": false,
            "type": "decimal",
            "idcsAuditable": true,
            "returned": "default",
            "multiValued": false,
            "uniqueness": "none",
            "idcsSearchable": true,
            "idcsValuePersisted": true,
            "idcsTargetAttributeName": "I_IN_IFLEX_2"
        },
        {
            "name": "weight",
            "idcsDisplayName": "weight",
            "description": "weight details",
            "required": false,
            "type": "decimal",
            "idcsValuePersisted": false,
            "idcsAuditable": true,
            "returned": "default",
            "multiValued": false,
            "uniqueness": "none",
            "idcsSearchable": true
        },
        {
            "name": "dateHired",
            "idcsDisplayName": "dateHired",
            "description": "date hired",
            "required": false,
            "type": "dateTime",
            "idcsSearchable": true,
            "idcsAuditable": true,
            "returned": "default",
            "multiValued": false,
            "uniqueness": "none",
            "idcsValuePersisted": true,
            "idcsTargetAttributeName": "I_DT_IFLEX_1"
        }
    ],
    "meta": {
        "lastModified": "2017-07-28T17:25:07.153Z",
        "resourceType": "/Schemas",
        "created": "2017-07-27T23:13:21.246Z",
        "location": "https://tenant-base-url/admin/v1/Schemas/urn:ietf:params:scim:schemas:idcs:extension:custom:User"
    },
    "idcsLastModifiedBy": {
        "type": "App",
        "display": "admin",
        "$ref": "https://tenant-base-url/admin/v1/Apps"
    },
    "idcsCreatedBy": {
        "value": "0625f1f18db543308c9e61fbc7cb8ee7",
        "type": "App",
        "display": "idcssm",
        "$ref": "https://tenant-base-url/admin/v1/Apps/0625f1f18db543308c9e61fbc7cb8ee7"
    }
}
Back to Top