Update Source Schema (Full)
PUT/sources/:sourceId/schemas/:schemaId
This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below.
- id
- name
- created
- modified
Any attempt to modify these fields will result in an error response with a status code of 400.
id
must remain in the request body, but it cannot be changed. Ifid
is omitted from the request body, the result will be a 400 error.
Request
Path Parameters
The Source id.
The Schema id.
- application/json
Body
required
- AUTHENTICATE: The source supports pass-through authentication.
- COMPOSITE: The source supports composite source creation.
- DIRECT_PERMISSIONS: The source supports returning DirectPermissions.
- DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.
- ENABLE The source supports reading if an account is enabled or disabled.
- MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.
- NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.
- PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.
- SEARCH
- TEMPLATE
- UNLOCK: The source supports reading if an account is locked or unlocked.
- UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.
- SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.
- PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.
- GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.
- SYNC_PROVISIONING: The source can provision accounts synchronously.
- PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.
- CURRENT_PASSWORD: Some source types support verification of the current password
- ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.
- ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.
- NO_AGGREGATION: A source that does not support aggregation.
- GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.
- NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.
- NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.
- NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.
- NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.
- USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure.
- PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning.
- ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM
- ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM
- ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM
Array [
]
The id of the Schema.
The name of the Schema.
The name of the object type on the native system that the schema represents.
The name of the attribute used to calculate the unique identifier for an object in the schema.
The name of the attribute used to calculate the display value for an object in the schema.
The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas.
Flag indicating whether or not the include permissions with the object data when aggregating the schema.
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
, ARM_SECURITY_EXTRACT
, ARM_UTILIZATION_EXTRACT
, ARM_CHANGELOG_EXTRACT
, USES_UUID
]
Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors.
Holds any extra configuration data that the schema may require.
attributes
object[]
The attribute definitions which form the schema.
The name of the attribute.
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.
Possible values: [CONNECTOR_SCHEMA
]
The type of object being referenced
The object ID this reference applies to.
The human-readable display name of the object.
A human-readable description of the attribute.
Flag indicating whether or not the attribute is multi-valued.
Flag indicating whether or not the attribute is an entitlement.
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..
The date the Schema was created.
The date the Schema was last modified.
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 500
The Schema was successfully replaced.
- application/json
- Schema
- Example (from schema)
Schema
- AUTHENTICATE: The source supports pass-through authentication.
- COMPOSITE: The source supports composite source creation.
- DIRECT_PERMISSIONS: The source supports returning DirectPermissions.
- DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.
- ENABLE The source supports reading if an account is enabled or disabled.
- MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.
- NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.
- PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.
- SEARCH
- TEMPLATE
- UNLOCK: The source supports reading if an account is locked or unlocked.
- UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.
- SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.
- PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.
- GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.
- SYNC_PROVISIONING: The source can provision accounts synchronously.
- PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.
- CURRENT_PASSWORD: Some source types support verification of the current password
- ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.
- ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.
- NO_AGGREGATION: A source that does not support aggregation.
- GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.
- NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.
- NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.
- NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.
- NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.
- USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure.
- PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning.
- ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM
- ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM
- ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM
Array [
]
The id of the Schema.
The name of the Schema.
The name of the object type on the native system that the schema represents.
The name of the attribute used to calculate the unique identifier for an object in the schema.
The name of the attribute used to calculate the display value for an object in the schema.
The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas.
Flag indicating whether or not the include permissions with the object data when aggregating the schema.
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
, ARM_SECURITY_EXTRACT
, ARM_UTILIZATION_EXTRACT
, ARM_CHANGELOG_EXTRACT
, USES_UUID
]
Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors.
Holds any extra configuration data that the schema may require.
attributes
object[]
The attribute definitions which form the schema.
The name of the attribute.
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.
Possible values: [CONNECTOR_SCHEMA
]
The type of object being referenced
The object ID this reference applies to.
The human-readable display name of the object.
A human-readable description of the attribute.
Flag indicating whether or not the attribute is multi-valued.
Flag indicating whether or not the attribute is an entitlement.
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..
The date the Schema was created.
The date the Schema was last modified.
{
"id": "2c9180835d191a86015d28455b4a2329",
"name": "account",
"nativeObjectType": "User",
"identityAttribute": "sAMAccountName",
"displayAttribute": "distinguishedName",
"hierarchyAttribute": "memberOf",
"includePermissions": false,
"features": [
"PROVISIONING",
"NO_PERMISSIONS_PROVISIONING",
"GROUPS_HAVE_MEMBERS"
],
"configuration": {
"groupMemberAttribute": "member"
},
"attributes": [
{
"name": "sAMAccountName",
"type": "STRING",
"isMultiValued": false,
"isEntitlement": false,
"isGroup": false
},
{
"name": "memberOf",
"type": "STRING",
"schema": {
"type": "CONNECTOR_SCHEMA",
"id": "2c9180887671ff8c01767b4671fc7d60",
"name": "group"
},
"description": "Group membership",
"isMultiValued": true,
"isEntitlement": true,
"isGroup": true
}
],
"created": "2019-12-24T22:32:58.104Z",
"modified": "2019-12-31T20:22:28.104Z"
}
Client Error - Returned if the request body is invalid.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
causes
object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
{
"detailCode": "400.1 Bad Request Content",
"trackingId": "e7eab60924f64aa284175b9fa3309599",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
],
"causes": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
]
}
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
{
"error": "JWT validation failed: JWT is expired"
}
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
- application/json
- Schema
- Example (from schema)
- 403
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
causes
object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
{
"detailCode": "400.1 Bad Request Content",
"trackingId": "e7eab60924f64aa284175b9fa3309599",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
],
"causes": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
]
}
An example of a 403 response object
{
"detailCode": "403 Forbidden",
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The server understood the request but refuses to authorize it."
}
]
}
Not Found - returned if the request URL refers to a resource or object that does not exist
- application/json
- Schema
- Example (from schema)
- 404
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
causes
object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
{
"detailCode": "400.1 Bad Request Content",
"trackingId": "e7eab60924f64aa284175b9fa3309599",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
],
"causes": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
]
}
An example of a 404 response object
{
"detailCode": "404 Not found",
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The server did not find a current representation for the target resource."
}
]
}
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
{
"message": " Rate Limit Exceeded "
}
Internal Server Error - Returned if there is an unexpected error.
- application/json
- Schema
- Example (from schema)
- 500
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
causes
object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
{
"detailCode": "400.1 Bad Request Content",
"trackingId": "e7eab60924f64aa284175b9fa3309599",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
],
"causes": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
]
}
An example of a 500 response object
{
"detailCode": "500.0 Internal Fault",
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "An internal fault occurred."
}
]
}