Skip to main content

Creates a new Schema on the specified Source in IdentityNow.

Creates a new Schema on the specified Source in IdentityNow.

Path Parameters
  • sourceId string required

    The Source id.

    Example: 2c9180835d191a86015d28455b4a2329
Request Body required
  • id string

    The id of the Schema.

  • name string

    The name of the Schema.

  • nativeObjectType string

    The name of the object type on the native system that the schema represents.

  • identityAttribute string

    The name of the attribute used to calculate the unique identifier for an object in the schema.

  • displayAttribute string

    The name of the attribute used to calculate the display value for an object in the schema.

  • hierarchyAttribute string

    The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas.

  • includePermissions boolean

    Flag indicating whether or not the include permissions with the object data when aggregating the schema.

  • features string[]

    Possible values: [AUTHENTICATE, COMPOSITE, DIRECT_PERMISSIONS, DISCOVER_SCHEMA, ENABLE, MANAGER_LOOKUP, NO_RANDOM_ACCESS, PROXY, SEARCH, TEMPLATE, UNLOCK, UNSTRUCTURED_TARGETS, SHAREPOINT_TARGET, PROVISIONING, GROUP_PROVISIONING, SYNC_PROVISIONING, PASSWORD, CURRENT_PASSWORD, ACCOUNT_ONLY_REQUEST, ADDITIONAL_ACCOUNT_REQUEST, NO_AGGREGATION, GROUPS_HAVE_MEMBERS, NO_PERMISSIONS_PROVISIONING, NO_GROUP_PERMISSIONS_PROVISIONING, NO_UNSTRUCTURED_TARGETS_PROVISIONING, NO_DIRECT_PERMISSIONS_PROVISIONING]

    The features that the schema supports.

  • configuration object

    Holds any extra configuration data that the schema may require.

  • attributes object[]

    The attribute definitions which form the schema.

  • name string

    The name of the attribute.

  • type string

    Possible values: [STRING, LONG, INT, BOOLEAN]

    The underlying type of the value which an AttributeDefinition represents.

  • schema object

    A reference to the schema on the source to the attribute values map to.

  • type string

    Possible values: [CONNECTOR_SCHEMA]

    The type of object being referenced

  • id string

    The object ID this reference applies to.

  • name string

    The human-readable display name of the object.

  • description string

    A human-readable description of the attribute.

  • isMulti boolean

    Flag indicating whether or not the attribute is multi-valued.

  • isEntitlement boolean

    Flag indicating whether or not the attribute is an entitlement.

  • isGroup boolean

    Flag indicating whether or not the attribute represents a group. This can only be true if isEntitlement is also true and there is a schema defined for the attribute..

  • created date-time

    The date the Schema was created.

  • modified date-time

    The date the Schema was last modified.

Responses

The Schema was successfully created on the specified Source.


Schema
  • id string

    The id of the Schema.

  • name string

    The name of the Schema.

  • nativeObjectType string

    The name of the object type on the native system that the schema represents.

  • identityAttribute string

    The name of the attribute used to calculate the unique identifier for an object in the schema.

  • displayAttribute string

    The name of the attribute used to calculate the display value for an object in the schema.

  • hierarchyAttribute string

    The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas.

  • includePermissions boolean

    Flag indicating whether or not the include permissions with the object data when aggregating the schema.

  • features string[]

    Possible values: [AUTHENTICATE, COMPOSITE, DIRECT_PERMISSIONS, DISCOVER_SCHEMA, ENABLE, MANAGER_LOOKUP, NO_RANDOM_ACCESS, PROXY, SEARCH, TEMPLATE, UNLOCK, UNSTRUCTURED_TARGETS, SHAREPOINT_TARGET, PROVISIONING, GROUP_PROVISIONING, SYNC_PROVISIONING, PASSWORD, CURRENT_PASSWORD, ACCOUNT_ONLY_REQUEST, ADDITIONAL_ACCOUNT_REQUEST, NO_AGGREGATION, GROUPS_HAVE_MEMBERS, NO_PERMISSIONS_PROVISIONING, NO_GROUP_PERMISSIONS_PROVISIONING, NO_UNSTRUCTURED_TARGETS_PROVISIONING, NO_DIRECT_PERMISSIONS_PROVISIONING]

    The features that the schema supports.

  • configuration object

    Holds any extra configuration data that the schema may require.

  • attributes object[]

    The attribute definitions which form the schema.

  • name string

    The name of the attribute.

  • type string

    Possible values: [STRING, LONG, INT, BOOLEAN]

    The underlying type of the value which an AttributeDefinition represents.

  • schema object

    A reference to the schema on the source to the attribute values map to.

  • type string

    Possible values: [CONNECTOR_SCHEMA]

    The type of object being referenced

  • id string

    The object ID this reference applies to.

  • name string

    The human-readable display name of the object.

  • description string

    A human-readable description of the attribute.

  • isMulti boolean

    Flag indicating whether or not the attribute is multi-valued.

  • isEntitlement boolean

    Flag indicating whether or not the attribute is an entitlement.

  • isGroup boolean

    Flag indicating whether or not the attribute represents a group. This can only be true if isEntitlement is also true and there is a schema defined for the attribute..

  • created date-time

    The date the Schema was created.

  • modified date-time

    The date the Schema was last modified.

Loading...