Update Source (Full)
PUT/sources/:id
This API updates a source in IdentityNow, using a full object representation. In other words, the existing Source configuration is completely replaced.
Some fields are immutable and cannot be changed, such as:
- id
- type
- authoritative
- connector
- connectorClass
- passwordPolicies
Attempts to modify these fields will result in a 400 error.
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
Request
Path Parameters
The Source id
- application/json
Body
required
- Array [
- ]
- Array [
- ]
- 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
Human-readable name of the source
Human-readable description of the source
owner objectrequired
Reference to an owning Identity Object
Possible values: [IDENTITY
]
The type of object being referenced
ID of the identity
Human-readable display name of the identity
cluster objectnullable
Reference to the associated Cluster
Possible values: [CLUSTER
]
The type of object being referenced
ID of the cluster
Human-readable display name of the cluster
accountCorrelationConfig objectnullable
Reference to an Account Correlation Config object
Possible values: [ACCOUNT_CORRELATION_CONFIG
]
The type of object being referenced
ID of the account correlation config
Human-readable display name of the account correlation config
accountCorrelationRule objectnullable
Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used.
Possible values: [RULE
]
The type of object being referenced
ID of the rule
Human-readable display name of the rule
managerCorrelationMapping object
Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity
Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity.
Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute.
managerCorrelationRule objectnullable
Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient.
Possible values: [RULE
]
The type of object being referenced
ID of the rule
Human-readable display name of the rule
beforeProvisioningRule objectnullable
Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.
Possible values: [RULE
]
The type of object being referenced
ID of the rule
Human-readable display name of the rule
schemas object[]
List of references to Schema objects
Possible values: [CONNECTOR_SCHEMA
]
The type of object being referenced
ID of the schema
Human-readable display name of the schema
passwordPolicies object[]nullable
List of references to the associated PasswordPolicy objects.
Possible values: [PASSWORD_POLICY
]
The type of object being referenced
ID of the policy
Human-readable display name of the policy
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.
Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the provisionasCsv
query parameter to true
.
Connector script name.
The fully qualified name of the Java class that implements the connector interface.
Connector specific configuration; will differ from type to type.
Number from 0 to 100 that specifies when to skip the delete phase.
Default value: false
When true indicates the source is referenced by an IdentityProfile.
managementWorkgroup objectnullable
Reference to Management Workgroup for this Source
Possible values: [GOVERNANCE_GROUP
]
The type of object being referenced
ID of the management workgroup
Human-readable display name of the management workgroup
Default value: false
When true indicates a healthy source
A status identifier, giving specific information on why a source is healthy or not
Timestamp showing when a source health check was last performed
The id of connector
The name of the connector that was chosen on source creation
The type of connection (direct or file)
The connector implementation id
The date-time when the source was created
The date-time when the source was last modified
Default value: false
Enables credential provider for this source. If credentialProvider is turned on then source can use credential provider(s) to fetch credentials.
The category of source (e.g. null, CredentialProvider)
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 500
Updated Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
- 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
the id of the Source
Human-readable name of the source
Human-readable description of the source
owner objectrequired
Reference to an owning Identity Object
Possible values: [IDENTITY
]
The type of object being referenced
ID of the identity
Human-readable display name of the identity
cluster objectnullable
Reference to the associated Cluster
Possible values: [CLUSTER
]
The type of object being referenced
ID of the cluster
Human-readable display name of the cluster
accountCorrelationConfig objectnullable
Reference to an Account Correlation Config object
Possible values: [ACCOUNT_CORRELATION_CONFIG
]
The type of object being referenced
ID of the account correlation config
Human-readable display name of the account correlation config
accountCorrelationRule objectnullable
Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used.
Possible values: [RULE
]
The type of object being referenced
ID of the rule
Human-readable display name of the rule
managerCorrelationMapping object
Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity
Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity.
Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute.
managerCorrelationRule objectnullable
Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient.
Possible values: [RULE
]
The type of object being referenced
ID of the rule
Human-readable display name of the rule
beforeProvisioningRule objectnullable
Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.
Possible values: [RULE
]
The type of object being referenced
ID of the rule
Human-readable display name of the rule
schemas object[]
List of references to Schema objects
Possible values: [CONNECTOR_SCHEMA
]
The type of object being referenced
ID of the schema
Human-readable display name of the schema
passwordPolicies object[]nullable
List of references to the associated PasswordPolicy objects.
Possible values: [PASSWORD_POLICY
]
The type of object being referenced
ID of the policy
Human-readable display name of the policy
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.
Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the provisionasCsv
query parameter to true
.
Connector script name.
The fully qualified name of the Java class that implements the connector interface.
Connector specific configuration; will differ from type to type.
Number from 0 to 100 that specifies when to skip the delete phase.
Default value: false
When true indicates the source is referenced by an IdentityProfile.
managementWorkgroup objectnullable
Reference to Management Workgroup for this Source
Possible values: [GOVERNANCE_GROUP
]
The type of object being referenced
ID of the management workgroup
Human-readable display name of the management workgroup
Default value: false
When true indicates a healthy source
A status identifier, giving specific information on why a source is healthy or not
Timestamp showing when a source health check was last performed
The id of connector
The name of the connector that was chosen on source creation
The type of connection (direct or file)
The connector implementation id
The date-time when the source was created
The date-time when the source was last modified
Default value: false
Enables credential provider for this source. If credentialProvider is turned on then source can use credential provider(s) to fetch credentials.
The category of source (e.g. null, CredentialProvider)
{
"id": "2c91808568c529c60168cca6f90c1324",
"name": "My Source",
"description": "This is the corporate directory.",
"owner": {
"type": "IDENTITY",
"id": "2c91808568c529c60168cca6f90c1313",
"name": "MyName"
},
"cluster": {
"type": "CLUSTER",
"id": "2c9180866166b5b0016167c32ef31a66",
"name": "Corporate Cluster"
},
"accountCorrelationConfig": {
"type": "ACCOUNT_CORRELATION_CONFIG",
"id": "2c9180855d191c59015d28583727245a",
"name": "Directory [source-62867] Account Correlation"
},
"accountCorrelationRule": {
"type": "RULE",
"id": "2c918085708c274401708c2a8a760001",
"name": "Example Rule"
},
"managerCorrelationMapping": {
"accountAttributeName": "manager",
"identityAttributeName": "manager"
},
"managerCorrelationRule": {
"type": "RULE",
"id": "2c918085708c274401708c2a8a760001",
"name": "Example Rule"
},
"beforeProvisioningRule": {
"type": "RULE",
"id": "2c918085708c274401708c2a8a760001",
"name": "Example Rule"
},
"schemas": [
{
"type": "CONNECTOR_SCHEMA",
"id": "2c9180835d191a86015d28455b4b232a",
"name": "account"
},
{
"type": "CONNECTOR_SCHEMA",
"id": "2c9180835d191a86015d28455b4b232b",
"name": "group"
}
],
"passwordPolicies": [
{
"type": "PASSWORD_POLICY",
"id": "2c9180855d191c59015d291ceb053980",
"name": "Corporate Password Policy"
},
{
"type": "PASSWORD_POLICY",
"id": "2c9180855d191c59015d291ceb057777",
"name": "Vendor Password Policy"
}
],
"features": [
"PROVISIONING",
"NO_PERMISSIONS_PROVISIONING",
"GROUPS_HAVE_MEMBERS"
],
"type": "OpenLDAP - Direct",
"connector": "active-directory",
"connectorClass": "sailpoint.connector.LDAPConnector",
"connectorAttributes": {
"healthCheckTimeout": 30,
"authSearchAttributes": [
"cn",
"uid",
"mail"
]
},
"deleteThreshold": 10,
"authoritative": false,
"managementWorkgroup": {
"type": "GOVERNANCE_GROUP",
"id": "2c91808568c529c60168cca6f90c2222",
"name": "My Management Workgroup"
},
"healthy": true,
"status": "SOURCE_STATE_HEALTHY",
"since": "2021-09-28T15:48:29.3801666300Z",
"connectorId": "active-directory",
"connectorName": "Active Directory",
"connectionType": "file",
"connectorImplementationId": "delimited-file",
"created": "2022-02-08T14:50:03.827Z",
"modified": "2024-01-23T18:08:50.897Z",
"credentialProviderEnabled": false,
"category": "CredentialProvider"
}
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."
}
]
}