Update Source (Full)
PUT/sources/:id
Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration.
These fields are immutable, so they cannot be changed:
- id
- type
- authoritative
- connector
- connectorClass
- passwordPolicies
Attempts to modify these fields will result in a 400 error.
Request
Path Parameters
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
Source's human-readable name.
Source's human-readable description.
owner
object
required
Reference to identity object who owns the source.
Possible values: [IDENTITY
]
Type of object being referenced.
Owner identity's ID.
Owner identity's human-readable display name.
cluster
object
nullable
Reference to the source's associated cluster.
Possible values: [CLUSTER
]
Type of object being referenced.
Cluster ID.
Cluster's human-readable display name.
accountCorrelationConfig
object
nullable
Reference to account correlation config object.
Possible values: [ACCOUNT_CORRELATION_CONFIG
]
Type of object being referenced.
Account correlation config ID.
Account correlation config's human-readable display name.
accountCorrelationRule
object
nullable
Reference to a rule that can do COMPLEX correlation. Only use this rule when you can't use accountCorrelationConfig.
Possible values: [RULE
]
Type of object being referenced.
Rule ID.
Rule's human-readable display name.
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
object
nullable
Reference to the ManagerCorrelationRule. Only use this rule when a simple filter isn't sufficient.
Possible values: [RULE
]
Type of object being referenced.
Rule ID.
Rule's human-readable display name.
beforeProvisioningRule
object
nullable
Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector.
Possible values: [RULE
]
Type of object being referenced.
Rule ID.
Rule's human-readable display name.
schemas
object[]
List of references to schema objects.
Possible values: [CONNECTOR_SCHEMA
]
Type of object being referenced.
Schema ID.
Schema's human-readable display name.
passwordPolicies
object[]
nullable
List of references to the associated PasswordPolicy objects.
Possible values: [PASSWORD_POLICY
]
Type of object being referenced.
Policy ID.
Policy's human-readable display name.
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.
Fully qualified name of the Java class that implements the connector interface.
Connector specific configuration. This configuration will differ from type to type.
Number from 0 to 100 that specifies when to skip the delete phase.
When this is true, it indicates that the source is referenced by an identity profile.
managementWorkgroup
object
nullable
Reference to management workgroup for the source.
Possible values: [GOVERNANCE_GROUP
]
Type of object being referenced.
Management workgroup ID.
Management workgroup's human-readable display name.
When this is true, it indicates that the source is healthy.
Possible values: [SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT
, SOURCE_STATE_ERROR_CLUSTER
, SOURCE_STATE_ERROR_SOURCE
, SOURCE_STATE_ERROR_VA
, SOURCE_STATE_FAILURE_CLUSTER
, SOURCE_STATE_FAILURE_SOURCE
, SOURCE_STATE_HEALTHY
, SOURCE_STATE_UNCHECKED_CLUSTER
, SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES
, SOURCE_STATE_UNCHECKED_SOURCE
, SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS
]
Status identifier that gives specific information about why a source is or isn't healthy.
Timestamp that shows when a source health check was last performed.
Connector ID
Name of the connector that was chosen during source creation.
Type of connection (direct or file).
Connector implementation ID.
Date-time when the source was created
Date-time when the source was last modified.
If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials.
Source category (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 so that they aren't decryptable in Identity Security Cloud (ISC) cloud-based services, per ISC 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
Source ID.
Source's human-readable name.
Source's human-readable description.
owner
object
required
Reference to identity object who owns the source.
Possible values: [IDENTITY
]
Type of object being referenced.
Owner identity's ID.
Owner identity's human-readable display name.
cluster
object
nullable
Reference to the source's associated cluster.
Possible values: [CLUSTER
]
Type of object being referenced.
Cluster ID.
Cluster's human-readable display name.
accountCorrelationConfig
object
nullable
Reference to account correlation config object.
Possible values: [ACCOUNT_CORRELATION_CONFIG
]
Type of object being referenced.
Account correlation config ID.
Account correlation config's human-readable display name.
accountCorrelationRule
object
nullable
Reference to a rule that can do COMPLEX correlation. Only use this rule when you can't use accountCorrelationConfig.
Possible values: [RULE
]
Type of object being referenced.
Rule ID.
Rule's human-readable display name.
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
object
nullable
Reference to the ManagerCorrelationRule. Only use this rule when a simple filter isn't sufficient.
Possible values: [RULE
]
Type of object being referenced.
Rule ID.
Rule's human-readable display name.
beforeProvisioningRule
object
nullable
Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector.
Possible values: [RULE
]
Type of object being referenced.
Rule ID.
Rule's human-readable display name.
schemas
object[]
List of references to schema objects.
Possible values: [CONNECTOR_SCHEMA
]
Type of object being referenced.
Schema ID.
Schema's human-readable display name.
passwordPolicies
object[]
nullable
List of references to the associated PasswordPolicy objects.
Possible values: [PASSWORD_POLICY
]
Type of object being referenced.
Policy ID.
Policy's human-readable display name.
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.
Fully qualified name of the Java class that implements the connector interface.
Connector specific configuration. This configuration will differ from type to type.
Number from 0 to 100 that specifies when to skip the delete phase.
When this is true, it indicates that the source is referenced by an identity profile.
managementWorkgroup
object
nullable
Reference to management workgroup for the source.
Possible values: [GOVERNANCE_GROUP
]
Type of object being referenced.
Management workgroup ID.
Management workgroup's human-readable display name.
When this is true, it indicates that the source is healthy.
Possible values: [SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT
, SOURCE_STATE_ERROR_CLUSTER
, SOURCE_STATE_ERROR_SOURCE
, SOURCE_STATE_ERROR_VA
, SOURCE_STATE_FAILURE_CLUSTER
, SOURCE_STATE_FAILURE_SOURCE
, SOURCE_STATE_HEALTHY
, SOURCE_STATE_UNCHECKED_CLUSTER
, SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES
, SOURCE_STATE_UNCHECKED_SOURCE
, SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS
]
Status identifier that gives specific information about why a source is or isn't healthy.
Timestamp that shows when a source health check was last performed.
Connector ID
Name of the connector that was chosen during source creation.
Type of connection (direct or file).
Connector implementation ID.
Date-time when the source was created
Date-time when the source was last modified.
If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials.
Source category (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."
}
]
}