List Triggers
GET/triggers
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true
to use this endpoint.
Gets a list of triggers that are available in the tenant.
Request
Query Parameters
Possible values: <= 250
Default value: 250
Max number of results to return. See V3 API Standard Collection Parameters for more information.
Default value: 0
Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.
Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.
See V3 API Standard Collection Parameters for more information.
Filter results using the standard syntax described in V3 API Standard Collection Parameters
Filtering is supported for the following fields and operators:
id: eq, ge, le
Sort results using the standard syntax described in V3 API Standard Collection Parameters
Sorting is supported for the following fields: id, name
Header Parameters
Default value: true
Use this header to enable this experimental API.
Responses
- 200
- 400
- 401
- 403
- 429
- 500
List of triggers.
- application/json
- Schema
- Example (from schema)
Schema
Array [
- Access Request Dynamic Approver
- Access Request Post Approval
- Access Request Pre Approval
- Account Aggregation Completed
- Account Attributes Changed
- Account Correlated
- Accounts Collected for Aggregation
- Account Uncorrelated
- Campaign Activated
- Campaign Ended
- Campaign Generated
- Certification Signed Off
- Identity Attributes Changed
- Identity Created
- Identity Deleted
- Provisioning Completed
- Saved Search Complete
- Source Account Created
- Source Account Deleted
- Source Account Updated
- Source Created
- Source Deleted
- Source Updated
- VA Cluster Status Change Event
Array [
]
Array [
]
Array [
]
Array [
Array [
]
]
Array [
]
Array [
]
Array [
- MOD1
- MOD2
- MOD3
Array [
]
- MOD1
- MOD2
- MOD3
Array [
]
]
STAGED
: The campaign is waiting to be activated.ACTIVE
: The campaign is active.SIGNED
: The reviewer has signed off on the campaign, and it is considered complete.Array [
- MOD1
- MOD2
- MOD3
- MOD4
Array [
]
- MOD1
- MOD2
- MOD3
- MOD4
- MOD1
- MOD2
- MOD3
- MOD4
Array [
]
- MOD1
- MOD2
- MOD3
- MOD4
]
Array [
Array [
]
]
- Access Request Dynamic Approver
- Access Request Pre Approval
]
Unique identifier of the trigger.
Trigger Name.
Possible values: [REQUEST_RESPONSE
, FIRE_AND_FORGET
]
The type of trigger.
Trigger Description.
The JSON schema of the payload that will be sent by the trigger to the subscribed service.
exampleInput
object
required
An example of the JSON payload that will be sent by the trigger to the subscribed service.
oneOf
The unique ID of the access request object. Can be used with the access request status endpoint to get the status of the request.
requestedFor
object[]
required
Possible values: >= 1
, <= 10
Identities access was requested for.
Possible values: [IDENTITY
]
DTO type of identity the access item is requested for.
ID of identity the access item is requested for.
Human-readable display name of identity the access item is requested for.
requestedItems
object[]
required
Possible values: >= 1
, <= 25
The access items that are being requested.
The unique ID of the access item.
Human friendly name of the access item.
Extended description of the access item.
Possible values: [ACCESS_PROFILE
, ROLE
, ENTITLEMENT
]
The type of access item being requested.
Possible values: [Add
, Remove
]
Grant or revoke the access item
A comment from the requestor on why the access is needed.
requestedBy
object
required
Access item requester's identity.
Possible values: [IDENTITY
]
Access item requester's DTO type.
Access item requester's identity ID.
Access item owner's human-readable display name.
The unique ID of the access request.
requestedFor
object[]
required
Possible values: >= 1
, <= 10
Identities access was requested for.
Possible values: [IDENTITY
]
DTO type of identity the access item is requested for.
ID of identity the access item is requested for.
Human-readable display name of identity the access item is requested for.
requestedItemsStatus
object[]
required
Details on the outcome of each access item.
The unique ID of the access item being requested.
The human friendly name of the access item.
Detailed description of the access item.
Possible values: [ACCESS_PROFILE
, ROLE
, ENTITLEMENT
]
The type of access item.
Possible values: [Add
, Remove
]
The action to perform on the access item.
A comment from the identity requesting the access.
clientMetadata
object
nullable
Additional customer defined metadata about the access item.
Additional customer defined metadata about the access item.
approvalInfo
object[]
required
A list of one or more approvers for the access request.
A comment left by the approver.
Possible values: [APPROVED
, DENIED
]
The final decision of the approver.
The name of the approver
approver
object
required
The identity of the approver.
Possible values: [IDENTITY
]
The type of object that is referenced
Possible values: [IDENTITY
]
DTO type of identity who approved the access item request.
ID of identity who approved the access item request.
Human-readable display name of identity who approved the access item request.
requestedBy
object
required
Access item requester's identity.
Possible values: [IDENTITY
]
Access item requester's DTO type.
Access item requester's identity ID.
Access item owner's human-readable display name.
The unique ID of the access request.
requestedFor
object[]
required
Possible values: >= 1
, <= 10
Identities access was requested for.
Possible values: [IDENTITY
]
DTO type of identity the access item is requested for.
ID of identity the access item is requested for.
Human-readable display name of identity the access item is requested for.
requestedItems
object[]
required
Possible values: >= 1
, <= 25
Details of the access items being requested.
The unique ID of the access item being requested.
The human friendly name of the access item.
Detailed description of the access item.
Possible values: [ACCESS_PROFILE
, ROLE
, ENTITLEMENT
]
The type of access item.
Possible values: [Add
, Remove
]
The action to perform on the access item.
A comment from the identity requesting the access.
requestedBy
object
required
Access item requester's identity.
Possible values: [IDENTITY
]
Access item requester's DTO type.
Access item requester's identity ID.
Access item owner's human-readable display name.
source
object
required
The source the accounts are being aggregated from.
Possible values: [SOURCE
]
The DTO type of the source the accounts are being aggregated from.
The ID of the source the accounts are being aggregated from.
Display name of the source the accounts are being aggregated from.
Possible values: [Success
, Failed
, Terminated
]
The overall status of the aggregation.
The date and time when the account aggregation started.
The date and time when the account aggregation finished.
A list of errors that occurred during the aggregation.
A list of warnings that occurred during the aggregation.
stats
object
required
Overall statistics about the account aggregation.
Possible values: <= 2147483647
The number of accounts which were scanned / iterated over.
Possible values: <= 2147483647
The number of accounts which existed before, but had no changes.
Possible values: <= 2147483647
The number of accounts which existed before, but had changes.
Possible values: <= 2147483647
The number of accounts which are new - have not existed before.
Possible values: <= 2147483647
The number accounts which existed before, but no longer exist (thus getting removed).
identity
object
required
The identity whose account attributes were updated.
Possible values: [IDENTITY
]
DTO type of the identity whose account attributes were updated.
ID of the identity whose account attributes were updated.
Display name of the identity whose account attributes were updated.
source
object
required
The source that contains the account.
ID of the object to which this reference applies
Possible values: [SOURCE
]
The type of object that is referenced
Human-readable display name of the object to which this reference applies
account
object
required
Details of the account where the attributes changed.
SailPoint generated unique identifier.
The source's unique identifier for the account. UUID is generated by the source system.
Name of the account.
Unique ID of the account on the source.
Possible values: [ACCOUNT
]
The type of the account
changes
object[]
required
A list of attributes that changed.
The name of the attribute.
oldValue
object
nullable
required
The previous value of the attribute.
oneOf
string
boolean
string
newValue
object
nullable
required
The new value of the attribute.
oneOf
string
boolean
string
identity
object
required
Identity the account is correlated with.
Possible values: [IDENTITY
]
DTO type of the identity the account is correlated with.
ID of the identity the account is correlated with.
Display name of the identity the account is correlated with.
source
object
required
The source the accounts are being correlated from.
Possible values: [SOURCE
]
The DTO type of the source the accounts are being correlated from.
The ID of the source the accounts are being correlated from.
Display name of the source the accounts are being correlated from.
account
object
required
The correlated account.
Possible values: [ACCOUNT
]
The correlated account's DTO type.
The correlated account's ID.
The correlated account's display name.
Unique ID of the account on the source.
The source's unique identifier for the account. UUID is generated by the source system.
attributes
object
required
The attributes associated with the account. Attributes are unique per source.
The attributes associated with the account. Attributes are unique per source.
The number of entitlements associated with this account.
source
object
required
Reference to the source that has been aggregated.
ID of the object to which this reference applies
Possible values: [SOURCE
]
The type of object that is referenced
Human-readable display name of the object to which this reference applies
Possible values: [Success
, Failed
, Terminated
]
The overall status of the collection.
The date and time when the account collection started.
The date and time when the account collection finished.
A list of errors that occurred during the collection.
A list of warnings that occurred during the collection.
stats
object
required
Overall statistics about the account collection.
Possible values: <= 2147483647
The number of accounts which were scanned / iterated over.
Possible values: <= 2147483647
The number of accounts which existed before, but had no changes.
Possible values: <= 2147483647
The number of accounts which existed before, but had changes.
Possible values: <= 2147483647
The number of accounts which are new - have not existed before.
Possible values: <= 2147483647
The number accounts which existed before, but no longer exist (thus getting removed).
identity
object
required
Identity the account is uncorrelated with.
Possible values: [IDENTITY
]
DTO type of the identity the account is uncorrelated with.
ID of the identity the account is uncorrelated with.
Display name of the identity the account is uncorrelated with.
source
object
required
The source the accounts are uncorrelated from.
Possible values: [SOURCE
]
The DTO type of the source the accounts are uncorrelated from.
The ID of the source the accounts are uncorrelated from.
Display name of the source the accounts are uncorrelated from.
account
object
required
Uncorrelated account.
Possible values: [ACCOUNT
]
Uncorrelated account's DTO type.
Uncorrelated account's ID.
Uncorrelated account's display name.
Unique ID of the account on the source.
The source's unique identifier for the account. UUID is generated by the source system.
The number of entitlements associated with this account.
campaign
object
required
Details about the certification campaign that was activated.
Unique ID for the campaign.
The human friendly name of the campaign.
Extended description of the campaign.
The date and time the campaign was created.
The date and time the campaign was last modified.
The date and time the campaign is due.
Possible values: [MANAGER
, SOURCE_OWNER
, SEARCH
, ROLE_COMPOSITION
]
The type of campaign.
campaignOwner
object
required
Details of the identity that owns the campaign.
The unique ID of the identity.
The human friendly name of the identity.
The primary email address of the identity.
Possible values: [ACTIVE
]
The current status of the campaign.
campaign
object
required
Details about the certification campaign that ended.
Unique ID for the campaign.
The human friendly name of the campaign.
Extended description of the campaign.
The date and time the campaign was created.
The date and time the campaign was last modified.
The date and time the campaign is due.
Possible values: [MANAGER
, SOURCE_OWNER
, SEARCH
, ROLE_COMPOSITION
]
The type of campaign.
campaignOwner
object
required
Details of the identity that owns the campaign.
The unique ID of the identity.
The human friendly name of the identity.
The primary email address of the identity.
Possible values: [COMPLETED
]
The current status of the campaign.
campaign
object
required
Details about the campaign that was generated.
The unique ID of the campaign.
Human friendly name of the campaign.
Extended description of the campaign.
The date and time the campaign was created.
The date and time the campaign was last modified.
The date and time when the campaign must be finished by.
Possible values: [MANAGER
, SOURCE_OWNER
, SEARCH
, ROLE_COMPOSITION
]
The type of campaign that was generated.
campaignOwner
object
required
The identity that owns the campaign.
The unique ID of the identity.
The display name of the identity.
The primary email address of the identity.
Possible values: [STAGED
, ACTIVATING
, ACTIVE
]
The current status of the campaign.
certification
object
required
The certification campaign that was signed off on.
Unique ID of the certification.
The name of the certification.
The date and time the certification was created.
The date and time the certification was last modified.
campaignRef
object
required
The unique ID of the campaign.
The name of the campaign.
Possible values: [CAMPAIGN
]
The type of object that is being referenced.
Possible values: [MANAGER
, SOURCE_OWNER
, SEARCH
]
The type of the campaign.
The description of the campaign set by the admin who created it.
Possible values: [CORRELATED
, UNCORRELATED
]
The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).
Possible values: [ALL_DECISIONS
, REVOKE_ONLY_DECISIONS
, NO_DECISIONS
]
Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.
Possible values: [STAGED
, ACTIVE
, SIGNED
]
The current phase of the campaign.
The due date of the certification.
The date the reviewer signed off on the certification.
reviewer
object
required
A reference to the reviewer of the campaign.
Possible values: [IDENTITY
, GOVERNANCE_GROUP
]
The reviewer's DTO type.
The reviewer's ID.
The reviewer's display name.
The reviewing identity's email. Only applicable to IDENTITY
.
reassignment
object
nullable
A reference to a reviewer that this campaign has been reassigned to.
from
object
Previous certification.
Possible values: [CERTIFICATION
]
DTO type of certification for review.
ID of certification for review.
Display name of certification for review.
reviewer
object
Certification reviewer
Possible values: [IDENTITY
, GOVERNANCE_GROUP
]
The reviewer's DTO type.
The reviewer's ID.
The reviewer's display name.
The reviewing identity's email. Only applicable to IDENTITY
.
Comments from the previous reviewer.
Indicates it the certification has any errors.
A message indicating what the error is.
Indicates if all certification decisions have been made.
The number of approve/revoke/acknowledge decisions that have been made by the reviewer.
The total number of approve/revoke/acknowledge decisions for the certification.
The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete.
The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete.
identity
object
required
Identity whose attributes changed.
Possible values: [IDENTITY
]
DTO type of identity whose attributes changed.
ID of identity whose attributes changed.
Display name of identity whose attributes changed.
changes
object[]
required
A list of one or more identity attributes that changed on the identity.
The name of the identity attribute that changed.
oldValue
object
nullable
The value of the identity attribute before it changed.
oneOf
string
boolean
string
property name*
object
nullable
oneOf
string
number
integer
boolean
newValue
object
The value of the identity attribute after it changed.
oneOf
string
boolean
string
property name*
object
nullable
oneOf
string
number
integer
boolean
identity
object
required
Created identity.
Possible values: [IDENTITY
]
Created identity's DTO type.
Created identity ID.
Created identity's display name.
attributes
object
required
The attributes assigned to the identity. Attributes are determined by the identity profile.
The attributes assigned to the identity. Attributes are determined by the identity profile.
identity
object
required
Deleted identity.
Possible values: [IDENTITY
]
Deleted identity's DTO type.
Deleted identity ID.
Deleted identity's display name.
attributes
object
required
The attributes assigned to the identity. Attributes are determined by the identity profile.
The attributes assigned to the identity. Attributes are determined by the identity profile.
The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface.
One or more sources that the provisioning transaction(s) were done against. Sources are comma separated.
Origin of where the provisioning request came from.
A list of any accumulated error messages that occurred during provisioning.
A list of any accumulated warning messages that occurred during provisioning.
recipient
object
required
Provisioning recpient.
Possible values: [IDENTITY
]
Provisioning recipient DTO type.
Provisioning recipient's identity ID.
Provisioning recipient's display name.
requester
object
nullable
Provisioning requester's identity.
Possible values: [IDENTITY
]
Provisioning requester's DTO type.
Provisioning requester's identity ID.
Provisioning owner's human-readable display name.
accountRequests
object[]
required
A list of provisioning instructions to perform on an account-by-account basis.
source
object
required
Reference to the source being provisioned against.
ID of the object to which this reference applies
Possible values: [SOURCE
]
The type of object that is referenced
Human-readable display name of the object to which this reference applies
The unique idenfier of the account being provisioned.
The provisioning operation; typically Create, Modify, Enable, Disable, Unlock, or Delete.
Possible values: [SUCCESS
, PENDING
, FAILED
]
The overall result of the provisioning transaction; this could be success, pending, failed, etc.
The name of the provisioning channel selected; this could be the same as the source, or could be a Service Desk Integration Module (SDIM).
A reference to a tracking number, if this is sent to a Service Desk Integration Module (SDIM).
attributeRequests
object[]
nullable
A list of attributes as part of the provisioning transaction.
The name of the attribute being provisioned.
The value of the attribute being provisioned.
Possible values: [Add
, Set
, Remove
]
The operation to handle the attribute.
A name for the report file.
The email address of the identity that owns the saved search.
The name of the identity that owns the saved search.
The search query that was used to generate the report.
The name of the saved search.
searchResults
object
required
A preview of the search results for each object type. This includes a count as well as headers, and the first several rows of data, per object type.
Account
object
nullable
A table of accounts that match the search criteria.
The number of rows in the table.
The type of object represented in the table.
A sample of the data in the table.
Entitlement
object
nullable
A table of entitlements that match the search criteria.
The number of rows in the table.
The type of object represented in the table.
A sample of the data in the table.
Identity
object
nullable
A table of identities that match the search criteria.
The number of rows in the table.
The type of object represented in the table.
A sample of the data in the table.
The Amazon S3 URL to download the report from.
Source unique identifier for the identity. UUID is generated by the source system.
SailPoint generated unique identifier.
Unique ID of the account on the source.
The ID of the source.
The name of the source.
The ID of the identity that is correlated with this account.
The name of the identity that is correlated with this account.
attributes
object
required
The attributes of the account. The contents of attributes depends on the account schema for the source.
The attributes of the account. The contents of attributes depends on the account schema for the source.
Source unique identifier for the identity. UUID is generated by the source system.
SailPoint generated unique identifier.
Unique ID of the account on the source.
The ID of the source.
The name of the source.
The ID of the identity that is correlated with this account.
The name of the identity that is correlated with this account.
attributes
object
required
The attributes of the account. The contents of attributes depends on the account schema for the source.
The attributes of the account. The contents of attributes depends on the account schema for the source.
Source unique identifier for the identity. UUID is generated by the source system.
SailPoint generated unique identifier.
Unique ID of the account on the source.
The ID of the source.
The name of the source.
The ID of the identity that is correlated with this account.
The name of the identity that is correlated with this account.
attributes
object
required
The attributes of the account. The contents of attributes depends on the account schema for the source.
The attributes of the account. The contents of attributes depends on the account schema for the source.
The unique ID of the source.
Human friendly name of the source.
The connection type.
The date and time the source was created.
The connector type used to connect to the source.
actor
object
required
Identity who created the source.
Possible values: [IDENTITY
]
DTO type of identity who created the source.
ID of identity who created the source.
Display name of identity who created the source.
The unique ID of the source.
Human friendly name of the source.
The connection type.
The date and time the source was deleted.
The connector type used to connect to the source.
actor
object
required
Identity who deleted the source.
Possible values: [IDENTITY
]
DTO type of identity who deleted the source.
ID of identity who deleted the source.
Display name of identity who deleted the source.
The unique ID of the source.
The user friendly name of the source.
The connection type of the source.
The date and time the source was modified.
The connector type used to connect to the source.
actor
object
required
Identity who updated the source.
Possible values: [IDENTITY
]
DTO type of identity who updated the source.
ID of identity who updated the source.
Display name of identity who updated the source.
The date and time the status change occurred.
Possible values: [SOURCE
, CLUSTER
]
The type of the object that initiated this event.
application
object
required
Details about the CLUSTER
or SOURCE
that initiated this event.
The GUID of the application
The name of the application
attributes
object
nullable
required
Custom map of attributes for a source. This will only be populated if type is SOURCE
and the source has a proxy.
Custom map of attributes for a source. This will only be populated if type is SOURCE
and the source has a proxy.
healthCheckResult
object
required
The results of the most recent health check.
Detailed message of the result of the health check.
The type of the health check result.
Possible values: [Succeeded
, Failed
]
The status of the health check.
previousHealthCheckResult
object
required
The results of the last health check.
Detailed message of the result of the health check.
The type of the health check result.
Possible values: [Succeeded
, Failed
]
The status of the health check.
The JSON schema of the response that will be sent by the subscribed service to the trigger in response to an event. This only applies to a trigger type of REQUEST_RESPONSE
.
exampleOutput
object
nullable
An example of the JSON payload that will be sent by the subscribed service to the trigger in response to an event.
oneOf
The unique ID of the identity to add to the approver list for the access request.
The name of the identity to add to the approver list for the access request.
Possible values: [IDENTITY
, GOVERNANCE_GROUP
]
The type of object being referenced.
Whether or not to approve the access request.
A comment about the decision to approve or deny the request.
The name of the entity that approved or denied the request.
[
{
"id": "idn:access-request-dynamic-approver",
"name": "Access Request Dynamic Approver",
"type": "REQUEST_RESPONSE",
"description": "Trigger for getting a dynamic approver.",
"inputSchema": "{\"definitions\":{\"record:AccessRequestDynamicApproverInput\":{\"type\":\"object\",\"required\":[\"accessRequestId\",\"requestedFor\",\"requestedItems\",\"requestedBy\"],\"additionalProperties\":true,\"properties\":{\"accessRequestId\":{\"type\":\"string\"},\"requestedFor\":{\"$ref\":\"#/definitions/record:requestedForIdentityRef\"},\"requestedItems\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/record:requestedObjectRef\"}},\"requestedBy\":{\"$ref\":\"#/definitions/record:requestedByIdentityRef\"}}},\"record:requestedForIdentityRef\":{\"type\":\"object\",\"required\":[\"id\",\"name\",\"type\"],\"additionalProperties\":true,\"properties\":{\"id\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"},\"type\":{\"type\":\"string\"}}},\"record:requestedObjectRef\":{\"type\":\"object\",\"optional\":[\"description\",\"comment\"],\"required\":[\"id\",\"name\",\"type\",\"operation\"],\"additionalProperties\":true,\"properties\":{\"id\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"},\"description\":{\"oneOf\":[{\"type\":\"null\"},{\"type\":\"string\"}]},\"type\":{\"type\":\"string\"},\"operation\":{\"type\":\"string\"},\"comment\":{\"oneOf\":[{\"type\":\"null\"},{\"type\":\"string\"}]}}},\"record:requestedByIdentityRef\":{\"type\":\"object\",\"required\":[\"type\",\"id\",\"name\"],\"additionalProperties\":true,\"properties\":{\"type\":{\"type\":\"string\"},\"id\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"}}}},\"$ref\":\"#/definitions/record:AccessRequestDynamicApproverInput\"}",
"exampleInput": {},
"outputSchema": "{\"definitions\":{\"record:AccessRequestDynamicApproverOutput\":{\"type\":[\"null\",\"object\"],\"required\":[\"id\",\"name\",\"type\"],\"additionalProperties\":true,\"properties\":{\"id\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"},\"type\":{\"type\":\"string\"}}}},\"$ref\":\"#/definitions/record:AccessRequestDynamicApproverOutput\"}",
"exampleOutput": {}
}
]
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."
}
]
}
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."
}
]
}