Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Schema

SCIM schema

Properties

Optional attributes

attributes: Array<SchemaAttributes>

A complex type that specifies the set of Resource attributes

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

Optional description

description: undefined | string

Schema's human-readable description

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

Optional externalId

externalId: undefined | string

An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.

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

Optional idcsAttributeCacheable

idcsAttributeCacheable: undefined | false | true

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.

*Added In:** 17.3.4

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

idcsMappable

idcsMappable: boolean

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: false - mutability: readOnly - required: true - returned: default - type: boolean - uniqueness: none

Optional idcsMapsToSameTargetAttributeNameAs

idcsMapsToSameTargetAttributeNameAs: undefined | string

Contains the canonical name of the other attribute sharing the same idcsTargetAttributeName

*Added In:** 2209122038

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

Optional idcsOverrideCommonAttribute

idcsOverrideCommonAttribute: undefined | false | true

Specifies whether the dataprovider mapping from resource schema should override from common schema with the same name.

*Added In:** 2102181953

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

Optional idcsResourceTypes

idcsResourceTypes: Array<string>

Resource types defs this resource refers to

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

Optional name

name: undefined | string

Schema's human-readable name

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

schemas

schemas: Array<string>

REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.

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

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Schema): object

getJsonObj

  • getJsonObj(obj: Schema): object