Create a campaign​
This endpoint has been deprecated and may be removed in future versions of the API.
Creates a new Certification Campaign with the information provided in the request body.
- application/json
Request Body required
- name string required
The campaign name. If this object is part of a template, special formatting applies; see the
/campaign-templates/{id}/generate
endpoint documentation for details. - description string required
The campaign description. If this object is part of a template, special formatting applies; see the
/campaign-templates/{id}/generate
endpoint documentation for details. - deadline date-time
The campaign's completion deadline.
- type string required
Possible values: [
MANAGER
,SOURCE_OWNER
,SEARCH
,ROLE_COMPOSITION
]The type of campaign. Could be extended in the future.
- emailNotificationEnabled boolean
Default value:
false
Enables email notification for this campaign
- autoRevokeAllowed boolean
Default value:
false
Allows auto revoke for this campaign
- recommendationsEnabled boolean
Default value:
false
Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.
- correlatedStatus string
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).
filter object
Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank.
id stringThe ID of whatever type of filter is being used.
type stringPossible values: [
CAMPAIGN_FILTER
,RULE
]Type of the filter
name stringName of the filter
- sunsetCommentsRequired boolean
Default value:
true
Determines if comments on sunset date changes are required.
sourceOwnerCampaignInfo object
Must be set only if the campaign type is SOURCE_OWNER.
sourceIds string[]The list of sources to be included in the campaign.
searchCampaignInfo object
Must be set only if the campaign type is SEARCH.
type string requiredPossible values: [
IDENTITY
,ACCESS
]The type of search campaign represented.
description stringDescribes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available.
reviewer object
If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP
type stringPossible values: [
ACCOUNT_CORRELATION_CONFIG
,ACCESS_PROFILE
,ACCESS_REQUEST_APPROVAL
,ACCOUNT
,APPLICATION
,CAMPAIGN
,CAMPAIGN_FILTER
,CERTIFICATION
,CLUSTER
,CONNECTOR_SCHEMA
,ENTITLEMENT
,GOVERNANCE_GROUP
,IDENTITY
,IDENTITY_PROFILE
,IDENTITY_REQUEST
,LIFECYCLE_STATE
,PASSWORD_POLICY
,ROLE
,RULE
,SOD_POLICY
,SOURCE
,TAG
,TAG_CATEGORY
,TASK_RESULT
,REPORT_RESULT
,SOD_VIOLATION
,ACCOUNT_ACTIVITY
]DTO type
id stringID of the object to which this reference applies
name stringHuman-readable display name of the object to which this reference applies
query stringThe scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of
query
oridentityIds
must be set.identityIds string[]Possible values:
<= 1000
A direct list of identities to include in this campaign. One of
identityIds
orquery
must be set.accessConstraints object[]
Possible values:
<= 1000
Further reduces the scope of the campaign by excluding identities (from
query
oridentityIds
) that do not have this access.type string requiredPossible values: [
ENTITLEMENT
,ACCESS_PROFILE
,ROLE
]Type of Access
ids string[]Must be set only if operator is SELECTED.
operator string requiredPossible values: [
ALL
,SELECTED
]Used to determine whether the scope of the campaign should be reduced for selected ids or all.
roleCompositionCampaignInfo object
Optional configuration options for role composition campaigns.
reviewer object
If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP
type stringPossible values: [
ACCOUNT_CORRELATION_CONFIG
,ACCESS_PROFILE
,ACCESS_REQUEST_APPROVAL
,ACCOUNT
,APPLICATION
,CAMPAIGN
,CAMPAIGN_FILTER
,CERTIFICATION
,CLUSTER
,CONNECTOR_SCHEMA
,ENTITLEMENT
,GOVERNANCE_GROUP
,IDENTITY
,IDENTITY_PROFILE
,IDENTITY_REQUEST
,LIFECYCLE_STATE
,PASSWORD_POLICY
,ROLE
,RULE
,SOD_POLICY
,SOURCE
,TAG
,TAG_CATEGORY
,TASK_RESULT
,REPORT_RESULT
,SOD_VIOLATION
,ACCOUNT_ACTIVITY
]DTO type
id stringID of the object to which this reference applies
name stringHuman-readable display name of the object to which this reference applies
roleIds string[]Optional list of roles to include in this campaign. Only one of
roleIds
andquery
may be set; if neither are set, all roles are included.remediatorRef object required
This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin.
type string requiredPossible values: [
IDENTITY
]Legal Remediator Type
id string requiredThe ID of the remediator.
query stringOptional search query to scope this campaign to a set of roles. Only one of
roleIds
andquery
may be set; if neither are set, all roles are included.description stringDescribes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available.
alerts object[]
A list of errors and warnings that have accumulated.
level stringPossible values: [
ERROR
,WARN
,INFO
]Denotes the level of the message
localizations object[]
locale stringThe locale for the message text, a BCP 47 language tag.
localeOrigin stringPossible values: [
DEFAULT
,REQUEST
]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.
text stringActual text of the error message in the indicated locale.
sourcesWithOrphanEntitlements object[]
A list of sources in the campaign that contain \"orphan entitlements\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented).
id stringId of the source
type stringPossible values: [
SOURCE
]Type
name stringName of the source
- mandatoryCommentRequirement string
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.
- 200
- 400
- 401
- 403
- 429
- 500
Indicates that the campaign requested was successfully created and returns its representation.
- application/json
- Schema
- Example (from schema)
- Manager
- Search
- Source Owner
- Role Composition
Schema
- id string
Id of the campaign
- name string
The campaign name. If this object is part of a template, special formatting applies; see the
/campaign-templates/{id}/generate
endpoint documentation for details. - description string
The campaign description. If this object is part of a template, special formatting applies; see the
/campaign-templates/{id}/generate
endpoint documentation for details. - deadline date-time
The campaign's completion deadline.
- type string
Possible values: [
MANAGER
,SOURCE_OWNER
,SEARCH
,ROLE_COMPOSITION
]The type of campaign. Could be extended in the future.
- emailNotificationEnabled boolean
Default value:
false
Enables email notification for this campaign
- autoRevokeAllowed boolean
Default value:
false
Allows auto revoke for this campaign
- recommendationsEnabled boolean
Default value:
false
Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.
- status string
Possible values: [
PENDING
,STAGED
,CANCELING
,ACTIVATING
,ACTIVE
,COMPLETING
,COMPLETED
,ERROR
,ARCHIVED
]The campaign's current status.
- correlatedStatus string
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).
- created date-time
Created time of the campaign
- modified date-time
Modified time of the campaign
filter object
Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank.
id stringThe ID of whatever type of filter is being used.
type stringPossible values: [
CAMPAIGN_FILTER
,RULE
]Type of the filter
name stringName of the filter
- sunsetCommentsRequired boolean
Default value:
true
Determines if comments on sunset date changes are required.
sourceOwnerCampaignInfo object
Must be set only if the campaign type is SOURCE_OWNER.
sourceIds string[]The list of sources to be included in the campaign.
searchCampaignInfo object
Must be set only if the campaign type is SEARCH.
type stringPossible values: [
IDENTITY
,ACCESS
]The type of search campaign represented.
description stringDescribes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available.
reviewer object
If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP
type stringPossible values: [
ACCOUNT_CORRELATION_CONFIG
,ACCESS_PROFILE
,ACCESS_REQUEST_APPROVAL
,ACCOUNT
,APPLICATION
,CAMPAIGN
,CAMPAIGN_FILTER
,CERTIFICATION
,CLUSTER
,CONNECTOR_SCHEMA
,ENTITLEMENT
,GOVERNANCE_GROUP
,IDENTITY
,IDENTITY_PROFILE
,IDENTITY_REQUEST
,LIFECYCLE_STATE
,PASSWORD_POLICY
,ROLE
,RULE
,SOD_POLICY
,SOURCE
,TAG
,TAG_CATEGORY
,TASK_RESULT
,REPORT_RESULT
,SOD_VIOLATION
,ACCOUNT_ACTIVITY
]DTO type
id stringID of the object to which this reference applies
name stringHuman-readable display name of the object to which this reference applies
query stringThe scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of
query
oridentityIds
must be set.identityIds string[]Possible values:
<= 1000
A direct list of identities to include in this campaign. One of
identityIds
orquery
must be set.accessConstraints object[]
Possible values:
<= 1000
Further reduces the scope of the campaign by excluding identities (from
query
oridentityIds
) that do not have this access.type stringPossible values: [
ENTITLEMENT
,ACCESS_PROFILE
,ROLE
]Type of Access
ids string[]Must be set only if operator is SELECTED.
operator stringPossible values: [
ALL
,SELECTED
]Used to determine whether the scope of the campaign should be reduced for selected ids or all.
roleCompositionCampaignInfo object
Optional configuration options for role composition campaigns.
reviewer object
If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP
type stringPossible values: [
ACCOUNT_CORRELATION_CONFIG
,ACCESS_PROFILE
,ACCESS_REQUEST_APPROVAL
,ACCOUNT
,APPLICATION
,CAMPAIGN
,CAMPAIGN_FILTER
,CERTIFICATION
,CLUSTER
,CONNECTOR_SCHEMA
,ENTITLEMENT
,GOVERNANCE_GROUP
,IDENTITY
,IDENTITY_PROFILE
,IDENTITY_REQUEST
,LIFECYCLE_STATE
,PASSWORD_POLICY
,ROLE
,RULE
,SOD_POLICY
,SOURCE
,TAG
,TAG_CATEGORY
,TASK_RESULT
,REPORT_RESULT
,SOD_VIOLATION
,ACCOUNT_ACTIVITY
]DTO type
id stringID of the object to which this reference applies
name stringHuman-readable display name of the object to which this reference applies
roleIds string[]Optional list of roles to include in this campaign. Only one of
roleIds
andquery
may be set; if neither are set, all roles are included.remediatorRef object
This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin.
type stringPossible values: [
IDENTITY
]Legal Remediator Type
id stringThe ID of the remediator.
name stringThe name of the remediator.
query stringOptional search query to scope this campaign to a set of roles. Only one of
roleIds
andquery
may be set; if neither are set, all roles are included.description stringDescribes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available.
alerts object[]
A list of errors and warnings that have accumulated.
level stringPossible values: [
ERROR
,WARN
,INFO
]Denotes the level of the message
localizations object[]
locale stringThe locale for the message text, a BCP 47 language tag.
localeOrigin stringPossible values: [
DEFAULT
,REQUEST
]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.
text stringActual text of the error message in the indicated locale.
- totalCertifications integer
The total number of certifications in this campaign.
- completedCertifications integer
The number of completed certifications in this campaign.
sourcesWithOrphanEntitlements object[]
A list of sources in the campaign that contain \"orphan entitlements\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented).
id stringId of the source
type stringPossible values: [
SOURCE
]Type
name stringName of the source
- mandatoryCommentRequirement string
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.
{
"id": "2c9079b270a266a60170a2779fcb0007",
"name": "Manager Campaign",
"description": "Everyone needs to be reviewed by their manager",
"deadline": "2020-03-15T10:00:01.456Z",
"type": "MANAGER",
"emailNotificationEnabled": false,
"autoRevokeAllowed": false,
"recommendationsEnabled": true,
"status": "ACTIVE",
"correlatedStatus": "CORRELATED",
"created": "2020-03-03T22:15:13.611Z",
"modified": "2020-03-03T22:20:12.674Z",
"filter": {
"id": "0fbe863c063c4c88a35fd7f17e8a3df5",
"type": "CAMPAIGN_FILTER",
"name": "Test Filter"
},
"sunsetCommentsRequired": true,
"sourceOwnerCampaignInfo": {
"sourceIds": [
"0fbe863c063c4c88a35fd7f17e8a3df5"
]
},
"searchCampaignInfo": {
"type": "ACCESS",
"description": "Search Campaign description",
"reviewer": {
"type": "IDENTITY",
"id": "2c91808568c529c60168cca6f90c1313",
"name": "William Wilson"
},
"query": "Search Campaign query description",
"identityIds": [
"0fbe863c063c4c88a35fd7f17e8a3df5"
],
"accessConstraints": [
{
"type": "ENTITLEMENT",
"ids": [
"2c90ad2a70ace7d50170acf22ca90010"
],
"operator": "SELECTED"
}
]
},
"roleCompositionCampaignInfo": {
"reviewer": {
"type": "IDENTITY",
"id": "2c91808568c529c60168cca6f90c1313",
"name": "William Wilson"
},
"roleIds": [
"2c90ad2a70ace7d50170acf22ca90010"
],
"remediatorRef": {
"type": "IDENTITY",
"id": "2c90ad2a70ace7d50170acf22ca90010",
"name": "Role Admin"
},
"query": "Search Query",
"description": "Role Composition Description"
},
"alerts": [
{
"level": "ERROR",
"localizations": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
]
}
],
"totalCertifications": 100,
"completedCertifications": 10,
"sourcesWithOrphanEntitlements": [
{
"id": "2c90ad2a70ace7d50170acf22ca90010",
"type": "SOURCE",
"name": "Source with orphan entitlements"
}
],
"mandatoryCommentRequirement": "NO_DECISIONS"
}
{
"id": "5594f43b76804a6980ece5fdccf74be7",
"name": "Manager Review",
"description": "A review of everyone's access by their manager.",
"deadline": "2020-12-25T06:00:00.468Z",
"type": "MANAGER",
"status": "PENDING",
"emailNotificationEnabled": false,
"autoRevokeAllowed": false,
"recommendationsEnabled": false,
"created": "2022-08-02T20:21:18.421Z",
"modified": null,
"filter": {
"type": "CAMPAIGN_FILTER",
"id": "0fbe863c063c4c88a35fd7f17e8a3df5",
"name": "Test Manager Filter"
},
"sunsetCommentsRequired": true,
"sourceOwnerCampaignInfo": null,
"searchCampaignInfo": null,
"roleCompositionCampaignInfo": null,
"alerts": null,
"totalCertifications": 0,
"completedCertifications": 0,
"sourcesWithOrphanEntitlements": null,
"mandatoryCommentRequirement": "NO_DECISIONS"
}
{
"id": "ec041831cb2147778b594feb9d8db44a",
"name": "Search Campaign",
"description": "Search Campaign",
"deadline": "2020-12-25T06:00:00.468Z",
"type": "SEARCH",
"status": "PENDING",
"emailNotificationEnabled": false,
"autoRevokeAllowed": false,
"recommendationsEnabled": false,
"created": "2022-08-03T13:54:34.344Z",
"modified": null,
"filter": {
"type": "CAMPAIGN_FILTER",
"id": "0fbe863c063c4c88a35fd7f17e8a3df5",
"name": "Test Search Filter"
},
"sunsetCommentsRequired": true,
"sourceOwnerCampaignInfo": null,
"searchCampaignInfo": {
"type": "ACCESS",
"description": "user",
"reviewer": {
"type": "IDENTITY",
"id": "7ec252acbd4245548bc25df22348cb75",
"name": null
},
"query": "user",
"identityIds": null,
"accessConstraints": []
},
"roleCompositionCampaignInfo": null,
"alerts": null,
"totalCertifications": 0,
"completedCertifications": 0,
"sourcesWithOrphanEntitlements": null,
"mandatoryCommentRequirement": "NO_DECISIONS"
}
{
"id": "fd7b76ba4ea042de8a9414aa12fc977a",
"name": "Source Owner",
"description": "Source Owner Info",
"deadline": "2020-12-25T06:00:00.468Z",
"type": "SOURCE_OWNER",
"status": "PENDING",
"emailNotificationEnabled": false,
"autoRevokeAllowed": false,
"recommendationsEnabled": false,
"created": "2022-08-03T13:34:19.541Z",
"modified": null,
"filter": {
"type": "CAMPAIGN_FILTER",
"id": "0fbe863c063c4c88a35fd7f17e8a3df5",
"name": "Test Source Owner Filter"
},
"sunsetCommentsRequired": true,
"sourceOwnerCampaignInfo": null,
"sourceIds": [
"612b31b1a0f04aaf83123bdb80e70db6"
],
"searchCampaignInfo": null,
"roleCompositionCampaignInfo": null,
"alerts": null,
"totalCertifications": 0,
"completedCertifications": 0,
"sourcesWithOrphanEntitlements": null,
"correlatedStatus": "CORRELATED",
"mandatoryCommentRequirement": "NO_DECISIONS"
}
{
"id": "3b2e2e5821e84127b6d693d41c40623b",
"name": "Role Composition Campaign",
"description": "A review done by a role owner.",
"deadline": "2020-12-25T06:00:00.468Z",
"type": "ROLE_COMPOSITION",
"status": "PENDING",
"emailNotificationEnabled": false,
"autoRevokeAllowed": false,
"recommendationsEnabled": false,
"created": "2022-08-02T20:30:46.083Z",
"modified": null,
"filter": {
"type": "CAMPAIGN_FILTER",
"id": "0fbe863c063c4c88a35fd7f17e8a3df5",
"name": "Test Role Composition Filter"
},
"sunsetCommentsRequired": true,
"sourceOwnerCampaignInfo": null,
"searchCampaignInfo": null,
"roleCompositionCampaignInfo": {
"remediatorRef": {
"type": "IDENTITY",
"id": "7ec252acbd4245548bc25df22348cb75",
"name": "SailPoint Support"
},
"reviewerId": null,
"reviewer": null,
"roleIds": [
"b15d609fc5c8434b865fe552315fda8f"
],
"query": null,
"description": null
},
"alerts": null,
"totalCertifications": 0,
"completedCertifications": 0,
"sourcesWithOrphanEntitlements": null,
"mandatoryCommentRequirement": "NO_DECISIONS"
}
Client Error - Returned if the request body is invalid.
- application/json
- Schema
- Example (from schema)
Schema
- detailCode string
Fine-grained error code providing more detail of the error.
- trackingId string
Unique tracking id for the error.
messages object[]
Generic localized reason for error
locale stringThe locale for the message text, a BCP 47 language tag.
localeOrigin stringPossible values: [
DEFAULT
,REQUEST
]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.
text stringActual 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
locale stringThe locale for the message text, a BCP 47 language tag.
localeOrigin stringPossible values: [
DEFAULT
,REQUEST
]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.
text stringActual 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
- error
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
- detailCode string
Fine-grained error code providing more detail of the error.
- trackingId string
Unique tracking id for the error.
messages object[]
Generic localized reason for error
locale stringThe locale for the message text, a BCP 47 language tag.
localeOrigin stringPossible values: [
DEFAULT
,REQUEST
]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.
text stringActual 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
locale stringThe locale for the message text, a BCP 47 language tag.
localeOrigin stringPossible values: [
DEFAULT
,REQUEST
]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.
text stringActual 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
- message
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
- detailCode string
Fine-grained error code providing more detail of the error.
- trackingId string
Unique tracking id for the error.
messages object[]
Generic localized reason for error
locale stringThe locale for the message text, a BCP 47 language tag.
localeOrigin stringPossible values: [
DEFAULT
,REQUEST
]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.
text stringActual 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
locale stringThe locale for the message text, a BCP 47 language tag.
localeOrigin stringPossible values: [
DEFAULT
,REQUEST
]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.
text stringActual 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."
}
]
}