Skip to main content

Uploads source accounts schema template

POST 

/sources/:id/schemas/accounts

This API uploads a source schema template file to configure a source's account attributes.

To retrieve the file to modify and upload, log into Identity Now.

Click Admin -> Connections -> Sources -> {SourceName} -> Import Data -> Account Schema -> Options -> Download Schema

NOTE: This API is designated only for Delimited File sources.

Request

Path Parameters

    id stringrequired

    The Source id

    Example: 8c190e6787aa4ed9a90bd9d5344523fb

Body

required
    file binary

Responses

Successfully uploaded the file

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 SourceFeature[]

    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, PREFER_UUID]

    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.

  • Array [
  • name string

    The name of the attribute.

    type AttributeDefinitionType

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

    The type of the attribute.

    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

    Default value: false

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

    isEntitlement boolean

    Default value: false

    Flag indicating whether or not the attribute is an entitlement.

    isGroup boolean

    Default value: false

    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...