---
id: get-active-campaigns
sidebar_label: List Campaigns
hide_title: true
hide_table_of_contents: true
api: {"operationId":"getActiveCampaigns","tags":["Certification Campaigns"],"description":"Gets campaigns and returns them in a list. Can provide increased level of detail for each campaign if provided the correct query.","security":[{"oauth2":["idn:campaign-list:read"]}],"parameters":[{"in":"query","name":"detail","schema":{"type":"string","enum":["SLIM","FULL"]},"required":false,"description":"Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.","example":"FULL"},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"required":false,"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**status**: *eq, in*","example":"name eq \"Manager Campaign\""},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"required":false,"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name**, **created**","example":"name"}],"responses":{"200":{"description":"A list of campaign objects.","content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"type":"object","title":"Slim Campaign","required":["name","description","type"],"properties":{"id":{"type":"string","readOnly":true,"description":"Id of the campaign","example":"2c9079b270a266a60170a2779fcb0007"},"name":{"description":"The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","type":"string","example":"Manager Campaign"},"description":{"type":"string","description":"The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","example":"Everyone needs to be reviewed by their manager"},"deadline":{"type":"string","format":"date-time","description":"The campaign's completion deadline.","example":"2020-03-15T10:00:01.456Z"},"type":{"type":"string","description":"The type of campaign. Could be extended in the future.","enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"],"example":"MANAGER"},"emailNotificationEnabled":{"type":"boolean","description":"Enables email notification for this campaign","default":false,"example":false},"autoRevokeAllowed":{"type":"boolean","description":"Allows auto revoke for this campaign","default":false,"example":false},"recommendationsEnabled":{"type":"boolean","description":"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.","default":false,"example":true},"status":{"type":"string","description":"The campaign's current status.","readOnly":true,"enum":["PENDING","STAGED","CANCELING","ACTIVATING","ACTIVE","COMPLETING","COMPLETED","ERROR","ARCHIVED"],"example":"ACTIVE"},"correlatedStatus":{"type":"string","description":"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).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"}}},{"type":"object","title":"Campaign","allOf":[{"type":"object","title":"Slim Campaign","required":["name","description","type"],"properties":{"id":{"type":"string","readOnly":true,"description":"Id of the campaign","example":"2c9079b270a266a60170a2779fcb0007"},"name":{"description":"The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","type":"string","example":"Manager Campaign"},"description":{"type":"string","description":"The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","example":"Everyone needs to be reviewed by their manager"},"deadline":{"type":"string","format":"date-time","description":"The campaign's completion deadline.","example":"2020-03-15T10:00:01.456Z"},"type":{"type":"string","description":"The type of campaign. Could be extended in the future.","enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"],"example":"MANAGER"},"emailNotificationEnabled":{"type":"boolean","description":"Enables email notification for this campaign","default":false,"example":false},"autoRevokeAllowed":{"type":"boolean","description":"Allows auto revoke for this campaign","default":false,"example":false},"recommendationsEnabled":{"type":"boolean","description":"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.","default":false,"example":true},"status":{"type":"string","description":"The campaign's current status.","readOnly":true,"enum":["PENDING","STAGED","CANCELING","ACTIVATING","ACTIVE","COMPLETING","COMPLETED","ERROR","ARCHIVED"],"example":"ACTIVE"},"correlatedStatus":{"type":"string","description":"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).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"}}},{"type":"object","properties":{"created":{"type":"string","readOnly":true,"format":"date-time","description":"Created time of the campaign","example":"2020-03-03T22:15:13.611Z"},"modified":{"type":"string","readOnly":true,"format":"date-time","description":"Modified time of the campaign","example":"2020-03-03T22:20:12.674Z"},"correlatedStatus":{"description":"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).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"},"filter":{"type":"object","description":"Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank.","properties":{"id":{"type":"string","description":"The ID of whatever type of filter is being used.","example":"0fbe863c063c4c88a35fd7f17e8a3df5"},"type":{"type":"string","description":"Type of the filter","enum":["CAMPAIGN_FILTER","RULE"],"example":"CAMPAIGN_FILTER"},"name":{"type":"string","description":"Name of the filter","example":"Test Filter"}}},"sunsetCommentsRequired":{"type":"boolean","description":"Determines if comments on sunset date changes are required.","default":true,"example":true},"sourceOwnerCampaignInfo":{"type":"object","description":"Must be set only if the campaign type is SOURCE_OWNER.","properties":{"sourceIds":{"type":"array","description":"The list of sources to be included in the campaign.","items":{"type":"string"},"example":["0fbe863c063c4c88a35fd7f17e8a3df5"]}}},"searchCampaignInfo":{"type":"object","description":"Must be set only if the campaign type is SEARCH.","properties":{"type":{"type":"string","description":"The type of search campaign represented.","enum":["IDENTITY","ACCESS"],"example":"ACCESS"},"description":{"type":"string","description":"Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available.","example":"Search Campaign description"},"reviewer":{"description":"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","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object"}]},"query":{"type":"string","description":"The 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` or `identityIds` must be set.","example":"Search Campaign query description"},"identityIds":{"type":"array","description":"A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set.","items":{"type":"string"},"maxItems":1000,"example":["0fbe863c063c4c88a35fd7f17e8a3df5"]},"accessConstraints":{"type":"array","description":"Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT","ACCESS_PROFILE","ROLE"],"description":"Type of Access","example":"ENTITLEMENT"},"ids":{"description":"Must be set only if operator is SELECTED.","type":"array","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]},"operator":{"type":"string","enum":["ALL","SELECTED"],"description":"Used to determine whether the scope of the campaign should be reduced for selected ids or all.","example":"SELECTED"}},"required":["type","operator"]},"maxItems":1000}},"required":["type"]},"roleCompositionCampaignInfo":{"type":"object","description":"Optional configuration options for role composition campaigns.","properties":{"reviewer":{"description":"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","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["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"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object"}]},"roleIds":{"type":"array","description":"Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]},"remediatorRef":{"type":"object","description":"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.","properties":{"type":{"type":"string","enum":["IDENTITY"],"description":"Legal Remediator Type","example":"IDENTITY"},"id":{"type":"string","description":"The ID of the remediator.","example":"2c90ad2a70ace7d50170acf22ca90010"},"name":{"type":"string","description":"The name of the remediator.","readOnly":true,"example":"Role Admin"}},"required":["type","id"]},"query":{"type":"string","description":"Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","example":"Search Query"},"description":{"type":"string","description":"Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available.","example":"Role Composition Description"}},"required":["remediatorRef"]},"alerts":{"type":"array","description":"A list of errors and warnings that have accumulated.","readOnly":true,"items":{"type":"object","properties":{"level":{"type":"string","enum":["ERROR","WARN","INFO"],"description":"Denotes the level of the message","example":"ERROR"},"localizations":{"type":"array","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"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.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}},"totalCertifications":{"type":"integer","description":"The total number of certifications in this campaign.","readOnly":true,"example":100},"completedCertifications":{"type":"integer","description":"The number of completed certifications in this campaign.","readOnly":true,"example":10},"sourcesWithOrphanEntitlements":{"type":"array","description":"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).","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the source","example":"2c90ad2a70ace7d50170acf22ca90010"},"type":{"type":"string","enum":["SOURCE"],"description":"Type","example":"SOURCE"},"name":{"type":"string","description":"Name of the source","example":"Source with orphan entitlements"}}}},"mandatoryCommentRequirement":{"type":"string","description":"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.","enum":["ALL_DECISIONS","REVOKE_ONLY_DECISIONS","NO_DECISIONS"],"example":"NO_DECISIONS"}}}]}]}},"examples":{"Slim Campaign":{"description":"List of Slim Campaigns that would result from not specifying *detail* or specifying SLIM","value":[{"id":"2c918086719eec070171a7e3355a360a","name":"Manager Review","description":"A review of everyone's access by their manager.","deadline":"2020-12-25T06:00:00.123Z","type":"MANAGER","status":"ACTIVE","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false},{"id":"7e1a731e3fb845cfbe58112ba4673ee4","name":"Search Campaign","description":"Search Campaign Info","deadline":"2022-07-26T15:42:44Z","type":"SEARCH","status":"ACTIVE","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false},{"id":"2c918086719eec070171a7e3355a412b","name":"AD Source Review","description":"A review of our AD source.","deadline":"2020-12-25T06:00:00.123Z","type":"SOURCE_OWNER","status":"STAGED","emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"correlatedStatus":"CORRELATED"},{"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":"ACTIVE","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false}]},"Full Campaign":{"description":"List of Campaigns that would result from specifying *detail* as FULL","value":[{"id":"078696a575e045c68d6722ccdb9f101d","name":"Role Composition Campaign","description":"A review done by a role owner.","deadline":"2020-12-25T06:00:00.468Z","type":"ROLE_COMPOSITION","status":"ERROR","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"created":"2022-08-02T20:29:51.065Z","modified":"2022-08-02T20:29:51.331Z","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":[{"level":"ERROR","localizations":[{"locale":"en","localeOrigin":"DEFAULT","text":"Composite criterion must have children non-composite criterion must not."}]}],"totalCertifications":0,"completedCertifications":0,"sourcesWithOrphanEntitlements":null,"mandatoryCommentRequirement":"NO_DECISIONS"},{"id":"1be8fc1103914bf0a4e14e316b6a7b7c","name":"Manager Review","description":"A review of everyone's access by their manager.","deadline":"2020-12-25T06:00:00.468Z","type":"MANAGER","status":"STAGED","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"created":"2022-08-02T19:00:27.731Z","modified":"2022-08-02T19:00:34.391Z","filter":{"type":"CAMPAIGN_FILTER","id":"0fbe863c063c4c88a35fd7f17e8a3df5","name":"Test Manager Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":null,"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":5,"completedCertifications":0,"sourcesWithOrphanEntitlements":[],"mandatoryCommentRequirement":"NO_DECISIONS"},{"id":"7e1a731e3fb845cfbe58112ba4673ee4","name":"Search Campaign","description":"Search Campaign for Identities","deadline":"2022-07-26T15:42:44Z","type":"SEARCH","status":"ACTIVE","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"created":"2022-07-25T15:42:18.276Z","modified":"2022-07-25T15:42:53.718Z","filter":{"type":"CAMPAIGN_FILTER","id":"0fbe863c063c4c88a35fd7f17e8a3df5","name":"Test Search Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":{"type":"IDENTITY","description":"Example of Search Campaign","reviewer":{"type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":null},"query":"user","identityIds":null,"accessConstraints":[]},"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":6,"completedCertifications":0,"sourcesWithOrphanEntitlements":[],"mandatoryCommentRequirement":"NO_DECISIONS"},{"id":"ad3cf3dd50394b1bad646de4bc51b999","name":"Source Owner Campaign","description":"Example for Source Owner Campaign","deadline":"2022-08-10T17:09:02Z","type":"SOURCE_OWNER","status":"ACTIVE","emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"created":"2022-07-27T17:04:19.027Z","modified":"2022-07-27T17:09:13.925Z","filter":{"type":"CAMPAIGN_FILTER","id":"0fbe863c063c4c88a35fd7f17e8a3df5","name":"Test Source Owner Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":{"sourceIds":["2c91808781fd5aea01821200dc88318e"]},"searchCampaignInfo":null,"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":2,"completedCertifications":0,"sourcesWithOrphanEntitlements":[],"correlatedStatus":"CORRELATED","mandatoryCommentRequirement":"NO_DECISIONS"}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"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.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"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.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"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.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"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.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"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.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"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.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/campaigns","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose?  See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"List Campaigns","description":{"content":"Gets campaigns and returns them in a list. Can provide increased level of detail for each campaign if provided the correct query.","type":"text/plain"},"url":{"path":["campaigns"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.","type":"text/plain"},"key":"detail","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**status**: *eq, in*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name**, **created**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}}
sidebar_class_name: "get api-method"
info_path: idn/api/v3/identitynow-v-3-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Campaigns' (get-active-campaigns)"
---

import ApiTabs from "@theme/ApiTabs";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import TabItem from "@theme/TabItem";

## List Campaigns



Gets campaigns and returns them in a list. Can provide increased level of detail for each campaign if provided the correct query.

<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Query Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"detail","schema":{"type":"string","enum":["SLIM","FULL"]},"required":false,"description":"Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.","example":"FULL"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filters","schema":{"type":"string"},"required":false,"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**status**: *eq, in*","example":"name eq \"Manager Campaign\""}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"required":false,"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name**, **created**","example":"name"}}></ParamsItem></ul></div></details><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

A list of campaign objects.

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong><span style={{"opacity":"0.6"}}> array</span></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Slim Campaign"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={"Id of the campaign"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} deprecated={undefined} schemaDescription={"The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} deprecated={undefined} schemaDescription={"The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"deadline"} required={false} deprecated={undefined} schemaDescription={"The campaign's completion deadline."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"The type of campaign. Could be extended in the future."} schemaName={"string"} qualifierMessage={"**Possible values:** [`MANAGER`, `SOURCE_OWNER`, `SEARCH`, `ROLE_COMPOSITION`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"emailNotificationEnabled"} required={false} deprecated={undefined} schemaDescription={"Enables email notification for this campaign"} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}></SchemaItem><SchemaItem collapsible={false} name={"autoRevokeAllowed"} required={false} deprecated={undefined} schemaDescription={"Allows auto revoke for this campaign"} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}></SchemaItem><SchemaItem collapsible={false} name={"recommendationsEnabled"} required={false} deprecated={undefined} schemaDescription={"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."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} deprecated={undefined} schemaDescription={"The campaign's current status."} schemaName={"string"} qualifierMessage={"**Possible values:** [`PENDING`, `STAGED`, `CANCELING`, `ACTIVATING`, `ACTIVE`, `COMPLETING`, `COMPLETED`, `ERROR`, `ARCHIVED`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"correlatedStatus"} required={false} deprecated={undefined} schemaDescription={"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)."} schemaName={"string"} qualifierMessage={"**Possible values:** [`CORRELATED`, `UNCORRELATED`]"} defaultValue={undefined}></SchemaItem></TabItem><TabItem label={"Campaign"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={"Id of the campaign"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} deprecated={undefined} schemaDescription={"The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} deprecated={undefined} schemaDescription={"The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"deadline"} required={false} deprecated={undefined} schemaDescription={"The campaign's completion deadline."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"The type of campaign. Could be extended in the future."} schemaName={"string"} qualifierMessage={"**Possible values:** [`MANAGER`, `SOURCE_OWNER`, `SEARCH`, `ROLE_COMPOSITION`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"emailNotificationEnabled"} required={false} deprecated={undefined} schemaDescription={"Enables email notification for this campaign"} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}></SchemaItem><SchemaItem collapsible={false} name={"autoRevokeAllowed"} required={false} deprecated={undefined} schemaDescription={"Allows auto revoke for this campaign"} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}></SchemaItem><SchemaItem collapsible={false} name={"recommendationsEnabled"} required={false} deprecated={undefined} schemaDescription={"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."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} deprecated={undefined} schemaDescription={"The campaign's current status."} schemaName={"string"} qualifierMessage={"**Possible values:** [`PENDING`, `STAGED`, `CANCELING`, `ACTIVATING`, `ACTIVE`, `COMPLETING`, `COMPLETED`, `ERROR`, `ARCHIVED`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"correlatedStatus"} required={false} deprecated={undefined} schemaDescription={"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)."} schemaName={"string"} qualifierMessage={"**Possible values:** [`CORRELATED`, `UNCORRELATED`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} deprecated={undefined} schemaDescription={"Created time of the campaign"} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} deprecated={undefined} schemaDescription={"Modified time of the campaign"} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>filter</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank.

</div><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={"The ID of whatever type of filter is being used."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"Type of the filter"} schemaName={"string"} qualifierMessage={"**Possible values:** [`CAMPAIGN_FILTER`, `RULE`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} deprecated={undefined} schemaDescription={"Name of the filter"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"sunsetCommentsRequired"} required={false} deprecated={undefined} schemaDescription={"Determines if comments on sunset date changes are required."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={true}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>sourceOwnerCampaignInfo</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Must be set only if the campaign type is SOURCE_OWNER.

</div><SchemaItem collapsible={false} name={"sourceIds"} required={false} deprecated={undefined} schemaDescription={"The list of sources to be included in the campaign."} schemaName={"string[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>searchCampaignInfo</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Must be set only if the campaign type is SEARCH.

</div><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"The type of search campaign represented."} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`, `ACCESS`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} deprecated={undefined} schemaDescription={"Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>reviewer</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

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

</div><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"DTO type"} schemaName={"string"} qualifierMessage={"**Possible 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`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} deprecated={undefined} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"query"} required={false} deprecated={undefined} schemaDescription={"The 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` or `identityIds` must be set."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"identityIds"} required={false} deprecated={undefined} schemaDescription={"A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set."} schemaName={"string[]"} qualifierMessage={"**Possible values:** `<= 1000`"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>accessConstraints</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

**Possible values:** `<= 1000`

</div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access.

</div><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"Type of Access"} schemaName={"string"} qualifierMessage={"**Possible values:** [`ENTITLEMENT`, `ACCESS_PROFILE`, `ROLE`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"ids"} required={false} deprecated={undefined} schemaDescription={"Must be set only if operator is SELECTED."} schemaName={"string[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"operator"} required={false} deprecated={undefined} schemaDescription={"Used to determine whether the scope of the campaign should be reduced for selected ids or all."} schemaName={"string"} qualifierMessage={"**Possible values:** [`ALL`, `SELECTED`]"} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>roleCompositionCampaignInfo</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Optional configuration options for role composition campaigns.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>reviewer</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

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

</div><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"DTO type"} schemaName={"string"} qualifierMessage={"**Possible 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`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} deprecated={undefined} schemaDescription={"Human-readable display name of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"roleIds"} required={false} deprecated={undefined} schemaDescription={"Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included."} schemaName={"string[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>remediatorRef</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

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.

</div><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"Legal Remediator Type"} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={"The ID of the remediator."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} deprecated={undefined} schemaDescription={"The name of the remediator."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"query"} required={false} deprecated={undefined} schemaDescription={"Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} deprecated={undefined} schemaDescription={"Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>alerts</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A list of errors and warnings that have accumulated.

</div><SchemaItem collapsible={false} name={"level"} required={false} deprecated={undefined} schemaDescription={"Denotes the level of the message"} schemaName={"string"} qualifierMessage={"**Possible values:** [`ERROR`, `WARN`, `INFO`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>localizations</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"locale"} required={false} deprecated={undefined} schemaDescription={"The locale for the message text, a BCP 47 language tag."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} deprecated={undefined} schemaDescription={"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."} schemaName={"string"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} deprecated={undefined} schemaDescription={"Actual text of the error message in the indicated locale."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"totalCertifications"} required={false} deprecated={undefined} schemaDescription={"The total number of certifications in this campaign."} schemaName={"integer"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"completedCertifications"} required={false} deprecated={undefined} schemaDescription={"The number of completed certifications in this campaign."} schemaName={"integer"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>sourcesWithOrphanEntitlements</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

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).

</div><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={"Id of the source"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"Type"} schemaName={"string"} qualifierMessage={"**Possible values:** [`SOURCE`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} deprecated={undefined} schemaDescription={"Name of the source"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"mandatoryCommentRequirement"} required={false} deprecated={undefined} schemaDescription={"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."} schemaName={"string"} qualifierMessage={"**Possible values:** [`ALL_DECISIONS`, `REVOKE_ONLY_DECISIONS`, `NO_DECISIONS`]"} defaultValue={undefined}></SchemaItem></TabItem></SchemaTabs></div></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n  {\n    \"id\": \"2c9079b270a266a60170a2779fcb0007\",\n    \"name\": \"Manager Campaign\",\n    \"description\": \"Everyone needs to be reviewed by their manager\",\n    \"deadline\": \"2020-03-15T10:00:01.456Z\",\n    \"type\": \"MANAGER\",\n    \"emailNotificationEnabled\": false,\n    \"autoRevokeAllowed\": false,\n    \"recommendationsEnabled\": true,\n    \"status\": \"ACTIVE\",\n    \"correlatedStatus\": \"CORRELATED\"\n  },\n  {\n    \"id\": \"2c9079b270a266a60170a2779fcb0007\",\n    \"name\": \"Manager Campaign\",\n    \"description\": \"Everyone needs to be reviewed by their manager\",\n    \"deadline\": \"2020-03-15T10:00:01.456Z\",\n    \"type\": \"MANAGER\",\n    \"emailNotificationEnabled\": false,\n    \"autoRevokeAllowed\": false,\n    \"recommendationsEnabled\": true,\n    \"status\": \"ACTIVE\",\n    \"correlatedStatus\": \"CORRELATED\",\n    \"created\": \"2020-03-03T22:15:13.611Z\",\n    \"modified\": \"2020-03-03T22:20:12.674Z\",\n    \"filter\": {\n      \"id\": \"0fbe863c063c4c88a35fd7f17e8a3df5\",\n      \"type\": \"CAMPAIGN_FILTER\",\n      \"name\": \"Test Filter\"\n    },\n    \"sunsetCommentsRequired\": true,\n    \"sourceOwnerCampaignInfo\": {\n      \"sourceIds\": [\n        \"0fbe863c063c4c88a35fd7f17e8a3df5\"\n      ]\n    },\n    \"searchCampaignInfo\": {\n      \"type\": \"ACCESS\",\n      \"description\": \"Search Campaign description\",\n      \"reviewer\": {\n        \"type\": \"IDENTITY\",\n        \"id\": \"2c91808568c529c60168cca6f90c1313\",\n        \"name\": \"William Wilson\"\n      },\n      \"query\": \"Search Campaign query description\",\n      \"identityIds\": [\n        \"0fbe863c063c4c88a35fd7f17e8a3df5\"\n      ],\n      \"accessConstraints\": [\n        {\n          \"type\": \"ENTITLEMENT\",\n          \"ids\": [\n            \"2c90ad2a70ace7d50170acf22ca90010\"\n          ],\n          \"operator\": \"SELECTED\"\n        }\n      ]\n    },\n    \"roleCompositionCampaignInfo\": {\n      \"reviewer\": {\n        \"type\": \"IDENTITY\",\n        \"id\": \"2c91808568c529c60168cca6f90c1313\",\n        \"name\": \"William Wilson\"\n      },\n      \"roleIds\": [\n        \"2c90ad2a70ace7d50170acf22ca90010\"\n      ],\n      \"remediatorRef\": {\n        \"type\": \"IDENTITY\",\n        \"id\": \"2c90ad2a70ace7d50170acf22ca90010\",\n        \"name\": \"Role Admin\"\n      },\n      \"query\": \"Search Query\",\n      \"description\": \"Role Composition Description\"\n    },\n    \"alerts\": [\n      {\n        \"level\": \"ERROR\",\n        \"localizations\": [\n          {\n            \"locale\": \"en-US\",\n            \"localeOrigin\": \"DEFAULT\",\n            \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n          }\n        ]\n      }\n    ],\n    \"totalCertifications\": 100,\n    \"completedCertifications\": 10,\n    \"sourcesWithOrphanEntitlements\": [\n      {\n        \"id\": \"2c90ad2a70ace7d50170acf22ca90010\",\n        \"type\": \"SOURCE\",\n        \"name\": \"Source with orphan entitlements\"\n      }\n    ],\n    \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n  }\n]"} language={"json"}></ResponseSamples></TabItem><TabItem label={" Slim  Campaign"} value={" Slim  Campaign"}><ResponseSamples responseExample={"[\n  {\n    \"id\": \"2c918086719eec070171a7e3355a360a\",\n    \"name\": \"Manager Review\",\n    \"description\": \"A review of everyone's access by their manager.\",\n    \"deadline\": \"2020-12-25T06:00:00.123Z\",\n    \"type\": \"MANAGER\",\n    \"status\": \"ACTIVE\",\n    \"emailNotificationEnabled\": false,\n    \"autoRevokeAllowed\": false,\n    \"recommendationsEnabled\": false\n  },\n  {\n    \"id\": \"7e1a731e3fb845cfbe58112ba4673ee4\",\n    \"name\": \"Search Campaign\",\n    \"description\": \"Search Campaign Info\",\n    \"deadline\": \"2022-07-26T15:42:44Z\",\n    \"type\": \"SEARCH\",\n    \"status\": \"ACTIVE\",\n    \"emailNotificationEnabled\": false,\n    \"autoRevokeAllowed\": false,\n    \"recommendationsEnabled\": false\n  },\n  {\n    \"id\": \"2c918086719eec070171a7e3355a412b\",\n    \"name\": \"AD Source Review\",\n    \"description\": \"A review of our AD source.\",\n    \"deadline\": \"2020-12-25T06:00:00.123Z\",\n    \"type\": \"SOURCE_OWNER\",\n    \"status\": \"STAGED\",\n    \"emailNotificationEnabled\": true,\n    \"autoRevokeAllowed\": false,\n    \"recommendationsEnabled\": false,\n    \"correlatedStatus\": \"CORRELATED\"\n  },\n  {\n    \"id\": \"3b2e2e5821e84127b6d693d41c40623b\",\n    \"name\": \"Role Composition Campaign\",\n    \"description\": \"A review done by a role owner.\",\n    \"deadline\": \"2020-12-25T06:00:00.468Z\",\n    \"type\": \"ROLE_COMPOSITION\",\n    \"status\": \"ACTIVE\",\n    \"emailNotificationEnabled\": false,\n    \"autoRevokeAllowed\": false,\n    \"recommendationsEnabled\": false\n  }\n]"} language={"json"}></ResponseSamples></TabItem><TabItem label={" Full  Campaign"} value={" Full  Campaign"}><ResponseSamples responseExample={"[\n  {\n    \"id\": \"078696a575e045c68d6722ccdb9f101d\",\n    \"name\": \"Role Composition Campaign\",\n    \"description\": \"A review done by a role owner.\",\n    \"deadline\": \"2020-12-25T06:00:00.468Z\",\n    \"type\": \"ROLE_COMPOSITION\",\n    \"status\": \"ERROR\",\n    \"emailNotificationEnabled\": false,\n    \"autoRevokeAllowed\": false,\n    \"recommendationsEnabled\": false,\n    \"created\": \"2022-08-02T20:29:51.065Z\",\n    \"modified\": \"2022-08-02T20:29:51.331Z\",\n    \"filter\": {\n      \"type\": \"CAMPAIGN_FILTER\",\n      \"id\": \"0fbe863c063c4c88a35fd7f17e8a3df5\",\n      \"name\": \"Test Role Composition Filter\"\n    },\n    \"sunsetCommentsRequired\": true,\n    \"sourceOwnerCampaignInfo\": null,\n    \"searchCampaignInfo\": null,\n    \"roleCompositionCampaignInfo\": {\n      \"remediatorRef\": {\n        \"type\": \"IDENTITY\",\n        \"id\": \"7ec252acbd4245548bc25df22348cb75\",\n        \"name\": \"SailPoint Support\"\n      },\n      \"reviewerId\": null,\n      \"reviewer\": null,\n      \"roleIds\": [\n        \"b15d609fc5c8434b865fe552315fda8f\"\n      ],\n      \"query\": null,\n      \"description\": null\n    },\n    \"alerts\": [\n      {\n        \"level\": \"ERROR\",\n        \"localizations\": [\n          {\n            \"locale\": \"en\",\n            \"localeOrigin\": \"DEFAULT\",\n            \"text\": \"Composite criterion must have children non-composite criterion must not.\"\n          }\n        ]\n      }\n    ],\n    \"totalCertifications\": 0,\n    \"completedCertifications\": 0,\n    \"sourcesWithOrphanEntitlements\": null,\n    \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n  },\n  {\n    \"id\": \"1be8fc1103914bf0a4e14e316b6a7b7c\",\n    \"name\": \"Manager Review\",\n    \"description\": \"A review of everyone's access by their manager.\",\n    \"deadline\": \"2020-12-25T06:00:00.468Z\",\n    \"type\": \"MANAGER\",\n    \"status\": \"STAGED\",\n    \"emailNotificationEnabled\": false,\n    \"autoRevokeAllowed\": false,\n    \"recommendationsEnabled\": false,\n    \"created\": \"2022-08-02T19:00:27.731Z\",\n    \"modified\": \"2022-08-02T19:00:34.391Z\",\n    \"filter\": {\n      \"type\": \"CAMPAIGN_FILTER\",\n      \"id\": \"0fbe863c063c4c88a35fd7f17e8a3df5\",\n      \"name\": \"Test Manager Filter\"\n    },\n    \"sunsetCommentsRequired\": true,\n    \"sourceOwnerCampaignInfo\": null,\n    \"searchCampaignInfo\": null,\n    \"roleCompositionCampaignInfo\": null,\n    \"alerts\": null,\n    \"totalCertifications\": 5,\n    \"completedCertifications\": 0,\n    \"sourcesWithOrphanEntitlements\": [],\n    \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n  },\n  {\n    \"id\": \"7e1a731e3fb845cfbe58112ba4673ee4\",\n    \"name\": \"Search Campaign\",\n    \"description\": \"Search Campaign for Identities\",\n    \"deadline\": \"2022-07-26T15:42:44Z\",\n    \"type\": \"SEARCH\",\n    \"status\": \"ACTIVE\",\n    \"emailNotificationEnabled\": false,\n    \"autoRevokeAllowed\": false,\n    \"recommendationsEnabled\": false,\n    \"created\": \"2022-07-25T15:42:18.276Z\",\n    \"modified\": \"2022-07-25T15:42:53.718Z\",\n    \"filter\": {\n      \"type\": \"CAMPAIGN_FILTER\",\n      \"id\": \"0fbe863c063c4c88a35fd7f17e8a3df5\",\n      \"name\": \"Test Search Filter\"\n    },\n    \"sunsetCommentsRequired\": true,\n    \"sourceOwnerCampaignInfo\": null,\n    \"searchCampaignInfo\": {\n      \"type\": \"IDENTITY\",\n      \"description\": \"Example of Search Campaign\",\n      \"reviewer\": {\n        \"type\": \"IDENTITY\",\n        \"id\": \"7ec252acbd4245548bc25df22348cb75\",\n        \"name\": null\n      },\n      \"query\": \"user\",\n      \"identityIds\": null,\n      \"accessConstraints\": []\n    },\n    \"roleCompositionCampaignInfo\": null,\n    \"alerts\": null,\n    \"totalCertifications\": 6,\n    \"completedCertifications\": 0,\n    \"sourcesWithOrphanEntitlements\": [],\n    \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n  },\n  {\n    \"id\": \"ad3cf3dd50394b1bad646de4bc51b999\",\n    \"name\": \"Source Owner Campaign\",\n    \"description\": \"Example for Source Owner Campaign\",\n    \"deadline\": \"2022-08-10T17:09:02Z\",\n    \"type\": \"SOURCE_OWNER\",\n    \"status\": \"ACTIVE\",\n    \"emailNotificationEnabled\": true,\n    \"autoRevokeAllowed\": false,\n    \"recommendationsEnabled\": false,\n    \"created\": \"2022-07-27T17:04:19.027Z\",\n    \"modified\": \"2022-07-27T17:09:13.925Z\",\n    \"filter\": {\n      \"type\": \"CAMPAIGN_FILTER\",\n      \"id\": \"0fbe863c063c4c88a35fd7f17e8a3df5\",\n      \"name\": \"Test Source Owner Filter\"\n    },\n    \"sunsetCommentsRequired\": true,\n    \"sourceOwnerCampaignInfo\": {\n      \"sourceIds\": [\n        \"2c91808781fd5aea01821200dc88318e\"\n      ]\n    },\n    \"searchCampaignInfo\": null,\n    \"roleCompositionCampaignInfo\": null,\n    \"alerts\": null,\n    \"totalCertifications\": 2,\n    \"completedCertifications\": 0,\n    \"sourcesWithOrphanEntitlements\": [],\n    \"correlatedStatus\": \"CORRELATED\",\n    \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n  }\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Client Error - Returned if the request body is invalid.

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} deprecated={undefined} schemaDescription={"Fine-grained error code providing more detail of the error."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} deprecated={undefined} schemaDescription={"Unique tracking id for the error."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>messages</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><SchemaItem collapsible={false} name={"locale"} required={false} deprecated={undefined} schemaDescription={"The locale for the message text, a BCP 47 language tag."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} deprecated={undefined} schemaDescription={"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."} schemaName={"string"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} deprecated={undefined} schemaDescription={"Actual text of the error message in the indicated locale."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>causes</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><SchemaItem collapsible={false} name={"locale"} required={false} deprecated={undefined} schemaDescription={"The locale for the message text, a BCP 47 language tag."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} deprecated={undefined} schemaDescription={"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."} schemaName={"string"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} deprecated={undefined} schemaDescription={"Actual text of the error message in the indicated locale."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} deprecated={undefined} schemaDescription={"A message describing the error"} schemaName={""} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} deprecated={undefined} schemaDescription={"Fine-grained error code providing more detail of the error."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} deprecated={undefined} schemaDescription={"Unique tracking id for the error."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>messages</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><SchemaItem collapsible={false} name={"locale"} required={false} deprecated={undefined} schemaDescription={"The locale for the message text, a BCP 47 language tag."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} deprecated={undefined} schemaDescription={"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."} schemaName={"string"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} deprecated={undefined} schemaDescription={"Actual text of the error message in the indicated locale."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>causes</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><SchemaItem collapsible={false} name={"locale"} required={false} deprecated={undefined} schemaDescription={"The locale for the message text, a BCP 47 language tag."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} deprecated={undefined} schemaDescription={"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."} schemaName={"string"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} deprecated={undefined} schemaDescription={"Actual text of the error message in the indicated locale."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><p> An example of a 403 response object</p><ResponseSamples responseExample={"{\n  \"detailCode\": \"403 Forbidden\",\n  \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The server understood the request but refuses to authorize it.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>

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.

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} deprecated={undefined} schemaDescription={"A message describing the error"} schemaName={""} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal Server Error - Returned if there is an unexpected error.

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} deprecated={undefined} schemaDescription={"Fine-grained error code providing more detail of the error."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} deprecated={undefined} schemaDescription={"Unique tracking id for the error."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>messages</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><SchemaItem collapsible={false} name={"locale"} required={false} deprecated={undefined} schemaDescription={"The locale for the message text, a BCP 47 language tag."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} deprecated={undefined} schemaDescription={"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."} schemaName={"string"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} deprecated={undefined} schemaDescription={"Actual text of the error message in the indicated locale."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>causes</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><SchemaItem collapsible={false} name={"locale"} required={false} deprecated={undefined} schemaDescription={"The locale for the message text, a BCP 47 language tag."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} deprecated={undefined} schemaDescription={"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."} schemaName={"string"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} deprecated={undefined} schemaDescription={"Actual text of the error message in the indicated locale."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><p> An example of a 500 response object</p><ResponseSamples responseExample={"{\n  \"detailCode\": \"500.0 Internal Fault\",\n  \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"An internal fault occurred.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>