LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 20:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
61d7c3be6eea03b02405ac429a9c5bfc283a68d3
developer.sailpoint.com/docs/sailpoint-api-beta/create-campaign-template.api.mdx
jordan-violet-sp 61d7c3be6e added docs folder back into project
2022-08-16 21:39:45 -04:00

171 lines
98 KiB
Plaintext
Raw Blame History

---
id: create-campaign-template
sidebar_label: Create a Campaign Template
hide_title: true
hide_table_of_contents: true
api: {"operationId":"createCampaignTemplate","tags":["Certification Campaigns"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"This template's name. Has no bearing on generated campaigns' names."},"description":{"type":"string","description":"This template's description. Has no bearing on generated campaigns' descriptions."},"created":{"type":"string","readOnly":true,"format":"date-time"},"modified":{"type":"string","readOnly":true,"format":"date-time"},"scheduled":{"type":"boolean","readOnly":true,"description":"Indicates if this campaign template has been scheduled."},"ownerRef":{"type":"object","description":"The owner of this template, and the owner of campaigns generated from this template via a schedule. This field is automatically populated at creation time with the current user.","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["IDENTITY"]},"name":{"type":"string"},"email":{"type":"string"}}},"deadlineDuration":{"type":"string","description":"The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign's deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was \"P2W\" (two weeks), the resulting campaign's deadline would be 2020-01-15 (the current date plus 14 days)."},"campaign":{"type":"object","title":"Campaign","allOf":[{"type":"object","title":"Slim Campaign","required":["name","description","type"],"properties":{"id":{"type":"string","readOnly":true},"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"},"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."},"deadline":{"type":"string","format":"date-time","description":"The campaign's completion deadline."},"type":{"type":"string","description":"The type of campaign. Could be extended in the future.","enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"]},"emailNotificationEnabled":{"type":"boolean"},"autoRevokeAllowed":{"type":"boolean"},"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."},"status":{"type":"string","description":"The campaign's current status.","readOnly":true,"enum":["PENDING","STAGED","CANCELING","ACTIVATING","ACTIVE","COMPLETING","COMPLETED","ERROR","ARCHIVED"]}},"example":{"id":"2c9079b270a266a60170a2779fcb0007","name":"Manager Campaign","description":"Everyone needs to be reviewed by their manager.","deadline":"2020-03-15T10:00:01.456Z","type":"MANAGER","emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"status":"ACTIVE"}},{"type":"object","properties":{"created":{"type":"string","readOnly":true,"format":"date-time"},"modified":{"type":"string","readOnly":true,"format":"date-time"},"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."},"type":{"type":"string","enum":["CAMPAIGN_FILTER"]}}},"sunsetCommentsRequired":{"type":"boolean","description":"Determines if comments on sunset date changes are required.","default":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"}}}},"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"]},"description":{"type":"string","description":"Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available."},"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_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."},"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},"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"]},"ids":{"description":"Must be set only if operator is SELECTED.","type":"array","items":{"type":"string"}},"operator":{"type":"string","enum":["ALL","SELECTED"]}},"required":["type","operator"],"example":{"type":"ENTITLEMENT","ids":["2c90ad2a70ace7d50170acf22ca90010"],"operator":"SELECTED"}},"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_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"}},"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"]},"id":{"type":"string","description":"The ID of the remediator."},"name":{"type":"string","description":"The name of the remediator.","readOnly":true}},"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."},"description":{"type":"string","description":"Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available."}},"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"]},"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},"completedCertifications":{"type":"integer","description":"The number of completed certifications in this campaign.","readOnly":true},"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"},"type":{"type":"string","enum":["SOURCE"]},"name":{"type":"string"}}}}}}],"example":{"id":"2c9079b270a266a60170a2779fcb0007","name":"Manager Campaign","description":"Everyone needs to be reviewed by their manager.","created":"2020-03-03T22:15:13.611Z","modified":"2020-03-03T22:20:12.674Z","deadline":"2020-03-15T00:00:00.456Z","type":"MANAGER","emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"status":"ACTIVE","filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c"}}}},"required":["name","description","created","modified","campaign"],"example":{"id":"2c9079b270a266a60170a277bb960008","name":"Manager Campaign Template","description":"Template for the annual manager campaign.","created":"2020-03-05T22:44:00.364Z","modified":"2020-03-05T22:52:09.969Z","ownerRef":{"type":"IDENTITY","id":"2c918086676d3e0601677611dbde220f","email":"mr.manager@example.com","name":"Mister Manager"},"deadlineDuration":"P2W","campaign":{"name":"%Y Manager Campaign","description":"Everyone needs to be reviewed by their manager.","type":"MANAGER","emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c"}}}},"examples":{"Manager":{"description":"This creates a template that can be used to generate manager campaigns. The campaigns will have a due date that is two weeks after their creation date, and will be named \"{current date} Manager Review\" (e.g. \"2020-03-16 Manager Review\").","value":{"name":"Manager Review","description":"A review of everyone's access by their manager.","deadlineDuration":"P2W","campaign":{"name":"Manager Review","description":"Review everyone's access.","type":"MANAGER","filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c"},"emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false}}},"Search":{"description":"This creates a template that can be used to generate search access campaigns. The campaigns will cover the \"reporter\" access item for across all identities.","value":{"name":"Reporting Access Review","description":"A review of everyone's access to the reporting system.","deadlineDuration":"P2W","campaign":{"name":"Search Review","description":"Review everyone's access to the reporting system.","type":"SEARCH","filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c"},"searchCampaignInfo":{"type":"ACCESS","query":"@access(name: (\"reporter\"))","description":"Identities with reporting abilities"},"emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false}}},"Source Owner":{"description":"This creates a template that can be used to generate source owner campaigns. The campaigns will have a due date that is one month after their creation date, and will review one source.","value":{"name":"AD Source Review","description":"A review of our AD source.","deadlineDuration":"P1M","campaign":{"name":"Source Review","description":"Review everyone's access.","type":"SOURCE_OWNER","filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c"},"sourceOwnerCampaignInfo":{"sourceIds":["2c918084707deba501709d45ce4e5569"]},"emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false}}},"RoleComposition":{"description":"This creates a template that can be used to generate role composition campaigns. The campaigns will have a due date that is two weeks after their creation date, and will be named \"{current date} Role Composition Review\" (e.g. \"2020-03-16 Role Composition Review\").","value":{"name":"Role Composition Review","description":"A review of every role's access items, by the specified reviewer.","deadlineDuration":"P2W","campaign":{"name":"Role Composition Review","description":"Review all our roles.","type":"ROLE_COMPOSITION","roleCompositionCampaignInfo":{"remediatorRef":{"type":"IDENTITY","id":"2c9180876ab2c053016ab6f65dfd5aaa"}},"emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false}}}}}}},"responses":{"200":{"description":"Created successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"This template's name. Has no bearing on generated campaigns' names."},"description":{"type":"string","description":"This template's description. Has no bearing on generated campaigns' descriptions."},"created":{"type":"string","readOnly":true,"format":"date-time"},"modified":{"type":"string","readOnly":true,"format":"date-time"},"scheduled":{"type":"boolean","readOnly":true,"description":"Indicates if this campaign template has been scheduled."},"ownerRef":{"type":"object","description":"The owner of this template, and the owner of campaigns generated from this template via a schedule. This field is automatically populated at creation time with the current user.","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["IDENTITY"]},"name":{"type":"string"},"email":{"type":"string"}}},"deadlineDuration":{"type":"string","description":"The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign's deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was \"P2W\" (two weeks), the resulting campaign's deadline would be 2020-01-15 (the current date plus 14 days)."},"campaign":{"type":"object","title":"Campaign","allOf":[{"type":"object","title":"Slim Campaign","required":["name","description","type"],"properties":{"id":{"type":"string","readOnly":true},"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"},"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."},"deadline":{"type":"string","format":"date-time","description":"The campaign's completion deadline."},"type":{"type":"string","description":"The type of campaign. Could be extended in the future.","enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"]},"emailNotificationEnabled":{"type":"boolean"},"autoRevokeAllowed":{"type":"boolean"},"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."},"status":{"type":"string","description":"The campaign's current status.","readOnly":true,"enum":["PENDING","STAGED","CANCELING","ACTIVATING","ACTIVE","COMPLETING","COMPLETED","ERROR","ARCHIVED"]}},"example":{"id":"2c9079b270a266a60170a2779fcb0007","name":"Manager Campaign","description":"Everyone needs to be reviewed by their manager.","deadline":"2020-03-15T10:00:01.456Z","type":"MANAGER","emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"status":"ACTIVE"}},{"type":"object","properties":{"created":{"type":"string","readOnly":true,"format":"date-time"},"modified":{"type":"string","readOnly":true,"format":"date-time"},"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."},"type":{"type":"string","enum":["CAMPAIGN_FILTER"]}}},"sunsetCommentsRequired":{"type":"boolean","description":"Determines if comments on sunset date changes are required.","default":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"}}}},"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"]},"description":{"type":"string","description":"Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available."},"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_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."},"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},"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"]},"ids":{"description":"Must be set only if operator is SELECTED.","type":"array","items":{"type":"string"}},"operator":{"type":"string","enum":["ALL","SELECTED"]}},"required":["type","operator"],"example":{"type":"ENTITLEMENT","ids":["2c90ad2a70ace7d50170acf22ca90010"],"operator":"SELECTED"}},"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_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"}},"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"]},"id":{"type":"string","description":"The ID of the remediator."},"name":{"type":"string","description":"The name of the remediator.","readOnly":true}},"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."},"description":{"type":"string","description":"Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available."}},"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"]},"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},"completedCertifications":{"type":"integer","description":"The number of completed certifications in this campaign.","readOnly":true},"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"},"type":{"type":"string","enum":["SOURCE"]},"name":{"type":"string"}}}}}}],"example":{"id":"2c9079b270a266a60170a2779fcb0007","name":"Manager Campaign","description":"Everyone needs to be reviewed by their manager.","created":"2020-03-03T22:15:13.611Z","modified":"2020-03-03T22:20:12.674Z","deadline":"2020-03-15T00:00:00.456Z","type":"MANAGER","emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"status":"ACTIVE","filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c"}}}},"required":["name","description","created","modified","campaign"],"example":{"id":"2c9079b270a266a60170a277bb960008","name":"Manager Campaign Template","description":"Template for the annual manager campaign.","created":"2020-03-05T22:44:00.364Z","modified":"2020-03-05T22:52:09.969Z","ownerRef":{"type":"IDENTITY","id":"2c918086676d3e0601677611dbde220f","email":"mr.manager@example.com","name":"Mister Manager"},"deadlineDuration":"P2W","campaign":{"name":"%Y Manager Campaign","description":"Everyone needs to be reviewed by their manager.","type":"MANAGER","emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c"}}}},"examples":{"Manager":{"value":{"id":"e7dbec99d49349c8951bd84f58a05120","name":"Manager Review","created":"2022-08-02T19:16:42.632Z","modified":null,"description":"A review of everyone's access by their manager.","deadlineDuration":"P14D","ownerRef":{"email":"support@testmail.identitysoon.com","type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"scheduled":false,"campaign":{"created":null,"modified":null,"filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":null,"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":null,"completedCertifications":null,"sourcesWithOrphanEntitlements":null,"id":null,"name":"Manager Review","description":"Review everyone's access.","deadline":null,"type":"MANAGER","status":null,"emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false}}},"Search":{"value":{"id":"b7e6459eed5247ac8b98a5fed81fe27f","name":"Reporting Access Review","created":"2022-07-28T19:19:40.035Z","modified":null,"description":"A review of everyone's access to the reporting system.","deadlineDuration":"P14D","ownerRef":{"email":"support@testmail.identitysoon.com","type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"scheduled":false,"campaign":{"created":null,"modified":null,"filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":{"type":"ACCESS","description":"Identities with reporting abilities","reviewerId":null,"reviewer":null,"query":"@access(name: (\"reporter\"))","identityIds":null,"accessConstraints":[]},"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":null,"completedCertifications":null,"sourcesWithOrphanEntitlements":null,"id":null,"name":"Search Campaign Review","description":"Review everyone's access to the reporting system.","deadline":null,"type":"SEARCH","status":null,"emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false}}},"Source Owner":{"value":{"id":"b9f41bc69e7a4291b9de0630396d030d","name":"AD Source Review","created":"2022-08-02T13:40:36.857Z","modified":null,"description":"A review of our AD source.","deadlineDuration":"P1M","ownerRef":{"email":"support@testmail.identitysoon.com","type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"scheduled":false,"campaign":{"created":null,"modified":null,"filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":{"sourceIds":["2c918084707deba501709d45ce4e5569"]},"searchCampaignInfo":null,"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":null,"completedCertifications":null,"sourcesWithOrphanEntitlements":null,"id":null,"name":"AD Source Review","description":"Review everyone's access.","deadline":null,"type":"SOURCE_OWNER","status":null,"emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false}}},"RoleComposition":{"value":{"id":"b9f41bc69e7a4291b9de0630396d030d","name":"Campaign With Admin Role","created":"2022-08-02T13:40:36.857Z","modified":null,"description":"Campaign With Admin Role","deadlineDuration":null,"ownerRef":{"email":"support@testmail.identitysoon.com","type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"scheduled":false,"campaign":{"created":null,"modified":null,"filter":null,"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":null,"completedCertifications":null,"sourcesWithOrphanEntitlements":null,"id":null,"name":"Campaign With Admin Role","description":"Campaign With Admin Role","deadline":null,"type":"ROLE_COMPOSITION","status":null,"emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false}}}}}}},"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."}]}}}}}}},"description":"Create a Campaign Template","method":"post","path":"/campaign-templates","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/docs/authentication.html) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/docs/authentication.html#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/docs/authentication.html#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/docs/authentication.html#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/docs/authentication.html#which-oauth-2-0-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/docs/authentication.html#finding-your-tenant-s-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"}}}}},"jsonRequestBodyExample":{"id":"2c9079b270a266a60170a277bb960008","name":"Manager Campaign Template","description":"Template for the annual manager campaign.","created":"2020-03-05T22:44:00.364Z","modified":"2020-03-05T22:52:09.969Z","ownerRef":{"type":"IDENTITY","id":"2c918086676d3e0601677611dbde220f","email":"mr.manager@example.com","name":"Mister Manager"},"deadlineDuration":"P2W","campaign":{"name":"%Y Manager Campaign","description":"Everyone needs to be reviewed by their manager.","type":"MANAGER","emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c"}}},"info":{"contact":{"email":"developers@sailpoint.com","name":"Developer Relations","url":"https://developer.sailpoint.com/discuss"},"description":"These are the public, beta APIs for SailPoint's SaaS services and are subject to change.","title":"SailPoint - Beta SaaS API","version":"3.1.0-beta"},"postman":{"name":"Create a Campaign Template","description":{"type":"text/plain"},"url":{"path":["campaign-templates"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}}
sidebar_class_name: "post api-method"
info_path: docs/sailpoint-api-beta/sail-point-beta-saa-s-api
---
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";
## Create a Campaign Template
Create a Campaign Template
<MimeTabs><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Request Body</strong><strong style={{"fontSize":"var(--ifm-code-font-size)","color":"var(--openapi-required)"}}> required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaDescription={"This template's name. Has no bearing on generated campaigns' names."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaDescription={"This template's description. Has no bearing on generated campaigns' descriptions."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>ownerRef</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The owner of this template, and the owner of campaigns generated from this template via a schedule. This field is automatically populated at creation time with the current user.
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={undefined} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"deadlineDuration"} required={false} schemaDescription={"The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign's deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was \"P2W\" (two weeks), the resulting campaign's deadline would be 2020-01-15 (the current date plus 14 days)."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>campaign</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={true} 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={true} 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} schemaDescription={"The campaign's completion deadline."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} 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} schemaDescription={undefined} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"autoRevokeAllowed"} required={false} schemaDescription={undefined} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"recommendationsEnabled"} required={false} 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={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} 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} schemaDescription={undefined} schemaName={"string"} qualifierMessage={"**Possible values:** [`CAMPAIGN_FILTER`]"} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"sunsetCommentsRequired"} required={false} 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} 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={true} schemaDescription={"The type of search campaign represented."} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`, `ACCESS`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} 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} 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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} 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} 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} 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={true} schemaDescription={undefined} schemaName={"string"} qualifierMessage={"**Possible values:** [`ENTITLEMENT`, `ACCESS_PROFILE`, `ROLE`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"ids"} required={false} schemaDescription={"Must be set only if operator is SELECTED."} schemaName={"string[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"operator"} required={true} schemaDescription={undefined} 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} 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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} 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} 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={true} schemaDescription={undefined} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaDescription={"The ID of the remediator."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"query"} required={false} 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} 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} schemaDescription={undefined} 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} 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} 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} 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={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} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={undefined} schemaName={"string"} qualifierMessage={"**Possible values:** [`SOURCE`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
Created successfully.
</div><div><MimeTabs groupId={"mime-type"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs groupId={"schema-tabs"}><TabTtem 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={"id"} required={false} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"This template's name. Has no bearing on generated campaigns' names."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaDescription={"This template's description. Has no bearing on generated campaigns' descriptions."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaDescription={undefined} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaDescription={undefined} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"scheduled"} required={false} schemaDescription={"Indicates if this campaign template has been scheduled."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>ownerRef</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The owner of this template, and the owner of campaigns generated from this template via a schedule. This field is automatically populated at creation time with the current user.
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={undefined} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"deadlineDuration"} required={false} schemaDescription={"The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign's deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was \"P2W\" (two weeks), the resulting campaign's deadline would be 2020-01-15 (the current date plus 14 days)."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>campaign</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} 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} 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} schemaDescription={"The campaign's completion deadline."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} 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} schemaDescription={undefined} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"autoRevokeAllowed"} required={false} schemaDescription={undefined} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"recommendationsEnabled"} required={false} 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={undefined}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} 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={"created"} required={false} schemaDescription={undefined} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaDescription={undefined} 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} 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} schemaDescription={undefined} schemaName={"string"} qualifierMessage={"**Possible values:** [`CAMPAIGN_FILTER`]"} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"sunsetCommentsRequired"} required={false} 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} 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} schemaDescription={"The type of search campaign represented."} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`, `ACCESS`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} 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} 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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} 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} 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} 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} schemaDescription={undefined} schemaName={"string"} qualifierMessage={"**Possible values:** [`ENTITLEMENT`, `ACCESS_PROFILE`, `ROLE`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"ids"} required={false} schemaDescription={"Must be set only if operator is SELECTED."} schemaName={"string[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"operator"} required={false} schemaDescription={undefined} 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} 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_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"ID of the object to which this reference applies"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} 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} 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} schemaDescription={undefined} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={"The ID of the remediator."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={"The name of the remediator."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"query"} required={false} 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} 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} schemaDescription={undefined} 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} 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} 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} 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} schemaDescription={"The total number of certifications in this campaign."} schemaName={"integer"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"completedCertifications"} required={false} 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} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaDescription={undefined} schemaName={"string"} qualifierMessage={"**Possible values:** [`SOURCE`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabTtem><TabItem label={" Manager"} value={" Manager"}><ResponseSamples responseExample={"{\n \"id\": \"e7dbec99d49349c8951bd84f58a05120\",\n \"name\": \"Manager Review\",\n \"created\": \"2022-08-02T19:16:42.632Z\",\n \"modified\": null,\n \"description\": \"A review of everyone's access by their manager.\",\n \"deadlineDuration\": \"P14D\",\n \"ownerRef\": {\n \"email\": \"support@testmail.identitysoon.com\",\n \"type\": \"IDENTITY\",\n \"id\": \"7ec252acbd4245548bc25df22348cb75\",\n \"name\": \"SailPoint Support\"\n },\n \"scheduled\": false,\n \"campaign\": {\n \"created\": null,\n \"modified\": null,\n \"filter\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"e0adaae69852e8fe8b8a3d48e5ce757c\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": null,\n \"searchCampaignInfo\": null,\n \"roleCompositionCampaignInfo\": null,\n \"alerts\": null,\n \"totalCertifications\": null,\n \"completedCertifications\": null,\n \"sourcesWithOrphanEntitlements\": null,\n \"id\": null,\n \"name\": \"Manager Review\",\n \"description\": \"Review everyone's access.\",\n \"deadline\": null,\n \"type\": \"MANAGER\",\n \"status\": null,\n \"emailNotificationEnabled\": true,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false\n }\n}"}></ResponseSamples></TabItem><TabItem label={" Search"} value={" Search"}><ResponseSamples responseExample={"{\n \"id\": \"b7e6459eed5247ac8b98a5fed81fe27f\",\n \"name\": \"Reporting Access Review\",\n \"created\": \"2022-07-28T19:19:40.035Z\",\n \"modified\": null,\n \"description\": \"A review of everyone's access to the reporting system.\",\n \"deadlineDuration\": \"P14D\",\n \"ownerRef\": {\n \"email\": \"support@testmail.identitysoon.com\",\n \"type\": \"IDENTITY\",\n \"id\": \"7ec252acbd4245548bc25df22348cb75\",\n \"name\": \"SailPoint Support\"\n },\n \"scheduled\": false,\n \"campaign\": {\n \"created\": null,\n \"modified\": null,\n \"filter\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"e0adaae69852e8fe8b8a3d48e5ce757c\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": null,\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"Identities with reporting abilities\",\n \"reviewerId\": null,\n \"reviewer\": null,\n \"query\": \"@access(name: (\\\"reporter\\\"))\",\n \"identityIds\": null,\n \"accessConstraints\": []\n },\n \"roleCompositionCampaignInfo\": null,\n \"alerts\": null,\n \"totalCertifications\": null,\n \"completedCertifications\": null,\n \"sourcesWithOrphanEntitlements\": null,\n \"id\": null,\n \"name\": \"Search Campaign Review\",\n \"description\": \"Review everyone's access to the reporting system.\",\n \"deadline\": null,\n \"type\": \"SEARCH\",\n \"status\": null,\n \"emailNotificationEnabled\": true,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false\n }\n}"}></ResponseSamples></TabItem><TabItem label={" Source Owner"} value={" Source Owner"}><ResponseSamples responseExample={"{\n \"id\": \"b9f41bc69e7a4291b9de0630396d030d\",\n \"name\": \"AD Source Review\",\n \"created\": \"2022-08-02T13:40:36.857Z\",\n \"modified\": null,\n \"description\": \"A review of our AD source.\",\n \"deadlineDuration\": \"P1M\",\n \"ownerRef\": {\n \"email\": \"support@testmail.identitysoon.com\",\n \"type\": \"IDENTITY\",\n \"id\": \"7ec252acbd4245548bc25df22348cb75\",\n \"name\": \"SailPoint Support\"\n },\n \"scheduled\": false,\n \"campaign\": {\n \"created\": null,\n \"modified\": null,\n \"filter\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"e0adaae69852e8fe8b8a3d48e5ce757c\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"2c918084707deba501709d45ce4e5569\"\n ]\n },\n \"searchCampaignInfo\": null,\n \"roleCompositionCampaignInfo\": null,\n \"alerts\": null,\n \"totalCertifications\": null,\n \"completedCertifications\": null,\n \"sourcesWithOrphanEntitlements\": null,\n \"id\": null,\n \"name\": \"AD Source Review\",\n \"description\": \"Review everyone's access.\",\n \"deadline\": null,\n \"type\": \"SOURCE_OWNER\",\n \"status\": null,\n \"emailNotificationEnabled\": true,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false\n }\n}"}></ResponseSamples></TabItem><TabItem label={" Role Composition"} value={" Role Composition"}><ResponseSamples responseExample={"{\n \"id\": \"b9f41bc69e7a4291b9de0630396d030d\",\n \"name\": \"Campaign With Admin Role\",\n \"created\": \"2022-08-02T13:40:36.857Z\",\n \"modified\": null,\n \"description\": \"Campaign With Admin Role\",\n \"deadlineDuration\": null,\n \"ownerRef\": {\n \"email\": \"support@testmail.identitysoon.com\",\n \"type\": \"IDENTITY\",\n \"id\": \"7ec252acbd4245548bc25df22348cb75\",\n \"name\": \"SailPoint Support\"\n },\n \"scheduled\": false,\n \"campaign\": {\n \"created\": null,\n \"modified\": null,\n \"filter\": null,\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\": null,\n \"totalCertifications\": null,\n \"completedCertifications\": null,\n \"sourcesWithOrphanEntitlements\": null,\n \"id\": null,\n \"name\": \"Campaign With Admin Role\",\n \"description\": \"Campaign With Admin Role\",\n \"deadline\": null,\n \"type\": \"ROLE_COMPOSITION\",\n \"status\": null,\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false\n }\n}"}></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 groupId={"mime-type"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs groupId={"schema-tabs"}><TabTtem 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} 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} 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} 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} 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} 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} 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} 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} schemaDescription={"Actual text of the error message in the indicated locale."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></ul></details></TabTtem></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 groupId={"mime-type"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs groupId={"schema-tabs"}><TabTtem 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} schemaDescription={"A message describing the error"} schemaName={""} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabTtem></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 groupId={"mime-type"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs groupId={"schema-tabs"}><TabTtem 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} 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} 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} 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} 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} 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} 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} 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} schemaDescription={"Actual text of the error message in the indicated locale."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></ul></details></TabTtem><TabItem label={"403"} value={"403"}><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}"}></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 groupId={"mime-type"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs groupId={"schema-tabs"}><TabTtem 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} schemaDescription={"A message describing the error"} schemaName={""} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabTtem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
Internal Server Error - Returned if there is an unexpected error.
</div><div><MimeTabs groupId={"mime-type"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs groupId={"schema-tabs"}><TabTtem 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} 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} 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} 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} 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} 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} 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} 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} schemaDescription={"Actual text of the error message in the indicated locale."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></ul></details></TabTtem><TabItem label={"500"} value={"500"}><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}"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>
Reference in New Issue View Git Blame Copy Permalink