mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 20:37:50 +00:00
Apply automatic changes
This commit is contained in:
tyler-mairose-sp
committed by
github-actions[bot]
github-actions[bot]
parent
cc7b22aa77
commit
21c46ba045
@@ -15332,6 +15332,947 @@ paths:
|
||||
localeOrigin: DEFAULT
|
||||
text: An internal fault occurred.
|
||||
/campaigns:
|
||||
get:
|
||||
operationId: getActiveCampaigns
|
||||
tags:
|
||||
- Certification Campaigns
|
||||
summary: List Campaigns
|
||||
description: Gets campaigns and returns them in a list. Can provide increased level of detail for each campaign if provided the correct query.
|
||||
security:
|
||||
- oauth2: []
|
||||
parameters:
|
||||
- in: query
|
||||
name: detail
|
||||
schema:
|
||||
type: string
|
||||
enum:
|
||||
- SLIM
|
||||
- FULL
|
||||
required: false
|
||||
description: 'Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.'
|
||||
example: FULL
|
||||
- in: query
|
||||
name: limit
|
||||
description: |-
|
||||
Max number of results to return.
|
||||
See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
required: false
|
||||
example: 250
|
||||
schema:
|
||||
type: integer
|
||||
format: int32
|
||||
minimum: 0
|
||||
maximum: 250
|
||||
default: 250
|
||||
- in: query
|
||||
name: offset
|
||||
description: |-
|
||||
Offset into the full result set. Usually specified with *limit* to paginate through the results.
|
||||
See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
required: false
|
||||
example: 0
|
||||
schema:
|
||||
type: integer
|
||||
format: int32
|
||||
minimum: 0
|
||||
default: 0
|
||||
- in: query
|
||||
name: count
|
||||
description: |-
|
||||
If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.
|
||||
|
||||
Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.
|
||||
|
||||
See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
required: false
|
||||
example: true
|
||||
schema:
|
||||
type: boolean
|
||||
default: false
|
||||
- in: query
|
||||
name: filters
|
||||
schema:
|
||||
type: string
|
||||
required: false
|
||||
description: |-
|
||||
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
||||
|
||||
Filtering is supported for the following fields and operators:
|
||||
|
||||
**id**: *eq, in*
|
||||
|
||||
**name**: *eq, sw*
|
||||
|
||||
**status**: *eq, in*
|
||||
example: name eq "Manager Campaign"
|
||||
- in: query
|
||||
name: sorters
|
||||
schema:
|
||||
type: string
|
||||
format: comma-separated
|
||||
required: false
|
||||
description: |-
|
||||
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
||||
|
||||
Sorting is supported for the following fields: **name**, **created**
|
||||
example: name
|
||||
responses:
|
||||
'200':
|
||||
description: A list of campaign objects.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
oneOf:
|
||||
- type: object
|
||||
title: Slim Campaign
|
||||
required:
|
||||
- name
|
||||
- description
|
||||
- type
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
readOnly: true
|
||||
description: Id of the campaign
|
||||
example: 2c9079b270a266a60170a2779fcb0007
|
||||
name:
|
||||
description: 'The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.'
|
||||
type: string
|
||||
example: Manager Campaign
|
||||
description:
|
||||
type: string
|
||||
description: 'The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.'
|
||||
example: Everyone needs to be reviewed by their manager
|
||||
deadline:
|
||||
type: string
|
||||
format: date-time
|
||||
description: The campaign's completion deadline.
|
||||
example: '2020-03-15T10:00:01.456Z'
|
||||
type:
|
||||
type: string
|
||||
description: The type of campaign. Could be extended in the future.
|
||||
enum:
|
||||
- MANAGER
|
||||
- SOURCE_OWNER
|
||||
- SEARCH
|
||||
- ROLE_COMPOSITION
|
||||
example: MANAGER
|
||||
emailNotificationEnabled:
|
||||
type: boolean
|
||||
description: Enables email notification for this campaign
|
||||
default: false
|
||||
example: false
|
||||
autoRevokeAllowed:
|
||||
type: boolean
|
||||
description: Allows auto revoke for this campaign
|
||||
default: false
|
||||
example: false
|
||||
recommendationsEnabled:
|
||||
type: boolean
|
||||
description: Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.
|
||||
default: false
|
||||
example: true
|
||||
status:
|
||||
type: string
|
||||
description: The campaign's current status.
|
||||
readOnly: true
|
||||
enum:
|
||||
- PENDING
|
||||
- STAGED
|
||||
- CANCELING
|
||||
- ACTIVATING
|
||||
- ACTIVE
|
||||
- COMPLETING
|
||||
- COMPLETED
|
||||
- ERROR
|
||||
- ARCHIVED
|
||||
example: ACTIVE
|
||||
correlatedStatus:
|
||||
type: string
|
||||
description: The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).
|
||||
enum:
|
||||
- CORRELATED
|
||||
- UNCORRELATED
|
||||
example: CORRELATED
|
||||
- type: object
|
||||
title: Campaign
|
||||
allOf:
|
||||
- type: object
|
||||
title: Slim Campaign
|
||||
required:
|
||||
- name
|
||||
- description
|
||||
- type
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
readOnly: true
|
||||
description: Id of the campaign
|
||||
example: 2c9079b270a266a60170a2779fcb0007
|
||||
name:
|
||||
description: 'The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.'
|
||||
type: string
|
||||
example: Manager Campaign
|
||||
description:
|
||||
type: string
|
||||
description: 'The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.'
|
||||
example: Everyone needs to be reviewed by their manager
|
||||
deadline:
|
||||
type: string
|
||||
format: date-time
|
||||
description: The campaign's completion deadline.
|
||||
example: '2020-03-15T10:00:01.456Z'
|
||||
type:
|
||||
type: string
|
||||
description: The type of campaign. Could be extended in the future.
|
||||
enum:
|
||||
- MANAGER
|
||||
- SOURCE_OWNER
|
||||
- SEARCH
|
||||
- ROLE_COMPOSITION
|
||||
example: MANAGER
|
||||
emailNotificationEnabled:
|
||||
type: boolean
|
||||
description: Enables email notification for this campaign
|
||||
default: false
|
||||
example: false
|
||||
autoRevokeAllowed:
|
||||
type: boolean
|
||||
description: Allows auto revoke for this campaign
|
||||
default: false
|
||||
example: false
|
||||
recommendationsEnabled:
|
||||
type: boolean
|
||||
description: Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.
|
||||
default: false
|
||||
example: true
|
||||
status:
|
||||
type: string
|
||||
description: The campaign's current status.
|
||||
readOnly: true
|
||||
enum:
|
||||
- PENDING
|
||||
- STAGED
|
||||
- CANCELING
|
||||
- ACTIVATING
|
||||
- ACTIVE
|
||||
- COMPLETING
|
||||
- COMPLETED
|
||||
- ERROR
|
||||
- ARCHIVED
|
||||
example: ACTIVE
|
||||
correlatedStatus:
|
||||
type: string
|
||||
description: The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).
|
||||
enum:
|
||||
- CORRELATED
|
||||
- UNCORRELATED
|
||||
example: CORRELATED
|
||||
- type: object
|
||||
properties:
|
||||
created:
|
||||
type: string
|
||||
readOnly: true
|
||||
format: date-time
|
||||
description: Created time of the campaign
|
||||
example: '2020-03-03T22:15:13.611Z'
|
||||
modified:
|
||||
type: string
|
||||
readOnly: true
|
||||
format: date-time
|
||||
description: Modified time of the campaign
|
||||
example: '2020-03-03T22:20:12.674Z'
|
||||
correlatedStatus:
|
||||
description: The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).
|
||||
enum:
|
||||
- CORRELATED
|
||||
- UNCORRELATED
|
||||
example: CORRELATED
|
||||
filter:
|
||||
type: object
|
||||
description: Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank.
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The ID of whatever type of filter is being used.
|
||||
example: 0fbe863c063c4c88a35fd7f17e8a3df5
|
||||
type:
|
||||
type: string
|
||||
description: Type of the filter
|
||||
enum:
|
||||
- CAMPAIGN_FILTER
|
||||
- RULE
|
||||
example: CAMPAIGN_FILTER
|
||||
name:
|
||||
type: string
|
||||
description: Name of the filter
|
||||
example: Test Filter
|
||||
sunsetCommentsRequired:
|
||||
type: boolean
|
||||
description: Determines if comments on sunset date changes are required.
|
||||
default: true
|
||||
example: true
|
||||
sourceOwnerCampaignInfo:
|
||||
type: object
|
||||
description: Must be set only if the campaign type is SOURCE_OWNER.
|
||||
properties:
|
||||
sourceIds:
|
||||
type: array
|
||||
description: The list of sources to be included in the campaign.
|
||||
items:
|
||||
type: string
|
||||
example:
|
||||
- 0fbe863c063c4c88a35fd7f17e8a3df5
|
||||
searchCampaignInfo:
|
||||
type: object
|
||||
description: Must be set only if the campaign type is SEARCH.
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
description: The type of search campaign represented.
|
||||
enum:
|
||||
- IDENTITY
|
||||
- ACCESS
|
||||
example: ACCESS
|
||||
description:
|
||||
type: string
|
||||
description: 'Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available.'
|
||||
example: Search Campaign description
|
||||
reviewer:
|
||||
description: 'If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP'
|
||||
allOf:
|
||||
- type: object
|
||||
properties:
|
||||
type:
|
||||
description: DTO type
|
||||
type: string
|
||||
enum:
|
||||
- ACCOUNT_CORRELATION_CONFIG
|
||||
- ACCESS_PROFILE
|
||||
- ACCESS_REQUEST_APPROVAL
|
||||
- ACCOUNT
|
||||
- APPLICATION
|
||||
- CAMPAIGN
|
||||
- CAMPAIGN_FILTER
|
||||
- CERTIFICATION
|
||||
- CLUSTER
|
||||
- CONNECTOR_SCHEMA
|
||||
- ENTITLEMENT
|
||||
- GOVERNANCE_GROUP
|
||||
- IDENTITY
|
||||
- IDENTITY_PROFILE
|
||||
- IDENTITY_REQUEST
|
||||
- LIFECYCLE_STATE
|
||||
- PASSWORD_POLICY
|
||||
- ROLE
|
||||
- RULE
|
||||
- SOD_POLICY
|
||||
- SOURCE
|
||||
- TAG
|
||||
- TAG_CATEGORY
|
||||
- TASK_RESULT
|
||||
- REPORT_RESULT
|
||||
- SOD_VIOLATION
|
||||
- ACCOUNT_ACTIVITY
|
||||
example: IDENTITY
|
||||
id:
|
||||
type: string
|
||||
description: ID of the object to which this reference applies
|
||||
example: 2c91808568c529c60168cca6f90c1313
|
||||
name:
|
||||
type: string
|
||||
description: Human-readable display name of the object to which this reference applies
|
||||
example: William Wilson
|
||||
- type: object
|
||||
query:
|
||||
type: string
|
||||
description: The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set.
|
||||
example: Search Campaign query description
|
||||
identityIds:
|
||||
type: array
|
||||
description: A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set.
|
||||
items:
|
||||
type: string
|
||||
maxItems: 1000
|
||||
example:
|
||||
- 0fbe863c063c4c88a35fd7f17e8a3df5
|
||||
accessConstraints:
|
||||
type: array
|
||||
description: Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access.
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
enum:
|
||||
- ENTITLEMENT
|
||||
- ACCESS_PROFILE
|
||||
- ROLE
|
||||
description: Type of Access
|
||||
example: ENTITLEMENT
|
||||
ids:
|
||||
description: Must be set only if operator is SELECTED.
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example:
|
||||
- 2c90ad2a70ace7d50170acf22ca90010
|
||||
operator:
|
||||
type: string
|
||||
enum:
|
||||
- ALL
|
||||
- SELECTED
|
||||
description: Used to determine whether the scope of the campaign should be reduced for selected ids or all.
|
||||
example: SELECTED
|
||||
required:
|
||||
- type
|
||||
- operator
|
||||
maxItems: 1000
|
||||
required:
|
||||
- type
|
||||
roleCompositionCampaignInfo:
|
||||
type: object
|
||||
description: Optional configuration options for role composition campaigns.
|
||||
properties:
|
||||
reviewer:
|
||||
description: 'If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP'
|
||||
allOf:
|
||||
- type: object
|
||||
properties:
|
||||
type:
|
||||
description: DTO type
|
||||
type: string
|
||||
enum:
|
||||
- ACCOUNT_CORRELATION_CONFIG
|
||||
- ACCESS_PROFILE
|
||||
- ACCESS_REQUEST_APPROVAL
|
||||
- ACCOUNT
|
||||
- APPLICATION
|
||||
- CAMPAIGN
|
||||
- CAMPAIGN_FILTER
|
||||
- CERTIFICATION
|
||||
- CLUSTER
|
||||
- CONNECTOR_SCHEMA
|
||||
- ENTITLEMENT
|
||||
- GOVERNANCE_GROUP
|
||||
- IDENTITY
|
||||
- IDENTITY_PROFILE
|
||||
- IDENTITY_REQUEST
|
||||
- LIFECYCLE_STATE
|
||||
- PASSWORD_POLICY
|
||||
- ROLE
|
||||
- RULE
|
||||
- SOD_POLICY
|
||||
- SOURCE
|
||||
- TAG
|
||||
- TAG_CATEGORY
|
||||
- TASK_RESULT
|
||||
- REPORT_RESULT
|
||||
- SOD_VIOLATION
|
||||
- ACCOUNT_ACTIVITY
|
||||
example: IDENTITY
|
||||
id:
|
||||
type: string
|
||||
description: ID of the object to which this reference applies
|
||||
example: 2c91808568c529c60168cca6f90c1313
|
||||
name:
|
||||
type: string
|
||||
description: Human-readable display name of the object to which this reference applies
|
||||
example: William Wilson
|
||||
- type: object
|
||||
roleIds:
|
||||
type: array
|
||||
description: 'Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.'
|
||||
items:
|
||||
type: string
|
||||
example:
|
||||
- 2c90ad2a70ace7d50170acf22ca90010
|
||||
remediatorRef:
|
||||
type: object
|
||||
description: 'This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is ''IDENTITY'', and the chosen identity must be a Role Admin or Org Admin.'
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
enum:
|
||||
- IDENTITY
|
||||
description: Legal Remediator Type
|
||||
example: IDENTITY
|
||||
id:
|
||||
type: string
|
||||
description: The ID of the remediator.
|
||||
example: 2c90ad2a70ace7d50170acf22ca90010
|
||||
name:
|
||||
type: string
|
||||
description: The name of the remediator.
|
||||
readOnly: true
|
||||
example: Role Admin
|
||||
required:
|
||||
- type
|
||||
- id
|
||||
query:
|
||||
type: string
|
||||
description: 'Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.'
|
||||
example: Search Query
|
||||
description:
|
||||
type: string
|
||||
description: 'Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available.'
|
||||
example: Role Composition Description
|
||||
required:
|
||||
- remediatorRef
|
||||
alerts:
|
||||
type: array
|
||||
description: A list of errors and warnings that have accumulated.
|
||||
readOnly: true
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
level:
|
||||
type: string
|
||||
enum:
|
||||
- ERROR
|
||||
- WARN
|
||||
- INFO
|
||||
description: Denotes the level of the message
|
||||
example: ERROR
|
||||
localizations:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
|
||||
example: DEFAULT
|
||||
text:
|
||||
type: string
|
||||
description: Actual text of the error message in the indicated locale.
|
||||
example: The request was syntactically correct but its content is semantically invalid.
|
||||
totalCertifications:
|
||||
type: integer
|
||||
description: The total number of certifications in this campaign.
|
||||
readOnly: true
|
||||
example: 100
|
||||
completedCertifications:
|
||||
type: integer
|
||||
description: The number of completed certifications in this campaign.
|
||||
readOnly: true
|
||||
example: 10
|
||||
sourcesWithOrphanEntitlements:
|
||||
type: array
|
||||
description: A list of sources in the campaign that contain \"orphan entitlements\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented).
|
||||
readOnly: true
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: Id of the source
|
||||
example: 2c90ad2a70ace7d50170acf22ca90010
|
||||
type:
|
||||
type: string
|
||||
enum:
|
||||
- SOURCE
|
||||
description: Type
|
||||
example: SOURCE
|
||||
name:
|
||||
type: string
|
||||
description: Name of the source
|
||||
example: Source with orphan entitlements
|
||||
mandatoryCommentRequirement:
|
||||
type: string
|
||||
description: 'Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.'
|
||||
enum:
|
||||
- ALL_DECISIONS
|
||||
- REVOKE_ONLY_DECISIONS
|
||||
- NO_DECISIONS
|
||||
example: NO_DECISIONS
|
||||
examples:
|
||||
Slim Campaign:
|
||||
description: List of Slim Campaigns that would result from not specifying *detail* or specifying SLIM
|
||||
value:
|
||||
- id: 2c918086719eec070171a7e3355a360a
|
||||
name: Manager Review
|
||||
description: A review of everyone's access by their manager.
|
||||
deadline: '2020-12-25T06:00:00.123Z'
|
||||
type: MANAGER
|
||||
status: ACTIVE
|
||||
emailNotificationEnabled: false
|
||||
autoRevokeAllowed: false
|
||||
recommendationsEnabled: false
|
||||
- id: 7e1a731e3fb845cfbe58112ba4673ee4
|
||||
name: Search Campaign
|
||||
description: Search Campaign Info
|
||||
deadline: 2022-07-26T15:42:44.000Z
|
||||
type: SEARCH
|
||||
status: ACTIVE
|
||||
emailNotificationEnabled: false
|
||||
autoRevokeAllowed: false
|
||||
recommendationsEnabled: false
|
||||
- id: 2c918086719eec070171a7e3355a412b
|
||||
name: AD Source Review
|
||||
description: A review of our AD source.
|
||||
deadline: '2020-12-25T06:00:00.123Z'
|
||||
type: SOURCE_OWNER
|
||||
status: STAGED
|
||||
emailNotificationEnabled: true
|
||||
autoRevokeAllowed: false
|
||||
recommendationsEnabled: false
|
||||
correlatedStatus: CORRELATED
|
||||
- id: 3b2e2e5821e84127b6d693d41c40623b
|
||||
name: Role Composition Campaign
|
||||
description: A review done by a role owner.
|
||||
deadline: 2020-12-25T06:00:00.468Z
|
||||
type: ROLE_COMPOSITION
|
||||
status: ACTIVE
|
||||
emailNotificationEnabled: false
|
||||
autoRevokeAllowed: false
|
||||
recommendationsEnabled: false
|
||||
Full Campaign:
|
||||
description: List of Campaigns that would result from specifying *detail* as FULL
|
||||
value:
|
||||
- id: 078696a575e045c68d6722ccdb9f101d
|
||||
name: Role Composition Campaign
|
||||
description: A review done by a role owner.
|
||||
deadline: 2020-12-25T06:00:00.468Z
|
||||
type: ROLE_COMPOSITION
|
||||
status: ERROR
|
||||
emailNotificationEnabled: false
|
||||
autoRevokeAllowed: false
|
||||
recommendationsEnabled: false
|
||||
created: 2022-08-02T20:29:51.065Z
|
||||
modified: 2022-08-02T20:29:51.331Z
|
||||
filter:
|
||||
type: CAMPAIGN_FILTER
|
||||
id: 0fbe863c063c4c88a35fd7f17e8a3df5
|
||||
name: Test Role Composition Filter
|
||||
sunsetCommentsRequired: true
|
||||
sourceOwnerCampaignInfo: null
|
||||
searchCampaignInfo: null
|
||||
roleCompositionCampaignInfo:
|
||||
remediatorRef:
|
||||
type: IDENTITY
|
||||
id: 7ec252acbd4245548bc25df22348cb75
|
||||
name: SailPoint Support
|
||||
reviewerId: null
|
||||
reviewer: null
|
||||
roleIds:
|
||||
- b15d609fc5c8434b865fe552315fda8f
|
||||
query: null
|
||||
description: null
|
||||
alerts:
|
||||
- level: ERROR
|
||||
localizations:
|
||||
- locale: en
|
||||
localeOrigin: DEFAULT
|
||||
text: Composite criterion must have children non-composite criterion must not.
|
||||
totalCertifications: 0
|
||||
completedCertifications: 0
|
||||
sourcesWithOrphanEntitlements: null
|
||||
mandatoryCommentRequirement: NO_DECISIONS
|
||||
- id: 1be8fc1103914bf0a4e14e316b6a7b7c
|
||||
name: Manager Review
|
||||
description: A review of everyone's access by their manager.
|
||||
deadline: 2020-12-25T06:00:00.468Z
|
||||
type: MANAGER
|
||||
status: STAGED
|
||||
emailNotificationEnabled: false
|
||||
autoRevokeAllowed: false
|
||||
recommendationsEnabled: false
|
||||
created: 2022-08-02T19:00:27.731Z
|
||||
modified: 2022-08-02T19:00:34.391Z
|
||||
filter:
|
||||
type: CAMPAIGN_FILTER
|
||||
id: 0fbe863c063c4c88a35fd7f17e8a3df5
|
||||
name: Test Manager Filter
|
||||
sunsetCommentsRequired: true
|
||||
sourceOwnerCampaignInfo: null
|
||||
searchCampaignInfo: null
|
||||
roleCompositionCampaignInfo: null
|
||||
alerts: null
|
||||
totalCertifications: 5
|
||||
completedCertifications: 0
|
||||
sourcesWithOrphanEntitlements: []
|
||||
mandatoryCommentRequirement: NO_DECISIONS
|
||||
- id: 7e1a731e3fb845cfbe58112ba4673ee4
|
||||
name: Search Campaign
|
||||
description: Search Campaign for Identities
|
||||
deadline: 2022-07-26T15:42:44.000Z
|
||||
type: SEARCH
|
||||
status: ACTIVE
|
||||
emailNotificationEnabled: false
|
||||
autoRevokeAllowed: false
|
||||
recommendationsEnabled: false
|
||||
created: 2022-07-25T15:42:18.276Z
|
||||
modified: 2022-07-25T15:42:53.718Z
|
||||
filter:
|
||||
type: CAMPAIGN_FILTER
|
||||
id: 0fbe863c063c4c88a35fd7f17e8a3df5
|
||||
name: Test Search Filter
|
||||
sunsetCommentsRequired: true
|
||||
sourceOwnerCampaignInfo: null
|
||||
searchCampaignInfo:
|
||||
type: IDENTITY
|
||||
description: Example of Search Campaign
|
||||
reviewer:
|
||||
type: IDENTITY
|
||||
id: 7ec252acbd4245548bc25df22348cb75
|
||||
name: null
|
||||
query: user
|
||||
identityIds: null
|
||||
accessConstraints: []
|
||||
roleCompositionCampaignInfo: null
|
||||
alerts: null
|
||||
totalCertifications: 6
|
||||
completedCertifications: 0
|
||||
sourcesWithOrphanEntitlements: []
|
||||
mandatoryCommentRequirement: NO_DECISIONS
|
||||
- id: ad3cf3dd50394b1bad646de4bc51b999
|
||||
name: Source Owner Campaign
|
||||
description: Example for Source Owner Campaign
|
||||
deadline: 2022-08-10T17:09:02.000Z
|
||||
type: SOURCE_OWNER
|
||||
status: ACTIVE
|
||||
emailNotificationEnabled: true
|
||||
autoRevokeAllowed: false
|
||||
recommendationsEnabled: false
|
||||
created: 2022-07-27T17:04:19.027Z
|
||||
modified: 2022-07-27T17:09:13.925Z
|
||||
filter:
|
||||
type: CAMPAIGN_FILTER
|
||||
id: 0fbe863c063c4c88a35fd7f17e8a3df5
|
||||
name: Test Source Owner Filter
|
||||
sunsetCommentsRequired: true
|
||||
sourceOwnerCampaignInfo:
|
||||
sourceIds:
|
||||
- 2c91808781fd5aea01821200dc88318e
|
||||
searchCampaignInfo: null
|
||||
roleCompositionCampaignInfo: null
|
||||
alerts: null
|
||||
totalCertifications: 2
|
||||
completedCertifications: 0
|
||||
sourcesWithOrphanEntitlements: []
|
||||
correlatedStatus: CORRELATED
|
||||
mandatoryCommentRequirement: NO_DECISIONS
|
||||
'400':
|
||||
description: Client Error - Returned if the request body is invalid.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
description: Fine-grained error code providing more detail of the error.
|
||||
example: 400.1 Bad Request Content
|
||||
trackingId:
|
||||
type: string
|
||||
description: Unique tracking id for the error.
|
||||
example: e7eab60924f64aa284175b9fa3309599
|
||||
messages:
|
||||
type: array
|
||||
description: Generic localized reason for error
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
|
||||
example: DEFAULT
|
||||
text:
|
||||
type: string
|
||||
description: Actual text of the error message in the indicated locale.
|
||||
example: The request was syntactically correct but its content is semantically invalid.
|
||||
causes:
|
||||
type: array
|
||||
description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
|
||||
example: DEFAULT
|
||||
text:
|
||||
type: string
|
||||
description: Actual text of the error message in the indicated locale.
|
||||
example: The request was syntactically correct but its content is semantically invalid.
|
||||
'401':
|
||||
description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
error:
|
||||
description: A message describing the error
|
||||
example: 'JWT validation failed: JWT is expired'
|
||||
'403':
|
||||
description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
description: Fine-grained error code providing more detail of the error.
|
||||
example: 400.1 Bad Request Content
|
||||
trackingId:
|
||||
type: string
|
||||
description: Unique tracking id for the error.
|
||||
example: e7eab60924f64aa284175b9fa3309599
|
||||
messages:
|
||||
type: array
|
||||
description: Generic localized reason for error
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
|
||||
example: DEFAULT
|
||||
text:
|
||||
type: string
|
||||
description: Actual text of the error message in the indicated locale.
|
||||
example: The request was syntactically correct but its content is semantically invalid.
|
||||
causes:
|
||||
type: array
|
||||
description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
|
||||
example: DEFAULT
|
||||
text:
|
||||
type: string
|
||||
description: Actual text of the error message in the indicated locale.
|
||||
example: The request was syntactically correct but its content is semantically invalid.
|
||||
examples:
|
||||
'403':
|
||||
summary: An example of a 403 response object
|
||||
value:
|
||||
detailCode: 403 Forbidden
|
||||
trackingId: b21b1f7ce4da4d639f2c62a57171b427
|
||||
messages:
|
||||
- locale: en-US
|
||||
localeOrigin: DEFAULT
|
||||
text: The server understood the request but refuses to authorize it.
|
||||
'429':
|
||||
description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
message:
|
||||
description: A message describing the error
|
||||
example: ' Rate Limit Exceeded '
|
||||
'500':
|
||||
description: Internal Server Error - Returned if there is an unexpected error.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
description: Fine-grained error code providing more detail of the error.
|
||||
example: 400.1 Bad Request Content
|
||||
trackingId:
|
||||
type: string
|
||||
description: Unique tracking id for the error.
|
||||
example: e7eab60924f64aa284175b9fa3309599
|
||||
messages:
|
||||
type: array
|
||||
description: Generic localized reason for error
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
|
||||
example: DEFAULT
|
||||
text:
|
||||
type: string
|
||||
description: Actual text of the error message in the indicated locale.
|
||||
example: The request was syntactically correct but its content is semantically invalid.
|
||||
causes:
|
||||
type: array
|
||||
description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
|
||||
example: DEFAULT
|
||||
text:
|
||||
type: string
|
||||
description: Actual text of the error message in the indicated locale.
|
||||
example: The request was syntactically correct but its content is semantically invalid.
|
||||
examples:
|
||||
'500':
|
||||
summary: An example of a 500 response object
|
||||
value:
|
||||
detailCode: 500.0 Internal Fault
|
||||
trackingId: b21b1f7ce4da4d639f2c62a57171b427
|
||||
messages:
|
||||
- locale: en-US
|
||||
localeOrigin: DEFAULT
|
||||
text: An internal fault occurred.
|
||||
post:
|
||||
operationId: createCampaign
|
||||
tags:
|
||||
|
||||
Reference in New Issue
Block a user