From 70a94ff097cfa20156c4f32e2fee287f841b44f3 Mon Sep 17 00:00:00 2001 From: tyler-mairose-sp Date: Mon, 4 Sep 2023 12:45:47 +0000 Subject: [PATCH] Apply automatic changes --- dereferenced/deref-sailpoint-api.v3.yaml | 149630 ++++++++++--------- postman/collections/sailpoint-api-v3.json | 6720 +- 2 files changed, 78445 insertions(+), 77905 deletions(-) diff --git a/dereferenced/deref-sailpoint-api.v3.yaml b/dereferenced/deref-sailpoint-api.v3.yaml index a88b263c..79bd4a8b 100644 --- a/dereferenced/deref-sailpoint-api.v3.yaml +++ b/dereferenced/deref-sailpoint-api.v3.yaml @@ -21767,308 +21767,119 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - /certifications: + '/campaigns/{id}/reports': get: - operationId: listIdentityCertifications + operationId: getCampaignReports tags: - - Certifications - summary: Identity Campaign Certifications by IDs - description: 'This API returns a list of identity campaign certifications that satisfy the given query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to Governance Groups.' + - Certification Campaigns + summary: Get Campaign Reports + description: |- + Fetches all reports for a certification campaign by campaign ID. + Requires roles of CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN + security: + - UserContextAuth: + - 'idn:campaign-report:read' parameters: - - in: query - name: reviewer-identity - schema: - type: string - example: me - description: The ID of reviewer identity. *me* indicates the current user. - required: false - - 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 - required: false - schema: - type: string - example: id eq "ef38f94347e94562b5bb8424a56397d8" - 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* - **campaign.id**: *eq, in* - **phase**: *eq* - **completed**: *eq, ne* - - in: query - name: sorters - required: false + - in: path + name: campaignId schema: type: string - format: comma-separated - example: 'name,due' - 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, due, signed** + example: 2c91808571bcfcf80171c23e4b4221fc + required: true + description: The ID of the campaign for which reports are being fetched. responses: '200': - description: List of identity campaign certifications + description: Array of campaign report objects. content: application/json: schema: type: array items: type: object - properties: - id: - example: 2c9180835d2e5168015d32f890ca1581 - type: string - description: id of the certification - name: - example: 'Source Owner Access Review for Employees [source]' - type: string - description: name of the certification - campaign: - type: object - required: - - id - - name - - type - - campaignType - - description - - correlatedStatus - - mandatoryCommentRequirement - properties: - id: - type: string - description: The unique ID of the campaign. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the campaign. - example: Campaign Name - type: - type: string - enum: - - CAMPAIGN - description: The type of object that is being referenced. - example: CAMPAIGN - campaignType: - type: string - enum: - - MANAGER - - SOURCE_OWNER - - SEARCH - description: The type of the campaign. - example: MANAGER - description: - type: string - description: The description of the campaign set by the admin who created it. - nullable: true - example: A description of the campaign - 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 - 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 - completed: - type: boolean - description: Have all decisions been made? - example: true - identitiesCompleted: - type: integer - description: The number of identities for whom all decisions have been made and are complete. - example: 5 - format: int32 - identitiesTotal: - type: integer - description: 'The total number of identities in the Certification, both complete and incomplete.' - example: 10 - format: int32 - created: - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: created date - modified: - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: modified date - decisionsMade: - type: integer - description: The number of approve/revoke/acknowledge decisions that have been made. - example: 20 - format: int32 - decisionsTotal: - type: integer - description: The total number of approve/revoke/acknowledge decisions. - example: 40 - format: int32 - due: - type: string - format: date-time - description: The due date of the certification. - example: '2018-10-19T13:49:37.385Z' - signed: - type: string - format: date-time - nullable: true - description: The date the reviewer signed off on the Certification. - example: '2018-10-19T13:49:37.385Z' - reviewer: - type: object - properties: - id: - type: string - description: The id of the reviewer. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the reviewer. - example: Reviewer Name - email: - type: string - description: The email of the reviewing identity. - example: reviewer@test.com - type: - type: string - enum: - - IDENTITY - description: The type of the reviewing identity. - example: IDENTITY - created: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: The created date of the reviewing identity. - modified: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: The modified date of the reviewing identity. - reassignment: - type: object - nullable: true - properties: - from: - type: object + title: Campaign Report + required: + - reportType + allOf: + - 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 + - WORKGROUP + example: IDENTITY id: type: string - description: The id of the certification. - example: ef38f94347e94562b5bb8424a56397d8 + description: ID of the object to which this reference applies + example: 2c91808568c529c60168cca6f90c1313 name: type: string - description: The name of the certification. - example: Certification Name - type: + description: Human-readable display name of the object to which this reference applies + example: William Wilson + - type: object + properties: + status: type: string + description: Status of a violation report enum: - - CERTIFICATION - example: CERTIFICATION - reviewer: - type: object - properties: - id: - type: string - description: The id of the reviewer. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the reviewer. - example: Reviewer Name - email: - type: string - description: The email of the reviewing identity. - example: reviewer@test.com - type: - type: string - enum: - - IDENTITY - description: The type of the reviewing identity. - example: IDENTITY - created: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: The created date of the reviewing identity. - modified: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: The modified date of the reviewing identity. - comment: + - SUCCESS + - WARNING + - ERROR + - TERMINATED + - TEMP_ERROR + - PENDING + example: PENDING + - type: object + properties: + reportType: type: string - description: The comment entered when the Certification was reassigned - example: Reassigned for a reason - hasErrors: - description: Identifies if the certification has an error - type: boolean - example: false - errorMessage: - description: Description of the certification error - nullable: true - type: string - example: The certification has an error - phase: - type: string - description: | - The current phase of the campaign. - * `STAGED`: The campaign is waiting to be activated. - * `ACTIVE`: The campaign is active. - * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. - enum: - - STAGED - - ACTIVE - - SIGNED - example: ACTIVE + description: type of a Report + enum: + - CAMPAIGN_COMPOSITION_REPORT + - CAMPAIGN_REMEDIATION_STATUS_REPORT + - CAMPAIGN_STATUS_REPORT + - CERTIFICATION_SIGNOFF_REPORT + example: CAMPAIGN_COMPOSITION_REPORT + lastRunAt: + type: string + readOnly: true + format: date-time + description: The most recent date and time this report was run + example: + type: REPORT_RESULT + id: 2c91808568c529c60168cca6f90c1313 + name: Campaign Composition Report + status: SUCCESS + reportType: CAMPAIGN_COMPOSITION_REPORT + lastRunAt: '2019-12-19T13:49:37.385Z' '400': description: Client Error - Returned if the request body is invalid. content: @@ -22203,6 +22014,73 @@ paths: - locale: en-US localeOrigin: DEFAULT text: The server understood the request but refuses to authorize it. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. '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: @@ -22280,257 +22158,58 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/certifications/{id}': - get: - operationId: getIdentityCertification + '/campaigns/{id}/run-report/{type}': + post: + operationId: startCampaignReport tags: - - Certifications - summary: Identity Certification by ID - description: This API returns a single identity campaign certification by its ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + - Certification Campaigns + summary: Run Campaign Report + description: |- + Runs a report for a certification campaign. + Requires the following roles: CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN. + security: + - UserContextAuth: + - 'idn:campaign-report:run' parameters: - in: path name: id schema: type: string + example: 2c91808571bcfcf80171c23e4b4221fc required: true - description: The certification id - example: ef38f94347e94562b5bb8424a56397d8 + description: The ID of the campaign for which report is being run. + - in: path + name: type + schema: + type: string + description: type of a Report + enum: + - CAMPAIGN_COMPOSITION_REPORT + - CAMPAIGN_REMEDIATION_STATUS_REPORT + - CAMPAIGN_STATUS_REPORT + - CERTIFICATION_SIGNOFF_REPORT + example: CAMPAIGN_COMPOSITION_REPORT + required: true + description: The type of the report to run. responses: - '200': - description: An identity campaign certification object + '202': + description: Accepted - Returned if the request was successfully accepted into the system. + content: + application/json: + schema: + type: object + '400': + description: Client Error - Returned if the request body is invalid. content: application/json: schema: type: object properties: - id: - example: 2c9180835d2e5168015d32f890ca1581 + detailCode: type: string - description: id of the certification - name: - example: 'Source Owner Access Review for Employees [source]' - type: string - description: name of the certification - campaign: - type: object - required: - - id - - name - - type - - campaignType - - description - - correlatedStatus - - mandatoryCommentRequirement - properties: - id: - type: string - description: The unique ID of the campaign. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the campaign. - example: Campaign Name - type: - type: string - enum: - - CAMPAIGN - description: The type of object that is being referenced. - example: CAMPAIGN - campaignType: - type: string - enum: - - MANAGER - - SOURCE_OWNER - - SEARCH - description: The type of the campaign. - example: MANAGER - description: - type: string - description: The description of the campaign set by the admin who created it. - nullable: true - example: A description of the campaign - 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 - 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 - completed: - type: boolean - description: Have all decisions been made? - example: true - identitiesCompleted: - type: integer - description: The number of identities for whom all decisions have been made and are complete. - example: 5 - format: int32 - identitiesTotal: - type: integer - description: 'The total number of identities in the Certification, both complete and incomplete.' - example: 10 - format: int32 - created: - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: created date - modified: - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: modified date - decisionsMade: - type: integer - description: The number of approve/revoke/acknowledge decisions that have been made. - example: 20 - format: int32 - decisionsTotal: - type: integer - description: The total number of approve/revoke/acknowledge decisions. - example: 40 - format: int32 - due: - type: string - format: date-time - description: The due date of the certification. - example: '2018-10-19T13:49:37.385Z' - signed: - type: string - format: date-time - nullable: true - description: The date the reviewer signed off on the Certification. - example: '2018-10-19T13:49:37.385Z' - reviewer: - type: object - properties: - id: - type: string - description: The id of the reviewer. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the reviewer. - example: Reviewer Name - email: - type: string - description: The email of the reviewing identity. - example: reviewer@test.com - type: - type: string - enum: - - IDENTITY - description: The type of the reviewing identity. - example: IDENTITY - created: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: The created date of the reviewing identity. - modified: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: The modified date of the reviewing identity. - reassignment: - type: object - nullable: true - properties: - from: - type: object - properties: - id: - type: string - description: The id of the certification. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the certification. - example: Certification Name - type: - type: string - enum: - - CERTIFICATION - example: CERTIFICATION - reviewer: - type: object - properties: - id: - type: string - description: The id of the reviewer. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the reviewer. - example: Reviewer Name - email: - type: string - description: The email of the reviewing identity. - example: reviewer@test.com - type: - type: string - enum: - - IDENTITY - description: The type of the reviewing identity. - example: IDENTITY - created: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: The created date of the reviewing identity. - modified: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: The modified date of the reviewing identity. - comment: - type: string - description: The comment entered when the Certification was reassigned - example: Reassigned for a reason - hasErrors: - description: Identifies if the certification has an error - type: boolean - example: false - errorMessage: - description: Description of the certification error - nullable: true - type: string - example: The certification has an error - phase: - type: string - description: | - The current phase of the campaign. - * `STAGED`: The campaign is waiting to be activated. - * `ACTIVE`: The campaign is active. - * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. - enum: - - STAGED - - ACTIVE - - SIGNED - example: ACTIVE - '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: + 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 @@ -22797,21 +22476,261 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/certifications/{id}/access-review-items': + /campaigns/reports-configuration: get: - operationId: listIdentityAccessReviewItems + operationId: getCampaignReportsConfig + tags: + - Certification Campaigns + summary: Get Campaign Reports Configuration + description: |- + Fetches configuration for campaign reports. Currently it includes only one element - identity attributes defined as custom report columns. + Requires roles of CERT_ADMIN and ORG_ADMIN. + security: + - UserContextAuth: + - 'idn:campaign-reports-config:read' + responses: + '200': + description: Campaign Report Configuration + content: + application/json: + schema: + type: object + title: Campaign Reports Configuration + properties: + identityAttributeColumns: + type: array + description: list of identity attribute columns + items: + type: string + example: + - firstname + - lastname + '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. + /certifications: + get: + operationId: listIdentityCertifications tags: - Certifications - summary: List of Access Review Items - description: This API returns a list of access review items for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + summary: Identity Campaign Certifications by IDs + description: 'This API returns a list of identity campaign certifications that satisfy the given query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to Governance Groups.' parameters: - - in: path - name: id + - in: query + name: reviewer-identity schema: type: string - required: true - description: The identity campaign certification ID - example: ef38f94347e94562b5bb8424a56397d8 + example: me + description: The ID of reviewer identity. *me* indicates the current user. + required: false - in: query name: limit description: |- @@ -22851,77 +22770,31 @@ paths: type: boolean default: false - in: query - required: false name: filters + required: false schema: type: string + example: id eq "ef38f94347e94562b5bb8424a56397d8" 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* - - **type / access.type**: *eq* - + **campaign.id**: *eq, in* + **phase**: *eq* **completed**: *eq, ne* - - **identitySummary.id**: *eq, in* - - **identitySummary.name**: *eq, sw* - - **access.id**: *eq, in* - - **access.name**: *eq, sw* - - **entitlement.sourceName**: *eq, sw* - - **accessProfile.sourceName**: *eq, sw* - example: id eq "ef38f94347e94562b5bb8424a56397d8" - in: query name: sorters required: false schema: type: string format: comma-separated - example: 'access.name,-accessProfile.sourceName' + example: 'name,due' 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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** - - in: query - name: entitlements - required: false - schema: - type: string - example: identityEntitlement - description: |- - Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. - - An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. - - in: query - name: access-profiles - required: false - schema: - type: string - example: accessProfile1 - description: |- - Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. - - An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. - - in: query - name: roles - required: false - schema: - type: string - example: userRole - description: |- - Filter results to view access review items that pertain to any of the specified comma-separated role IDs. - - An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. + Sorting is supported for the following fields: **name, due, signed** responses: '200': - description: A list of access review items + description: List of identity campaign certifications content: application/json: schema: @@ -22929,722 +22802,222 @@ paths: items: type: object properties: - accessSummary: - type: object - description: An object holding the access that is being reviewed + id: + example: 2c9180835d2e5168015d32f890ca1581 + type: string + description: id of the certification + name: + example: 'Source Owner Access Review for Employees [source]' + type: string + description: name of the certification + campaign: + type: object + required: + - id + - name + - type + - campaignType + - description + - correlatedStatus + - mandatoryCommentRequirement properties: - access: - type: object - properties: - type: - description: The type of item being certified - 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 - - WORKGROUP - example: IDENTITY - id: - type: string - description: The ID of the item being certified - example: 2c9180867160846801719932c5153fb7 - name: - type: string - description: The name of the item being certified - example: Entitlement for Company Database - entitlement: - type: object + id: + type: string + description: The unique ID of the campaign. + example: ef38f94347e94562b5bb8424a56397d8 + name: + type: string + description: The name of the campaign. + example: Campaign Name + type: + type: string + enum: + - CAMPAIGN + description: The type of object that is being referenced. + example: CAMPAIGN + campaignType: + type: string + enum: + - MANAGER + - SOURCE_OWNER + - SEARCH + description: The type of the campaign. + example: MANAGER + description: + type: string + description: The description of the campaign set by the admin who created it. + nullable: true + example: A description of the campaign + 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 + 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 + completed: + type: boolean + description: Have all decisions been made? + example: true + identitiesCompleted: + type: integer + description: The number of identities for whom all decisions have been made and are complete. + example: 5 + format: int32 + identitiesTotal: + type: integer + description: 'The total number of identities in the Certification, both complete and incomplete.' + example: 10 + format: int32 + created: + example: '2018-06-25T20:22:28.104Z' + format: date-time + type: string + description: created date + modified: + example: '2018-06-25T20:22:28.104Z' + format: date-time + type: string + description: modified date + decisionsMade: + type: integer + description: The number of approve/revoke/acknowledge decisions that have been made. + example: 20 + format: int32 + decisionsTotal: + type: integer + description: The total number of approve/revoke/acknowledge decisions. + example: 40 + format: int32 + due: + type: string + format: date-time + description: The due date of the certification. + example: '2018-10-19T13:49:37.385Z' + signed: + type: string + format: date-time + nullable: true + description: The date the reviewer signed off on the Certification. + example: '2018-10-19T13:49:37.385Z' + reviewer: + type: object + properties: + id: + type: string + description: The id of the reviewer. + example: ef38f94347e94562b5bb8424a56397d8 + name: + type: string + description: The name of the reviewer. + example: Reviewer Name + email: + type: string + description: The email of the reviewing identity. + example: reviewer@test.com + type: + type: string + enum: + - IDENTITY + description: The type of the reviewing identity. + example: IDENTITY + created: + nullable: true + example: '2018-06-25T20:22:28.104Z' + format: date-time + type: string + description: The created date of the reviewing identity. + modified: nullable: true + example: '2018-06-25T20:22:28.104Z' + format: date-time + type: string + description: The modified date of the reviewing identity. + reassignment: + type: object + nullable: true + properties: + from: + type: object properties: id: type: string - description: The id for the entitlement - example: 2c918085718230600171993742c63558 + description: The id of the certification. + example: ef38f94347e94562b5bb8424a56397d8 name: type: string - description: The name of the entitlement - example: CN=entitlement.bbb7c650 - description: - nullable: true + description: The name of the certification. + example: Certification Name + type: type: string - description: Information about the entitlement - example: Gives read/write access to the company database - privileged: - type: boolean - example: false - description: Indicates if the entitlement is a privileged entitlement - owner: + enum: + - CERTIFICATION + example: CERTIFICATION + reviewer: type: object - nullable: true properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY id: type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e + description: The id of the reviewer. + example: ef38f94347e94562b5bb8424a56397d8 name: type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso + description: The name of the reviewer. + example: Reviewer Name email: type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - attributeName: - type: string - description: The name of the attribute on the source - example: memberOf - attributeValue: - type: string - description: The value of the attribute on the source - example: CN=entitlement.bbb7c650 - sourceSchemaObjectType: - type: string - description: The schema object type on the source used to represent the entitlement and its attributes - example: groups - sourceName: - type: string - description: The name of the source for which this entitlement belongs - example: ODS-AD-Source - sourceType: - type: string - description: The type of the source for which the entitlement belongs - example: Active Directory - Direct - hasPermissions: - type: boolean - description: Indicates if the entitlement has permissions - example: false - isPermission: - type: boolean - description: Indicates if the entitlement is a representation of an account permission - example: false - revocable: - type: boolean - description: Indicates whether the entitlement can be revoked - example: true - cloudGoverned: - type: boolean - description: True if the entitlement is cloud governed - example: false - account: - type: object - nullable: true - description: Information about the status of the entitlement - properties: - nativeIdentity: - type: string - description: The native identity for this account - example: CN=Alison Ferguso - disabled: - type: boolean - example: false - description: Indicates whether this account is currently disabled - locked: - type: boolean - example: false - description: Indicates whether this account is currently locked + description: The email of the reviewing identity. + example: reviewer@test.com 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + description: The type of the reviewing identity. example: IDENTITY - id: - nullable: true - type: string - description: The id associated with the account - example: 2c9180857182305e0171993737eb29e6 - name: - nullable: true - type: string - description: The account name - example: Alison Ferguso created: nullable: true - type: string + example: '2018-06-25T20:22:28.104Z' format: date-time - description: When the account was created - example: '2020-04-20T20:11:05.067Z' + type: string + description: The created date of the reviewing identity. modified: nullable: true - type: string + example: '2018-06-25T20:22:28.104Z' format: date-time - description: When the account was last modified - example: '2020-05-20T18:57:16.987Z' - accessProfile: - type: object - properties: - id: - type: string - description: The id of the Access Profile - example: 2c91808a7190d06e01719938fcd20792 - name: - type: string - description: Name of the Access Profile - example: Employee-database-read-write - description: - type: string - description: Information about the Access Profile - example: Collection of entitlements to read/write the employee database - privileged: - type: boolean - description: Indicates if the entitlement is a privileged entitlement - example: false - cloudGoverned: - type: boolean - description: True if the entitlement is cloud governed - example: false - endDate: - nullable: true - type: string - format: date-time - description: The date at which a user's access expires - example: '2021-12-25T00:00:00.000Z' - owner: - description: Owner of the Access Profile - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - entitlements: - type: array - description: A list of entitlements associated with this Access Profile - items: - type: object - nullable: true - properties: - id: - type: string - description: The id for the entitlement - example: 2c918085718230600171993742c63558 - name: - type: string - description: The name of the entitlement - example: CN=entitlement.bbb7c650 - description: - nullable: true - type: string - description: Information about the entitlement - example: Gives read/write access to the company database - privileged: - type: boolean - example: false - description: Indicates if the entitlement is a privileged entitlement - owner: - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - attributeName: - type: string - description: The name of the attribute on the source - example: memberOf - attributeValue: - type: string - description: The value of the attribute on the source - example: CN=entitlement.bbb7c650 - sourceSchemaObjectType: - type: string - description: The schema object type on the source used to represent the entitlement and its attributes - example: groups - sourceName: - type: string - description: The name of the source for which this entitlement belongs - example: ODS-AD-Source - sourceType: - type: string - description: The type of the source for which the entitlement belongs - example: Active Directory - Direct - hasPermissions: - type: boolean - description: Indicates if the entitlement has permissions - example: false - isPermission: - type: boolean - description: Indicates if the entitlement is a representation of an account permission - example: false - revocable: - type: boolean - description: Indicates whether the entitlement can be revoked - example: true - cloudGoverned: - type: boolean - description: True if the entitlement is cloud governed - example: false - account: - type: object - nullable: true - description: Information about the status of the entitlement - properties: - nativeIdentity: - type: string - description: The native identity for this account - example: CN=Alison Ferguso - disabled: - type: boolean - example: false - description: Indicates whether this account is currently disabled - locked: - type: boolean - example: false - description: Indicates whether this account is currently locked - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - nullable: true - type: string - description: The id associated with the account - example: 2c9180857182305e0171993737eb29e6 - name: - nullable: true - type: string - description: The account name - example: Alison Ferguso - created: - nullable: true - type: string - format: date-time - description: When the account was created - example: '2020-04-20T20:11:05.067Z' - modified: - nullable: true - type: string - format: date-time - description: When the account was last modified - example: '2020-05-20T18:57:16.987Z' - created: - type: string - description: Date the Access Profile was created. - format: date-time - example: '2021-01-01T22:32:58.104Z' - modified: - type: string - description: Date the Access Profile was last modified. - format: date-time - example: '2021-02-01T22:32:58.104Z' - role: - type: object - nullable: true - properties: - id: - type: string - description: The id for the Role - example: 2c91808a7190d06e0171993907fd0794 - name: - type: string - description: The name of the Role - example: Accounting-Employees - description: - type: string - description: Information about the Role - example: Role for members of the accounting department with the necessary Access Profiles - privileged: - type: boolean - description: Indicates if the entitlement is a privileged entitlement - example: false - owner: - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - revocable: - type: boolean - description: Indicates whether the Role can be revoked or requested - example: false - endDate: - type: string - format: date-time - description: The date when a user's access expires. - example: '2021-12-25T00:00:00.000Z' - accessProfiles: - type: array - description: The list of Access Profiles associated with this Role - items: - type: object - properties: - id: - type: string - description: The id of the Access Profile - example: 2c91808a7190d06e01719938fcd20792 - name: - type: string - description: Name of the Access Profile - example: Employee-database-read-write - description: - type: string - description: Information about the Access Profile - example: Collection of entitlements to read/write the employee database - privileged: - type: boolean - description: Indicates if the entitlement is a privileged entitlement - example: false - cloudGoverned: - type: boolean - description: True if the entitlement is cloud governed - example: false - endDate: - nullable: true - type: string - format: date-time - description: The date at which a user's access expires - example: '2021-12-25T00:00:00.000Z' - owner: - description: Owner of the Access Profile - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - entitlements: - type: array - description: A list of entitlements associated with this Access Profile - items: - type: object - nullable: true - properties: - id: - type: string - description: The id for the entitlement - example: 2c918085718230600171993742c63558 - name: - type: string - description: The name of the entitlement - example: CN=entitlement.bbb7c650 - description: - nullable: true - type: string - description: Information about the entitlement - example: Gives read/write access to the company database - privileged: - type: boolean - example: false - description: Indicates if the entitlement is a privileged entitlement - owner: - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - attributeName: - type: string - description: The name of the attribute on the source - example: memberOf - attributeValue: - type: string - description: The value of the attribute on the source - example: CN=entitlement.bbb7c650 - sourceSchemaObjectType: - type: string - description: The schema object type on the source used to represent the entitlement and its attributes - example: groups - sourceName: - type: string - description: The name of the source for which this entitlement belongs - example: ODS-AD-Source - sourceType: - type: string - description: The type of the source for which the entitlement belongs - example: Active Directory - Direct - hasPermissions: - type: boolean - description: Indicates if the entitlement has permissions - example: false - isPermission: - type: boolean - description: Indicates if the entitlement is a representation of an account permission - example: false - revocable: - type: boolean - description: Indicates whether the entitlement can be revoked - example: true - cloudGoverned: - type: boolean - description: True if the entitlement is cloud governed - example: false - account: - type: object - nullable: true - description: Information about the status of the entitlement - properties: - nativeIdentity: - type: string - description: The native identity for this account - example: CN=Alison Ferguso - disabled: - type: boolean - example: false - description: Indicates whether this account is currently disabled - locked: - type: boolean - example: false - description: Indicates whether this account is currently locked - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - nullable: true - type: string - description: The id associated with the account - example: 2c9180857182305e0171993737eb29e6 - name: - nullable: true - type: string - description: The account name - example: Alison Ferguso - created: - nullable: true - type: string - format: date-time - description: When the account was created - example: '2020-04-20T20:11:05.067Z' - modified: - nullable: true - type: string - format: date-time - description: When the account was last modified - example: '2020-05-20T18:57:16.987Z' - created: - type: string - description: Date the Access Profile was created. - format: date-time - example: '2021-01-01T22:32:58.104Z' - modified: - type: string - description: Date the Access Profile was last modified. - format: date-time - example: '2021-02-01T22:32:58.104Z' - identitySummary: - type: object - properties: - id: - type: string - description: The ID of the identity summary - example: 2c91808772a504f50172a9540e501ba7 - name: - type: string - description: Name of the linked identity - example: Alison Ferguso - identityId: + description: The modified date of the reviewing identity. + comment: type: string - description: The ID of the identity being certified - example: 2c9180857182306001719937377a33de - completed: - type: boolean - description: Indicates whether the review items for the linked identity's certification have been completed - example: true - id: - type: string - description: The review item's id - example: ef38f94347e94562b5bb8424a56397d8 - completed: - type: boolean - description: Whether the review item is complete - example: false - newAccess: + description: The comment entered when the Certification was reassigned + example: Reassigned for a reason + hasErrors: + description: Identifies if the certification has an error type: boolean - description: Indicates whether the review item is for new access to a source example: false - decision: - type: string - description: The decision to approve or revoke the review item - enum: - - APPROVE - - REVOKE - example: APPROVE - comments: + errorMessage: + description: Description of the certification error nullable: true type: string - description: Comments for this review item - example: This user still needs access to this source + example: The certification has an error + phase: + type: string + description: | + The current phase of the campaign. + * `STAGED`: The campaign is waiting to be activated. + * `ACTIVE`: The campaign is active. + * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. + enum: + - STAGED + - ACTIVE + - SIGNED + example: ACTIVE '400': description: Client Error - Returned if the request body is invalid. content: @@ -23779,73 +23152,6 @@ paths: - locale: en-US localeOrigin: DEFAULT text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. '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: @@ -23923,92 +23229,21 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/certifications/{id}/decide': - post: - operationId: makeIdentityDecision + '/certifications/{id}': + get: + operationId: getIdentityCertification tags: - Certifications - summary: Decide on a Certification Item - description: The API makes a decision to approve or revoke one or more identity campaign certification items. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + summary: Identity Certification by ID + description: This API returns a single identity campaign certification by its ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. parameters: - in: path name: id schema: type: string required: true - description: The ID of the identity campaign certification on which to make decisions + description: The certification id example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - description: A non-empty array of decisions to be made. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: The id of the review decision - example: ef38f94347e94562b5bb8424a56397d8 - decision: - type: string - description: The decision to approve or revoke the review item - enum: - - APPROVE - - REVOKE - example: APPROVE - proposedEndDate: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - description: The date at which a user's access should be taken away. Should only be set for `REVOKE` decisions. - bulk: - type: boolean - description: Indicates whether decision should be marked as part of a larger bulk decision - example: true - recommendation: - nullable: true - type: object - properties: - recommendation: - type: string - description: The recommendation from IAI at the time of the decision. This field will be null if no recommendation was made. - example: null - nullable: true - reasons: - type: array - items: - type: string - description: A list of reasons for the recommendation. - example: - - Reason 1 - - Reason 2 - timestamp: - type: string - format: date-time - description: The time at which the recommendation was recorded. - example: '2020-06-01T13:49:37.385Z' - comments: - type: string - description: Comments recorded when the decision was made - example: This user no longer needs access to this source - required: - - id - - decision - - bulk - minItems: 1 - maxItems: 250 - example: - - id: ef38f94347e94562b5bb8424a56396b5 - decision: APPROVE - bulk: true - comments: This user still needs access to this source. - - id: ef38f94347e94562b5bb8424a56397d8 - decision: APPROVE - bulk: true - comments: This user still needs access to this source too. responses: '200': description: An identity campaign certification object @@ -24511,13 +23746,13 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/certifications/{id}/reassign': - post: - operationId: reassignIdentityCertifications + '/certifications/{id}/access-review-items': + get: + operationId: listIdentityAccessReviewItems tags: - Certifications - summary: Reassign Identities or Items - description: This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + summary: List of Access Review Items + description: This API returns a list of access review items for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. parameters: - in: path name: id @@ -24526,39134 +23761,4683 @@ paths: required: true description: The identity campaign certification ID example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - reassign: - type: array - items: - type: object - properties: - id: - type: string - description: The ID of item or identity being reassigned. - example: ef38f94347e94562b5bb8424a56397d8 - type: - type: string - description: The type of item or identity being reassigned. - enum: - - TARGET_SUMMARY - - ITEM - - IDENTITY_SUMMARY - example: ITEM - required: - - id - - type - reassignTo: - type: string - description: The ID of the identity to which the certification is reassigned - example: ef38f94347e94562b5bb8424a56397d8 - reason: - type: string - description: The reason comment for why the reassign was made - example: reassigned for some reason - required: - - reassign - - reassignTo - - reason + - 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 + required: false + name: filters + schema: + type: string + 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* + + **type / access.type**: *eq* + + **completed**: *eq, ne* + + **identitySummary.id**: *eq, in* + + **identitySummary.name**: *eq, sw* + + **access.id**: *eq, in* + + **access.name**: *eq, sw* + + **entitlement.sourceName**: *eq, sw* + + **accessProfile.sourceName**: *eq, sw* + example: id eq "ef38f94347e94562b5bb8424a56397d8" + - in: query + name: sorters + required: false + schema: + type: string + format: comma-separated + example: 'access.name,-accessProfile.sourceName' + 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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** + - in: query + name: entitlements + required: false + schema: + type: string + example: identityEntitlement + description: |- + Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. + + An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. + - in: query + name: access-profiles + required: false + schema: + type: string + example: accessProfile1 + description: |- + Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. + + An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. + - in: query + name: roles + required: false + schema: + type: string + example: userRole + description: |- + Filter results to view access review items that pertain to any of the specified comma-separated role IDs. + + An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. responses: '200': - description: An identity campaign certification details after completing the reassignment. - content: - application/json: - schema: - type: object - properties: - id: - example: 2c9180835d2e5168015d32f890ca1581 - type: string - description: id of the certification - name: - example: 'Source Owner Access Review for Employees [source]' - type: string - description: name of the certification - campaign: - type: object - required: - - id - - name - - type - - campaignType - - description - - correlatedStatus - - mandatoryCommentRequirement - properties: - id: - type: string - description: The unique ID of the campaign. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the campaign. - example: Campaign Name - type: - type: string - enum: - - CAMPAIGN - description: The type of object that is being referenced. - example: CAMPAIGN - campaignType: - type: string - enum: - - MANAGER - - SOURCE_OWNER - - SEARCH - description: The type of the campaign. - example: MANAGER - description: - type: string - description: The description of the campaign set by the admin who created it. - nullable: true - example: A description of the campaign - 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 - 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 - completed: - type: boolean - description: Have all decisions been made? - example: true - identitiesCompleted: - type: integer - description: The number of identities for whom all decisions have been made and are complete. - example: 5 - format: int32 - identitiesTotal: - type: integer - description: 'The total number of identities in the Certification, both complete and incomplete.' - example: 10 - format: int32 - created: - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: created date - modified: - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: modified date - decisionsMade: - type: integer - description: The number of approve/revoke/acknowledge decisions that have been made. - example: 20 - format: int32 - decisionsTotal: - type: integer - description: The total number of approve/revoke/acknowledge decisions. - example: 40 - format: int32 - due: - type: string - format: date-time - description: The due date of the certification. - example: '2018-10-19T13:49:37.385Z' - signed: - type: string - format: date-time - nullable: true - description: The date the reviewer signed off on the Certification. - example: '2018-10-19T13:49:37.385Z' - reviewer: - type: object - properties: - id: - type: string - description: The id of the reviewer. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the reviewer. - example: Reviewer Name - email: - type: string - description: The email of the reviewing identity. - example: reviewer@test.com - type: - type: string - enum: - - IDENTITY - description: The type of the reviewing identity. - example: IDENTITY - created: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: The created date of the reviewing identity. - modified: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: The modified date of the reviewing identity. - reassignment: - type: object - nullable: true - properties: - from: - type: object - properties: - id: - type: string - description: The id of the certification. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the certification. - example: Certification Name - type: - type: string - enum: - - CERTIFICATION - example: CERTIFICATION - reviewer: - type: object - properties: - id: - type: string - description: The id of the reviewer. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the reviewer. - example: Reviewer Name - email: - type: string - description: The email of the reviewing identity. - example: reviewer@test.com - type: - type: string - enum: - - IDENTITY - description: The type of the reviewing identity. - example: IDENTITY - created: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: The created date of the reviewing identity. - modified: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: The modified date of the reviewing identity. - comment: - type: string - description: The comment entered when the Certification was reassigned - example: Reassigned for a reason - hasErrors: - description: Identifies if the certification has an error - type: boolean - example: false - errorMessage: - description: Description of the certification error - nullable: true - type: string - example: The certification has an error - phase: - type: string - description: | - The current phase of the campaign. - * `STAGED`: The campaign is waiting to be activated. - * `ACTIVE`: The campaign is active. - * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. - enum: - - STAGED - - ACTIVE - - SIGNED - example: ACTIVE - '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.' + description: A list of access review items 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: array + items: + type: object + properties: + accessSummary: type: object + description: An object holding the access that is being reviewed 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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - '/certifications/{id}/sign-off': - post: - operationId: signOffIdentityCertification - tags: - - Certifications - summary: Finalize Identity Certification Decisions - description: This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The identity campaign certification ID - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: An identity campaign certification object - content: - application/json: - schema: - type: object - properties: - id: - example: 2c9180835d2e5168015d32f890ca1581 - type: string - description: id of the certification - name: - example: 'Source Owner Access Review for Employees [source]' - type: string - description: name of the certification - campaign: - type: object - required: - - id - - name - - type - - campaignType - - description - - correlatedStatus - - mandatoryCommentRequirement - properties: - id: - type: string - description: The unique ID of the campaign. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the campaign. - example: Campaign Name - type: - type: string - enum: - - CAMPAIGN - description: The type of object that is being referenced. - example: CAMPAIGN - campaignType: - type: string - enum: - - MANAGER - - SOURCE_OWNER - - SEARCH - description: The type of the campaign. - example: MANAGER - description: - type: string - description: The description of the campaign set by the admin who created it. - nullable: true - example: A description of the campaign - 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 - 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 - completed: - type: boolean - description: Have all decisions been made? - example: true - identitiesCompleted: - type: integer - description: The number of identities for whom all decisions have been made and are complete. - example: 5 - format: int32 - identitiesTotal: - type: integer - description: 'The total number of identities in the Certification, both complete and incomplete.' - example: 10 - format: int32 - created: - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: created date - modified: - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: modified date - decisionsMade: - type: integer - description: The number of approve/revoke/acknowledge decisions that have been made. - example: 20 - format: int32 - decisionsTotal: - type: integer - description: The total number of approve/revoke/acknowledge decisions. - example: 40 - format: int32 - due: - type: string - format: date-time - description: The due date of the certification. - example: '2018-10-19T13:49:37.385Z' - signed: - type: string - format: date-time - nullable: true - description: The date the reviewer signed off on the Certification. - example: '2018-10-19T13:49:37.385Z' - reviewer: - type: object - properties: - id: - type: string - description: The id of the reviewer. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the reviewer. - example: Reviewer Name - email: - type: string - description: The email of the reviewing identity. - example: reviewer@test.com - type: - type: string - enum: - - IDENTITY - description: The type of the reviewing identity. - example: IDENTITY - created: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: The created date of the reviewing identity. - modified: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: The modified date of the reviewing identity. - reassignment: - type: object - nullable: true - properties: - from: - type: object - properties: - id: - type: string - description: The id of the certification. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the certification. - example: Certification Name - type: - type: string - enum: - - CERTIFICATION - example: CERTIFICATION - reviewer: - type: object - properties: - id: - type: string - description: The id of the reviewer. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the reviewer. - example: Reviewer Name - email: - type: string - description: The email of the reviewing identity. - example: reviewer@test.com - type: - type: string - enum: - - IDENTITY - description: The type of the reviewing identity. - example: IDENTITY - created: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: The created date of the reviewing identity. - modified: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: The modified date of the reviewing identity. - comment: - type: string - description: The comment entered when the Certification was reassigned - example: Reassigned for a reason - hasErrors: - description: Identifies if the certification has an error - type: boolean - example: false - errorMessage: - description: Description of the certification error - nullable: true - type: string - example: The certification has an error - phase: - type: string - description: | - The current phase of the campaign. - * `STAGED`: The campaign is waiting to be activated. - * `ACTIVE`: The campaign is active. - * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. - enum: - - STAGED - - ACTIVE - - SIGNED - example: ACTIVE - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - '/certifications/{id}/decision-summary': - get: - operationId: getIdentityDecisionSummary - tags: - - Certification Summaries - summary: Summary of Certification Decisions - description: This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The certification ID - example: ef38f94347e94562b5bb8424a56397d8 - - in: query - name: filters - required: false - schema: - type: string - example: identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8" - 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: - - **identitySummary.id**: *eq, in* - responses: - '200': - description: Summary of the decisions made - content: - application/json: - schema: - type: object - properties: - entitlementDecisionsMade: - type: integer - description: Number of entitlement decisions that have been made - example: 3 - format: int32 - accessProfileDecisionsMade: - type: integer - description: Number of access profile decisions that have been made - example: 5 - format: int32 - roleDecisionsMade: - type: integer - description: Number of role decisions that have been made - example: 2 - format: int32 - accountDecisionsMade: - type: integer - description: Number of account decisions that have been made - example: 4 - format: int32 - entitlementDecisionsTotal: - type: integer - description: 'The total number of entitlement decisions on the certification, both complete and incomplete' - example: 6 - format: int32 - accessProfileDecisionsTotal: - type: integer - description: 'The total number of access profile decisions on the certification, both complete and incomplete' - example: 10 - format: int32 - roleDecisionsTotal: - type: integer - description: 'The total number of role decisions on the certification, both complete and incomplete' - example: 4 - format: int32 - accountDecisionsTotal: - type: integer - description: 'The total number of account decisions on the certification, both complete and incomplete' - example: 8 - format: int32 - entitlementsApproved: - type: integer - description: The number of entitlement decisions that have been made which were approved - example: 2 - format: int32 - entitlementsRevoked: - type: integer - description: The number of entitlement decisions that have been made which were revoked - example: 1 - format: int32 - accessProfilesApproved: - type: integer - description: The number of access profile decisions that have been made which were approved - example: 3 - format: int32 - accessProfilesRevoked: - type: integer - description: The number of access profile decisions that have been made which were revoked - example: 2 - format: int32 - rolesApproved: - type: integer - description: The number of role decisions that have been made which were approved - example: 2 - format: int32 - rolesRevoked: - type: integer - description: The number of role decisions that have been made which were revoked - example: 0 - format: int32 - accountsApproved: - type: integer - description: The number of account decisions that have been made which were approved - example: 1 - format: int32 - accountsRevoked: - type: integer - description: The number of account decisions that have been made which were revoked - example: 3 - format: int32 - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - '/certifications/{id}/identity-summaries': - get: - operationId: getIdentitySummaries - tags: - - Certification Summaries - summary: Identity Summaries for Campaign Certification - description: This API returns a list of the identity summaries for a specific identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The identity campaign certification ID - example: ef38f94347e94562b5bb8424a56397d8 - - 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 - required: false - schema: - type: string - example: id eq "ef38f94347e94562b5bb8424a56397d8" - 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* - - **completed**: *eq, ne* - - **name**: *eq, sw* - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: name - 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** - responses: - '200': - description: List of identity summaries - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: The ID of the identity summary - example: 2c91808772a504f50172a9540e501ba7 - name: - type: string - description: Name of the linked identity - example: Alison Ferguso - identityId: - type: string - description: The ID of the identity being certified - example: 2c9180857182306001719937377a33de - completed: - type: boolean - description: Indicates whether the review items for the linked identity's certification have been completed - example: true - example: - - id: 2c91808772a504f50172a9540e501ba7 - name: Aaron Grey - identityId: 2c9180857182306001719937379633e4 - completed: false - - id: 2c91808772a504f50172a9540e501ba8 - name: Aglae Wilson - identityId: 2c9180857182306001719937377a33de - completed: true - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - '/certifications/{id}/access-summaries/{type}': - get: - operationId: getIdentityAccessSummaries - tags: - - Certification Summaries - summary: Access Summaries - description: This API returns a list of access summaries for the specified identity campaign certification and type. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The identity campaign certification ID - example: ef38f94347e94562b5bb8424a56397d8 - - in: path - name: type - schema: - type: string - enum: - - ROLE - - ACCESS_PROFILE - - ENTITLEMENT - required: true - description: The type of access review item to retrieve summaries for - example: ACCESS_PROFILE - - 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 - required: false - schema: - type: string - example: access.id eq "ef38f94347e94562b5bb8424a56397d8" - 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: - - **completed**: *eq, ne* - - **access.id**: *eq, in* - - **access.name**: *eq, sw* - - **entitlement.sourceName**: *eq, sw* - - **accessProfile.sourceName**: *eq, sw* - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: access.name - 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: **access.name** - responses: - '200': - description: List of access summaries - content: - application/json: - schema: - type: array - items: - type: object - description: An object holding the access that is being reviewed - properties: - access: - type: object - properties: - type: - description: The type of item being certified - 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 - - WORKGROUP - example: IDENTITY - id: - type: string - description: The ID of the item being certified - example: 2c9180867160846801719932c5153fb7 - name: - type: string - description: The name of the item being certified - example: Entitlement for Company Database - entitlement: - type: object - nullable: true - properties: - id: - type: string - description: The id for the entitlement - example: 2c918085718230600171993742c63558 - name: - type: string - description: The name of the entitlement - example: CN=entitlement.bbb7c650 - description: - nullable: true - type: string - description: Information about the entitlement - example: Gives read/write access to the company database - privileged: - type: boolean - example: false - description: Indicates if the entitlement is a privileged entitlement - owner: - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - attributeName: - type: string - description: The name of the attribute on the source - example: memberOf - attributeValue: - type: string - description: The value of the attribute on the source - example: CN=entitlement.bbb7c650 - sourceSchemaObjectType: - type: string - description: The schema object type on the source used to represent the entitlement and its attributes - example: groups - sourceName: - type: string - description: The name of the source for which this entitlement belongs - example: ODS-AD-Source - sourceType: - type: string - description: The type of the source for which the entitlement belongs - example: Active Directory - Direct - hasPermissions: - type: boolean - description: Indicates if the entitlement has permissions - example: false - isPermission: - type: boolean - description: Indicates if the entitlement is a representation of an account permission - example: false - revocable: - type: boolean - description: Indicates whether the entitlement can be revoked - example: true - cloudGoverned: - type: boolean - description: True if the entitlement is cloud governed - example: false - account: - type: object - nullable: true - description: Information about the status of the entitlement - properties: - nativeIdentity: - type: string - description: The native identity for this account - example: CN=Alison Ferguso - disabled: - type: boolean - example: false - description: Indicates whether this account is currently disabled - locked: - type: boolean - example: false - description: Indicates whether this account is currently locked - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - nullable: true - type: string - description: The id associated with the account - example: 2c9180857182305e0171993737eb29e6 - name: - nullable: true - type: string - description: The account name - example: Alison Ferguso - created: - nullable: true - type: string - format: date-time - description: When the account was created - example: '2020-04-20T20:11:05.067Z' - modified: - nullable: true - type: string - format: date-time - description: When the account was last modified - example: '2020-05-20T18:57:16.987Z' - accessProfile: - type: object - properties: - id: - type: string - description: The id of the Access Profile - example: 2c91808a7190d06e01719938fcd20792 - name: - type: string - description: Name of the Access Profile - example: Employee-database-read-write - description: - type: string - description: Information about the Access Profile - example: Collection of entitlements to read/write the employee database - privileged: - type: boolean - description: Indicates if the entitlement is a privileged entitlement - example: false - cloudGoverned: - type: boolean - description: True if the entitlement is cloud governed - example: false - endDate: - nullable: true - type: string - format: date-time - description: The date at which a user's access expires - example: '2021-12-25T00:00:00.000Z' - owner: - description: Owner of the Access Profile - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - entitlements: - type: array - description: A list of entitlements associated with this Access Profile - items: - type: object - nullable: true - properties: - id: - type: string - description: The id for the entitlement - example: 2c918085718230600171993742c63558 - name: - type: string - description: The name of the entitlement - example: CN=entitlement.bbb7c650 - description: - nullable: true - type: string - description: Information about the entitlement - example: Gives read/write access to the company database - privileged: - type: boolean - example: false - description: Indicates if the entitlement is a privileged entitlement - owner: - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - attributeName: - type: string - description: The name of the attribute on the source - example: memberOf - attributeValue: - type: string - description: The value of the attribute on the source - example: CN=entitlement.bbb7c650 - sourceSchemaObjectType: - type: string - description: The schema object type on the source used to represent the entitlement and its attributes - example: groups - sourceName: - type: string - description: The name of the source for which this entitlement belongs - example: ODS-AD-Source - sourceType: - type: string - description: The type of the source for which the entitlement belongs - example: Active Directory - Direct - hasPermissions: - type: boolean - description: Indicates if the entitlement has permissions - example: false - isPermission: - type: boolean - description: Indicates if the entitlement is a representation of an account permission - example: false - revocable: - type: boolean - description: Indicates whether the entitlement can be revoked - example: true - cloudGoverned: - type: boolean - description: True if the entitlement is cloud governed - example: false - account: - type: object - nullable: true - description: Information about the status of the entitlement - properties: - nativeIdentity: - type: string - description: The native identity for this account - example: CN=Alison Ferguso - disabled: - type: boolean - example: false - description: Indicates whether this account is currently disabled - locked: - type: boolean - example: false - description: Indicates whether this account is currently locked - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - nullable: true - type: string - description: The id associated with the account - example: 2c9180857182305e0171993737eb29e6 - name: - nullable: true - type: string - description: The account name - example: Alison Ferguso - created: - nullable: true - type: string - format: date-time - description: When the account was created - example: '2020-04-20T20:11:05.067Z' - modified: - nullable: true - type: string - format: date-time - description: When the account was last modified - example: '2020-05-20T18:57:16.987Z' - created: - type: string - description: Date the Access Profile was created. - format: date-time - example: '2021-01-01T22:32:58.104Z' - modified: - type: string - description: Date the Access Profile was last modified. - format: date-time - example: '2021-02-01T22:32:58.104Z' - role: - type: object - nullable: true - properties: - id: - type: string - description: The id for the Role - example: 2c91808a7190d06e0171993907fd0794 - name: - type: string - description: The name of the Role - example: Accounting-Employees - description: - type: string - description: Information about the Role - example: Role for members of the accounting department with the necessary Access Profiles - privileged: - type: boolean - description: Indicates if the entitlement is a privileged entitlement - example: false - owner: - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - revocable: - type: boolean - description: Indicates whether the Role can be revoked or requested - example: false - endDate: - type: string - format: date-time - description: The date when a user's access expires. - example: '2021-12-25T00:00:00.000Z' - accessProfiles: - type: array - description: The list of Access Profiles associated with this Role - items: - type: object - properties: - id: - type: string - description: The id of the Access Profile - example: 2c91808a7190d06e01719938fcd20792 - name: - type: string - description: Name of the Access Profile - example: Employee-database-read-write - description: - type: string - description: Information about the Access Profile - example: Collection of entitlements to read/write the employee database - privileged: - type: boolean - description: Indicates if the entitlement is a privileged entitlement - example: false - cloudGoverned: - type: boolean - description: True if the entitlement is cloud governed - example: false - endDate: - nullable: true - type: string - format: date-time - description: The date at which a user's access expires - example: '2021-12-25T00:00:00.000Z' - owner: - description: Owner of the Access Profile - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - entitlements: - type: array - description: A list of entitlements associated with this Access Profile - items: - type: object - nullable: true - properties: - id: - type: string - description: The id for the entitlement - example: 2c918085718230600171993742c63558 - name: - type: string - description: The name of the entitlement - example: CN=entitlement.bbb7c650 - description: - nullable: true - type: string - description: Information about the entitlement - example: Gives read/write access to the company database - privileged: - type: boolean - example: false - description: Indicates if the entitlement is a privileged entitlement - owner: - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - attributeName: - type: string - description: The name of the attribute on the source - example: memberOf - attributeValue: - type: string - description: The value of the attribute on the source - example: CN=entitlement.bbb7c650 - sourceSchemaObjectType: - type: string - description: The schema object type on the source used to represent the entitlement and its attributes - example: groups - sourceName: - type: string - description: The name of the source for which this entitlement belongs - example: ODS-AD-Source - sourceType: - type: string - description: The type of the source for which the entitlement belongs - example: Active Directory - Direct - hasPermissions: - type: boolean - description: Indicates if the entitlement has permissions - example: false - isPermission: - type: boolean - description: Indicates if the entitlement is a representation of an account permission - example: false - revocable: - type: boolean - description: Indicates whether the entitlement can be revoked - example: true - cloudGoverned: - type: boolean - description: True if the entitlement is cloud governed - example: false - account: - type: object - nullable: true - description: Information about the status of the entitlement - properties: - nativeIdentity: - type: string - description: The native identity for this account - example: CN=Alison Ferguso - disabled: - type: boolean - example: false - description: Indicates whether this account is currently disabled - locked: - type: boolean - example: false - description: Indicates whether this account is currently locked - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - nullable: true - type: string - description: The id associated with the account - example: 2c9180857182305e0171993737eb29e6 - name: - nullable: true - type: string - description: The account name - example: Alison Ferguso - created: - nullable: true - type: string - format: date-time - description: When the account was created - example: '2020-04-20T20:11:05.067Z' - modified: - nullable: true - type: string - format: date-time - description: When the account was last modified - example: '2020-05-20T18:57:16.987Z' - created: - type: string - description: Date the Access Profile was created. - format: date-time - example: '2021-01-01T22:32:58.104Z' - modified: - type: string - description: Date the Access Profile was last modified. - format: date-time - example: '2021-02-01T22:32:58.104Z' - example: - - access: - type: ENTITLEMENT - id: 2c9180857182305e01719937429e2bad - name: CN=Engineering - entitlement: - id: 2c9180857182305e01719937429e2bad - name: CN=Engineering - description: Access to the engineering database - privileged: false - owner: - email: brandon.gray@acme-solar.com - type: IDENTITY - id: 2c9180867160846801719932c5153fb7 - name: Brandon Gray - attributeName: memberOf - attributeValue: CN=Engineering - sourceName: ODS-AD-Source - hasPermissions: true - revocable: true - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - '/certifications/{id}/identity-summaries/{identitySummaryId}': - get: - operationId: getIdentitySummary - tags: - - Certification Summaries - summary: Summary for Identity - description: This API returns the summary for an identity on a specified identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The identity campaign certification ID - example: ef38f94347e94562b5bb8424a56397d8 - - in: path - name: identitySummaryId - schema: - type: string - required: true - description: The identity summary ID - example: 2c91808772a504f50172a9540e501ba8 - responses: - '200': - description: An identity summary - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The ID of the identity summary - example: 2c91808772a504f50172a9540e501ba7 - name: - type: string - description: Name of the linked identity - example: Alison Ferguso - identityId: - type: string - description: The ID of the identity being certified - example: 2c9180857182306001719937377a33de - completed: - type: boolean - description: Indicates whether the review items for the linked identity's certification have been completed - example: true - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - '/identities/{identity-id}/set-lifecycle-state': - post: - operationId: setLifecycleState - tags: - - Lifecycle States - summary: Set Lifecycle State - description: |- - This endpoint will set/update an identity's lifecycle state to the one provided and updates the corresponding Identity Profile. - A token with ORG_ADMIN or API authority is required to call this API. - security: - - UserContextAuth: - - 'idn:identity-lifecycle-state:update' - parameters: - - in: path - name: identity-id - description: The ID of the identity to update - required: true - example: 2c9180857893f1290178944561990364 - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - lifecycleStateId: - type: string - description: The ID of the lifecycle state to set - example: 2c9180877a86e408017a8c19fefe046c - responses: - '200': - description: The request was successfully accepted into the system. - content: - application/json: - schema: - type: object - properties: - accountActivityId: - type: string - example: 2c9180837ab5b716017ab7c6c9ef1e20 - description: The ID of the IdentityRequest object that was generated when the workflow launches - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - '/identity-profiles/{identity-profile-id}/lifecycle-states': - get: - operationId: listLifecycleStates - tags: - - Lifecycle States - summary: Lists LifecycleStates - description: |- - This end-point lists all the LifecycleStates associated with IdentityProfiles. - A token with API, or ORG_ADMIN authority is required to call this API. - security: - - UserContextAuth: - - 'idn:identity-profile-lifecycle-state:read' - parameters: - - in: path - name: identity-profile-id - description: The IdentityProfile id - required: true - schema: - type: string - example: ef38f94347e94562b5bb8424a56397d8 - - 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: sorters - required: false - schema: - type: string - format: comma-separated - example: 'created,modified' - 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: **created, modified** - responses: - '200': - description: List of LifecycleState objects - content: - application/json: - schema: - type: array - items: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - - type: object - required: - - technicalName - properties: - enabled: - type: boolean - example: true - description: Whether the lifecycle state is enabled or disabled. - technicalName: - type: string - example: Technical Name - description: The technical name for lifecycle state. This is for internal use. - description: - type: string - example: Lifecycle description - description: Lifecycle state description. - identityCount: - type: integer - format: int32 - example: 42 - readOnly: true - description: Number of identities that have the lifecycle state. - emailNotificationOption: - type: object - description: This is used for representing email configuration for a lifecycle state - properties: - notifyManagers: - type: boolean - example: true - description: 'If true, then the manager is notified of the lifecycle state change.' - notifyAllAdmins: - type: boolean - example: true - description: 'If true, then all the admins are notified of the lifecycle state change.' - notifySpecificUsers: - type: boolean - example: true - description: 'If true, then the users specified in "emailAddressList" below are notified of lifecycle state change.' - emailAddressList: - type: array - example: - - test@test.com - - test2@test.com - items: - type: string - description: 'List of user email addresses. If "notifySpecificUsers" option is true, then these users are notified of lifecycle state change.' - accountActions: - type: array - items: - type: object - description: Object for specifying Actions to be performed on a specified list of sources' account. - properties: - action: - example: ENABLE - type: string - description: Describes if action will be enabled or disabled - enum: - - ENABLE - - DISABLE - sourceIds: - type: array - items: - type: string - uniqueItems: true - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - description: List of unique source IDs. The sources must have the ENABLE feature or flat file source. See "/sources" endpoint for source features. - accessProfileIds: - type: array - items: - type: string - uniqueItems: true - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - description: List of unique access-profile IDs that are associated with the lifecycle state. - '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: createLifecycleState - tags: - - Lifecycle States - summary: Create Lifecycle State - description: |- - This API creates a new Lifecycle State. - A token with ORG_ADMIN or API authority is required to call this API. - security: - - UserContextAuth: - - 'idn:identity-profile-lifecycle-state:manage' - parameters: - - in: path - name: identity-profile-id - description: Identity Profile ID - required: true - schema: - type: string - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - description: Lifecycle State - required: true - content: - application/json: - schema: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - - type: object - required: - - technicalName - properties: - enabled: - type: boolean - example: true - description: Whether the lifecycle state is enabled or disabled. - technicalName: - type: string - example: Technical Name - description: The technical name for lifecycle state. This is for internal use. - description: - type: string - example: Lifecycle description - description: Lifecycle state description. - identityCount: - type: integer - format: int32 - example: 42 - readOnly: true - description: Number of identities that have the lifecycle state. - emailNotificationOption: - type: object - description: This is used for representing email configuration for a lifecycle state - properties: - notifyManagers: - type: boolean - example: true - description: 'If true, then the manager is notified of the lifecycle state change.' - notifyAllAdmins: - type: boolean - example: true - description: 'If true, then all the admins are notified of the lifecycle state change.' - notifySpecificUsers: - type: boolean - example: true - description: 'If true, then the users specified in "emailAddressList" below are notified of lifecycle state change.' - emailAddressList: - type: array - example: - - test@test.com - - test2@test.com - items: - type: string - description: 'List of user email addresses. If "notifySpecificUsers" option is true, then these users are notified of lifecycle state change.' - accountActions: - type: array - items: - type: object - description: Object for specifying Actions to be performed on a specified list of sources' account. - properties: - action: - example: ENABLE - type: string - description: Describes if action will be enabled or disabled - enum: - - ENABLE - - DISABLE - sourceIds: - type: array - items: - type: string - uniqueItems: true - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - description: List of unique source IDs. The sources must have the ENABLE feature or flat file source. See "/sources" endpoint for source features. - accessProfileIds: - type: array - items: - type: string - uniqueItems: true - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - description: List of unique access-profile IDs that are associated with the lifecycle state. - responses: - '201': - description: Created LifecycleState object. - content: - application/json: - schema: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - - type: object - required: - - technicalName - properties: - enabled: - type: boolean - example: true - description: Whether the lifecycle state is enabled or disabled. - technicalName: - type: string - example: Technical Name - description: The technical name for lifecycle state. This is for internal use. - description: - type: string - example: Lifecycle description - description: Lifecycle state description. - identityCount: - type: integer - format: int32 - example: 42 - readOnly: true - description: Number of identities that have the lifecycle state. - emailNotificationOption: - type: object - description: This is used for representing email configuration for a lifecycle state - properties: - notifyManagers: - type: boolean - example: true - description: 'If true, then the manager is notified of the lifecycle state change.' - notifyAllAdmins: - type: boolean - example: true - description: 'If true, then all the admins are notified of the lifecycle state change.' - notifySpecificUsers: - type: boolean - example: true - description: 'If true, then the users specified in "emailAddressList" below are notified of lifecycle state change.' - emailAddressList: - type: array - example: - - test@test.com - - test2@test.com - items: - type: string - description: 'List of user email addresses. If "notifySpecificUsers" option is true, then these users are notified of lifecycle state change.' - accountActions: - type: array - items: - type: object - description: Object for specifying Actions to be performed on a specified list of sources' account. - properties: - action: - example: ENABLE - type: string - description: Describes if action will be enabled or disabled - enum: - - ENABLE - - DISABLE - sourceIds: - type: array - items: - type: string - uniqueItems: true - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - description: List of unique source IDs. The sources must have the ENABLE feature or flat file source. See "/sources" endpoint for source features. - accessProfileIds: - type: array - items: - type: string - uniqueItems: true - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - description: List of unique access-profile IDs that are associated with the lifecycle state. - '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. - '/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}': - get: - operationId: getLifecycleState - tags: - - Lifecycle States - summary: Retrieves Lifecycle State - description: |- - This endpoint retrieves a Lifecycle State. - A token with ORG_ADMIN or API authority is required to call this API. - security: - - UserContextAuth: - - 'idn:identity-profile-lifecycle-state:read' - parameters: - - in: path - name: identity-profile-id - description: Identity Profile ID - required: true - schema: - type: string - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - - in: path - name: lifecycle-state-id - description: Lifecycle State ID - required: true - schema: - type: string - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: The requested LifecycleState was successfully retrieved. - content: - application/json: - schema: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - - type: object - required: - - technicalName - properties: - enabled: - type: boolean - example: true - description: Whether the lifecycle state is enabled or disabled. - technicalName: - type: string - example: Technical Name - description: The technical name for lifecycle state. This is for internal use. - description: - type: string - example: Lifecycle description - description: Lifecycle state description. - identityCount: - type: integer - format: int32 - example: 42 - readOnly: true - description: Number of identities that have the lifecycle state. - emailNotificationOption: - type: object - description: This is used for representing email configuration for a lifecycle state - properties: - notifyManagers: - type: boolean - example: true - description: 'If true, then the manager is notified of the lifecycle state change.' - notifyAllAdmins: - type: boolean - example: true - description: 'If true, then all the admins are notified of the lifecycle state change.' - notifySpecificUsers: - type: boolean - example: true - description: 'If true, then the users specified in "emailAddressList" below are notified of lifecycle state change.' - emailAddressList: - type: array - example: - - test@test.com - - test2@test.com - items: - type: string - description: 'List of user email addresses. If "notifySpecificUsers" option is true, then these users are notified of lifecycle state change.' - accountActions: - type: array - items: - type: object - description: Object for specifying Actions to be performed on a specified list of sources' account. - properties: - action: - example: ENABLE - type: string - description: Describes if action will be enabled or disabled - enum: - - ENABLE - - DISABLE - sourceIds: - type: array - items: - type: string - uniqueItems: true - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - description: List of unique source IDs. The sources must have the ENABLE feature or flat file source. See "/sources" endpoint for source features. - accessProfileIds: - type: array - items: - type: string - uniqueItems: true - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - description: List of unique access-profile IDs that are associated with the lifecycle state. - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - patch: - operationId: updateLifecycleStates - tags: - - Lifecycle States - summary: Update Lifecycle State - description: |- - This endpoint updates individual Lifecycle State fields using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - A token with ORG_ADMIN or API authority is required to call this API. - security: - - UserContextAuth: - - 'idn:identity-profile-lifecycle-state:manage' - parameters: - - in: path - name: identity-profile-id - description: Identity Profile ID - required: true - schema: - type: string - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - - in: path - name: lifecycle-state-id - description: Lifecycle State ID - required: true - schema: - type: string - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - description: | - A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - The following fields can be updated: - * enabled - * description - * accountActions - * accessProfileIds - * emailNotificationOption - content: - application/json-patch+json: - schema: - type: array - items: - type: object - description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' - required: - - op - - path - properties: - op: - type: string - description: The operation to be performed - enum: - - add - - remove - - replace - - move - - copy - - test - example: replace - path: - type: string - description: A string JSON Pointer representing the target path to an element to be affected by the operation - example: /description - value: - anyOf: - - type: string - - type: integer - - type: object - - type: array - items: - anyOf: - - type: string - - type: integer - - type: object - description: 'The value to be used for the operation, required for "add" and "replace" operations' - example: New description - example: - - op: replace - path: /description - value: Updated description! - - op: replace - path: /accessProfileIds - value: - - 2c918087742bab150174407a80f3125e - - 2c918087742bab150174407a80f3124f - - op: replace - path: /accountActions - value: - - action: ENABLE - sourceIds: - - 2c9180846a2f82fb016a481c1b1560c5 - - 2c9180846a2f82fb016a481c1b1560cc - - action: DISABLE - sourceIds: - - 2c91808869a0c9980169a207258513fb - - op: replace - path: /emailNotificationOption - value: - notifyManagers: true - notifyAllAdmins: false - notifySpecificUsers: false - emailAddressList: [] - responses: - '200': - description: The LifecycleState was successfully updated. - content: - application/json: - schema: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - - type: object - required: - - technicalName - properties: - enabled: - type: boolean - example: true - description: Whether the lifecycle state is enabled or disabled. - technicalName: - type: string - example: Technical Name - description: The technical name for lifecycle state. This is for internal use. - description: - type: string - example: Lifecycle description - description: Lifecycle state description. - identityCount: - type: integer - format: int32 - example: 42 - readOnly: true - description: Number of identities that have the lifecycle state. - emailNotificationOption: - type: object - description: This is used for representing email configuration for a lifecycle state - properties: - notifyManagers: - type: boolean - example: true - description: 'If true, then the manager is notified of the lifecycle state change.' - notifyAllAdmins: - type: boolean - example: true - description: 'If true, then all the admins are notified of the lifecycle state change.' - notifySpecificUsers: - type: boolean - example: true - description: 'If true, then the users specified in "emailAddressList" below are notified of lifecycle state change.' - emailAddressList: - type: array - example: - - test@test.com - - test2@test.com - items: - type: string - description: 'List of user email addresses. If "notifySpecificUsers" option is true, then these users are notified of lifecycle state change.' - accountActions: - type: array - items: - type: object - description: Object for specifying Actions to be performed on a specified list of sources' account. - properties: - action: - example: ENABLE - type: string - description: Describes if action will be enabled or disabled - enum: - - ENABLE - - DISABLE - sourceIds: - type: array - items: - type: string - uniqueItems: true - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - description: List of unique source IDs. The sources must have the ENABLE feature or flat file source. See "/sources" endpoint for source features. - accessProfileIds: - type: array - items: - type: string - uniqueItems: true - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - description: List of unique access-profile IDs that are associated with the lifecycle state. - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - delete: - operationId: deleteLifecycleState - tags: - - Lifecycle States - summary: Delete Lifecycle State by ID - description: |- - This endpoint deletes the Lifecycle State using it's ID. - A token with API, or ORG_ADMIN authority is required to call this API. - security: - - UserContextAuth: - - 'idn:identity-profile-lifecycle-state:manage' - parameters: - - in: path - name: identity-profile-id - description: Identity Profile ID - required: true - schema: - type: string - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - - in: path - name: lifecycle-state-id - description: Lifecycle State ID - required: true - schema: - type: string - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '202': - description: The request was successfully accepted into the system. - content: - application/json: - schema: - 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 - - WORKGROUP - 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 - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - /identity-profiles: - get: - operationId: listIdentityProfiles - tags: - - Identity Profiles - summary: Identity Profiles List - description: |- - This returns a list of Identity Profiles based on the specified query parameters. - A token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles. - parameters: - - 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 - required: false - schema: - type: string - example: id eq "ef38f94347e94562b5bb8424a56397d8" - 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, ne* - - **name**: *eq, ne* - - **priority**: *eq, ne* - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: 'id,name' - 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: **id**, **name**, **priority** - responses: - '200': - description: List of identityProfiles. - content: - application/json: - schema: - type: array - items: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - - type: object - required: - - authoritativeSource - properties: - description: - type: string - description: The description of the Identity Profile. - example: My custom flat file profile - nullable: true - owner: - type: object - description: The owner of the Identity Profile. - nullable: true - properties: - type: - type: string - enum: - - IDENTITY - description: Type of the object to which this reference applies - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - priority: - type: integer - format: int64 - description: The priority for an Identity Profile. - example: 10 - authoritativeSource: - type: object - properties: - type: - type: string - enum: - - SOURCE - description: Type of the object to which this reference applies - example: SOURCE - id: - type: string - description: ID of the object to which this reference applies - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: HR Active Directory - identityRefreshRequired: - type: boolean - default: false - description: True if a identity refresh is needed. Typically triggered when a change on the source has been made. - example: true - identityCount: - type: integer - description: The number of identities that belong to the Identity Profile. - format: int32 - example: 8 - identityAttributeConfig: - type: object - description: Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. - properties: - enabled: - description: The backend will only promote values if the profile/mapping is enabled. - type: boolean - default: false - example: true - attributeTransforms: - type: array - items: - type: object - description: Defines a transformation definition for an identity attribute. - properties: - identityAttributeName: - type: string - description: Name of the identity attribute. - example: email - transformDefinition: - description: The seaspray transformation definition. - type: object - properties: - type: - type: string - description: The type of the transform definition. - example: accountAttribute - attributes: - type: object - additionalProperties: - anyOf: - - type: string - - type: object - description: Arbitrary key-value pairs to store any metadata for the object - example: - attributeName: e-mail - sourceName: MySource - sourceId: 2c9180877a826e68017a8c0b03da1a53 - identityExceptionReportReference: - type: object - nullable: true - properties: - taskResultId: - type: string - format: uuid - description: The id of the task result. - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - reportName: - type: string - example: My annual report - description: The name of the report. - hasTimeBasedAttr: - description: Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. - type: boolean - default: false - example: true - '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. - security: - - UserContextAuth: - - 'idn:identity-profile:read' - /identity-profiles/bulk-delete: - post: - operationId: deleteIdentityProfiles - tags: - - Identity Profiles - summary: Delete Identity Profiles - description: |- - This deletes multiple Identity Profiles via a list of supplied IDs. - - On success, this endpoint will return a reference to the bulk delete task result. - - A token with ORG_ADMIN authority is required to call this API. - - The following rights are required to access this endpoint: idn:identity-profile:delete - requestBody: - description: Identity Profile bulk delete request body. - required: true - content: - application/json: - schema: - description: List of Identity Profile IDs to delete. - type: array - items: - type: string - example: - - 2c9180867b2a34e0017b3078d60b0699 - - 2c9180867b2a34e0017b3078d60b0698 - responses: - '202': - description: Accepted - Returns a TaskResult object referencing the bulk delete job created. - content: - application/json: - schema: - description: An object with a TaskResult reference of the bulk delete job - type: object - properties: - id: - type: string - description: Task identifier - example: ff8081814d977c21014da056804a0af3 - name: - type: string - description: Task name - example: Background Object Terminator c8f030f2-b1a6-4e33-99e8-6935bc18735d - description: - type: string - description: Task description - example: 'Generic task for terminating data in the overlay, used by the TerminationService.' - launcher: - type: string - description: User or process who launched the task - example: support - completed: - type: string - format: date-time - description: Date time of completion - example: 'Mon Aug 21 14:57:39 CDT 2023' - launched: - type: string - format: date-time - description: Date time when the task was launched - example: 'Mon Aug 21 14:55:39 CDT 2023' - completionStatus: - type: string - enum: - - Success - - Warning - - Error - - Terminated - - TempError - description: Task result status - example: Success - '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. - security: - - UserContextAuth: - - 'idn:identity-profile:delete' - /identity-profiles/export: - get: - operationId: exportIdentityProfiles - tags: - - Identity Profiles - summary: Export Identity Profiles - description: This exports existing identity profiles in the format specified by the sp-config service. - parameters: - - 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 - required: false - schema: - type: string - example: id eq "ef38f94347e94562b5bb8424a56397d8" - 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, ne* - - **name**: *eq, ne* - - **priority**: *eq, ne* - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: 'id,name' - 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: **id**, **name**, **priority** - responses: - '200': - description: List of export objects with identity profiles. - content: - application/json: - schema: - type: array - items: - type: object - description: Identity Profile exported object - properties: - version: - type: integer - example: 1 - description: Version or object from the target service. - format: int32 - self: - 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 - - WORKGROUP - 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 - object: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - - type: object - required: - - authoritativeSource - properties: - description: - type: string - description: The description of the Identity Profile. - example: My custom flat file profile - nullable: true - owner: - type: object - description: The owner of the Identity Profile. - nullable: true - properties: - type: - type: string - enum: - - IDENTITY - description: Type of the object to which this reference applies - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - priority: - type: integer - format: int64 - description: The priority for an Identity Profile. - example: 10 - authoritativeSource: - type: object - properties: - type: - type: string - enum: - - SOURCE - description: Type of the object to which this reference applies - example: SOURCE - id: - type: string - description: ID of the object to which this reference applies - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: HR Active Directory - identityRefreshRequired: - type: boolean - default: false - description: True if a identity refresh is needed. Typically triggered when a change on the source has been made. - example: true - identityCount: - type: integer - description: The number of identities that belong to the Identity Profile. - format: int32 - example: 8 - identityAttributeConfig: - type: object - description: Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. - properties: - enabled: - description: The backend will only promote values if the profile/mapping is enabled. - type: boolean - default: false - example: true - attributeTransforms: - type: array - items: - type: object - description: Defines a transformation definition for an identity attribute. - properties: - identityAttributeName: - type: string - description: Name of the identity attribute. - example: email - transformDefinition: - description: The seaspray transformation definition. - type: object - properties: - type: - type: string - description: The type of the transform definition. - example: accountAttribute - attributes: - type: object - additionalProperties: - anyOf: - - type: string - - type: object - description: Arbitrary key-value pairs to store any metadata for the object - example: - attributeName: e-mail - sourceName: MySource - sourceId: 2c9180877a826e68017a8c0b03da1a53 - identityExceptionReportReference: - type: object - nullable: true - properties: - taskResultId: - type: string - format: uuid - description: The id of the task result. - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - reportName: - type: string - example: My annual report - description: The name of the report. - hasTimeBasedAttr: - description: Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. - type: boolean - default: false - example: true - '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. - security: - - UserContextAuth: - - 'idn:identity-profile:read' - /identity-profiles/import: - post: - operationId: importIdentityProfiles - summary: Import Identity Profiles - description: This imports previously exported identity profiles. - tags: - - Identity Profiles - requestBody: - description: Previously exported Identity Profiles. - required: true - content: - application/json: - schema: - type: array - items: - type: object - description: Identity Profile exported object - properties: - version: - type: integer - example: 1 - description: Version or object from the target service. - format: int32 - self: - 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 - - WORKGROUP - 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 - object: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - - type: object - required: - - authoritativeSource - properties: - description: - type: string - description: The description of the Identity Profile. - example: My custom flat file profile - nullable: true - owner: - type: object - description: The owner of the Identity Profile. - nullable: true - properties: - type: - type: string - enum: - - IDENTITY - description: Type of the object to which this reference applies - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - priority: - type: integer - format: int64 - description: The priority for an Identity Profile. - example: 10 - authoritativeSource: - type: object - properties: - type: - type: string - enum: - - SOURCE - description: Type of the object to which this reference applies - example: SOURCE - id: - type: string - description: ID of the object to which this reference applies - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: HR Active Directory - identityRefreshRequired: - type: boolean - default: false - description: True if a identity refresh is needed. Typically triggered when a change on the source has been made. - example: true - identityCount: - type: integer - description: The number of identities that belong to the Identity Profile. - format: int32 - example: 8 - identityAttributeConfig: - type: object - description: Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. - properties: - enabled: - description: The backend will only promote values if the profile/mapping is enabled. - type: boolean - default: false - example: true - attributeTransforms: - type: array - items: - type: object - description: Defines a transformation definition for an identity attribute. - properties: - identityAttributeName: - type: string - description: Name of the identity attribute. - example: email - transformDefinition: - description: The seaspray transformation definition. - type: object - properties: - type: - type: string - description: The type of the transform definition. - example: accountAttribute - attributes: - type: object - additionalProperties: - anyOf: - - type: string - - type: object - description: Arbitrary key-value pairs to store any metadata for the object - example: - attributeName: e-mail - sourceName: MySource - sourceId: 2c9180877a826e68017a8c0b03da1a53 - identityExceptionReportReference: - type: object - nullable: true - properties: - taskResultId: - type: string - format: uuid - description: The id of the task result. - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - reportName: - type: string - example: My annual report - description: The name of the report. - hasTimeBasedAttr: - description: Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. - type: boolean - default: false - example: true - responses: - '200': - description: The result of importing Identity Profiles. - content: - application/json: - schema: - type: object - title: Import Object Response Body - description: Response model for import of a single object. - properties: - infos: - description: Informational messages returned from the target service on import. - type: array - items: - type: object - title: Config Import/Export Message - description: Message model for Config Import/Export. - properties: - key: - type: string - description: Message key. - example: UNKNOWN_REFERENCE_RESOLVER - text: - type: string - description: Message text. - example: 'Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]' - details: - type: object - description: 'Message details if any, in key:value pairs.' - additionalProperties: true - example: - details: message details - required: - - key - - text - - details - warnings: - description: Warning messages returned from the target service on import. - type: array - items: - type: object - title: Config Import/Export Message - description: Message model for Config Import/Export. - properties: - key: - type: string - description: Message key. - example: UNKNOWN_REFERENCE_RESOLVER - text: - type: string - description: Message text. - example: 'Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]' - details: - type: object - description: 'Message details if any, in key:value pairs.' - additionalProperties: true - example: - details: message details - required: - - key - - text - - details - errors: - description: Error messages returned from the target service on import. - type: array - items: - type: object - title: Config Import/Export Message - description: Message model for Config Import/Export. - properties: - key: - type: string - description: Message key. - example: UNKNOWN_REFERENCE_RESOLVER - text: - type: string - description: Message text. - example: 'Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]' - details: - type: object - description: 'Message details if any, in key:value pairs.' - additionalProperties: true - example: - details: message details - required: - - key - - text - - details - importedObjects: - description: References to objects that were created or updated by the import. - type: array - items: - 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 - - WORKGROUP - 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 - required: - - infos - - warnings - - errors - - importedObjects - '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. - security: - - UserContextAuth: - - 'idn:identity-profile:manage' - '/identity-profiles/{identity-profile-id}': - get: - operationId: getIdentityProfile - tags: - - Identity Profiles - summary: Get single Identity Profile - description: |- - This returns a single Identity Profile based on ID. - A token with ORG_ADMIN or API authority is required to call this API. - parameters: - - in: path - name: identity-profile-id - schema: - type: string - format: uuid - required: true - description: The Identity Profile ID. - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - responses: - '200': - description: An Identity Profile object. - content: - application/json: - schema: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - - type: object - required: - - authoritativeSource - properties: - description: - type: string - description: The description of the Identity Profile. - example: My custom flat file profile - nullable: true - owner: - type: object - description: The owner of the Identity Profile. - nullable: true - properties: - type: - type: string - enum: - - IDENTITY - description: Type of the object to which this reference applies - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - priority: - type: integer - format: int64 - description: The priority for an Identity Profile. - example: 10 - authoritativeSource: - type: object - properties: - type: - type: string - enum: - - SOURCE - description: Type of the object to which this reference applies - example: SOURCE - id: - type: string - description: ID of the object to which this reference applies - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: HR Active Directory - identityRefreshRequired: - type: boolean - default: false - description: True if a identity refresh is needed. Typically triggered when a change on the source has been made. - example: true - identityCount: - type: integer - description: The number of identities that belong to the Identity Profile. - format: int32 - example: 8 - identityAttributeConfig: - type: object - description: Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. - properties: - enabled: - description: The backend will only promote values if the profile/mapping is enabled. - type: boolean - default: false - example: true - attributeTransforms: - type: array - items: - type: object - description: Defines a transformation definition for an identity attribute. - properties: - identityAttributeName: - type: string - description: Name of the identity attribute. - example: email - transformDefinition: - description: The seaspray transformation definition. - type: object - properties: - type: - type: string - description: The type of the transform definition. - example: accountAttribute - attributes: - type: object - additionalProperties: - anyOf: - - type: string - - type: object - description: Arbitrary key-value pairs to store any metadata for the object - example: - attributeName: e-mail - sourceName: MySource - sourceId: 2c9180877a826e68017a8c0b03da1a53 - identityExceptionReportReference: - type: object - nullable: true - properties: - taskResultId: - type: string - format: uuid - description: The id of the task result. - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - reportName: - type: string - example: My annual report - description: The name of the report. - hasTimeBasedAttr: - description: Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. - type: boolean - default: false - example: true - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - security: - - UserContextAuth: - - 'idn:identity-profile:read' - delete: - operationId: deleteIdentityProfile - tags: - - Identity Profiles - summary: Delete an Identity Profile - description: |- - This deletes an Identity Profile based on ID. - - On success, this endpoint will return a reference to the bulk delete task result. - - A token with ORG_ADMIN authority is required to call this API. - - The following rights are required to access this endpoint: idn:identity-profile:delete - parameters: - - in: path - name: identity-profile-id - schema: - type: string - format: uuid - required: true - description: The Identity Profile ID. - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '202': - description: Accepted - Returns a TaskResult object referencing the bulk delete job created. - content: - application/json: - schema: - description: An object with a TaskResult reference of the delete job. - type: object - properties: - id: - type: string - description: Task identifier - example: ff8081814d977c21014da056804a0af3 - name: - type: string - description: Task name - example: Background Object Terminator c8f030f2-b1a6-4e33-99e8-6935bc18735d - description: - type: string - description: Task description - example: 'Generic task for terminating data in the overlay, used by the TerminationService.' - launcher: - type: string - description: User or process who launched the task - example: support - completed: - type: string - format: date-time - description: Date time of completion - example: 'Mon Aug 21 14:57:39 CDT 2023' - launched: - type: string - format: date-time - description: Date time when the task was launched - example: 'Mon Aug 21 14:55:39 CDT 2023' - completionStatus: - type: string - enum: - - Success - - Warning - - Error - - Terminated - - TempError - description: Task result status - example: Success - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - security: - - UserContextAuth: - - 'idn:identity-profile:delete' - '/identity-profiles/{identity-profile-id}/default-identity-attribute-config': - get: - operationId: getDefaultIdentityAttributeConfig - tags: - - Identity Profiles - summary: Get default Identity Attribute Config - description: |- - This returns the default identity attribute config. - A token with ORG_ADMIN authority is required to call this API to get the default identity attribute config. - parameters: - - in: path - name: identity-profile-id - schema: - type: string - format: uuid - required: true - description: The Identity Profile ID. - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - responses: - '200': - description: An Identity Attribute Config object. - content: - application/json: - schema: - type: object - description: Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. - properties: - enabled: - description: The backend will only promote values if the profile/mapping is enabled. - type: boolean - default: false - example: true - attributeTransforms: - type: array - items: - type: object - description: Defines a transformation definition for an identity attribute. - properties: - identityAttributeName: - type: string - description: Name of the identity attribute. - example: email - transformDefinition: - description: The seaspray transformation definition. - type: object - properties: - type: - type: string - description: The type of the transform definition. - example: accountAttribute - attributes: - type: object - additionalProperties: - anyOf: - - type: string - - type: object - description: Arbitrary key-value pairs to store any metadata for the object - example: - attributeName: e-mail - sourceName: MySource - sourceId: 2c9180877a826e68017a8c0b03da1a53 - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - security: - - UserContextAuth: - - 'idn:identity-profile:manage' - '/identity-profiles/{identity-profile-id}/process-identities': - post: - operationId: syncIdentityProfile - tags: - - Identity Profiles - summary: Process identities under profile - description: |- - Process identities under the profile - - A token with ORG_ADMIN authority is required to call this API. - parameters: - - in: path - name: identity-profile-id - schema: - type: string - format: uuid - required: true - description: The Identity Profile ID to be processed - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '202': - description: Accepted status after refresh has launched - content: - application/json: - schema: - type: object - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - security: - - UserContextAuth: - - 'idn:identity-profile:refresh' - /non-employee-records: - post: - operationId: createNonEmployeeRecord - tags: - - Non-Employee Lifecycle Management - summary: Create Non-Employee Record - description: |- - This request will create a non-employee record. - Requires role context of `idn:nesr:create` - requestBody: - description: Non-Employee record creation request body. - required: true - content: - application/json: - schema: - type: object - properties: - accountName: - type: string - description: Requested identity account name. - example: william.smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5555555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - sourceId: - type: string - description: Non-Employee's source id. - example: 2c91808568c529c60168cca6f90c1313 - data: - type: object - additionalProperties: - type: string - description: 'Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported.' - example: - description: Auditing - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2020-03-24T00:00:00-05:00' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2021-03-25T00:00:00-05:00' - required: - - accountName - - firstName - - lastName - - email - - phone - - manager - - sourceId - - startDate - - endDate - responses: - '200': - description: Created non-employee record. - content: - application/json: - schema: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee record id. - example: ef38f94347e94562b5bb8424a56397d8 - accountName: - type: string - description: Requested identity account name. - example: Abby.Smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5555555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - sourceId: - type: string - description: Non-Employee's source id. - example: 2c91808568c529c60168cca6f90c1313 - data: - type: object - additionalProperties: - type: string - description: Attribute blob/bag for a non-employee. - example: - description: Auditing - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2019-08-23T18:52:59.162Z' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2020-08-23T18:52:59.162Z' - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - '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. - get: - operationId: listNonEmployeeRecords - security: - - UserContextAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: List Non-Employee Records - description: |- - This gets a list of non-employee records. There are two contextual uses for this endpoint: - 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. - 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. - parameters: - - 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: sorters - required: false - schema: - type: string - format: comma-separated - example: 'accountName,sourceId' - description: 'Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified**' - - in: query - name: filters - required: false - schema: - type: string - example: sourceId eq "2c91808568c529c60168cca6f90c1313" - description: 'Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407) Filtering is supported for the following fields and operators: **sourceId**: *eq* *Example:* sourceId eq "2c91808568c529c60168cca6f90c1313"' - responses: - '200': - description: Non-Employee record objects - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee record id. - example: ef38f94347e94562b5bb8424a56397d8 - accountName: - type: string - description: Requested identity account name. - example: Abby.Smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5555555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - sourceId: - type: string - description: Non-Employee's source id. - example: 2c91808568c529c60168cca6f90c1313 - data: - type: object - additionalProperties: - type: string - description: Attribute blob/bag for a non-employee. - example: - description: Auditing - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2019-08-23T18:52:59.162Z' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2020-08-23T18:52:59.162Z' - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - '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. - '/non-employee-records/{id}': - get: - operationId: getNonEmployeeRecord - tags: - - Non-Employee Lifecycle Management - summary: Get a Non-Employee Record - description: |- - This gets a non-employee record. - Requires role context of `idn:nesr:read` - parameters: - - in: path - name: id - description: Non-Employee record id (UUID) - required: true - example: ef38f94347e94562b5bb8424a56397d8 - schema: - type: string - responses: - '200': - description: Non-Employee record object - content: - application/json: - schema: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee record id. - example: ef38f94347e94562b5bb8424a56397d8 - accountName: - type: string - description: Requested identity account name. - example: Abby.Smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5555555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - sourceId: - type: string - description: Non-Employee's source id. - example: 2c91808568c529c60168cca6f90c1313 - data: - type: object - additionalProperties: - type: string - description: Attribute blob/bag for a non-employee. - example: - description: Auditing - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2019-08-23T18:52:59.162Z' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2020-08-23T18:52:59.162Z' - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - '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. - put: - operationId: updateNonEmployeeRecord - security: - - UserContextAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Update Non-Employee Record - description: |- - This request will update a non-employee record. There are two contextual uses for this endpoint: - 1. The user has the role context of `idn:nesr:update`, in which case they - update all available fields. - 2. The user is owner of the source, in this case they can only update the - end date. - parameters: - - in: path - name: id - description: Non-employee record id (UUID) - example: ef38f94347e94562b5bb8424a56397d8 - required: true - schema: - type: string - requestBody: - description: Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - required: true - content: - application/json: - schema: - type: object - properties: - accountName: - type: string - description: Requested identity account name. - example: william.smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5555555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - sourceId: - type: string - description: Non-Employee's source id. - example: 2c91808568c529c60168cca6f90c1313 - data: - type: object - additionalProperties: - type: string - description: 'Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported.' - example: - description: Auditing - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2020-03-24T00:00:00-05:00' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2021-03-25T00:00:00-05:00' - required: - - accountName - - firstName - - lastName - - email - - phone - - manager - - sourceId - - startDate - - endDate - responses: - '200': - description: An updated non-employee record. - content: - application/json: - schema: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee record id. - example: ef38f94347e94562b5bb8424a56397d8 - accountName: - type: string - description: Requested identity account name. - example: Abby.Smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5555555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - sourceId: - type: string - description: Non-Employee's source id. - example: 2c91808568c529c60168cca6f90c1313 - data: - type: object - additionalProperties: - type: string - description: Attribute blob/bag for a non-employee. - example: - description: Auditing - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2019-08-23T18:52:59.162Z' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2020-08-23T18:52:59.162Z' - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - patch: - operationId: patchNonEmployeeRecord - security: - - UserContextAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Patch Non-Employee Record - description: |- - This request will patch a non-employee record. There are two contextual uses for this endpoint: - 1. The user has the role context of `idn:nesr:update`, in which case they - update all available fields. - 2. The user is owner of the source, in this case they can only update the - end date. - parameters: - - in: path - name: id - description: Non-employee record id (UUID) - example: ef38f94347e94562b5bb8424a56397d8 - required: true - schema: - type: string - requestBody: - description: 'A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.' - required: true - content: - application/json-patch+json: - schema: - type: array - items: - type: object - description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' - required: - - op - - path - properties: - op: - type: string - description: The operation to be performed - enum: - - add - - remove - - replace - - move - - copy - - test - example: replace - path: - type: string - description: A string JSON Pointer representing the target path to an element to be affected by the operation - example: /description - value: - anyOf: - - type: string - - type: integer - - type: object - - type: array - items: - anyOf: - - type: string - - type: integer - - type: object - description: 'The value to be used for the operation, required for "add" and "replace" operations' - example: New description - example: - - op: replace - path: /endDate - value: '2019-08-23T18:40:35.772Z' - responses: - '200': - description: A patched non-employee record. - content: - application/json: - schema: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee record id. - example: ef38f94347e94562b5bb8424a56397d8 - accountName: - type: string - description: Requested identity account name. - example: Abby.Smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5555555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - sourceId: - type: string - description: Non-Employee's source id. - example: 2c91808568c529c60168cca6f90c1313 - data: - type: object - additionalProperties: - type: string - description: Attribute blob/bag for a non-employee. - example: - description: Auditing - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2019-08-23T18:52:59.162Z' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2020-08-23T18:52:59.162Z' - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - delete: - operationId: deleteNonEmployeeRecord - tags: - - Non-Employee Lifecycle Management - summary: Delete Non-Employee Record - description: |- - This request will delete a non-employee record. - Requires role context of `idn:nesr:delete` - parameters: - - in: path - name: id - description: Non-Employee record id (UUID) - example: ef38f94347e94562b5bb8424a56397d8 - required: true - schema: - type: string - responses: - '204': - description: No content - indicates the request was successful but there is no content to be returned in the response. - '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. - /non-employee-records/bulk-delete: - post: - operationId: deleteNonEmployeeRecordsInBulk - tags: - - Non-Employee Lifecycle Management - summary: Delete Multiple Non-Employee Records - description: 'This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete`' - requestBody: - description: Non-Employee bulk delete request body. - required: true - content: - application/json: - schema: - type: object - properties: - ids: - description: List of non-employee ids. - type: array - items: - type: string - format: uuid - example: - - 2b838de9-db9b-abcf-e646-d4f274ad4238 - - 2d838de9-db9b-abcf-e646-d4f274ad4238 - required: - - ids - responses: - '204': - description: No content - indicates the request was successful but there is no content to be returned in the response. - '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. - /non-employee-requests: - post: - operationId: createNonEmployeeRequest - security: - - UserContextAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Create Non-Employee Request - description: 'This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source.' - requestBody: - description: Non-Employee creation request body - required: true - content: - application/json: - schema: - type: object - properties: - accountName: - type: string - description: Requested identity account name. - example: william.smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5555555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - sourceId: - type: string - description: Non-Employee's source id. - example: 2c91808568c529c60168cca6f90c1313 - data: - type: object - additionalProperties: - type: string - description: 'Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported.' - example: - description: Auditing - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2020-03-24T00:00:00-05:00' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2021-03-25T00:00:00-05:00' - required: - - accountName - - firstName - - lastName - - email - - phone - - manager - - sourceId - - startDate - - endDate - responses: - '200': - description: Non-Employee request creation object - content: - application/json: - schema: - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee source id. - example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 - sourceId: - type: string - description: Source Id associated with this non-employee source. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Source name associated with this non-employee source. - example: Retail - description: - type: string - description: Source description associated with this non-employee source. - example: Source description - - type: object - properties: - accountName: - type: string - description: Requested identity account name. - example: william.smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5555555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - nonEmployeeSource: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee source id. - example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 - sourceId: - type: string - description: Source Id associated with this non-employee source. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Source name associated with this non-employee source. - example: Retail - description: - type: string - description: Source description associated with this non-employee source. - example: Source description - data: - type: object - additionalProperties: - type: string - description: Attribute blob/bag for a non-employee. - example: - description: Auditing - approvalItems: - description: List of approval item for the request - type: array - items: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee approval item id - example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c - approver: - description: Reference to the associated Identity - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - description: Identifies if the identity is a normal identity or a governance group - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - accountName: - type: string - description: Requested identity account name - example: test.account - approvalStatus: - type: string - enum: - - APPROVED - - REJECTED - - PENDING - - NOT_READY - - CANCELLED - description: Enum representing the non-employee request approval status - example: APPROVED - approvalOrder: - type: number - description: Approval order - example: 1 - format: float - comment: - type: string - description: comment of approver - example: I approve - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - approvalStatus: - type: string - enum: - - APPROVED - - REJECTED - - PENDING - - NOT_READY - - CANCELLED - description: Enum representing the non-employee request approval status - example: APPROVED - comment: - type: string - description: comment of requester - example: approved - completionDate: - type: string - format: date-time - description: When the request was completely approved. - example: '2020-03-24T11:11:41.139-05:00' - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2020-03-24T00:00:00-05:00' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2021-03-25T00:00:00-05:00' - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2020-03-24T11:11:41.139-05:00' - created: - type: string - format: date-time - description: When the request was created. - example: '2020-03-24T11:11:41.139-05:00' - '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. - examples: - 400.1 Bad Request Content: - description: Response for bad request content - value: - detailCode: 400.1 Bad Request Content - trackingId: e7eab60924f64aa284175b9fa3309599 - messages: - - locale: en - localeOrigin: REQUEST - text: firstName is required; accountName is required; - 400.1.409 Reference conflict: - description: Response for reference conflict - value: - detailCode: 400.1.409 Reference conflict - trackingId: e7eab60924f64aa284175b9fa3309599 - messages: - - locale: en - localeOrigin: REQUEST - text: Unable to create Non-Employee because the accountName "existed" is already being used. - '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. - get: - operationId: listNonEmployeeRequests - security: - - UserContextAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: List Non-Employee Requests - description: |- - This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: - 1. The user has the role context of `idn:nesr:read`, in which case he or - she may request a list non-employee requests assigned to a particular account manager by passing in that manager's id. - 2. The current user is an account manager, in which case "me" should be - provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. - parameters: - - 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: requested-for - required: true - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - description: The identity for whom the request was made. *me* indicates the current user. - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: 'created,approvalStatus' - description: 'Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate**' - - in: query - name: filters - required: false - schema: - type: string - example: sourceId eq "2c91808568c529c60168cca6f90c1313" - description: 'Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407) Filtering is supported for the following fields and operators: **sourceId**: *eq* *Example:* sourceId eq "2c91808568c529c60168cca6f90c1313"' - responses: - '200': - description: List of non-employee request objects. - content: - application/json: - schema: - type: array - items: - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee source id. - example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 - sourceId: - type: string - description: Source Id associated with this non-employee source. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Source name associated with this non-employee source. - example: Retail - description: - type: string - description: Source description associated with this non-employee source. - example: Source description - - type: object - properties: - accountName: - type: string - description: Requested identity account name. - example: william.smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5555555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - nonEmployeeSource: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee source id. - example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 - sourceId: - type: string - description: Source Id associated with this non-employee source. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Source name associated with this non-employee source. - example: Retail - description: - type: string - description: Source description associated with this non-employee source. - example: Source description - data: - type: object - additionalProperties: - type: string - description: Attribute blob/bag for a non-employee. - example: - description: Auditing - approvalItems: - description: List of approval item for the request - type: array - items: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee approval item id - example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c - approver: - description: Reference to the associated Identity - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - description: Identifies if the identity is a normal identity or a governance group - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - accountName: - type: string - description: Requested identity account name - example: test.account - approvalStatus: - type: string - enum: - - APPROVED - - REJECTED - - PENDING - - NOT_READY - - CANCELLED - description: Enum representing the non-employee request approval status - example: APPROVED - approvalOrder: - type: number - description: Approval order - example: 1 - format: float - comment: - type: string - description: comment of approver - example: I approve - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - approvalStatus: - type: string - enum: - - APPROVED - - REJECTED - - PENDING - - NOT_READY - - CANCELLED - description: Enum representing the non-employee request approval status - example: APPROVED - comment: - type: string - description: comment of requester - example: approved - completionDate: - type: string - format: date-time - description: When the request was completely approved. - example: '2020-03-24T11:11:41.139-05:00' - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2020-03-24T00:00:00-05:00' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2021-03-25T00:00:00-05:00' - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2020-03-24T11:11:41.139-05:00' - created: - type: string - format: date-time - description: When the request was created. - example: '2020-03-24T11:11:41.139-05:00' - '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. - '/non-employee-requests/{id}': - get: - operationId: getNonEmployeeRequest - security: - - UserContextAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Get a Non-Employee Request - description: |- - This gets a non-employee request. - There are two contextual uses for this endpoint: - 1. The user has the role context of `idn:nesr:read`, in this case the user - can get the non-employee request for any user. - 2. The user must be the owner of the non-employee request. - parameters: - - in: path - name: id - description: Non-Employee request id (UUID) - example: ac110005-7156-1150-8171-5b292e3e0084 - required: true - schema: - type: string - responses: - '200': - description: Non-Employee request object. - content: - application/json: - schema: - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee source id. - example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 - sourceId: - type: string - description: Source Id associated with this non-employee source. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Source name associated with this non-employee source. - example: Retail - description: - type: string - description: Source description associated with this non-employee source. - example: Source description - - type: object - properties: - accountName: - type: string - description: Requested identity account name. - example: william.smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5555555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - nonEmployeeSource: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee source id. - example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 - sourceId: - type: string - description: Source Id associated with this non-employee source. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Source name associated with this non-employee source. - example: Retail - description: - type: string - description: Source description associated with this non-employee source. - example: Source description - data: - type: object - additionalProperties: - type: string - description: Attribute blob/bag for a non-employee. - example: - description: Auditing - approvalItems: - description: List of approval item for the request - type: array - items: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee approval item id - example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c - approver: - description: Reference to the associated Identity - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - description: Identifies if the identity is a normal identity or a governance group - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - accountName: - type: string - description: Requested identity account name - example: test.account - approvalStatus: - type: string - enum: - - APPROVED - - REJECTED - - PENDING - - NOT_READY - - CANCELLED - description: Enum representing the non-employee request approval status - example: APPROVED - approvalOrder: - type: number - description: Approval order - example: 1 - format: float - comment: - type: string - description: comment of approver - example: I approve - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - approvalStatus: - type: string - enum: - - APPROVED - - REJECTED - - PENDING - - NOT_READY - - CANCELLED - description: Enum representing the non-employee request approval status - example: APPROVED - comment: - type: string - description: comment of requester - example: approved - completionDate: - type: string - format: date-time - description: When the request was completely approved. - example: '2020-03-24T11:11:41.139-05:00' - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2020-03-24T00:00:00-05:00' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2021-03-25T00:00:00-05:00' - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2020-03-24T11:11:41.139-05:00' - created: - type: string - format: date-time - description: When the request was created. - example: '2020-03-24T11:11:41.139-05:00' - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - delete: - operationId: deleteNonEmployeeRequest - tags: - - Non-Employee Lifecycle Management - summary: Delete Non-Employee Request - description: |- - This request will delete a non-employee request. - Requires role context of `idn:nesr:delete` - parameters: - - in: path - name: id - description: Non-Employee request id in the UUID format - required: true - schema: - type: string - format: uuid - example: ac110005-7156-1150-8171-5b292e3e0084 - responses: - '204': - description: No content - indicates the request was successful but there is no content to be returned in the response. - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - '/non-employee-requests/summary/{requested-for}': - get: - operationId: getNonEmployeeRequestSummary - security: - - UserContextAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Get Summary of Non-Employee Requests - description: |- - This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: - 1. The user has the role context of `idn:nesr:read`, in which case he or - she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id. - 2. The current user is an account manager, in which case "me" should be - provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. - parameters: - - in: path - name: requested-for - description: The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use "me" instead to indicate the current user. - required: true - schema: - type: string - format: uuid (if user is Org Admin) - example: 2c91808280430dfb0180431a59440460 - responses: - '200': - description: Non-Employee request summary object. - content: - application/json: - schema: - type: object - properties: - approved: - type: integer - description: The number of approved non-employee requests on all sources that *requested-for* user manages. - example: 2 - format: int32 - rejected: - type: integer - description: The number of rejected non-employee requests on all sources that *requested-for* user manages. - example: 2 - format: int32 - pending: - type: integer - description: The number of pending non-employee requests on all sources that *requested-for* user manages. - example: 2 - format: int32 - nonEmployeeCount: - type: integer - description: The number of non-employee records on all sources that *requested-for* user manages. - example: 2 - format: int32 - '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. - /non-employee-sources: - post: - operationId: createNonEmployeeSource - tags: - - Non-Employee Lifecycle Management - summary: Create Non-Employee Source - description: 'This request will create a non-employee source. Requires role context of `idn:nesr:create`' - requestBody: - description: Non-Employee source creation request body. - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: Name of non-employee source. - example: Retail - description: - type: string - description: Description of non-employee source. - example: Source description - owner: - description: Owner of non-employee source. - type: object - properties: - id: - type: string - format: UUID - description: Identity id. - example: 2c91808570313110017040b06f344ec9 - required: - - id - managementWorkgroup: - type: string - description: The ID for the management workgroup that contains source sub-admins - example: '123299' - approvers: - description: List of approvers. - type: array - items: - type: object - properties: - id: - type: string - format: UUID - description: Identity id. - example: 2c91808570313110017040b06f344ec9 - required: - - id - maxItems: 3 - accountManagers: - description: List of account managers. - type: array - items: - type: object - properties: - id: - type: string - format: UUID - description: Identity id. - example: 2c91808570313110017040b06f344ec9 - required: - - id - maxItems: 10 - required: - - owner - - name - - description - responses: - '200': - description: Created non-employee source. - content: - application/json: - schema: - allOf: - - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee source id. - example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 - sourceId: - type: string - description: Source Id associated with this non-employee source. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Source name associated with this non-employee source. - example: Retail - description: - type: string - description: Source description associated with this non-employee source. - example: Source description - - type: object - properties: - approvers: - description: List of approvers - type: array - items: - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - description: Identifies if the identity is a normal identity or a governance group - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - accountManagers: - description: List of account managers - type: array - items: - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - description: Identifies if the identity is a normal identity or a governance group - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - - type: object - properties: - cloudExternalId: - type: string - description: Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present. - example: '99999' - '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. - get: - operationId: listNonEmployeeSources - security: - - UserContextAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: List Non-Employee Sources - description: |- - This gets a list of non-employee sources. There are two contextual uses for the requested-for path parameter: - 1. The user has the role context of `idn:nesr:read`, in which case he or - she may request a list sources assigned to a particular account manager by passing in that manager's id. - 2. The current user is an account manager, in which case "me" should be - provided as the `requested-for` value. This will provide the user with a list of the sources that he or she owns. - parameters: - - 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: requested-for - required: true - schema: - type: string - example: me - description: The identity for whom the request was made. *me* indicates the current user. - - in: query - name: non-employee-count - required: false - example: true - schema: - type: boolean - description: The flag to determine whether return a non-employee count associate with source. - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: 'name,created' - description: 'Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949) Sorting is supported for the following fields: **name, created**' - responses: - '200': - description: List of non-employee sources objects. - content: - application/json: - schema: - type: array - items: - allOf: - - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee source id. - example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 - sourceId: - type: string - description: Source Id associated with this non-employee source. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Source name associated with this non-employee source. - example: Retail - description: - type: string - description: Source description associated with this non-employee source. - example: Source description - - type: object - properties: - approvers: - description: List of approvers - type: array - items: - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - description: Identifies if the identity is a normal identity or a governance group - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - accountManagers: - description: List of account managers - type: array - items: - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - description: Identifies if the identity is a normal identity or a governance group - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - - type: object - properties: - nonEmployeeCount: - type: integer - description: Number of non-employee records associated with this source. - format: int32 - example: 120 - '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. - '/non-employee-sources/{sourceId}': - get: - operationId: getNonEmployeeSource - security: - - UserContextAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Get a Non-Employee Source - description: |- - This gets a non-employee source. There are two contextual uses for the requested-for path parameter: - 1. The user has the role context of `idn:nesr:read`, in which case he or - she may request any source. - 2. The current user is an account manager, in which case the user can only - request sources that they own. - parameters: - - in: path - name: sourceId - description: Source Id - example: 2c91808b7c28b350017c2a2ec5790aa1 - required: true - schema: - type: string - responses: - '200': - description: Non-Employee source object. - content: - application/json: - schema: - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee source id. - example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 - sourceId: - type: string - description: Source Id associated with this non-employee source. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Source name associated with this non-employee source. - example: Retail - description: - type: string - description: Source description associated with this non-employee source. - example: Source description - - type: object - properties: - approvers: - description: List of approvers - type: array - items: - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - description: Identifies if the identity is a normal identity or a governance group - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - accountManagers: - description: List of account managers - type: array - items: - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - description: Identifies if the identity is a normal identity or a governance group - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - '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. - patch: - operationId: patchNonEmployeeSource - tags: - - Non-Employee Lifecycle Management - summary: Patch a Non-Employee Source - description: 'patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`.' - parameters: - - in: path - name: sourceId - description: Source Id - required: true - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - requestBody: - description: 'A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.' - required: true - content: - application/json-patch+json: - schema: - type: array - items: - type: object - description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' - required: - - op - - path - properties: - op: - type: string - description: The operation to be performed - enum: - - add - - remove - - replace - - move - - copy - - test - example: replace - path: - type: string - description: A string JSON Pointer representing the target path to an element to be affected by the operation - example: /description - value: - anyOf: - - type: string - - type: integer - - type: object - - type: array - items: - anyOf: - - type: string - - type: integer - - type: object - description: 'The value to be used for the operation, required for "add" and "replace" operations' - example: New description - example: - - op: replace - path: /name - value: - new name: null - - op: replace - path: /approvers - value: - - 2c91809f703bb37a017040a2fe8748c7 - - 48b1f463c9e8427db5a5071bd81914b8 - responses: - '200': - description: A patched non-employee source object. - content: - application/json: - schema: - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee source id. - example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 - sourceId: - type: string - description: Source Id associated with this non-employee source. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Source name associated with this non-employee source. - example: Retail - description: - type: string - description: Source description associated with this non-employee source. - example: Source description - - type: object - properties: - approvers: - description: List of approvers - type: array - items: - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - description: Identifies if the identity is a normal identity or a governance group - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - accountManagers: - description: List of account managers - type: array - items: - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - description: Identifies if the identity is a normal identity or a governance group - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - '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. - delete: - operationId: deleteNonEmployeeSource - tags: - - Non-Employee Lifecycle Management - summary: Delete Non-Employee Source - description: 'This request will delete a non-employee source. Requires role context of `idn:nesr:delete`.' - parameters: - - in: path - name: sourceId - description: Source Id - required: true - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - responses: - '204': - description: No content - indicates the request was successful but there is no content to be returned in the response. - '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. - '/non-employee-sources/{id}/non-employees/download': - get: - operationId: exportNonEmployeeRecords - tags: - - Non-Employee Lifecycle Management - summary: Exports Non-Employee Records to CSV - description: 'This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read`' - parameters: - - in: path - name: id - description: Source Id (UUID) - required: true - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - responses: - '200': - description: Exported CSV - content: - text/csv: - example: | - accountName,firstName,lastName,phone,email,manager,startDate,endDate - Jon.Smith, Jon, Smith, 555-555-5555, jon@jon.doe.nope.com, Jim Smith, 2020-04-05T08:00:00-10:00,2020-08-07T19:00:00-10:00 - William.Chaffin, William, Chaffin, 555-555-5555, william@chaffins.nope.com, Bertram Chaffin, 2020-04-05T08:00:00-10:00,2020-08-07T19:00:00-10:00 - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - '/non-employee-sources/{id}/non-employee-bulk-upload': - post: - operationId: importNonEmployeeRecordsInBulk - security: - - UserContextAuth: - - 'idn:nelm:manage' - tags: - - Non-Employee Lifecycle Management - summary: 'Imports, or Updates, Non-Employee Records' - description: 'This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create`' - parameters: - - in: path - name: id - description: Source Id (UUID) - required: true - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - requestBody: - content: - multipart/form-data: - schema: - type: object - properties: - data: - type: string - format: binary - required: - - data - responses: - '202': - description: The CSV was accepted to be bulk inserted now or at a later time. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The bulk upload job's ID. (UUID) - example: 2c91808568c529c60168cca6f90cffff - sourceId: - type: string - description: The ID of the source to bulk-upload non-employees to. (UUID) - example: 2c91808568c529c60168cca6f90c1313 - created: - type: string - format: date-time - description: The date-time the job was submitted. - example: '2019-08-23T18:52:59.162Z' - modified: - type: string - format: date-time - description: The date-time that the job was last updated. - example: '2019-08-23T18:52:59.162Z' - status: - type: string - enum: - - PENDING - - IN_PROGRESS - - COMPLETED - - ERROR - description: | - Returns the following values indicating the progress or result of the bulk upload job. - "PENDING" means the job is queued and waiting to be processed. - "IN_PROGRESS" means the job is currently being processed. - "COMPLETED" means the job has been completed without any errors. - "ERROR" means the job failed to process with errors. - example: PENDING - '400': - description: | - Client Error - Returned if the request body is invalid. - The response body will contain the list of specific errors with one on each line. - 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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - '/non-employee-sources/{id}/non-employee-bulk-upload/status': - get: - operationId: getNonEmployeeBulkUploadStatus - tags: - - Non-Employee Lifecycle Management - summary: Obtain the status of bulk upload on the source - description: | - The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. - Requires role context of `idn:nesr:read` - parameters: - - in: path - name: id - description: Source ID (UUID) - required: true - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - responses: - '200': - description: 'Status of the newest bulk-upload job, if any.' - content: - application/json: - schema: - type: object - properties: - status: - type: string - enum: - - PENDING - - IN_PROGRESS - - COMPLETED - - ERROR - description: | - Returns the following values indicating the progress or result of the bulk upload job. - "PENDING" means the job is queued and waiting to be processed. - "IN_PROGRESS" means the job is currently being processed. - "COMPLETED" means the job has been completed without any errors. - "ERROR" means the job failed to process with errors. - null means job has been submitted to the source. - example: PENDING - '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. - '/non-employee-sources/{id}/schema-attributes-template/download': - get: - operationId: exportNonEmployeeSourceSchemaTemplate - tags: - - Non-Employee Lifecycle Management - summary: Exports Source Schema Template - description: 'This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read`' - parameters: - - in: path - name: id - description: Source Id (UUID) - required: true - example: ef38f94347e94562b5bb8424a56397d8 - schema: - type: string - responses: - '200': - description: Exported Source Schema Template - content: - text/csv: - example: | - accountName,firstName,lastName,phone,email,manager,startDate,endDate - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - /non-employee-approvals: - get: - operationId: listNonEmployeeApprovals - security: - - UserContextAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Get List of Non-Employee Approval Requests - description: |- - This gets a list of non-employee approval requests. - There are two contextual uses for this endpoint: - 1. The user has the role context of `idn:nesr:read`, in which case they - can list the approvals for any approver. - 2. The user owns the requested approval. - parameters: - - in: query - name: requested-for - schema: - type: string - description: The identity for whom the request was made. *me* indicates the current user. - required: false - example: 2c91808280430dfb0180431a59440460 - - 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 - description: 'Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* *Example:* approvalStatus eq "PENDING"' - example: approvalStatus eq "Pending" - required: false - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: 'Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949) Sorting is supported for the following fields: **created, modified**' - required: false - example: created - responses: - '200': - description: List of approval items. - content: - application/json: - schema: - type: array - items: - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee approval item id - example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c - approver: - description: Reference to the associated Identity - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - description: Identifies if the identity is a normal identity or a governance group - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - accountName: - type: string - description: Requested identity account name - example: test.account - approvalStatus: - type: string - enum: - - APPROVED - - REJECTED - - PENDING - - NOT_READY - - CANCELLED - description: Enum representing the non-employee request approval status - example: APPROVED - approvalOrder: - type: number - description: Approval order - example: 1 - format: float - comment: - type: string - description: comment of approver - example: I approve - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - - type: object - properties: - nonEmployeeRequest: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee request id. - example: ac110005-7156-1150-8171-5b292e3e0084 - requester: - example: - type: IDENTITY - id: 2c9180866166b5b0016167c32ef31a66 - name: William Smith - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - description: Identifies if the identity is a normal identity or a governance group - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - '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. - '/non-employee-approvals/{id}': - get: - operationId: getNonEmployeeApproval - security: - - UserContextAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Get a non-employee approval item detail - description: |- - Gets a non-employee approval item detail. There are two contextual uses for this endpoint: - 1. The user has the role context of `idn:nesr:read`, in which case they - can get any approval. - 2. The user owns the requested approval. - parameters: - - in: path - name: id - description: Non-Employee approval item id (UUID) - required: true - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - - in: query - name: include-detail - description: The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* - required: false - schema: - type: boolean - example: true - responses: - '200': - description: Non-Employee approval item object. - content: - application/json: - schema: - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee approval item id - example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c - approver: - description: Reference to the associated Identity - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - description: Identifies if the identity is a normal identity or a governance group - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - accountName: - type: string - description: Requested identity account name - example: test.account - approvalStatus: - type: string - enum: - - APPROVED - - REJECTED - - PENDING - - NOT_READY - - CANCELLED - description: Enum representing the non-employee request approval status - example: APPROVED - approvalOrder: - type: number - description: Approval order - example: 1 - format: float - comment: - type: string - description: comment of approver - example: I approve - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - - type: object - properties: - nonEmployeeRequest: - description: Non-Employee request associated to this approval - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee request id. - example: ac110005-7156-1150-8171-5b292e3e0084 - requester: - example: - type: IDENTITY - id: 2c9180866166b5b0016167c32ef31a66 - name: William Smith - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - description: Identifies if the identity is a normal identity or a governance group - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - - type: object - properties: - accountName: - type: string - description: Requested identity account name. - example: william.smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5555555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - nonEmployeeSource: - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee source id. - example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 - sourceId: - type: string - description: Source Id associated with this non-employee source. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Source name associated with this non-employee source. - example: Retail - description: - type: string - description: Source description associated with this non-employee source. - example: Source description - - type: object - properties: - schemaAttributes: - description: List of schema attributes associated with this non-employee source. - type: array - items: - type: object - properties: - id: - type: string - format: UUID - example: ac110005-7156-1150-8171-5b292e3e0084 - description: Schema Attribute Id - system: - type: boolean - description: True if this schema attribute is mandatory on all non-employees sources. - example: true - modified: - type: string - format: date-time - description: When the schema attribute was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the schema attribute was created. - example: '2019-08-23T18:40:35.772Z' - type: - type: string - enum: - - TEXT - - DATE - - IDENTITY - description: Enum representing the type of data a schema attribute accepts. - example: TEXT - label: - type: string - description: Label displayed on the UI for this schema attribute. - example: Account Name - technicalName: - type: string - description: The technical name of the attribute. Must be unique per source. - example: account.name - helpText: - type: string - description: help text displayed by UI. - example: The unique identifier for the account - placeholder: - type: string - description: Hint text that fills UI box. - example: Enter a unique user name for this account. - required: - type: boolean - description: 'If true, the schema attribute is required for all non-employees in the source' - example: true - required: - - type - - technicalName - - label - data: - type: object - additionalProperties: - type: string - description: Attribute blob/bag for a non-employee. - example: - description: Auditing - approvalStatus: - type: string - enum: - - APPROVED - - REJECTED - - PENDING - - NOT_READY - - CANCELLED - description: Enum representing the non-employee request approval status - example: APPROVED - comment: - type: string - description: comment of requester - example: approved - completionDate: - type: string - format: date-time - description: When the request was completely approved. - example: '2020-03-24T11:11:41.139-05:00' - startDate: - type: string - format: date - description: Non-Employee employment start date. - example: '2020-03-24' - endDate: - type: string - format: date - description: Non-Employee employment end date. - example: '2021-03-25' - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2020-03-24T11:11:41.139-05:00' - created: - type: string - format: date-time - description: When the request was created. - example: '2020-03-24T11:11:41.139-05:00' - '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. - '/non-employee-approvals/{id}/approve': - post: - operationId: approveNonEmployeeRequest - security: - - UserContextAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Approve a Non-Employee Request - description: Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. - parameters: - - in: path - name: id - description: Non-Employee approval item id (UUID) - required: true - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - comment: - type: string - description: Comment on the approval item. - maxLength: 4000 - example: Approved by manager - responses: - '200': - description: Non-Employee approval item object. - content: - application/json: - schema: - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee approval item id - example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c - approver: - description: Reference to the associated Identity - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - description: Identifies if the identity is a normal identity or a governance group - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - accountName: - type: string - description: Requested identity account name - example: test.account - approvalStatus: - type: string - enum: - - APPROVED - - REJECTED - - PENDING - - NOT_READY - - CANCELLED - description: Enum representing the non-employee request approval status - example: APPROVED - approvalOrder: - type: number - description: Approval order - example: 1 - format: float - comment: - type: string - description: comment of approver - example: I approve - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - - type: object - properties: - nonEmployeeRequest: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee request id. - example: ac110005-7156-1150-8171-5b292e3e0084 - requester: - example: - type: IDENTITY - id: 2c9180866166b5b0016167c32ef31a66 - name: William Smith - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - description: Identifies if the identity is a normal identity or a governance group - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - '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. - '/non-employee-approvals/{id}/reject': - post: - operationId: rejectNonEmployeeRequest - security: - - UserContextAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Reject a Non-Employee Request - description: This endpoint will reject an approval item request and notify user. The current user must be the requested approver. - parameters: - - in: path - name: id - description: Non-Employee approval item id (UUID) - required: true - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - comment: - type: string - description: Comment on the approval item. - maxLength: 4000 - example: approved - required: - - comment - responses: - '200': - description: Non-Employee approval item object. - content: - application/json: - schema: - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee approval item id - example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c - approver: - description: Reference to the associated Identity - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - description: Identifies if the identity is a normal identity or a governance group - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - accountName: - type: string - description: Requested identity account name - example: test.account - approvalStatus: - type: string - enum: - - APPROVED - - REJECTED - - PENDING - - NOT_READY - - CANCELLED - description: Enum representing the non-employee request approval status - example: APPROVED - approvalOrder: - type: number - description: Approval order - example: 1 - format: float - comment: - type: string - description: comment of approver - example: I approve - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - - type: object - properties: - nonEmployeeRequest: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee request id. - example: ac110005-7156-1150-8171-5b292e3e0084 - requester: - example: - type: IDENTITY - id: 2c9180866166b5b0016167c32ef31a66 - name: William Smith - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - description: Identifies if the identity is a normal identity or a governance group - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - '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. - '/non-employee-approvals/summary/{requested-for}': - get: - operationId: getNonEmployeeApprovalSummary - security: - - UserContextAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Get Summary of Non-Employee Approval Requests - description: |- - This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: - 1. The user has the role context of `idn:nesr:read`, in which case he or - she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id. - 2. The current user is an approver, in which case "me" should be provided - as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. - parameters: - - in: path - name: requested-for - schema: - type: string - description: The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use "me" instead to indicate the current user. - required: true - example: 2c91808280430dfb0180431a59440460 - responses: - '200': - description: summary of non-employee approval requests - content: - application/json: - schema: - type: object - properties: - approved: - type: integer - description: The number of approved non-employee approval requests. - format: int32 - example: 2 - pending: - type: integer - description: The number of pending non-employee approval requests. - format: int32 - example: 2 - rejected: - type: integer - description: The number of rejected non-employee approval requests. - format: int32 - example: 2 - '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. - '/non-employee-sources/{sourceId}/schema-attributes': - get: - operationId: getNonEmployeeSourceSchemaAttributes - security: - - UserContextAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: List Schema Attributes Non-Employee Source - description: |- - This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. - Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - parameters: - - in: path - name: sourceId - schema: - type: string - required: true - example: ef38f94347e94562b5bb8424a56397d8 - description: The Source id - responses: - '200': - description: A list of Schema Attributes - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - format: UUID - example: ac110005-7156-1150-8171-5b292e3e0084 - description: Schema Attribute Id - system: - type: boolean - description: True if this schema attribute is mandatory on all non-employees sources. - example: true - modified: - type: string - format: date-time - description: When the schema attribute was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the schema attribute was created. - example: '2019-08-23T18:40:35.772Z' - type: - type: string - enum: - - TEXT - - DATE - - IDENTITY - description: Enum representing the type of data a schema attribute accepts. - example: TEXT - label: - type: string - description: Label displayed on the UI for this schema attribute. - example: Account Name - technicalName: - type: string - description: The technical name of the attribute. Must be unique per source. - example: account.name - helpText: - type: string - description: help text displayed by UI. - example: The unique identifier for the account - placeholder: - type: string - description: Hint text that fills UI box. - example: Enter a unique user name for this account. - required: - type: boolean - description: 'If true, the schema attribute is required for all non-employees in the source' - example: true - required: - - type - - technicalName - - label - maxItems: 18 - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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: createNonEmployeeSourceSchemaAttributes - tags: - - Non-Employee Lifecycle Management - summary: Create a new Schema Attribute for Non-Employee Source - description: |- - This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response. - Requires role context of `idn:nesr:create` - parameters: - - in: path - name: sourceId - schema: - type: string - required: true - description: The Source id - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - type: - type: string - description: Type of the attribute. Only type 'TEXT' is supported for custom attributes. - example: TEXT - label: - type: string - description: Label displayed on the UI for this schema attribute. - example: Account Name - technicalName: - type: string - description: The technical name of the attribute. Must be unique per source. - example: account.name - helpText: - type: string - description: help text displayed by UI. - example: The unique identifier for the account - placeholder: - type: string - description: Hint text that fills UI box. - example: Enter a unique user name for this account. - required: - type: boolean - description: 'If true, the schema attribute is required for all non-employees in the source' - example: true - required: - - type - - technicalName - - label - responses: - '200': - description: Schema Attribute created. - content: - application/json: - schema: - type: object - properties: - id: - type: string - format: UUID - example: ac110005-7156-1150-8171-5b292e3e0084 - description: Schema Attribute Id - system: - type: boolean - description: True if this schema attribute is mandatory on all non-employees sources. - example: true - modified: - type: string - format: date-time - description: When the schema attribute was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the schema attribute was created. - example: '2019-08-23T18:40:35.772Z' - type: - type: string - enum: - - TEXT - - DATE - - IDENTITY - description: Enum representing the type of data a schema attribute accepts. - example: TEXT - label: - type: string - description: Label displayed on the UI for this schema attribute. - example: Account Name - technicalName: - type: string - description: The technical name of the attribute. Must be unique per source. - example: account.name - helpText: - type: string - description: help text displayed by UI. - example: The unique identifier for the account - placeholder: - type: string - description: Hint text that fills UI box. - example: Enter a unique user name for this account. - required: - type: boolean - description: 'If true, the schema attribute is required for all non-employees in the source' - example: true - required: - - type - - technicalName - - label - '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. - delete: - operationId: deleteNonEmployeeSourceSchemaAttributes - tags: - - Non-Employee Lifecycle Management - summary: Delete all custom schema attributes for Non-Employee Source - description: 'This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete`' - parameters: - - in: path - name: sourceId - schema: - type: string - required: true - description: The Source id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '204': - description: All custon Schema Attributes were successfully deleted. - '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. - '/non-employee-sources/{sourceId}/schema-attributes/{attributeId}': - get: - operationId: getNonEmployeeSchemaAttribute - security: - - UserContextAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Get Schema Attribute Non-Employee Source - description: 'This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source.' - parameters: - - in: path - name: attributeId - schema: - type: string - required: true - example: ef38f94347e94562b5bb8424a56397d8 - description: The Schema Attribute Id (UUID) - - in: path - name: sourceId - schema: - type: string - required: true - example: ef38f94347e94562b5bb8424a56397d8 - description: The Source id - responses: - '200': - description: The Schema Attribute - content: - application/json: - schema: - type: object - properties: - id: - type: string - format: UUID - example: ac110005-7156-1150-8171-5b292e3e0084 - description: Schema Attribute Id - system: - type: boolean - description: True if this schema attribute is mandatory on all non-employees sources. - example: true - modified: - type: string - format: date-time - description: When the schema attribute was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the schema attribute was created. - example: '2019-08-23T18:40:35.772Z' - type: - type: string - enum: - - TEXT - - DATE - - IDENTITY - description: Enum representing the type of data a schema attribute accepts. - example: TEXT - label: - type: string - description: Label displayed on the UI for this schema attribute. - example: Account Name - technicalName: - type: string - description: The technical name of the attribute. Must be unique per source. - example: account.name - helpText: - type: string - description: help text displayed by UI. - example: The unique identifier for the account - placeholder: - type: string - description: Hint text that fills UI box. - example: Enter a unique user name for this account. - required: - type: boolean - description: 'If true, the schema attribute is required for all non-employees in the source' - example: true - required: - - type - - technicalName - - label - '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. - patch: - operationId: patchNonEmployeeSchemaAttribute - tags: - - Non-Employee Lifecycle Management - summary: Patch a Schema Attribute for Non-Employee Source - description: | - This end-point patches a specific schema attribute for a non-employee SourceId. - Requires role context of `idn:nesr:update` - parameters: - - in: path - name: attributeId - schema: - type: string - required: true - description: The Schema Attribute Id (UUID) - example: ef38f94347e94562b5bb8424a56397d8 - - in: path - name: sourceId - schema: - type: string - required: true - description: The Source id - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - description: 'A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update '':'' ''label'', ''helpText'', ''placeholder'', ''required''.' - content: - application/json-patch+json: - schema: - type: array - items: - type: object - description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' - required: - - op - - path - properties: - op: - type: string - description: The operation to be performed - enum: - - add - - remove - - replace - - move - - copy - - test - example: replace - path: - type: string - description: A string JSON Pointer representing the target path to an element to be affected by the operation - example: /description - value: - anyOf: - - type: string - - type: integer - - type: object - - type: array - items: - anyOf: - - type: string - - type: integer - - type: object - description: 'The value to be used for the operation, required for "add" and "replace" operations' - example: New description - example: - - op: replace - path: /label - value: - new attribute label: null - required: true - responses: - '200': - description: The Schema Attribute was successfully patched. - content: - application/json: - schema: - type: object - properties: - id: - type: string - format: UUID - example: ac110005-7156-1150-8171-5b292e3e0084 - description: Schema Attribute Id - system: - type: boolean - description: True if this schema attribute is mandatory on all non-employees sources. - example: true - modified: - type: string - format: date-time - description: When the schema attribute was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the schema attribute was created. - example: '2019-08-23T18:40:35.772Z' - type: - type: string - enum: - - TEXT - - DATE - - IDENTITY - description: Enum representing the type of data a schema attribute accepts. - example: TEXT - label: - type: string - description: Label displayed on the UI for this schema attribute. - example: Account Name - technicalName: - type: string - description: The technical name of the attribute. Must be unique per source. - example: account.name - helpText: - type: string - description: help text displayed by UI. - example: The unique identifier for the account - placeholder: - type: string - description: Hint text that fills UI box. - example: Enter a unique user name for this account. - required: - type: boolean - description: 'If true, the schema attribute is required for all non-employees in the source' - example: true - required: - - type - - technicalName - - label - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - delete: - operationId: deleteNonEmployeeSchemaAttribute - tags: - - Non-Employee Lifecycle Management - summary: Delete a Schema Attribute for Non-Employee Source - description: | - This end-point deletes a specific schema attribute for a non-employee source. - Requires role context of `idn:nesr:delete` - parameters: - - in: path - name: attributeId - schema: - type: string - required: true - description: The Schema Attribute Id (UUID) - example: ef38f94347e94562b5bb8424a56397d8 - - in: path - name: sourceId - schema: - type: string - required: true - description: The Source id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '204': - description: The Schema Attribute was successfully deleted. - '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. - /oauth-clients: - get: - operationId: listOauthClients - security: - - UserContextAuth: - - 'sp:oauth-client:manage' - tags: - - OAuth Clients - summary: List OAuth Clients - description: This gets a list of OAuth clients. - parameters: - - in: query - name: filters - required: false - schema: - type: string - 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: - - **lastUsed**: *le, isnull* - example: 'lastUsed le 2023-02-05T10:59:27.214Z' - responses: - '200': - description: List of OAuth clients. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: ID of the OAuth client - example: 2c9180835d2e5168015d32f890ca1581 - businessName: - type: string - nullable: true - description: The name of the business the API Client should belong to - example: Acme-Solar - homepageUrl: - type: string - nullable: true - description: The homepage URL associated with the owner of the API Client - example: 'http://localhost:12345' - name: - type: string - description: A human-readable name for the API Client - example: Demo API Client - description: - type: string - nullable: true - description: A description of the API Client - example: 'An API client used for the authorization_code, refresh_token, and client_credentials flows' - accessTokenValiditySeconds: - type: integer - format: int32 - description: The number of seconds an access token generated for this API Client is valid for - example: 750 - refreshTokenValiditySeconds: - type: integer - format: int32 - description: The number of seconds a refresh token generated for this API Client is valid for - example: 86400 - redirectUris: - type: array - nullable: true - items: - type: string - description: A list of the approved redirect URIs used with the authorization_code flow - example: - - 'http://localhost:12345' - grantTypes: - type: array - items: - description: OAuth2 Grant Type - type: string - example: CLIENT_CREDENTIALS - enum: - - CLIENT_CREDENTIALS - - AUTHORIZATION_CODE - - REFRESH_TOKEN - description: A list of OAuth 2.0 grant types this API Client can be used with - example: - - AUTHORIZATION_CODE - - CLIENT_CREDENTIALS - - REFRESH_TOKEN - accessType: - description: The access type (online or offline) of this API Client - example: OFFLINE - type: string - enum: - - ONLINE - - OFFLINE - type: - description: The type of the API Client (public or confidential) - example: CONFIDENTIAL - type: string - enum: - - CONFIDENTIAL - - PUBLIC - internal: - type: boolean - description: An indicator of whether the API Client can be used for requests internal to IDN - example: false - enabled: - type: boolean - description: An indicator of whether the API Client is enabled for use - example: true - strongAuthSupported: - type: boolean - description: An indicator of whether the API Client supports strong authentication - example: false - claimsSupported: - type: boolean - description: An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - example: false - created: - type: string - format: date-time - description: 'The date and time, down to the millisecond, when the API Client was created' - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - description: 'The date and time, down to the millisecond, when the API Client was last updated' - example: '2018-06-25T20:22:28.104Z' - lastUsed: - type: string - nullable: true - format: date-time - description: 'The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed.' - example: '2017-07-11T18:45:37.098Z' - scope: - type: array - nullable: true - items: - type: string - default: 'sp:scopes:all' - description: Scopes of the API Client. - example: - - 'demo:api-client-scope:first' - - 'demo:api-client-scope:second' - required: - - id - - businessName - - homepageUrl - - name - - description - - accessTokenValiditySeconds - - refreshTokenValiditySeconds - - redirectUris - - grantTypes - - accessType - - type - - internal - - enabled - - strongAuthSupported - - claimsSupported - - created - - modified - - scope - '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: createOauthClient - security: - - UserContextAuth: - - 'sp:oauth-client:manage' - tags: - - OAuth Clients - summary: Create OAuth Client - description: This creates an OAuth client. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - businessName: - type: string - nullable: true - description: The name of the business the API Client should belong to - example: Acme-Solar - homepageUrl: - type: string - nullable: true - description: The homepage URL associated with the owner of the API Client - example: 'http://localhost:12345' - name: - type: string - nullable: true - description: A human-readable name for the API Client - example: Demo API Client - description: - type: string - nullable: true - description: A description of the API Client - example: 'An API client used for the authorization_code, refresh_token, and client_credentials flows' - accessTokenValiditySeconds: - description: The number of seconds an access token generated for this API Client is valid for - type: integer - format: int32 - example: 750 - refreshTokenValiditySeconds: - description: The number of seconds a refresh token generated for this API Client is valid for - example: 86400 - type: integer - format: int32 - redirectUris: - type: array - nullable: true - items: - type: string - description: A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. - example: - - 'http://localhost:12345' - grantTypes: - type: array - nullable: true - items: - description: OAuth2 Grant Type - type: string - example: CLIENT_CREDENTIALS - enum: - - CLIENT_CREDENTIALS - - AUTHORIZATION_CODE - - REFRESH_TOKEN - description: A list of OAuth 2.0 grant types this API Client can be used with - example: - - AUTHORIZATION_CODE - - CLIENT_CREDENTIALS - - REFRESH_TOKEN - accessType: - description: The access type (online or offline) of this API Client - example: OFFLINE - type: string - enum: - - ONLINE - - OFFLINE - type: - description: The type of the API Client (public or confidential) - example: CONFIDENTIAL - type: string - enum: - - CONFIDENTIAL - - PUBLIC - internal: - type: boolean - description: An indicator of whether the API Client can be used for requests internal within the product. - example: false - enabled: - type: boolean - description: An indicator of whether the API Client is enabled for use - example: true - strongAuthSupported: - type: boolean - description: An indicator of whether the API Client supports strong authentication - example: false - claimsSupported: - type: boolean - description: An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - example: false - scope: - type: array - nullable: true - items: - type: string - default: 'sp:scopes:all' - description: 'Scopes of the API Client. If no scope is specified, the client will be created with the default scope "sp:scopes:all". This means the API Client will have all the rights of the owner who created it.' - example: - - 'demo:api-client-scope:first' - - 'demo:api-client-scope:second' - required: - - name - - description - - accessTokenValiditySeconds - - grantTypes - - accessType - - enabled - responses: - '200': - description: Request succeeded. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: ID of the OAuth client - example: 2c9180835d2e5168015d32f890ca1581 - secret: - type: string - description: Secret of the OAuth client (This field is only returned on the intial create call.) - example: 5c32dd9b21adb51c77794d46e71de117a1d0ddb36a7ff941fa28014ab7de2cf3 - businessName: - type: string - description: The name of the business the API Client should belong to - example: Acme-Solar - homepageUrl: - type: string - description: The homepage URL associated with the owner of the API Client - example: 'http://localhost:12345' - name: - type: string - description: A human-readable name for the API Client - example: Demo API Client - description: - type: string - description: A description of the API Client - example: 'An API client used for the authorization_code, refresh_token, and client_credentials flows' - accessTokenValiditySeconds: - description: The number of seconds an access token generated for this API Client is valid for - example: 750 - type: integer - format: int32 - refreshTokenValiditySeconds: - description: The number of seconds a refresh token generated for this API Client is valid for - example: 86400 - type: integer - format: int32 - redirectUris: - type: array - items: - type: string - description: A list of the approved redirect URIs used with the authorization_code flow - example: - - 'http://localhost:12345' - grantTypes: - type: array - items: - description: OAuth2 Grant Type - type: string - example: CLIENT_CREDENTIALS - enum: - - CLIENT_CREDENTIALS - - AUTHORIZATION_CODE - - REFRESH_TOKEN - description: A list of OAuth 2.0 grant types this API Client can be used with - example: - - AUTHORIZATION_CODE - - CLIENT_CREDENTIALS - - REFRESH_TOKEN - accessType: - description: The access type (online or offline) of this API Client - example: OFFLINE - type: string - enum: - - ONLINE - - OFFLINE - type: - description: The type of the API Client (public or confidential) - example: CONFIDENTIAL - type: string - enum: - - CONFIDENTIAL - - PUBLIC - internal: - type: boolean - description: An indicator of whether the API Client can be used for requests internal to IDN - example: false - enabled: - type: boolean - description: An indicator of whether the API Client is enabled for use - example: true - strongAuthSupported: - type: boolean - description: An indicator of whether the API Client supports strong authentication - example: false - claimsSupported: - type: boolean - description: An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - example: false - created: - type: string - format: date-time - description: 'The date and time, down to the millisecond, when the API Client was created' - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - description: 'The date and time, down to the millisecond, when the API Client was last updated' - example: '2018-06-25T20:22:28.104Z' - scope: - type: array - nullable: true - items: - type: string - default: 'sp:scopes:all' - description: Scopes of the API Client. - example: - - 'demo:api-client-scope:first' - - 'demo:api-client-scope:second' - required: - - id - - secret - - businessName - - homepageUrl - - name - - description - - accessTokenValiditySeconds - - refreshTokenValiditySeconds - - redirectUris - - grantTypes - - accessType - - type - - internal - - enabled - - strongAuthSupported - - claimsSupported - - created - - modified - - scope - '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. - '/oauth-clients/{id}': - get: - operationId: getOauthClient - security: - - UserContextAuth: - - 'sp:oauth-client:manage' - - 'sp:oauth-client:read' - tags: - - OAuth Clients - summary: Get OAuth Client - description: This gets details of an OAuth client. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The OAuth client id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: Request succeeded. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: ID of the OAuth client - example: 2c9180835d2e5168015d32f890ca1581 - businessName: - type: string - nullable: true - description: The name of the business the API Client should belong to - example: Acme-Solar - homepageUrl: - type: string - nullable: true - description: The homepage URL associated with the owner of the API Client - example: 'http://localhost:12345' - name: - type: string - description: A human-readable name for the API Client - example: Demo API Client - description: - type: string - nullable: true - description: A description of the API Client - example: 'An API client used for the authorization_code, refresh_token, and client_credentials flows' - accessTokenValiditySeconds: - type: integer - format: int32 - description: The number of seconds an access token generated for this API Client is valid for - example: 750 - refreshTokenValiditySeconds: - type: integer - format: int32 - description: The number of seconds a refresh token generated for this API Client is valid for - example: 86400 - redirectUris: - type: array - nullable: true - items: - type: string - description: A list of the approved redirect URIs used with the authorization_code flow - example: - - 'http://localhost:12345' - grantTypes: - type: array - items: - description: OAuth2 Grant Type - type: string - example: CLIENT_CREDENTIALS - enum: - - CLIENT_CREDENTIALS - - AUTHORIZATION_CODE - - REFRESH_TOKEN - description: A list of OAuth 2.0 grant types this API Client can be used with - example: - - AUTHORIZATION_CODE - - CLIENT_CREDENTIALS - - REFRESH_TOKEN - accessType: - description: The access type (online or offline) of this API Client - example: OFFLINE - type: string - enum: - - ONLINE - - OFFLINE - type: - description: The type of the API Client (public or confidential) - example: CONFIDENTIAL - type: string - enum: - - CONFIDENTIAL - - PUBLIC - internal: - type: boolean - description: An indicator of whether the API Client can be used for requests internal to IDN - example: false - enabled: - type: boolean - description: An indicator of whether the API Client is enabled for use - example: true - strongAuthSupported: - type: boolean - description: An indicator of whether the API Client supports strong authentication - example: false - claimsSupported: - type: boolean - description: An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - example: false - created: - type: string - format: date-time - description: 'The date and time, down to the millisecond, when the API Client was created' - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - description: 'The date and time, down to the millisecond, when the API Client was last updated' - example: '2018-06-25T20:22:28.104Z' - lastUsed: - type: string - nullable: true - format: date-time - description: 'The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed.' - example: '2017-07-11T18:45:37.098Z' - scope: - type: array - nullable: true - items: - type: string - default: 'sp:scopes:all' - description: Scopes of the API Client. - example: - - 'demo:api-client-scope:first' - - 'demo:api-client-scope:second' - required: - - id - - businessName - - homepageUrl - - name - - description - - accessTokenValiditySeconds - - refreshTokenValiditySeconds - - redirectUris - - grantTypes - - accessType - - type - - internal - - enabled - - strongAuthSupported - - claimsSupported - - created - - modified - - scope - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - delete: - operationId: deleteOauthClient - security: - - UserContextAuth: - - 'sp:oauth-client:manage' - tags: - - OAuth Clients - summary: Delete OAuth Client - description: This deletes an OAuth client. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The OAuth client id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '204': - description: No content. - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - patch: - operationId: patchOauthClient - security: - - UserContextAuth: - - 'sp:oauth-client:manage' - tags: - - OAuth Clients - summary: Patch OAuth Client - description: This performs a targeted update to the field(s) of an OAuth client. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The OAuth client id - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - description: | - A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - The following fields are patchable: - * tenant - * businessName - * homepageUrl - * name - * description - * accessTokenValiditySeconds - * refreshTokenValiditySeconds - * redirectUris - * grantTypes - * accessType - * enabled - * strongAuthSupported - * claimsSupported - content: - application/json-patch+json: - schema: - type: array - items: - type: object - description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' - required: - - op - - path - properties: - op: - type: string - description: The operation to be performed - enum: - - add - - remove - - replace - - move - - copy - - test - example: replace - path: - type: string - description: A string JSON Pointer representing the target path to an element to be affected by the operation - example: /description - value: - anyOf: - - type: string - - type: integer - - type: object - - type: array - items: - anyOf: - - type: string - - type: integer - - type: object - description: 'The value to be used for the operation, required for "add" and "replace" operations' - example: New description - example: - - op: replace - path: /strongAuthSupported - value: true - - op: replace - path: /businessName - value: acme-solar - responses: - '200': - description: 'Indicates the PATCH operation succeeded, and returns the OAuth client''s new representation.' - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: ID of the OAuth client - example: 2c9180835d2e5168015d32f890ca1581 - businessName: - type: string - nullable: true - description: The name of the business the API Client should belong to - example: Acme-Solar - homepageUrl: - type: string - nullable: true - description: The homepage URL associated with the owner of the API Client - example: 'http://localhost:12345' - name: - type: string - description: A human-readable name for the API Client - example: Demo API Client - description: - type: string - nullable: true - description: A description of the API Client - example: 'An API client used for the authorization_code, refresh_token, and client_credentials flows' - accessTokenValiditySeconds: - type: integer - format: int32 - description: The number of seconds an access token generated for this API Client is valid for - example: 750 - refreshTokenValiditySeconds: - type: integer - format: int32 - description: The number of seconds a refresh token generated for this API Client is valid for - example: 86400 - redirectUris: - type: array - nullable: true - items: - type: string - description: A list of the approved redirect URIs used with the authorization_code flow - example: - - 'http://localhost:12345' - grantTypes: - type: array - items: - description: OAuth2 Grant Type - type: string - example: CLIENT_CREDENTIALS - enum: - - CLIENT_CREDENTIALS - - AUTHORIZATION_CODE - - REFRESH_TOKEN - description: A list of OAuth 2.0 grant types this API Client can be used with - example: - - AUTHORIZATION_CODE - - CLIENT_CREDENTIALS - - REFRESH_TOKEN - accessType: - description: The access type (online or offline) of this API Client - example: OFFLINE - type: string - enum: - - ONLINE - - OFFLINE - type: - description: The type of the API Client (public or confidential) - example: CONFIDENTIAL - type: string - enum: - - CONFIDENTIAL - - PUBLIC - internal: - type: boolean - description: An indicator of whether the API Client can be used for requests internal to IDN - example: false - enabled: - type: boolean - description: An indicator of whether the API Client is enabled for use - example: true - strongAuthSupported: - type: boolean - description: An indicator of whether the API Client supports strong authentication - example: false - claimsSupported: - type: boolean - description: An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - example: false - created: - type: string - format: date-time - description: 'The date and time, down to the millisecond, when the API Client was created' - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - description: 'The date and time, down to the millisecond, when the API Client was last updated' - example: '2018-06-25T20:22:28.104Z' - lastUsed: - type: string - nullable: true - format: date-time - description: 'The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed.' - example: '2017-07-11T18:45:37.098Z' - scope: - type: array - nullable: true - items: - type: string - default: 'sp:scopes:all' - description: Scopes of the API Client. - example: - - 'demo:api-client-scope:first' - - 'demo:api-client-scope:second' - required: - - id - - businessName - - homepageUrl - - name - - description - - accessTokenValiditySeconds - - refreshTokenValiditySeconds - - redirectUris - - grantTypes - - accessType - - type - - internal - - enabled - - strongAuthSupported - - claimsSupported - - created - - modified - - scope - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - /password-sync-groups: - get: - operationId: getPasswordSyncGroups - tags: - - Password Sync Groups - summary: Get Password Sync Group List - description: This API returns a list of password sync groups. A token with ORG_ADMIN authority is required to call this API. - security: - - UserContextAuth: - - 'idn:password-sync-group-management:read' - parameters: - - 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 - responses: - '200': - description: A list of password sync groups. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: ID of the sync group - example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - name: - description: Name of the sync group - type: string - example: Password Sync Group 1 - passwordPolicyId: - type: string - description: ID of the password policy - example: 2c91808d744ba0ce01746f93b6204501 - sourceIds: - type: array - description: List of password managed sources IDs - items: - type: string - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - '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: createPasswordSyncGroup - tags: - - Password Sync Groups - summary: Create Password Sync Group - description: This API creates a password sync group based on the specifications provided. A token with ORG_ADMIN authority is required to call this API. - security: - - UserContextAuth: - - 'idn:password-sync-group-management:write' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: ID of the sync group - example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - name: - description: Name of the sync group - type: string - example: Password Sync Group 1 - passwordPolicyId: - type: string - description: ID of the password policy - example: 2c91808d744ba0ce01746f93b6204501 - sourceIds: - type: array - description: List of password managed sources IDs - items: - type: string - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - example: - name: Password Sync Group 2 - passwordPolicyId: 2c91808d744ba0ce01746f93b6204501 - sourceIds: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - responses: - '200': - description: Reference to the password sync group. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: ID of the sync group - example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - name: - description: Name of the sync group - type: string - example: Password Sync Group 1 - passwordPolicyId: - type: string - description: ID of the password policy - example: 2c91808d744ba0ce01746f93b6204501 - sourceIds: - type: array - description: List of password managed sources IDs - items: - type: string - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - example: - id: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - name: Password Sync Group 2 - passwordPolicyId: 2c91808d744ba0ce01746f93b6204501 - sourceIds: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - '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. - '/password-sync-groups/{id}': - get: - operationId: getPasswordSyncGroup - tags: - - Password Sync Groups - summary: Get Password Sync Group by ID - description: This API returns the sync group for the specified ID. A token with ORG_ADMIN authority is required to call this API. - security: - - UserContextAuth: - - 'idn:password-sync-group-management:read' - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The ID of password sync group to retrieve. - example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - responses: - '200': - description: Reference to the password sync group. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: ID of the sync group - example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - name: - description: Name of the sync group - type: string - example: Password Sync Group 1 - passwordPolicyId: - type: string - description: ID of the password policy - example: 2c91808d744ba0ce01746f93b6204501 - sourceIds: - type: array - description: List of password managed sources IDs - items: - type: string - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - example: - id: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - name: Password Sync Group 1 - passwordPolicyId: 2c91808d744ba0ce01746f93b6204501 - sourceIds: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - put: - operationId: updatePasswordSyncGroup - tags: - - Password Sync Groups - summary: Update Password Sync Group by ID - description: This API updates the specified password sync group. A token with ORG_ADMIN authority is required to call this API. - security: - - UserContextAuth: - - 'idn:password-sync-group-management:write' - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The ID of password sync group to update. - example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: ID of the sync group - example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - name: - description: Name of the sync group - type: string - example: Password Sync Group 1 - passwordPolicyId: - type: string - description: ID of the password policy - example: 2c91808d744ba0ce01746f93b6204501 - sourceIds: - type: array - description: List of password managed sources IDs - items: - type: string - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - example: - id: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - name: Password Sync Group 2 - passwordPolicyId: 2c91808d744ba0ce01746f93b6204501 - sourceIds: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - responses: - '200': - description: Reference to the password sync group. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: ID of the sync group - example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - name: - description: Name of the sync group - type: string - example: Password Sync Group 1 - passwordPolicyId: - type: string - description: ID of the password policy - example: 2c91808d744ba0ce01746f93b6204501 - sourceIds: - type: array - description: List of password managed sources IDs - items: - type: string - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - example: - id: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - name: Password Sync Group 2 - passwordPolicyId: 2c91808d744ba0ce01746f93b6204501 - sourceIds: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - delete: - operationId: deletePasswordSyncGroup - tags: - - Password Sync Groups - summary: Delete Password Sync Group by ID - description: This API deletes the specified password sync group. A token with ORG_ADMIN authority is required to call this API. - security: - - UserContextAuth: - - 'idn:password-sync-group-management:write' - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The ID of password sync group to delete. - example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - responses: - '204': - description: No content - indicates the request was successful but there is no content to be returned in the response. - '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. - /personal-access-tokens: - get: - operationId: listPersonalAccessTokens - security: - - UserContextAuth: - - 'sp:my-personal-access-tokens:read' - - 'sp:my-personal-access-tokens:manage' - - 'sp:all-personal-access-tokens:read' - - 'sp:all-personal-access-tokens:manage' - tags: - - Personal Access Tokens - summary: List Personal Access Tokens - description: 'This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the ''idn:all-personal-access-tokens:read'' right.' - parameters: - - in: query - name: owner-id - description: |- - The identity ID of the owner whose personal access tokens should be listed. If "me", the caller should have the following right: 'idn:my-personal-access-tokens:read' - If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. - If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' - required: false - schema: - type: string - default: null - example: 2c9180867b50d088017b554662fb281e - - in: query - name: filters - required: false - schema: - type: string - 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: - - **lastUsed**: *le, isnull* - example: 'lastUsed le 2023-02-05T10:59:27.214Z' - responses: - '200': - description: List of personal access tokens. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: The ID of the personal access token (to be used as the username for Basic Auth). - example: 86f1dc6fe8f54414950454cbb11278fa - name: - type: string - description: The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. - example: NodeJS Integration - scope: - type: array - nullable: true - items: - type: string - default: 'sp:scopes:all' - description: Scopes of the personal access token. - example: - - 'demo:personal-access-token-scope:first' - - 'demo:personal-access-token-scope:second' - owner: - description: Details about the owner of the personal access token. - 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 - - WORKGROUP - 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 - created: - type: string - format: date-time - description: 'The date and time, down to the millisecond, when this personal access token was created.' - example: '2017-07-11T18:45:37.098Z' - lastUsed: - type: string - nullable: true - format: date-time - description: 'The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed.' - example: '2017-07-11T18:45:37.098Z' - required: - - id - - name - - scope - - owner - - created - '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: createPersonalAccessToken - security: - - UserContextAuth: - - 'sp:my-personal-access-tokens:manage' - - 'sp:all-personal-access-tokens:manage' - tags: - - Personal Access Tokens - summary: Create Personal Access Token - description: This creates a personal access token. - requestBody: - description: Name and scope of personal access token. - required: true - content: - application/json: - schema: - type: object - description: Object for specifying the name of a personal access token to create - properties: - name: - type: string - description: The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. - example: NodeJS Integration - scope: - type: array - nullable: true - items: - type: string - default: 'sp:scopes:all' - description: 'Scopes of the personal access token. If no scope is specified, the token will be created with the default scope "sp:scopes:all". This means the personal access token will have all the rights of the owner who created it.' - example: - - 'demo:personal-access-token-scope:first' - - 'demo:personal-access-token-scope:second' - required: - - name - responses: - '200': - description: Created. Note - this is the only time Personal Access Tokens' secret attribute will be displayed. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The ID of the personal access token (to be used as the username for Basic Auth). - example: 86f1dc6fe8f54414950454cbb11278fa - secret: - type: string - description: The secret of the personal access token (to be used as the password for Basic Auth). - example: 1d1bef2b9f426383447f64f69349fc7cac176042578d205c256ba3f37c59adb9 - scope: - type: array - nullable: true - items: - type: string - default: 'sp:scopes:all' - description: Scopes of the personal access token. - example: - - 'demo:personal-access-token-scope:first' - - 'demo:personal-access-token-scope:second' - name: - type: string - description: The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. - example: NodeJS Integration - owner: - description: Details about the owner of the personal access token. - 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 - - WORKGROUP - 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 - created: - type: string - format: date-time - description: 'The date and time, down to the millisecond, when this personal access token was created.' - example: '2017-07-11T18:45:37.098Z' - required: - - id - - secret - - scope - - name - - owner - - created - '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. - '/personal-access-tokens/{id}': - patch: - operationId: patchPersonalAccessToken - security: - - UserContextAuth: - - 'sp:my-personal-access-tokens:manage' - tags: - - Personal Access Tokens - summary: Patch Personal Access Token - description: This performs a targeted update to the field(s) of a Personal Access Token. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The Personal Access Token id - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - description: | - A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - The following fields are patchable: - * name - * scope - content: - application/json-patch+json: - schema: - type: array - items: - type: object - description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' - required: - - op - - path - properties: - op: - type: string - description: The operation to be performed - enum: - - add - - remove - - replace - - move - - copy - - test - example: replace - path: - type: string - description: A string JSON Pointer representing the target path to an element to be affected by the operation - example: /description - value: - anyOf: - - type: string - - type: integer - - type: object - - type: array - items: - anyOf: - - type: string - - type: integer - - type: object - description: 'The value to be used for the operation, required for "add" and "replace" operations' - example: New description - example: - - op: replace - path: /name - value: New name - - op: replace - path: /scope - value: - - 'sp:scopes:all' - responses: - '200': - description: 'Indicates the PATCH operation succeeded, and returns the PAT''s new representation.' - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The ID of the personal access token (to be used as the username for Basic Auth). - example: 86f1dc6fe8f54414950454cbb11278fa - name: - type: string - description: The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. - example: NodeJS Integration - scope: - type: array - nullable: true - items: - type: string - default: 'sp:scopes:all' - description: Scopes of the personal access token. - example: - - 'demo:personal-access-token-scope:first' - - 'demo:personal-access-token-scope:second' - owner: - description: Details about the owner of the personal access token. - 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 - - WORKGROUP - 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 - created: - type: string - format: date-time - description: 'The date and time, down to the millisecond, when this personal access token was created.' - example: '2017-07-11T18:45:37.098Z' - lastUsed: - type: string - nullable: true - format: date-time - description: 'The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed.' - example: '2017-07-11T18:45:37.098Z' - required: - - id - - name - - scope - - owner - - created - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - delete: - operationId: deletePersonalAccessToken - security: - - UserContextAuth: - - 'sp:my-personal-access-tokens:manage' - - 'sp:all-personal-access-tokens:manage' - tags: - - Personal Access Tokens - summary: Delete Personal Access Token - description: This deletes a personal access token. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The personal access token id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '204': - description: No content. - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - /public-identities: - get: - operationId: getPublicIdentities - tags: - - Public Identities - summary: Get a list of public identities - parameters: - - 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* - - **alias**: *eq, sw* - - **email**: *eq, sw* - - **firstname**: *eq, sw* - - **lastname**: *eq, sw* - example: firstname eq "John" - - in: query - name: add-core-filters - description: |- - If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - - Should be either correlated or protected. - - Should not be "spadmin" or "cloudadmin". - - uid should not be null. - - lastname should not be null. - - email should not be null. - required: false - example: false - schema: - type: boolean - default: false - - 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** - example: name - responses: - '200': - description: A list of public identity objects. - content: - application/json: - schema: - type: array - items: - type: object - title: Public Identity - description: Details about a public identity - properties: - id: - type: string - description: Identity id - example: 2c9180857182305e0171993735622948 - name: - type: string - description: Human-readable display name of identity. - example: Alison Ferguso - alias: - type: string - description: Alternate unique identifier for the identity. - example: alison.ferguso - email: - nullable: true - type: string - description: Email address of identity. - example: alison.ferguso@acme-solar.com - status: - nullable: true - type: string - description: The lifecycle status for the identity - example: Active - manager: - description: An identity reference to the manager of this identity - type: object - nullable: true - properties: - type: - example: IDENTITY - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: Human-readable display name of identity. - example: Thomas Edison - attributes: - type: array - description: The public identity attributes of the identity - items: - type: object - properties: - key: - type: string - description: The attribute key - example: country - name: - type: string - description: Human-readable display name of the attribute - example: Country - value: - type: string - description: The attribute value - example: US - example: - - id: 2c9180857182305e0171993735622948 - name: Alison Ferguso - alias: alison.ferguso - email: alison.ferguso@acme-solar.com - status: Active - manager: - type: IDENTITY - id: 2c9180a46faadee4016fb4e018c20639 - name: Thomas Edison - attributes: - - key: phone - name: Phone - value: '5125551234' - - key: country - name: Country - value: US - - id: 2c9180a46faadee4016fb4e018c20639 - name: Thomas Edison - alias: thomas.edison - email: thomas.edison@acme-solar.com - status: Active - manager: - type: IDENTITY - id: 2c918086676d3e0601677611dbde220f - name: Mister Manager - attributes: - - key: phone - name: Phone - value: '5125554321' - - key: country - name: Country - value: US - '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. - /public-identities-config: - get: - operationId: getPublicIdentityConfig - tags: - - Public Identities Config - summary: Get the Public Identities Configuration - description: Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. A token with ORG ADMIN authority is required to call this API. - responses: - '200': - description: Request succeeded. - content: - application/json: - schema: - type: object - description: Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org. - properties: - attributes: - type: array - description: Up to 5 identity attributes that will be available to everyone in the org for all users in the org. - items: - type: object - description: Used to map an attribute key for an Identity to its display name. - properties: - key: - type: string - description: The attribute key - example: country - name: - type: string - description: The attribute display name - example: Country - modified: - nullable: true - type: string - description: When this configuration was last modified. - format: date-time - example: '2018-06-25T20:22:28.104Z' - modifiedBy: - description: The identity who last modified this configuration. - type: object - nullable: true - properties: - type: - example: IDENTITY - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: Human-readable display name of identity. - example: Thomas Edison - '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. - put: - operationId: updatePublicIdentityConfig - tags: - - Public Identities Config - summary: Update the Public Identities Configuration - description: Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. A token with ORG ADMIN authority is required to call this API. - requestBody: - required: true - content: - application/json: - schema: - type: object - description: Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org. - properties: - attributes: - type: array - description: Up to 5 identity attributes that will be available to everyone in the org for all users in the org. - items: - type: object - description: Used to map an attribute key for an Identity to its display name. - properties: - key: - type: string - description: The attribute key - example: country - name: - type: string - description: The attribute display name - example: Country - modified: - nullable: true - type: string - description: When this configuration was last modified. - format: date-time - example: '2018-06-25T20:22:28.104Z' - modifiedBy: - description: The identity who last modified this configuration. - type: object - nullable: true - properties: - type: - example: IDENTITY - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: Human-readable display name of identity. - example: Thomas Edison - responses: - '200': - description: Request succeeded. - content: - application/json: - schema: - type: object - description: Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org. - properties: - attributes: - type: array - description: Up to 5 identity attributes that will be available to everyone in the org for all users in the org. - items: - type: object - description: Used to map an attribute key for an Identity to its display name. - properties: - key: - type: string - description: The attribute key - example: country - name: - type: string - description: The attribute display name - example: Country - modified: - nullable: true - type: string - description: When this configuration was last modified. - format: date-time - example: '2018-06-25T20:22:28.104Z' - modifiedBy: - description: The identity who last modified this configuration. - type: object - nullable: true - properties: - type: - example: IDENTITY - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: Human-readable display name of identity. - example: Thomas Edison - '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. - /requestable-objects: - get: - operationId: listRequestableObjects - tags: - - Requestable Objects - summary: Requestable Objects List - description: |- - This endpoint returns a list of acccess items that that can be requested through the Access Request endpoints. Access items are marked with AVAILABLE, PENDING or ASSIGNED with respect to the identity provided using *identity-id* query param. - Any authenticated token can call this endpoint to see their requestable access items. A token with ORG_ADMIN authority is required to call this endpoint to return a list of all of the requestable access items for the org or for another identity. - parameters: - - in: query - name: identity-id - required: false - schema: - type: string - example: e7eab60924f64aa284175b9fa3309599 - description: |- - If present, the value returns only requestable objects for the specified identity. - * Admin users can call this with any identity ID value. - * Non-admin users can only specify *me* or pass their own identity ID value. - * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. - - in: query - name: types - description: 'Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice.' - required: false - schema: - type: array - items: - type: string - enum: - - ACCESS_PROFILE - - ROLE - description: 'The currently supported requestable object types. ' - example: ACCESS_PROFILE - example: 'ROLE,ACCESS_PROFILE' - explode: false - - in: query - name: term - required: false - schema: - type: string - example: Finance Role - description: 'It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored.' - - in: query - name: statuses - description: 'Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice.' - required: false - schema: - type: array - items: - type: string - enum: - - AVAILABLE - - PENDING - - ASSIGNED - description: 'Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results.' - example: AVAILABLE - explode: false - example: - - ASSIGNED - - PENDING - - 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 - example: name sw "bob" - 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, in, sw* - required: false - - in: query - name: sorters - schema: - type: string - format: comma-separated - required: false - example: name - 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** - responses: - '200': - description: List of requestable objects - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: Id of the requestable object itself - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: Human-readable display name of the requestable object - example: Applied Research Access - created: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - description: The time when the requestable object was created - modified: - nullable: true - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: The time when the requestable object was last modified - description: - type: string - description: Description of the requestable object. - example: 'Access to research information, lab results, and schematics.' - type: - type: string - enum: - - ACCESS_PROFILE - - ROLE - description: 'The currently supported requestable object types. ' - example: ACCESS_PROFILE - requestStatus: - type: string - enum: - - AVAILABLE - - PENDING - - ASSIGNED - description: 'Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results.' - example: AVAILABLE - identityRequestId: - type: string - description: 'If *requestStatus* is *PENDING*, indicates the id of the associated account activity.' - nullable: true - example: null - ownerRef: - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - requestCommentsRequired: - type: boolean - description: Whether the requester must provide comments when requesting the object. - example: 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. - /roles: - get: - operationId: listRoles - tags: - - Roles - summary: List Roles - description: |- - This API returns a list of Roles. - - A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - parameters: - - in: query - name: for-subadmin - schema: - type: string - description: 'If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity''s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.' - example: 5168015d32f890ca15812c9180835d2e - required: false - - in: query - name: limit - description: |- - Note that for this API the maximum value for limit is 50. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 50 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 50 - default: 50 - - 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 - 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* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* - example: requestable eq false - required: false - - in: query - name: sorters - schema: - type: string - format: comma-separated - 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, modified**' - example: 'name,-modified' - required: false - - in: query - name: for-segment-ids - schema: - type: string - format: comma-separated - description: |- - If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. - - If segmentation is currently unavailable, specifying this parameter results in an error. - example: '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' - required: false - - in: query - name: include-unsegmented - schema: - type: boolean - default: true - description: 'Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.' - example: false - required: false - responses: - '200': - description: List of Roles - content: - application/json: - schema: - type: array - items: - type: object - description: A Role - properties: - id: - type: string - description: 'The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result.' - example: 2c918086749d78830174a1a40e121518 - name: - type: string - description: The human-readable display name of the Role - maxLength: 128 - example: Role 2567 - created: - type: string - description: Date the Role was created - format: date-time - example: '2021-03-01T22:32:58.104Z' - readOnly: true - modified: - type: string - description: Date the Role was last modified. - format: date-time - example: '2021-03-02T20:22:28.104Z' - readOnly: true - description: - type: string - nullable: true - description: A human-readable description of the Role - example: Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor. - owner: - type: object - nullable: true - description: The owner of this object. - properties: - type: - description: 'Owner type. This field must be either left null or set to ''IDENTITY'' on input, otherwise a 400 Bad Request error will result.' - example: IDENTITY - 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 - - WORKGROUP - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: 'Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner''s display name, otherwise a 400 Bad Request error will result.' - example: support - accessProfiles: - type: array - items: - type: object - properties: - id: - type: string - description: ID of the Access Profile - example: ff808081751e6e129f1518161919ecca - type: - type: string - description: 'Type of requested object. This field must be either left null or set to ''ACCESS_PROFILE'' when creating an Access Profile, otherwise a 400 Bad Request error will result.' - enum: - - ACCESS_PROFILE - example: ACCESS_PROFILE - name: - type: string - description: Human-readable display name of the Access Profile. This field is ignored on input. - example: Access Profile 2567 - nullable: true - membership: - nullable: true - type: object - description: 'When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities.' - properties: - type: - type: string - enum: - - STANDARD - - IDENTITY_LIST - description: |- - This enum characterizes the type of a Role's membership selector. Only the following two are fully supported: - - STANDARD: Indicates that Role membership is defined in terms of a criteria expression - - IDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed - example: IDENTITY_LIST - criteria: - nullable: true - type: object - description: Defines STANDARD type Role membership - properties: - operation: - type: string - enum: - - EQUALS - - NOT_EQUALS - - CONTAINS - - STARTS_WITH - - ENDS_WITH - - AND - - OR - description: An operation - example: EQUALS - key: - type: object - nullable: true - description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' - properties: - type: - type: string - enum: - - IDENTITY - - ACCOUNT - - ENTITLEMENT - description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' - example: ACCOUNT - property: - type: string - description: The name of the attribute or entitlement to which the associated criteria applies. - example: attribute.email - sourceId: - type: string - nullable: true - description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT - example: 2c9180867427f3a301745aec18211519 - required: - - type - - property - stringValue: - type: string - nullable: true - description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' - example: carlee.cert1c9f9b6fd@mailinator.com - children: - type: array - items: - type: object - nullable: true - description: Defines STANDARD type Role membership - properties: - operation: - type: string - enum: - - EQUALS - - NOT_EQUALS - - CONTAINS - - STARTS_WITH - - ENDS_WITH - - AND - - OR - description: An operation - example: EQUALS - key: - type: object - nullable: true - description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' - properties: - type: - type: string - enum: - - IDENTITY - - ACCOUNT - - ENTITLEMENT - description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' - example: ACCOUNT - property: - type: string - description: The name of the attribute or entitlement to which the associated criteria applies. - example: attribute.email - sourceId: - type: string - nullable: true - description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT - example: 2c9180867427f3a301745aec18211519 - required: - - type - - property - stringValue: - type: string - nullable: true - description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' - example: carlee.cert1c9f9b6fd@mailinator.com - children: - type: array - items: - type: object - description: Defines STANDARD type Role membership - properties: - operation: - type: string - enum: - - EQUALS - - NOT_EQUALS - - CONTAINS - - STARTS_WITH - - ENDS_WITH - - AND - - OR - description: An operation - example: EQUALS - key: - type: object - nullable: true - description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' - properties: - type: - type: string - enum: - - IDENTITY - - ACCOUNT - - ENTITLEMENT - description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' - example: ACCOUNT - property: - type: string - description: The name of the attribute or entitlement to which the associated criteria applies. - example: attribute.email - sourceId: - type: string - nullable: true - description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT - example: 2c9180867427f3a301745aec18211519 - required: - - type - - property - stringValue: - type: string - description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' - example: carlee.cert1c9f9b6fd@mailinator.com - nullable: true - description: 'Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.' - nullable: true - description: 'Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.' - identities: - type: array - items: - type: object - description: A reference to an Identity in an IDENTITY_LIST role membership criteria. - properties: - type: - nullable: true - example: IDENTITY - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - nullable: true - description: Human-readable display name of the Identity. - example: Thomas Edison - aliasName: - type: string - nullable: true - description: User name of the Identity - example: t.edison - nullable: true - description: 'Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST.' - legacyMembershipInfo: - type: object - nullable: true - description: 'This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.' - example: - type: IDENTITY_LIST - additionalProperties: true - enabled: - type: boolean - description: Whether the Role is enabled or not. - example: true - default: false - requestable: - type: boolean - description: Whether the Role can be the target of access requests. - example: true - default: false - accessRequestConfig: - nullable: true - description: Access request configuration for this object - type: object - properties: - commentsRequired: - type: boolean - description: Whether the requester of the containing object must provide comments justifying the request - example: true - nullable: true - default: false - denialCommentsRequired: - type: boolean - description: Whether an approver must provide comments when denying the request - example: true - nullable: true - default: false - approvalSchemes: - type: array - description: List describing the steps in approving the request - items: - type: object - properties: - approverType: - type: string - enum: - - OWNER - - MANAGER - - GOVERNANCE_GROUP - description: |- - Describes the individual or group that is responsible for an approval step. Values are as follows. - - **OWNER**: Owner of the associated Role - - **MANAGER**: Manager of the Identity making the request - - **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field - example: GOVERNANCE_GROUP - approverId: - type: string - nullable: true - description: 'Id of the specific approver, used only when approverType is GOVERNANCE_GROUP' - example: 46c79819-a69f-49a2-becb-12c971ae66c6 - revocationRequestConfig: - nullable: true - default: null - description: Revocation request configuration for this object. - type: object - properties: - commentsRequired: - type: boolean - description: Whether the requester of the containing object must provide comments justifying the request - example: false - nullable: true - default: false - denialCommentsRequired: - type: boolean - description: Whether an approver must provide comments when denying the request - example: false - nullable: true - default: false - approvalSchemes: - type: array - description: List describing the steps in approving the revocation request - items: - type: object - properties: - approverType: - type: string - enum: - - APP_OWNER - - OWNER - - SOURCE_OWNER - - MANAGER - - GOVERNANCE_GROUP - description: |- - Describes the individual or group that is responsible for an approval step. Values are as follows. - **APP_OWNER**: The owner of the Application - - **OWNER**: Owner of the associated Access Profile or Role - - **SOURCE_OWNER**: Owner of the Source associated with an Access Profile - - **MANAGER**: Manager of the Identity making the request - - **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field - example: GOVERNANCE_GROUP - approverId: - type: string - nullable: true - description: 'Id of the specific approver, used only when approverType is GOVERNANCE_GROUP' - example: 46c79819-a69f-49a2-becb-12c971ae66c6 - segments: - type: array - items: - type: string - nullable: true - description: 'List of IDs of segments, if any, to which this Role is assigned.' - example: - - f7b1b8a3-5fed-4fd4-ad29-82014e137e19 - - 29cb6c06-1da8-43ea-8be4-b3125f248f2a - required: - - name - - owner - '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. - security: - - UserContextAuth: - - 'idn:role-unchecked:read' - - 'idn:role-unchecked:manage' - - 'idn:role-checked:manage' - - 'idn:role-checked:read' - post: - operationId: createRole - tags: - - Roles - summary: Create a Role - description: |- - This API creates a role. - You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. - In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. - The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - requestBody: - required: true - content: - application/json: - schema: - type: object - description: A Role - properties: - id: - type: string - description: 'The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result.' - example: 2c918086749d78830174a1a40e121518 - name: - type: string - description: The human-readable display name of the Role - maxLength: 128 - example: Role 2567 - created: - type: string - description: Date the Role was created - format: date-time - example: '2021-03-01T22:32:58.104Z' - readOnly: true - modified: - type: string - description: Date the Role was last modified. - format: date-time - example: '2021-03-02T20:22:28.104Z' - readOnly: true - description: - type: string - nullable: true - description: A human-readable description of the Role - example: Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor. - owner: - type: object - nullable: true - description: The owner of this object. - properties: - type: - description: 'Owner type. This field must be either left null or set to ''IDENTITY'' on input, otherwise a 400 Bad Request error will result.' - example: IDENTITY - 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 - - WORKGROUP - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: 'Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner''s display name, otherwise a 400 Bad Request error will result.' - example: support - accessProfiles: - type: array - items: - type: object - properties: - id: - type: string - description: ID of the Access Profile - example: ff808081751e6e129f1518161919ecca - type: - type: string - description: 'Type of requested object. This field must be either left null or set to ''ACCESS_PROFILE'' when creating an Access Profile, otherwise a 400 Bad Request error will result.' - enum: - - ACCESS_PROFILE - example: ACCESS_PROFILE - name: - type: string - description: Human-readable display name of the Access Profile. This field is ignored on input. - example: Access Profile 2567 - nullable: true - membership: - nullable: true - type: object - description: 'When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities.' - properties: - type: - type: string - enum: - - STANDARD - - IDENTITY_LIST - description: |- - This enum characterizes the type of a Role's membership selector. Only the following two are fully supported: - - STANDARD: Indicates that Role membership is defined in terms of a criteria expression - - IDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed - example: IDENTITY_LIST - criteria: - nullable: true - type: object - description: Defines STANDARD type Role membership - properties: - operation: - type: string - enum: - - EQUALS - - NOT_EQUALS - - CONTAINS - - STARTS_WITH - - ENDS_WITH - - AND - - OR - description: An operation - example: EQUALS - key: - type: object - nullable: true - description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' - properties: - type: - type: string - enum: - - IDENTITY - - ACCOUNT - - ENTITLEMENT - description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' - example: ACCOUNT - property: - type: string - description: The name of the attribute or entitlement to which the associated criteria applies. - example: attribute.email - sourceId: - type: string - nullable: true - description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT - example: 2c9180867427f3a301745aec18211519 - required: - - type - - property - stringValue: - type: string - nullable: true - description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' - example: carlee.cert1c9f9b6fd@mailinator.com - children: - type: array - items: - type: object - nullable: true - description: Defines STANDARD type Role membership - properties: - operation: - type: string - enum: - - EQUALS - - NOT_EQUALS - - CONTAINS - - STARTS_WITH - - ENDS_WITH - - AND - - OR - description: An operation - example: EQUALS - key: - type: object - nullable: true - description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' - properties: - type: - type: string - enum: - - IDENTITY - - ACCOUNT - - ENTITLEMENT - description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' - example: ACCOUNT - property: - type: string - description: The name of the attribute or entitlement to which the associated criteria applies. - example: attribute.email - sourceId: - type: string - nullable: true - description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT - example: 2c9180867427f3a301745aec18211519 - required: - - type - - property - stringValue: - type: string - nullable: true - description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' - example: carlee.cert1c9f9b6fd@mailinator.com - children: - type: array - items: - type: object - description: Defines STANDARD type Role membership - properties: - operation: - type: string - enum: - - EQUALS - - NOT_EQUALS - - CONTAINS - - STARTS_WITH - - ENDS_WITH - - AND - - OR - description: An operation - example: EQUALS - key: - type: object - nullable: true - description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' - properties: - type: - type: string - enum: - - IDENTITY - - ACCOUNT - - ENTITLEMENT - description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' - example: ACCOUNT - property: - type: string - description: The name of the attribute or entitlement to which the associated criteria applies. - example: attribute.email - sourceId: - type: string - nullable: true - description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT - example: 2c9180867427f3a301745aec18211519 - required: - - type - - property - stringValue: - type: string - description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' - example: carlee.cert1c9f9b6fd@mailinator.com - nullable: true - description: 'Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.' - nullable: true - description: 'Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.' - identities: - type: array - items: - type: object - description: A reference to an Identity in an IDENTITY_LIST role membership criteria. - properties: - type: - nullable: true - example: IDENTITY - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - nullable: true - description: Human-readable display name of the Identity. - example: Thomas Edison - aliasName: - type: string - nullable: true - description: User name of the Identity - example: t.edison - nullable: true - description: 'Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST.' - legacyMembershipInfo: - type: object - nullable: true - description: 'This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.' - example: - type: IDENTITY_LIST - additionalProperties: true - enabled: - type: boolean - description: Whether the Role is enabled or not. - example: true - default: false - requestable: - type: boolean - description: Whether the Role can be the target of access requests. - example: true - default: false - accessRequestConfig: - nullable: true - description: Access request configuration for this object - type: object - properties: - commentsRequired: - type: boolean - description: Whether the requester of the containing object must provide comments justifying the request - example: true - nullable: true - default: false - denialCommentsRequired: - type: boolean - description: Whether an approver must provide comments when denying the request - example: true - nullable: true - default: false - approvalSchemes: - type: array - description: List describing the steps in approving the request - items: - type: object - properties: - approverType: - type: string - enum: - - OWNER - - MANAGER - - GOVERNANCE_GROUP - description: |- - Describes the individual or group that is responsible for an approval step. Values are as follows. - - **OWNER**: Owner of the associated Role - - **MANAGER**: Manager of the Identity making the request - - **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field - example: GOVERNANCE_GROUP - approverId: - type: string - nullable: true - description: 'Id of the specific approver, used only when approverType is GOVERNANCE_GROUP' - example: 46c79819-a69f-49a2-becb-12c971ae66c6 - revocationRequestConfig: - nullable: true - default: null - description: Revocation request configuration for this object. - type: object - properties: - commentsRequired: - type: boolean - description: Whether the requester of the containing object must provide comments justifying the request - example: false - nullable: true - default: false - denialCommentsRequired: - type: boolean - description: Whether an approver must provide comments when denying the request - example: false - nullable: true - default: false - approvalSchemes: - type: array - description: List describing the steps in approving the revocation request - items: - type: object - properties: - approverType: - type: string - enum: - - APP_OWNER - - OWNER - - SOURCE_OWNER - - MANAGER - - GOVERNANCE_GROUP - description: |- - Describes the individual or group that is responsible for an approval step. Values are as follows. - **APP_OWNER**: The owner of the Application - - **OWNER**: Owner of the associated Access Profile or Role - - **SOURCE_OWNER**: Owner of the Source associated with an Access Profile - - **MANAGER**: Manager of the Identity making the request - - **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field - example: GOVERNANCE_GROUP - approverId: - type: string - nullable: true - description: 'Id of the specific approver, used only when approverType is GOVERNANCE_GROUP' - example: 46c79819-a69f-49a2-becb-12c971ae66c6 - segments: - type: array - items: - type: string - nullable: true - description: 'List of IDs of segments, if any, to which this Role is assigned.' - example: - - f7b1b8a3-5fed-4fd4-ad29-82014e137e19 - - 29cb6c06-1da8-43ea-8be4-b3125f248f2a - required: - - name - - owner - responses: - '201': - description: Role created - content: - application/json: - schema: - type: object - description: A Role - properties: - id: - type: string - description: 'The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result.' - example: 2c918086749d78830174a1a40e121518 - name: - type: string - description: The human-readable display name of the Role - maxLength: 128 - example: Role 2567 - created: - type: string - description: Date the Role was created - format: date-time - example: '2021-03-01T22:32:58.104Z' - readOnly: true - modified: - type: string - description: Date the Role was last modified. - format: date-time - example: '2021-03-02T20:22:28.104Z' - readOnly: true - description: - type: string - nullable: true - description: A human-readable description of the Role - example: Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor. - owner: - type: object - nullable: true - description: The owner of this object. - properties: - type: - description: 'Owner type. This field must be either left null or set to ''IDENTITY'' on input, otherwise a 400 Bad Request error will result.' - example: IDENTITY - 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 - - WORKGROUP - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: 'Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner''s display name, otherwise a 400 Bad Request error will result.' - example: support - accessProfiles: - type: array - items: - type: object - properties: - id: - type: string - description: ID of the Access Profile - example: ff808081751e6e129f1518161919ecca - type: - type: string - description: 'Type of requested object. This field must be either left null or set to ''ACCESS_PROFILE'' when creating an Access Profile, otherwise a 400 Bad Request error will result.' - enum: - - ACCESS_PROFILE - example: ACCESS_PROFILE - name: - type: string - description: Human-readable display name of the Access Profile. This field is ignored on input. - example: Access Profile 2567 - nullable: true - membership: - nullable: true - type: object - description: 'When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities.' - properties: - type: - type: string - enum: - - STANDARD - - IDENTITY_LIST - description: |- - This enum characterizes the type of a Role's membership selector. Only the following two are fully supported: - - STANDARD: Indicates that Role membership is defined in terms of a criteria expression - - IDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed - example: IDENTITY_LIST - criteria: - nullable: true - type: object - description: Defines STANDARD type Role membership - properties: - operation: - type: string - enum: - - EQUALS - - NOT_EQUALS - - CONTAINS - - STARTS_WITH - - ENDS_WITH - - AND - - OR - description: An operation - example: EQUALS - key: - type: object - nullable: true - description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' - properties: - type: - type: string - enum: - - IDENTITY - - ACCOUNT - - ENTITLEMENT - description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' - example: ACCOUNT - property: - type: string - description: The name of the attribute or entitlement to which the associated criteria applies. - example: attribute.email - sourceId: - type: string - nullable: true - description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT - example: 2c9180867427f3a301745aec18211519 - required: - - type - - property - stringValue: - type: string - nullable: true - description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' - example: carlee.cert1c9f9b6fd@mailinator.com - children: - type: array - items: - type: object - nullable: true - description: Defines STANDARD type Role membership - properties: - operation: - type: string - enum: - - EQUALS - - NOT_EQUALS - - CONTAINS - - STARTS_WITH - - ENDS_WITH - - AND - - OR - description: An operation - example: EQUALS - key: - type: object - nullable: true - description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' - properties: - type: - type: string - enum: - - IDENTITY - - ACCOUNT - - ENTITLEMENT - description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' - example: ACCOUNT - property: - type: string - description: The name of the attribute or entitlement to which the associated criteria applies. - example: attribute.email - sourceId: - type: string - nullable: true - description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT - example: 2c9180867427f3a301745aec18211519 - required: - - type - - property - stringValue: - type: string - nullable: true - description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' - example: carlee.cert1c9f9b6fd@mailinator.com - children: - type: array - items: - type: object - description: Defines STANDARD type Role membership - properties: - operation: - type: string - enum: - - EQUALS - - NOT_EQUALS - - CONTAINS - - STARTS_WITH - - ENDS_WITH - - AND - - OR - description: An operation - example: EQUALS - key: - type: object - nullable: true - description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' - properties: - type: - type: string - enum: - - IDENTITY - - ACCOUNT - - ENTITLEMENT - description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' - example: ACCOUNT - property: - type: string - description: The name of the attribute or entitlement to which the associated criteria applies. - example: attribute.email - sourceId: - type: string - nullable: true - description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT - example: 2c9180867427f3a301745aec18211519 - required: - - type - - property - stringValue: - type: string - description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' - example: carlee.cert1c9f9b6fd@mailinator.com - nullable: true - description: 'Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.' - nullable: true - description: 'Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.' - identities: - type: array - items: - type: object - description: A reference to an Identity in an IDENTITY_LIST role membership criteria. - properties: - type: - nullable: true - example: IDENTITY - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - nullable: true - description: Human-readable display name of the Identity. - example: Thomas Edison - aliasName: - type: string - nullable: true - description: User name of the Identity - example: t.edison - nullable: true - description: 'Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST.' - legacyMembershipInfo: - type: object - nullable: true - description: 'This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.' - example: - type: IDENTITY_LIST - additionalProperties: true - enabled: - type: boolean - description: Whether the Role is enabled or not. - example: true - default: false - requestable: - type: boolean - description: Whether the Role can be the target of access requests. - example: true - default: false - accessRequestConfig: - nullable: true - description: Access request configuration for this object - type: object - properties: - commentsRequired: - type: boolean - description: Whether the requester of the containing object must provide comments justifying the request - example: true - nullable: true - default: false - denialCommentsRequired: - type: boolean - description: Whether an approver must provide comments when denying the request - example: true - nullable: true - default: false - approvalSchemes: - type: array - description: List describing the steps in approving the request - items: - type: object - properties: - approverType: - type: string - enum: - - OWNER - - MANAGER - - GOVERNANCE_GROUP - description: |- - Describes the individual or group that is responsible for an approval step. Values are as follows. - - **OWNER**: Owner of the associated Role - - **MANAGER**: Manager of the Identity making the request - - **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field - example: GOVERNANCE_GROUP - approverId: - type: string - nullable: true - description: 'Id of the specific approver, used only when approverType is GOVERNANCE_GROUP' - example: 46c79819-a69f-49a2-becb-12c971ae66c6 - revocationRequestConfig: - nullable: true - default: null - description: Revocation request configuration for this object. - type: object - properties: - commentsRequired: - type: boolean - description: Whether the requester of the containing object must provide comments justifying the request - example: false - nullable: true - default: false - denialCommentsRequired: - type: boolean - description: Whether an approver must provide comments when denying the request - example: false - nullable: true - default: false - approvalSchemes: - type: array - description: List describing the steps in approving the revocation request - items: - type: object - properties: - approverType: - type: string - enum: - - APP_OWNER - - OWNER - - SOURCE_OWNER - - MANAGER - - GOVERNANCE_GROUP - description: |- - Describes the individual or group that is responsible for an approval step. Values are as follows. - **APP_OWNER**: The owner of the Application - - **OWNER**: Owner of the associated Access Profile or Role - - **SOURCE_OWNER**: Owner of the Source associated with an Access Profile - - **MANAGER**: Manager of the Identity making the request - - **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field - example: GOVERNANCE_GROUP - approverId: - type: string - nullable: true - description: 'Id of the specific approver, used only when approverType is GOVERNANCE_GROUP' - example: 46c79819-a69f-49a2-becb-12c971ae66c6 - segments: - type: array - items: - type: string - nullable: true - description: 'List of IDs of segments, if any, to which this Role is assigned.' - example: - - f7b1b8a3-5fed-4fd4-ad29-82014e137e19 - - 29cb6c06-1da8-43ea-8be4-b3125f248f2a - required: - - name - - owner - '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. - security: - - UserContextAuth: - - 'idn:role-unchecked:manage' - - 'idn:role-checked:manage' - '/roles/{id}': - get: - operationId: getRole - tags: - - Roles - summary: Get a Role - description: |- - This API returns a Role by its ID. - - A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - parameters: - - in: path - name: id - required: true - schema: - type: string - description: ID of the Role - example: 2c91808a7813090a017814121e121518 - responses: - '200': - description: List of all Roles - content: - application/json: - schema: - type: object - description: A Role - properties: - id: - type: string - description: 'The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result.' - example: 2c918086749d78830174a1a40e121518 - name: - type: string - description: The human-readable display name of the Role - maxLength: 128 - example: Role 2567 - created: - type: string - description: Date the Role was created - format: date-time - example: '2021-03-01T22:32:58.104Z' - readOnly: true - modified: - type: string - description: Date the Role was last modified. - format: date-time - example: '2021-03-02T20:22:28.104Z' - readOnly: true - description: - type: string - nullable: true - description: A human-readable description of the Role - example: Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor. - owner: - type: object - nullable: true - description: The owner of this object. - properties: - type: - description: 'Owner type. This field must be either left null or set to ''IDENTITY'' on input, otherwise a 400 Bad Request error will result.' - example: IDENTITY - 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 - - WORKGROUP - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: 'Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner''s display name, otherwise a 400 Bad Request error will result.' - example: support - accessProfiles: - type: array - items: - type: object - properties: - id: - type: string - description: ID of the Access Profile - example: ff808081751e6e129f1518161919ecca - type: - type: string - description: 'Type of requested object. This field must be either left null or set to ''ACCESS_PROFILE'' when creating an Access Profile, otherwise a 400 Bad Request error will result.' - enum: - - ACCESS_PROFILE - example: ACCESS_PROFILE - name: - type: string - description: Human-readable display name of the Access Profile. This field is ignored on input. - example: Access Profile 2567 - nullable: true - membership: - nullable: true - type: object - description: 'When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities.' - properties: - type: - type: string - enum: - - STANDARD - - IDENTITY_LIST - description: |- - This enum characterizes the type of a Role's membership selector. Only the following two are fully supported: - - STANDARD: Indicates that Role membership is defined in terms of a criteria expression - - IDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed - example: IDENTITY_LIST - criteria: - nullable: true - type: object - description: Defines STANDARD type Role membership - properties: - operation: - type: string - enum: - - EQUALS - - NOT_EQUALS - - CONTAINS - - STARTS_WITH - - ENDS_WITH - - AND - - OR - description: An operation - example: EQUALS - key: - type: object - nullable: true - description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' - properties: - type: - type: string - enum: - - IDENTITY - - ACCOUNT - - ENTITLEMENT - description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' - example: ACCOUNT - property: - type: string - description: The name of the attribute or entitlement to which the associated criteria applies. - example: attribute.email - sourceId: - type: string - nullable: true - description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT - example: 2c9180867427f3a301745aec18211519 - required: - - type - - property - stringValue: - type: string - nullable: true - description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' - example: carlee.cert1c9f9b6fd@mailinator.com - children: - type: array - items: - type: object - nullable: true - description: Defines STANDARD type Role membership - properties: - operation: - type: string - enum: - - EQUALS - - NOT_EQUALS - - CONTAINS - - STARTS_WITH - - ENDS_WITH - - AND - - OR - description: An operation - example: EQUALS - key: - type: object - nullable: true - description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' - properties: - type: - type: string - enum: - - IDENTITY - - ACCOUNT - - ENTITLEMENT - description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' - example: ACCOUNT - property: - type: string - description: The name of the attribute or entitlement to which the associated criteria applies. - example: attribute.email - sourceId: - type: string - nullable: true - description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT - example: 2c9180867427f3a301745aec18211519 - required: - - type - - property - stringValue: - type: string - nullable: true - description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' - example: carlee.cert1c9f9b6fd@mailinator.com - children: - type: array - items: - type: object - description: Defines STANDARD type Role membership - properties: - operation: - type: string - enum: - - EQUALS - - NOT_EQUALS - - CONTAINS - - STARTS_WITH - - ENDS_WITH - - AND - - OR - description: An operation - example: EQUALS - key: - type: object - nullable: true - description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' - properties: - type: - type: string - enum: - - IDENTITY - - ACCOUNT - - ENTITLEMENT - description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' - example: ACCOUNT - property: - type: string - description: The name of the attribute or entitlement to which the associated criteria applies. - example: attribute.email - sourceId: - type: string - nullable: true - description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT - example: 2c9180867427f3a301745aec18211519 - required: - - type - - property - stringValue: - type: string - description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' - example: carlee.cert1c9f9b6fd@mailinator.com - nullable: true - description: 'Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.' - nullable: true - description: 'Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.' - identities: - type: array - items: - type: object - description: A reference to an Identity in an IDENTITY_LIST role membership criteria. - properties: - type: - nullable: true - example: IDENTITY - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - nullable: true - description: Human-readable display name of the Identity. - example: Thomas Edison - aliasName: - type: string - nullable: true - description: User name of the Identity - example: t.edison - nullable: true - description: 'Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST.' - legacyMembershipInfo: - type: object - nullable: true - description: 'This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.' - example: - type: IDENTITY_LIST - additionalProperties: true - enabled: - type: boolean - description: Whether the Role is enabled or not. - example: true - default: false - requestable: - type: boolean - description: Whether the Role can be the target of access requests. - example: true - default: false - accessRequestConfig: - nullable: true - description: Access request configuration for this object - type: object - properties: - commentsRequired: - type: boolean - description: Whether the requester of the containing object must provide comments justifying the request - example: true - nullable: true - default: false - denialCommentsRequired: - type: boolean - description: Whether an approver must provide comments when denying the request - example: true - nullable: true - default: false - approvalSchemes: - type: array - description: List describing the steps in approving the request - items: - type: object - properties: - approverType: - type: string - enum: - - OWNER - - MANAGER - - GOVERNANCE_GROUP - description: |- - Describes the individual or group that is responsible for an approval step. Values are as follows. - - **OWNER**: Owner of the associated Role - - **MANAGER**: Manager of the Identity making the request - - **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field - example: GOVERNANCE_GROUP - approverId: - type: string - nullable: true - description: 'Id of the specific approver, used only when approverType is GOVERNANCE_GROUP' - example: 46c79819-a69f-49a2-becb-12c971ae66c6 - revocationRequestConfig: - nullable: true - default: null - description: Revocation request configuration for this object. - type: object - properties: - commentsRequired: - type: boolean - description: Whether the requester of the containing object must provide comments justifying the request - example: false - nullable: true - default: false - denialCommentsRequired: - type: boolean - description: Whether an approver must provide comments when denying the request - example: false - nullable: true - default: false - approvalSchemes: - type: array - description: List describing the steps in approving the revocation request - items: - type: object - properties: - approverType: - type: string - enum: - - APP_OWNER - - OWNER - - SOURCE_OWNER - - MANAGER - - GOVERNANCE_GROUP - description: |- - Describes the individual or group that is responsible for an approval step. Values are as follows. - **APP_OWNER**: The owner of the Application - - **OWNER**: Owner of the associated Access Profile or Role - - **SOURCE_OWNER**: Owner of the Source associated with an Access Profile - - **MANAGER**: Manager of the Identity making the request - - **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field - example: GOVERNANCE_GROUP - approverId: - type: string - nullable: true - description: 'Id of the specific approver, used only when approverType is GOVERNANCE_GROUP' - example: 46c79819-a69f-49a2-becb-12c971ae66c6 - segments: - type: array - items: - type: string - nullable: true - description: 'List of IDs of segments, if any, to which this Role is assigned.' - example: - - f7b1b8a3-5fed-4fd4-ad29-82014e137e19 - - 29cb6c06-1da8-43ea-8be4-b3125f248f2a - required: - - name - - owner - '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. - security: - - UserContextAuth: - - 'idn:role-unchecked:read' - - 'idn:role-unchecked:manage' - - 'idn:role-checked:manage' - - 'idn:role-checked:read' - patch: - operationId: patchRole - tags: - - Roles - summary: Patch a specified Role - description: |- - This API updates an existing Role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - - The following fields are patchable: **name**, **description**, **enabled**, **owner**, **accessProfiles**, **membership**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments** - A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - parameters: - - name: id - in: path - description: ID of the Role to patch - required: true - schema: - type: string - example: 2c91808a7813090a017814121e121518 - requestBody: - content: - application/json-patch+json: - schema: - type: array - items: - type: object - description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' - required: - - op - - path - properties: - op: - type: string - description: The operation to be performed - enum: - - add - - remove - - replace - - move - - copy - - test - example: replace - path: - type: string - description: A string JSON Pointer representing the target path to an element to be affected by the operation - example: /description - value: - anyOf: - - type: string - - type: integer - - type: object - - type: array - items: - anyOf: - - type: string - - type: integer - - type: object - description: 'The value to be used for the operation, required for "add" and "replace" operations' - example: New description - examples: - Make a Role Requestable and Enable it in One Call: - description: This example shows how multiple fields may be updated with a single patch call. - value: - - op: replace - path: /requestable - value: true - - op: replace - path: /enabled - value: true - Assign a Role to a Segment: - description: This example illustrates the use of patch to assign a Role to a Segment by adding the Segment's ID to the Role's segments array. - value: - - op: add - path: /segments/- - value: f7b1b8a3-5fed-4fd4-ad29-82014e137e19 - Set the Membership Selection Criteria to a List of Identities: - description: 'This example shows how to define a Role''s membershp by providing a list of Identities, referenced by their IDs.' - value: - - op: replace - path: /membership - value: - type: IDENTITY_LIST - identities: - - id: 2c91808973fe906c0174262092014ed9 - - id: 2c918086262092014ed94fb8a47612f3 - Set the Membership Selection Criteria to a Standard Expression: - description: 'This example shows how to define a Role''s membership using STANDARD criteria. In this case, the Role will be granted to all Identities which have the *Engineering* attribute from the indicated Source.' - value: - - op: replace - path: /membership - value: - type: STANDARD - criteria: - operation: OR - children: - - operation: EQUALS - key: - type: ENTITLEMENT - property: attribute.memberOf - sourceId: 2c9180887701fb2014213e122092014e - stringValue: Engineering - Add a New Clause as the Child of an Existing Standard Expression: - description: This example shows how to add a child clause to an existing STANDARD criteria expression. - value: - - op: add - path: /membership/criteria/children/- - value: - operation: ENDS_WITH - key: - type: IDENTITY - property: attribute.email - stringValue: '@identitynow.com' - required: true - responses: - '200': - description: Responds with the Role as updated. - content: - application/json: - schema: - type: object - description: A Role - properties: - id: - type: string - description: 'The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result.' - example: 2c918086749d78830174a1a40e121518 - name: - type: string - description: The human-readable display name of the Role - maxLength: 128 - example: Role 2567 - created: - type: string - description: Date the Role was created - format: date-time - example: '2021-03-01T22:32:58.104Z' - readOnly: true - modified: - type: string - description: Date the Role was last modified. - format: date-time - example: '2021-03-02T20:22:28.104Z' - readOnly: true - description: - type: string - nullable: true - description: A human-readable description of the Role - example: Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor. - owner: - type: object - nullable: true - description: The owner of this object. - properties: - type: - description: 'Owner type. This field must be either left null or set to ''IDENTITY'' on input, otherwise a 400 Bad Request error will result.' - example: IDENTITY - 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 - - WORKGROUP - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: 'Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner''s display name, otherwise a 400 Bad Request error will result.' - example: support - accessProfiles: - type: array - items: - type: object - properties: - id: - type: string - description: ID of the Access Profile - example: ff808081751e6e129f1518161919ecca - type: - type: string - description: 'Type of requested object. This field must be either left null or set to ''ACCESS_PROFILE'' when creating an Access Profile, otherwise a 400 Bad Request error will result.' - enum: - - ACCESS_PROFILE - example: ACCESS_PROFILE - name: - type: string - description: Human-readable display name of the Access Profile. This field is ignored on input. - example: Access Profile 2567 - nullable: true - membership: - nullable: true - type: object - description: 'When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities.' - properties: - type: - type: string - enum: - - STANDARD - - IDENTITY_LIST - description: |- - This enum characterizes the type of a Role's membership selector. Only the following two are fully supported: - - STANDARD: Indicates that Role membership is defined in terms of a criteria expression - - IDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed - example: IDENTITY_LIST - criteria: - nullable: true - type: object - description: Defines STANDARD type Role membership - properties: - operation: - type: string - enum: - - EQUALS - - NOT_EQUALS - - CONTAINS - - STARTS_WITH - - ENDS_WITH - - AND - - OR - description: An operation - example: EQUALS - key: - type: object - nullable: true - description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' - properties: - type: - type: string - enum: - - IDENTITY - - ACCOUNT - - ENTITLEMENT - description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' - example: ACCOUNT - property: - type: string - description: The name of the attribute or entitlement to which the associated criteria applies. - example: attribute.email - sourceId: - type: string - nullable: true - description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT - example: 2c9180867427f3a301745aec18211519 - required: - - type - - property - stringValue: - type: string - nullable: true - description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' - example: carlee.cert1c9f9b6fd@mailinator.com - children: - type: array - items: - type: object - nullable: true - description: Defines STANDARD type Role membership - properties: - operation: - type: string - enum: - - EQUALS - - NOT_EQUALS - - CONTAINS - - STARTS_WITH - - ENDS_WITH - - AND - - OR - description: An operation - example: EQUALS - key: - type: object - nullable: true - description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' - properties: - type: - type: string - enum: - - IDENTITY - - ACCOUNT - - ENTITLEMENT - description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' - example: ACCOUNT - property: - type: string - description: The name of the attribute or entitlement to which the associated criteria applies. - example: attribute.email - sourceId: - type: string - nullable: true - description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT - example: 2c9180867427f3a301745aec18211519 - required: - - type - - property - stringValue: - type: string - nullable: true - description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' - example: carlee.cert1c9f9b6fd@mailinator.com - children: - type: array - items: - type: object - description: Defines STANDARD type Role membership - properties: - operation: - type: string - enum: - - EQUALS - - NOT_EQUALS - - CONTAINS - - STARTS_WITH - - ENDS_WITH - - AND - - OR - description: An operation - example: EQUALS - key: - type: object - nullable: true - description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' - properties: - type: - type: string - enum: - - IDENTITY - - ACCOUNT - - ENTITLEMENT - description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' - example: ACCOUNT - property: - type: string - description: The name of the attribute or entitlement to which the associated criteria applies. - example: attribute.email - sourceId: - type: string - nullable: true - description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT - example: 2c9180867427f3a301745aec18211519 - required: - - type - - property - stringValue: - type: string - description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' - example: carlee.cert1c9f9b6fd@mailinator.com - nullable: true - description: 'Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.' - nullable: true - description: 'Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.' - identities: - type: array - items: - type: object - description: A reference to an Identity in an IDENTITY_LIST role membership criteria. - properties: - type: - nullable: true - example: IDENTITY - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - nullable: true - description: Human-readable display name of the Identity. - example: Thomas Edison - aliasName: - type: string - nullable: true - description: User name of the Identity - example: t.edison - nullable: true - description: 'Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST.' - legacyMembershipInfo: - type: object - nullable: true - description: 'This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.' - example: - type: IDENTITY_LIST - additionalProperties: true - enabled: - type: boolean - description: Whether the Role is enabled or not. - example: true - default: false - requestable: - type: boolean - description: Whether the Role can be the target of access requests. - example: true - default: false - accessRequestConfig: - nullable: true - description: Access request configuration for this object - type: object - properties: - commentsRequired: - type: boolean - description: Whether the requester of the containing object must provide comments justifying the request - example: true - nullable: true - default: false - denialCommentsRequired: - type: boolean - description: Whether an approver must provide comments when denying the request - example: true - nullable: true - default: false - approvalSchemes: - type: array - description: List describing the steps in approving the request - items: - type: object - properties: - approverType: - type: string - enum: - - OWNER - - MANAGER - - GOVERNANCE_GROUP - description: |- - Describes the individual or group that is responsible for an approval step. Values are as follows. - - **OWNER**: Owner of the associated Role - - **MANAGER**: Manager of the Identity making the request - - **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field - example: GOVERNANCE_GROUP - approverId: - type: string - nullable: true - description: 'Id of the specific approver, used only when approverType is GOVERNANCE_GROUP' - example: 46c79819-a69f-49a2-becb-12c971ae66c6 - revocationRequestConfig: - nullable: true - default: null - description: Revocation request configuration for this object. - type: object - properties: - commentsRequired: - type: boolean - description: Whether the requester of the containing object must provide comments justifying the request - example: false - nullable: true - default: false - denialCommentsRequired: - type: boolean - description: Whether an approver must provide comments when denying the request - example: false - nullable: true - default: false - approvalSchemes: - type: array - description: List describing the steps in approving the revocation request - items: - type: object - properties: - approverType: - type: string - enum: - - APP_OWNER - - OWNER - - SOURCE_OWNER - - MANAGER - - GOVERNANCE_GROUP - description: |- - Describes the individual or group that is responsible for an approval step. Values are as follows. - **APP_OWNER**: The owner of the Application - - **OWNER**: Owner of the associated Access Profile or Role - - **SOURCE_OWNER**: Owner of the Source associated with an Access Profile - - **MANAGER**: Manager of the Identity making the request - - **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field - example: GOVERNANCE_GROUP - approverId: - type: string - nullable: true - description: 'Id of the specific approver, used only when approverType is GOVERNANCE_GROUP' - example: 46c79819-a69f-49a2-becb-12c971ae66c6 - segments: - type: array - items: - type: string - nullable: true - description: 'List of IDs of segments, if any, to which this Role is assigned.' - example: - - f7b1b8a3-5fed-4fd4-ad29-82014e137e19 - - 29cb6c06-1da8-43ea-8be4-b3125f248f2a - required: - - name - - owner - '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. - security: - - UserContextAuth: - - 'idn:role-unchecked:manage' - - 'idn:role-checked:manage' - '/roles/{id}/assigned-identities': - get: - operationId: getRoleAssignedIdentities - tags: - - Roles - summary: List Identities assigned a Role - parameters: - - in: path - name: id - schema: - type: string - description: ID of the Role for which the assigned Identities are to be listed - example: 2c91808a7813090a017814121e121518 - required: true - - 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 - 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* - - **aliasName**: *eq, sw* - - **email**: *eq, sw* - - **name**: *eq, sw, co* - example: name sw Joe - - in: query - name: sorters - schema: - type: string - format: comma-separated - 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: **id**, **name**, **aliasName**, **email** - example: 'aliasName,name' - responses: - '200': - description: List of Identities assigned the Role - content: - application/json: - schema: - type: array - items: - type: object - description: A subset of the fields of an Identity which is a member of a Role. - properties: - id: - type: string - description: The ID of the Identity - example: 2c9180a46faadee4016fb4e018c20639 - aliasName: - type: string - description: The alias / username of the Identity - example: t.edison - name: - type: string - description: The human-readable display name of the Identity - example: Thomas Edison - email: - type: string - description: Email address of the Identity - example: t.edison@identitynow.com - roleAssignmentSource: - type: string - enum: - - ACCESS_REQUEST - - ROLE_MEMBERSHIP - description: Type which indicates how a particular Identity obtained a particular Role - example: ACCESS_REQUEST - '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. - security: - - UserContextAuth: - - 'idn:role-unchecked:read' - - 'idn:role-unchecked:manage' - - 'idn:role-checked:manage' - - 'idn:role-checked:read' - /saved-searches: - post: - tags: - - Saved Search - description: | - Creates a new saved search. - summary: Create a saved search - operationId: createSavedSearch - requestBody: - description: The saved search to persist. - content: - application/json: - schema: - allOf: - - type: object - properties: - name: - description: | - The name of the saved search. - type: string - example: Disabled accounts - description: - description: | - The description of the saved search. - type: string - nullable: true - example: Disabled accounts - - type: object - properties: - public: - description: | - Indicates if the saved search is public. - type: boolean - default: false - example: false - created: - description: | - The date the saved search was initially created. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - modified: - description: | - The last date the saved search was modified. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - indices: - description: | - The names of the Elasticsearch indices in which to search. - type: array - items: - description: |- - Enum representing the currently supported indices. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofiles - - accountactivities - - entitlements - - events - - identities - - roles - - '*' - example: identities - example: - - identities - columns: - description: | - The columns to be returned (specifies the order in which they will be presented) for each document type. - - The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - type: object - additionalProperties: - type: array - items: - type: object - properties: - field: - description: | - The name of the field. - type: string - example: email - header: - description: | - The value of the header. - type: string - example: Work Email - required: - - field - example: - identity: - - field: displayName - header: Display Name - - field: e-mail - header: Work Email - query: - description: | - The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - type: string - example: '@accounts(disabled:true)' - fields: - description: | - The fields to be searched against in a multi-field query. - type: array - nullable: true - items: - type: string - example: - - disabled - sort: - description: | - The fields to be used to sort the search results. - type: array - items: - type: string - example: - - displayName - filters: - nullable: true - allOf: - - type: object - description: The filters to be applied for each filtered field name. - example: - attributes.cloudAuthoritativeSource: - type: EXISTS - exclude: true - accessCount: - type: RANGE - range: - lower: - value: '3' - created: - type: RANGE - range: - lower: - value: '2019-12-01' - inclusive: true - upper: - value: '2020-01-01' - source.name: - type: TERMS - terms: - - HR Employees - - Corporate Active Directory - exclude: true - protected: - type: TERMS - terms: - - 'true' - - type: object - properties: - type: - description: |- - Enum representing the currently supported filter types. - Additional values may be added in the future without notice. - type: string - enum: - - EXISTS - - RANGE - - TERMS - example: RANGE - range: - type: object - description: The range of values to be filtered. - properties: - lower: - description: The lower bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - example: '1' - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - example: false - upper: - description: The upper bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - example: '1' - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - example: false - terms: - description: The terms to be filtered. - type: array - items: - type: string - example: account_count - exclude: - description: Indicates if the filter excludes results. - type: boolean - default: false - example: false - required: - - indices - - query - required: true - responses: - '201': - description: The persisted saved search. - content: - application/json: - schema: - type: object - allOf: - - type: object - properties: - id: - description: | - The saved search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - owner: - description: | - The owner of the saved search. - type: object - properties: - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - - type: object - properties: - name: - description: | - The name of the saved search. - type: string - example: Disabled accounts - description: - description: | - The description of the saved search. - type: string - nullable: true - example: Disabled accounts - - type: object - properties: - public: - description: | - Indicates if the saved search is public. - type: boolean - default: false - example: false - created: - description: | - The date the saved search was initially created. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - modified: - description: | - The last date the saved search was modified. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - indices: - description: | - The names of the Elasticsearch indices in which to search. - type: array - items: - description: |- - Enum representing the currently supported indices. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofiles - - accountactivities - - entitlements - - events - - identities - - roles - - '*' - example: identities - example: - - identities - columns: - description: | - The columns to be returned (specifies the order in which they will be presented) for each document type. - - The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - type: object - additionalProperties: - type: array - items: - type: object - properties: - field: - description: | - The name of the field. - type: string - example: email - header: - description: | - The value of the header. - type: string - example: Work Email - required: - - field - example: - identity: - - field: displayName - header: Display Name - - field: e-mail - header: Work Email - query: - description: | - The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - type: string - example: '@accounts(disabled:true)' - fields: - description: | - The fields to be searched against in a multi-field query. - type: array - nullable: true - items: - type: string - example: - - disabled - sort: - description: | - The fields to be used to sort the search results. - type: array - items: - type: string - example: - - displayName - filters: - nullable: true - allOf: - - type: object - description: The filters to be applied for each filtered field name. - example: - attributes.cloudAuthoritativeSource: - type: EXISTS - exclude: true - accessCount: - type: RANGE - range: - lower: - value: '3' - created: - type: RANGE - range: - lower: - value: '2019-12-01' - inclusive: true - upper: - value: '2020-01-01' - source.name: - type: TERMS - terms: - - HR Employees - - Corporate Active Directory - exclude: true - protected: - type: TERMS - terms: - - 'true' - - type: object - properties: - type: - description: |- - Enum representing the currently supported filter types. - Additional values may be added in the future without notice. - type: string - enum: - - EXISTS - - RANGE - - TERMS - example: RANGE - range: - type: object - description: The range of values to be filtered. - properties: - lower: - description: The lower bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - example: '1' - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - example: false - upper: - description: The upper bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - example: '1' - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - example: false - terms: - description: The terms to be filtered. - type: array - items: - type: string - example: account_count - exclude: - description: Indicates if the filter excludes results. - type: boolean - default: false - example: false - required: - - indices - - query - '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. - '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. - get: - tags: - - Saved Search - description: | - Returns a list of saved searches. - summary: Return a list of Saved Searches - operationId: listSavedSearches - parameters: - - 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: 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: 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 - - name: filters - in: query - schema: - type: string - description: | - An expression used to constrain the result set using the filtering syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results). - - Allowed filter properties: *owner.id*, *public* - - Allowed filter operator: *eq* - - **Example filters**: - - ```owner.id eq "0de46054-fe90-434a-b84e-c6b3359d0c64"``` -- returns saved searches for the specified owner ID - - ```public eq true``` -- returns all public saved searches - - ```owner.id eq me or public eq true``` -- returns all of the current user's saved searches as well as all public saved searches belonging to other users in the current org - example: public eq true - responses: - '200': - description: The list of requested saved searches. - content: - application/json: - schema: - type: array - items: - type: object - allOf: - - type: object - properties: - id: - description: | - The saved search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - owner: - description: | - The owner of the saved search. - type: object - properties: - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - - type: object - properties: - name: - description: | - The name of the saved search. - type: string - example: Disabled accounts - description: - description: | - The description of the saved search. - type: string - nullable: true - example: Disabled accounts - - type: object - properties: - public: - description: | - Indicates if the saved search is public. - type: boolean - default: false - example: false - created: - description: | - The date the saved search was initially created. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - modified: - description: | - The last date the saved search was modified. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - indices: - description: | - The names of the Elasticsearch indices in which to search. - type: array - items: - description: |- - Enum representing the currently supported indices. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofiles - - accountactivities - - entitlements - - events - - identities - - roles - - '*' - example: identities - example: - - identities - columns: - description: | - The columns to be returned (specifies the order in which they will be presented) for each document type. - - The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - type: object - additionalProperties: - type: array - items: - type: object - properties: - field: - description: | - The name of the field. - type: string - example: email - header: - description: | - The value of the header. - type: string - example: Work Email - required: - - field - example: - identity: - - field: displayName - header: Display Name - - field: e-mail - header: Work Email - query: - description: | - The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - type: string - example: '@accounts(disabled:true)' - fields: - description: | - The fields to be searched against in a multi-field query. - type: array - nullable: true - items: - type: string - example: - - disabled - sort: - description: | - The fields to be used to sort the search results. - type: array - items: - type: string - example: - - displayName - filters: - nullable: true - allOf: - - type: object - description: The filters to be applied for each filtered field name. - example: - attributes.cloudAuthoritativeSource: - type: EXISTS - exclude: true - accessCount: - type: RANGE - range: - lower: - value: '3' - created: - type: RANGE - range: - lower: - value: '2019-12-01' - inclusive: true - upper: - value: '2020-01-01' - source.name: - type: TERMS - terms: - - HR Employees - - Corporate Active Directory - exclude: true - protected: - type: TERMS - terms: - - 'true' - - type: object - properties: - type: - description: |- - Enum representing the currently supported filter types. - Additional values may be added in the future without notice. - type: string - enum: - - EXISTS - - RANGE - - TERMS - example: RANGE - range: - type: object - description: The range of values to be filtered. - properties: - lower: - description: The lower bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - example: '1' - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - example: false - upper: - description: The upper bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - example: '1' - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - example: false - terms: - description: The terms to be filtered. - type: array - items: - type: string - example: account_count - exclude: - description: Indicates if the filter excludes results. - type: boolean - default: false - example: false - required: - - indices - - query - headers: - X-Total-Count: - description: The total result count (returned only if the *count* parameter is specified as *true*). - schema: - type: integer - example: 5 - '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. - '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. - '/saved-searches/{id}': - put: - tags: - - Saved Search - description: | - Updates an existing saved search. - - >**NOTE: You cannot update the `owner` of the saved search.** - summary: | - Updates an existing saved search - operationId: putSavedSearch - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - example: 2c91808568c529c60168cca6f90c1313 - requestBody: - description: The saved search to persist. - content: - application/json: - schema: - type: object - allOf: - - type: object - properties: - id: - description: | - The saved search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - owner: - description: | - The owner of the saved search. - type: object - properties: - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - - type: object - properties: - name: - description: | - The name of the saved search. - type: string - example: Disabled accounts - description: - description: | - The description of the saved search. - type: string - nullable: true - example: Disabled accounts - - type: object - properties: - public: - description: | - Indicates if the saved search is public. - type: boolean - default: false - example: false - created: - description: | - The date the saved search was initially created. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - modified: - description: | - The last date the saved search was modified. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - indices: - description: | - The names of the Elasticsearch indices in which to search. - type: array - items: - description: |- - Enum representing the currently supported indices. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofiles - - accountactivities - - entitlements - - events - - identities - - roles - - '*' - example: identities - example: - - identities - columns: - description: | - The columns to be returned (specifies the order in which they will be presented) for each document type. - - The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - type: object - additionalProperties: - type: array - items: - type: object - properties: - field: - description: | - The name of the field. - type: string - example: email - header: - description: | - The value of the header. - type: string - example: Work Email - required: - - field - example: - identity: - - field: displayName - header: Display Name - - field: e-mail - header: Work Email - query: - description: | - The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - type: string - example: '@accounts(disabled:true)' - fields: - description: | - The fields to be searched against in a multi-field query. - type: array - nullable: true - items: - type: string - example: - - disabled - sort: - description: | - The fields to be used to sort the search results. - type: array - items: - type: string - example: - - displayName - filters: - nullable: true - allOf: - - type: object - description: The filters to be applied for each filtered field name. - example: - attributes.cloudAuthoritativeSource: - type: EXISTS - exclude: true - accessCount: - type: RANGE - range: - lower: - value: '3' - created: - type: RANGE - range: - lower: - value: '2019-12-01' - inclusive: true - upper: - value: '2020-01-01' - source.name: - type: TERMS - terms: - - HR Employees - - Corporate Active Directory - exclude: true - protected: - type: TERMS - terms: - - 'true' - - type: object - properties: - type: - description: |- - Enum representing the currently supported filter types. - Additional values may be added in the future without notice. - type: string - enum: - - EXISTS - - RANGE - - TERMS - example: RANGE - range: - type: object - description: The range of values to be filtered. - properties: - lower: - description: The lower bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - example: '1' - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - example: false - upper: - description: The upper bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - example: '1' - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - example: false - terms: - description: The terms to be filtered. - type: array - items: - type: string - example: account_count - exclude: - description: Indicates if the filter excludes results. - type: boolean - default: false - example: false - required: - - indices - - query - required: true - responses: - '200': - description: The persisted saved search. - content: - application/json: - schema: - type: object - allOf: - - type: object - properties: - id: - description: | - The saved search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - owner: - description: | - The owner of the saved search. - type: object - properties: - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - - type: object - properties: - name: - description: | - The name of the saved search. - type: string - example: Disabled accounts - description: - description: | - The description of the saved search. - type: string - nullable: true - example: Disabled accounts - - type: object - properties: - public: - description: | - Indicates if the saved search is public. - type: boolean - default: false - example: false - created: - description: | - The date the saved search was initially created. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - modified: - description: | - The last date the saved search was modified. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - indices: - description: | - The names of the Elasticsearch indices in which to search. - type: array - items: - description: |- - Enum representing the currently supported indices. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofiles - - accountactivities - - entitlements - - events - - identities - - roles - - '*' - example: identities - example: - - identities - columns: - description: | - The columns to be returned (specifies the order in which they will be presented) for each document type. - - The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - type: object - additionalProperties: - type: array - items: - type: object - properties: - field: - description: | - The name of the field. - type: string - example: email - header: - description: | - The value of the header. - type: string - example: Work Email - required: - - field - example: - identity: - - field: displayName - header: Display Name - - field: e-mail - header: Work Email - query: - description: | - The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - type: string - example: '@accounts(disabled:true)' - fields: - description: | - The fields to be searched against in a multi-field query. - type: array - nullable: true - items: - type: string - example: - - disabled - sort: - description: | - The fields to be used to sort the search results. - type: array - items: - type: string - example: - - displayName - filters: - nullable: true - allOf: - - type: object - description: The filters to be applied for each filtered field name. - example: - attributes.cloudAuthoritativeSource: - type: EXISTS - exclude: true - accessCount: - type: RANGE - range: - lower: - value: '3' - created: - type: RANGE - range: - lower: - value: '2019-12-01' - inclusive: true - upper: - value: '2020-01-01' - source.name: - type: TERMS - terms: - - HR Employees - - Corporate Active Directory - exclude: true - protected: - type: TERMS - terms: - - 'true' - - type: object - properties: - type: - description: |- - Enum representing the currently supported filter types. - Additional values may be added in the future without notice. - type: string - enum: - - EXISTS - - RANGE - - TERMS - example: RANGE - range: - type: object - description: The range of values to be filtered. - properties: - lower: - description: The lower bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - example: '1' - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - example: false - upper: - description: The upper bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - example: '1' - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - example: false - terms: - description: The terms to be filtered. - type: array - items: - type: string - example: account_count - exclude: - description: Indicates if the filter excludes results. - type: boolean - default: false - example: false - required: - - indices - - query - '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. - get: - tags: - - Saved Search - description: | - Returns the specified saved search. - summary: Return saved search by ID - operationId: getSavedSearch - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - example: 2c91808568c529c60168cca6f90c1313 - responses: - '200': - description: The requested saved search. - content: - application/json: - schema: - type: object - allOf: - - type: object - properties: - id: - description: | - The saved search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - owner: - description: | - The owner of the saved search. - type: object - properties: - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - - type: object - properties: - name: - description: | - The name of the saved search. - type: string - example: Disabled accounts - description: - description: | - The description of the saved search. - type: string - nullable: true - example: Disabled accounts - - type: object - properties: - public: - description: | - Indicates if the saved search is public. - type: boolean - default: false - example: false - created: - description: | - The date the saved search was initially created. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - modified: - description: | - The last date the saved search was modified. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - indices: - description: | - The names of the Elasticsearch indices in which to search. - type: array - items: - description: |- - Enum representing the currently supported indices. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofiles - - accountactivities - - entitlements - - events - - identities - - roles - - '*' - example: identities - example: - - identities - columns: - description: | - The columns to be returned (specifies the order in which they will be presented) for each document type. - - The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - type: object - additionalProperties: - type: array - items: - type: object - properties: - field: - description: | - The name of the field. - type: string - example: email - header: - description: | - The value of the header. - type: string - example: Work Email - required: - - field - example: - identity: - - field: displayName - header: Display Name - - field: e-mail - header: Work Email - query: - description: | - The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - type: string - example: '@accounts(disabled:true)' - fields: - description: | - The fields to be searched against in a multi-field query. - type: array - nullable: true - items: - type: string - example: - - disabled - sort: - description: | - The fields to be used to sort the search results. - type: array - items: - type: string - example: - - displayName - filters: - nullable: true - allOf: - - type: object - description: The filters to be applied for each filtered field name. - example: - attributes.cloudAuthoritativeSource: - type: EXISTS - exclude: true - accessCount: - type: RANGE - range: - lower: - value: '3' - created: - type: RANGE - range: - lower: - value: '2019-12-01' - inclusive: true - upper: - value: '2020-01-01' - source.name: - type: TERMS - terms: - - HR Employees - - Corporate Active Directory - exclude: true - protected: - type: TERMS - terms: - - 'true' - - type: object - properties: - type: - description: |- - Enum representing the currently supported filter types. - Additional values may be added in the future without notice. - type: string - enum: - - EXISTS - - RANGE - - TERMS - example: RANGE - range: - type: object - description: The range of values to be filtered. - properties: - lower: - description: The lower bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - example: '1' - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - example: false - upper: - description: The upper bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - example: '1' - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - example: false - terms: - description: The terms to be filtered. - type: array - items: - type: string - example: account_count - exclude: - description: Indicates if the filter excludes results. - type: boolean - default: false - example: false - required: - - indices - - query - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - delete: - tags: - - Saved Search - description: | - Deletes the specified saved search. - summary: Delete document by ID - operationId: deleteSavedSearch - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - example: 2c91808568c529c60168cca6f90c1313 - responses: - '204': - description: No Content - Indicates the request was successful but there is no content to be returned in the response. - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - '/saved-searches/{id}/execute': - post: - tags: - - Saved Search - description: | - Executes the specified saved search. - summary: Execute a saved search by ID - operationId: executeSavedSearch - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - example: 2c91808568c529c60168cca6f90c1313 - requestBody: - description: | - When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. - - If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. - content: - application/json: - schema: - type: object - properties: - scheduleId: - description: | - The ID of the scheduled search that triggered the saved search execution. - type: string - example: 7a724640-0c17-4ce9-a8c3-4a89738459c8 - owner: - description: | - The owner of the scheduled search being tested. - allOf: - - type: object - description: | - A typed reference to the object. - properties: - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - recipients: - description: | - The email recipients of the scheduled search being tested. - type: array - items: - type: object - description: | - A typed reference to the object. - properties: - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - examples: - scheduled: - summary: Triggered by Scheduled Search - value: - scheduleId: 7a724640-0c17-4ce9-a8c3-4a89738459c8 - test: - summary: Triggered by UI Test - value: - owner: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - recipients: - - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - required: true - responses: - '202': - description: Accepted - Returned if the request was successfully accepted into the system. - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - /scheduled-searches: - post: - tags: - - Scheduled Search - description: | - Creates a new scheduled search. - summary: Create a new scheduled search - operationId: createScheduledSearch - requestBody: - description: The scheduled search to persist. - content: - application/json: - schema: - allOf: - - type: object - properties: - name: - description: | - The name of the scheduled search. - type: string - example: Daily disabled accounts - nullable: true - description: - description: | - The description of the scheduled search. - type: string - nullable: true - example: Daily disabled accounts - - type: object - properties: - savedSearchId: - description: The ID of the saved search that will be executed. - type: string - example: 554f1511-f0a1-4744-ab14-599514d3e57c - created: - allOf: - - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - description: The date the scheduled search was initially created. - readOnly: true - modified: - allOf: - - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - description: The last date the scheduled search was modified. - readOnly: true - schedule: - type: object - description: The schedule information. - properties: - type: - description: | - Enum representing the currently supported schedule types. - - Additional values may be added in the future without notice. - type: string - enum: - - DAILY - - WEEKLY - - MONTHLY - - CALENDAR - example: WEEKLY - days: - allOf: - - type: object - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - - description: | - The days to execute the search. - - If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. - - If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. - example: - type: LIST - values: - - MON - - WED - - FRI - nullable: true - hours: - allOf: - - type: object - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - - description: The hours selected. - example: - type: RANGE - values: - - '9' - - '18' - interval: 3 - expiration: - description: 'The schedule expiration date. Latest possible expiration date is ''2038-01-19T03:14:07+0000''' - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - timeZoneId: - description: 'The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org''s default timezone is used.' - nullable: true - type: string - example: 'GMT-06:00' - required: - - type - - hours - recipients: - description: A list of identities that should receive the scheduled search report via email. - type: array - items: - type: object - properties: - type: - type: string - description: The type of object being referenced - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: The ID of the referenced object - example: 2c9180867624cbd7017642d8c8c81f67 - required: - - type - - id - enabled: - description: | - Indicates if the scheduled search is enabled. - type: boolean - default: false - example: false - emailEmptyResults: - description: | - Indicates if email generation should not be suppressed if search returns no results. - type: boolean - default: false - example: false - displayQueryDetails: - description: | - Indicates if the generated email should include the query and search results preview (which could include PII). - type: boolean - default: false - example: false - required: - - savedSearchId - - schedule - - recipients - examples: - Daily Search: - description: A search that executes each day at a 9 AM - value: - savedSearchId: 9c620e13-cd33-4804-a13d-403bd7bcdbad - schedule: - type: DAILY - hours: - type: LIST - values: - - '9' - recipients: - - type: IDENTITY - id: 2c9180867624cbd7017642d8c8c81f67 - Weekly Search: - description: A search that executes each week on select days and times - value: - savedSearchId: 9c620e13-cd33-4804-a13d-403bd7bcdbad - schedule: - type: WEEKLY - days: - type: LIST - values: - - MON - - TUE - - WED - - THU - - FRI - - SAT - - SUN - hours: - type: LIST - values: - - '9' - recipients: - - type: IDENTITY - id: 2c9180867624cbd7017642d8c8c81f67 - Monthly Search: - description: A search that executes each month on select days and times - value: - savedSearchId: 9c620e13-cd33-4804-a13d-403bd7bcdbad - schedule: - type: MONTHLY - days: - type: LIST - values: - - '1' - - '7' - - '14' - - L - hours: - type: LIST - values: - - '9' - recipients: - - type: IDENTITY - id: 2c9180867624cbd7017642d8c8c81f67 - Calendar Search: - description: A search that executes on specific calendar days - value: - savedSearchId: 9c620e13-cd33-4804-a13d-403bd7bcdbad - schedule: - type: CALENDAR - days: - type: LIST - values: - - '2023-01-22' - - '2023-02-22' - hours: - type: LIST - values: - - '9' - recipients: - - type: IDENTITY - id: 2c9180867624cbd7017642d8c8c81f67 - required: true - responses: - '201': - description: The persisted scheduled search. - content: - application/json: - schema: - type: object - allOf: - - type: object - properties: - id: - description: The scheduled search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - readOnly: true - owner: - description: The owner of the scheduled search - readOnly: true - type: object - properties: - type: - type: string - description: The type of object being referenced - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: The ID of the referenced object - example: 2c9180867624cbd7017642d8c8c81f67 - required: - - type - - id - ownerId: - description: | - The ID of the scheduled search owner. - - Please use the `id` in the `owner` object instead. - type: string - example: 2c9180867624cbd7017642d8c8c81f67 - readOnly: true - deprecated: true - - type: object - properties: - name: - description: | - The name of the scheduled search. - type: string - example: Daily disabled accounts - nullable: true - description: - description: | - The description of the scheduled search. - type: string - nullable: true - example: Daily disabled accounts - - type: object - properties: - savedSearchId: - description: The ID of the saved search that will be executed. - type: string - example: 554f1511-f0a1-4744-ab14-599514d3e57c - created: - allOf: - - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - description: The date the scheduled search was initially created. - readOnly: true - modified: - allOf: - - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - description: The last date the scheduled search was modified. - readOnly: true - schedule: - type: object - description: The schedule information. - properties: - type: - description: | - Enum representing the currently supported schedule types. - - Additional values may be added in the future without notice. - type: string - enum: - - DAILY - - WEEKLY - - MONTHLY - - CALENDAR - example: WEEKLY - days: - allOf: - - type: object - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - - description: | - The days to execute the search. - - If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. - - If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. - example: - type: LIST - values: - - MON - - WED - - FRI - nullable: true - hours: - allOf: - - type: object - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - - description: The hours selected. - example: - type: RANGE - values: - - '9' - - '18' - interval: 3 - expiration: - description: 'The schedule expiration date. Latest possible expiration date is ''2038-01-19T03:14:07+0000''' - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - timeZoneId: - description: 'The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org''s default timezone is used.' - nullable: true - type: string - example: 'GMT-06:00' - required: - - type - - hours - recipients: - description: A list of identities that should receive the scheduled search report via email. - type: array - items: - type: object - properties: - type: - type: string - description: The type of object being referenced - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: The ID of the referenced object - example: 2c9180867624cbd7017642d8c8c81f67 - required: - - type - - id - enabled: - description: | - Indicates if the scheduled search is enabled. - type: boolean - default: false - example: false - emailEmptyResults: - description: | - Indicates if email generation should not be suppressed if search returns no results. - type: boolean - default: false - example: false - displayQueryDetails: - description: | - Indicates if the generated email should include the query and search results preview (which could include PII). - type: boolean - default: false - example: false - required: - - savedSearchId - - schedule - - recipients - required: - - id - - owner - - ownerId - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - get: - tags: - - Scheduled Search - description: | - Returns a list of scheduled searches. - summary: List scheduled searches - operationId: listScheduledSearch - parameters: - - 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: 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: 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 - - name: filters - in: query - schema: - type: string - description: | - An expression used to constrain the result set using the filtering syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results). - - Allowed filter properties: *owner.id*, *savedSearchId* - - Allowed filter operator: *eq* - - **Example filters**: - - ```owner.id eq "0de46054-fe90-434a-b84e-c6b3359d0c64"``` -- returns scheduled searches for the specified owner ID - - ```savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"``` -- returns scheduled searches that reference the specified saved search - - ```owner.id eq me or savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"``` -- returns all of the current user's scheduled searches as well as all scheduled searches that reference the specified saved search - example: savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e" - responses: - '200': - description: The list of requested scheduled searches. - content: - application/json: - schema: - type: array - items: - type: object - allOf: - - type: object - properties: - id: - description: The scheduled search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - readOnly: true - owner: - description: The owner of the scheduled search - readOnly: true - type: object - properties: - type: - type: string - description: The type of object being referenced - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: The ID of the referenced object - example: 2c9180867624cbd7017642d8c8c81f67 - required: - - type - - id - ownerId: - description: | - The ID of the scheduled search owner. - - Please use the `id` in the `owner` object instead. - type: string - example: 2c9180867624cbd7017642d8c8c81f67 - readOnly: true - deprecated: true - - type: object - properties: - name: - description: | - The name of the scheduled search. - type: string - example: Daily disabled accounts - nullable: true - description: - description: | - The description of the scheduled search. - type: string - nullable: true - example: Daily disabled accounts - - type: object - properties: - savedSearchId: - description: The ID of the saved search that will be executed. - type: string - example: 554f1511-f0a1-4744-ab14-599514d3e57c - created: - allOf: - - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - description: The date the scheduled search was initially created. - readOnly: true - modified: - allOf: - - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - description: The last date the scheduled search was modified. - readOnly: true - schedule: - type: object - description: The schedule information. - properties: - type: - description: | - Enum representing the currently supported schedule types. - - Additional values may be added in the future without notice. - type: string - enum: - - DAILY - - WEEKLY - - MONTHLY - - CALENDAR - example: WEEKLY - days: - allOf: - - type: object - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - - description: | - The days to execute the search. - - If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. - - If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. - example: - type: LIST - values: - - MON - - WED - - FRI - nullable: true - hours: - allOf: - - type: object - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - - description: The hours selected. - example: - type: RANGE - values: - - '9' - - '18' - interval: 3 - expiration: - description: 'The schedule expiration date. Latest possible expiration date is ''2038-01-19T03:14:07+0000''' - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - timeZoneId: - description: 'The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org''s default timezone is used.' - nullable: true - type: string - example: 'GMT-06:00' - required: - - type - - hours - recipients: - description: A list of identities that should receive the scheduled search report via email. - type: array - items: - type: object - properties: - type: - type: string - description: The type of object being referenced - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: The ID of the referenced object - example: 2c9180867624cbd7017642d8c8c81f67 - required: - - type - - id - enabled: - description: | - Indicates if the scheduled search is enabled. - type: boolean - default: false - example: false - emailEmptyResults: - description: | - Indicates if email generation should not be suppressed if search returns no results. - type: boolean - default: false - example: false - displayQueryDetails: - description: | - Indicates if the generated email should include the query and search results preview (which could include PII). - type: boolean - default: false - example: false - required: - - savedSearchId - - schedule - - recipients - required: - - id - - owner - - ownerId - headers: - X-Total-Count: - description: The total result count (returned only if the *count* parameter is specified as *true*). - schema: - type: integer - example: 5 - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - '/scheduled-searches/{id}': - put: - tags: - - Scheduled Search - description: | - Updates an existing scheduled search. - summary: Update an existing Scheduled Search - operationId: updateScheduledSearch - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - example: 2c91808568c529c60168cca6f90c1313 - requestBody: - description: The scheduled search to persist. - content: - application/json: - schema: - type: object - allOf: - - type: object - properties: - id: - description: The scheduled search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - readOnly: true - owner: - description: The owner of the scheduled search - readOnly: true - type: object - properties: - type: - type: string - description: The type of object being referenced - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: The ID of the referenced object - example: 2c9180867624cbd7017642d8c8c81f67 - required: - - type - - id - ownerId: - description: | - The ID of the scheduled search owner. - - Please use the `id` in the `owner` object instead. - type: string - example: 2c9180867624cbd7017642d8c8c81f67 - readOnly: true - deprecated: true - - type: object - properties: - name: - description: | - The name of the scheduled search. - type: string - example: Daily disabled accounts - nullable: true - description: - description: | - The description of the scheduled search. - type: string - nullable: true - example: Daily disabled accounts - - type: object - properties: - savedSearchId: - description: The ID of the saved search that will be executed. - type: string - example: 554f1511-f0a1-4744-ab14-599514d3e57c - created: - allOf: - - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - description: The date the scheduled search was initially created. - readOnly: true - modified: - allOf: - - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - description: The last date the scheduled search was modified. - readOnly: true - schedule: - type: object - description: The schedule information. - properties: - type: - description: | - Enum representing the currently supported schedule types. - - Additional values may be added in the future without notice. - type: string - enum: - - DAILY - - WEEKLY - - MONTHLY - - CALENDAR - example: WEEKLY - days: - allOf: - - type: object - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - - description: | - The days to execute the search. - - If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. - - If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. - example: - type: LIST - values: - - MON - - WED - - FRI - nullable: true - hours: - allOf: - - type: object - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - - description: The hours selected. - example: - type: RANGE - values: - - '9' - - '18' - interval: 3 - expiration: - description: 'The schedule expiration date. Latest possible expiration date is ''2038-01-19T03:14:07+0000''' - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - timeZoneId: - description: 'The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org''s default timezone is used.' - nullable: true - type: string - example: 'GMT-06:00' - required: - - type - - hours - recipients: - description: A list of identities that should receive the scheduled search report via email. - type: array - items: - type: object - properties: - type: - type: string - description: The type of object being referenced - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: The ID of the referenced object - example: 2c9180867624cbd7017642d8c8c81f67 - required: - - type - - id - enabled: - description: | - Indicates if the scheduled search is enabled. - type: boolean - default: false - example: false - emailEmptyResults: - description: | - Indicates if email generation should not be suppressed if search returns no results. - type: boolean - default: false - example: false - displayQueryDetails: - description: | - Indicates if the generated email should include the query and search results preview (which could include PII). - type: boolean - default: false - example: false - required: - - savedSearchId - - schedule - - recipients - required: - - id - - owner - - ownerId - required: true - responses: - '200': - description: The persisted scheduled search. - content: - application/json: - schema: - type: object - allOf: - - type: object - properties: - id: - description: The scheduled search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - readOnly: true - owner: - description: The owner of the scheduled search - readOnly: true - type: object - properties: - type: - type: string - description: The type of object being referenced - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: The ID of the referenced object - example: 2c9180867624cbd7017642d8c8c81f67 - required: - - type - - id - ownerId: - description: | - The ID of the scheduled search owner. - - Please use the `id` in the `owner` object instead. - type: string - example: 2c9180867624cbd7017642d8c8c81f67 - readOnly: true - deprecated: true - - type: object - properties: - name: - description: | - The name of the scheduled search. - type: string - example: Daily disabled accounts - nullable: true - description: - description: | - The description of the scheduled search. - type: string - nullable: true - example: Daily disabled accounts - - type: object - properties: - savedSearchId: - description: The ID of the saved search that will be executed. - type: string - example: 554f1511-f0a1-4744-ab14-599514d3e57c - created: - allOf: - - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - description: The date the scheduled search was initially created. - readOnly: true - modified: - allOf: - - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - description: The last date the scheduled search was modified. - readOnly: true - schedule: - type: object - description: The schedule information. - properties: - type: - description: | - Enum representing the currently supported schedule types. - - Additional values may be added in the future without notice. - type: string - enum: - - DAILY - - WEEKLY - - MONTHLY - - CALENDAR - example: WEEKLY - days: - allOf: - - type: object - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - - description: | - The days to execute the search. - - If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. - - If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. - example: - type: LIST - values: - - MON - - WED - - FRI - nullable: true - hours: - allOf: - - type: object - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - - description: The hours selected. - example: - type: RANGE - values: - - '9' - - '18' - interval: 3 - expiration: - description: 'The schedule expiration date. Latest possible expiration date is ''2038-01-19T03:14:07+0000''' - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - timeZoneId: - description: 'The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org''s default timezone is used.' - nullable: true - type: string - example: 'GMT-06:00' - required: - - type - - hours - recipients: - description: A list of identities that should receive the scheduled search report via email. - type: array - items: - type: object - properties: - type: - type: string - description: The type of object being referenced - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: The ID of the referenced object - example: 2c9180867624cbd7017642d8c8c81f67 - required: - - type - - id - enabled: - description: | - Indicates if the scheduled search is enabled. - type: boolean - default: false - example: false - emailEmptyResults: - description: | - Indicates if email generation should not be suppressed if search returns no results. - type: boolean - default: false - example: false - displayQueryDetails: - description: | - Indicates if the generated email should include the query and search results preview (which could include PII). - type: boolean - default: false - example: false - required: - - savedSearchId - - schedule - - recipients - required: - - id - - owner - - ownerId - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - get: - tags: - - Scheduled Search - description: Returns the specified scheduled search. - summary: Get a Scheduled Search - operationId: getScheduledSearch - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - example: 2c91808568c529c60168cca6f90c1313 - responses: - '200': - description: The requested scheduled search. - content: - application/json: - schema: - type: object - allOf: - - type: object - properties: - id: - description: The scheduled search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - readOnly: true - owner: - description: The owner of the scheduled search - readOnly: true - type: object - properties: - type: - type: string - description: The type of object being referenced - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: The ID of the referenced object - example: 2c9180867624cbd7017642d8c8c81f67 - required: - - type - - id - ownerId: - description: | - The ID of the scheduled search owner. - - Please use the `id` in the `owner` object instead. - type: string - example: 2c9180867624cbd7017642d8c8c81f67 - readOnly: true - deprecated: true - - type: object - properties: - name: - description: | - The name of the scheduled search. - type: string - example: Daily disabled accounts - nullable: true - description: - description: | - The description of the scheduled search. - type: string - nullable: true - example: Daily disabled accounts - - type: object - properties: - savedSearchId: - description: The ID of the saved search that will be executed. - type: string - example: 554f1511-f0a1-4744-ab14-599514d3e57c - created: - allOf: - - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - description: The date the scheduled search was initially created. - readOnly: true - modified: - allOf: - - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - description: The last date the scheduled search was modified. - readOnly: true - schedule: - type: object - description: The schedule information. - properties: - type: - description: | - Enum representing the currently supported schedule types. - - Additional values may be added in the future without notice. - type: string - enum: - - DAILY - - WEEKLY - - MONTHLY - - CALENDAR - example: WEEKLY - days: - allOf: - - type: object - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - - description: | - The days to execute the search. - - If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. - - If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. - example: - type: LIST - values: - - MON - - WED - - FRI - nullable: true - hours: - allOf: - - type: object - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - - description: The hours selected. - example: - type: RANGE - values: - - '9' - - '18' - interval: 3 - expiration: - description: 'The schedule expiration date. Latest possible expiration date is ''2038-01-19T03:14:07+0000''' - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - timeZoneId: - description: 'The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org''s default timezone is used.' - nullable: true - type: string - example: 'GMT-06:00' - required: - - type - - hours - recipients: - description: A list of identities that should receive the scheduled search report via email. - type: array - items: - type: object - properties: - type: - type: string - description: The type of object being referenced - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: The ID of the referenced object - example: 2c9180867624cbd7017642d8c8c81f67 - required: - - type - - id - enabled: - description: | - Indicates if the scheduled search is enabled. - type: boolean - default: false - example: false - emailEmptyResults: - description: | - Indicates if email generation should not be suppressed if search returns no results. - type: boolean - default: false - example: false - displayQueryDetails: - description: | - Indicates if the generated email should include the query and search results preview (which could include PII). - type: boolean - default: false - example: false - required: - - savedSearchId - - schedule - - recipients - required: - - id - - owner - - ownerId - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - delete: - tags: - - Scheduled Search - description: | - Deletes the specified scheduled search. - operationId: deleteScheduledSearch - summary: Delete a Scheduled Search - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - example: 2c91808568c529c60168cca6f90c1313 - responses: - '204': - description: No Content - Indicates the request was successful but there is no content to be returned in the response. - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - '/scheduled-searches/{id}/unsubscribe': - post: - tags: - - Scheduled Search - description: | - Unsubscribes a recipient from the specified scheduled search. - operationId: unsubscribeScheduledSearch - summary: Unsubscribe a recipient from Scheduled Search - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - example: 2c91808568c529c60168cca6f90c1313 - requestBody: - description: | - The recipient to be removed from the scheduled search. - content: - application/json: - schema: - type: object - description: | - A typed reference to the object. - properties: - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - required: true - responses: - '204': - description: No Content - Indicates the request was successful but there is no content to be returned in the response. - '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. - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - /search: - post: - tags: - - Search - description: 'Performs a search with the provided query and returns a matching result collection. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. ' - externalDocs: - description: Learn more about search. - url: 'https://documentation.sailpoint.com/saas/help/search/index.html' - operationId: searchPost - summary: Perform Search - parameters: - - 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: 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: 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 - requestBody: - content: - application/json: - schema: - type: object - properties: - indices: - description: 'The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched.' - externalDocs: - description: Learn more about search indices here. - url: 'https://documentation.sailpoint.com/saas/help/search/searchable-fields.html' - type: array - items: - description: |- - Enum representing the currently supported indices. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofiles - - accountactivities - - entitlements - - events - - identities - - roles - - '*' - example: identities - example: - - identities - queryType: - description: |- - The type of query to use. By default, the `SAILPOINT` query type is used, which requires the `query` object to be defined in the request body. - To use the `queryDsl` or `typeAheadQuery` objects in the request, you must set the type to `DSL` or `TYPEAHEAD` accordingly. - Additional values may be added in the future without notice. - type: string - enum: - - DSL - - SAILPOINT - - TEXT - - TYPEAHEAD - default: SAILPOINT - example: SAILPOINT - queryVersion: - allOf: - - description: The current Elasticserver version. - type: string - default: '5.2' - example: '5.2' - - type: string - description: |- - The version of the query object. - This version number will map to the version of Elasticsearch for the query strings and objects being used. - query: - type: object - description: Query parameters used to construct an Elasticsearch query object. - properties: - query: - description: 'The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.' - type: string - example: 'name:a*' - fields: - description: The fields to which the specified query will be applied. The available fields are dependent on the indice(s) being searched on. Please refer to the response schema of this API for a list of available fields. - type: array - items: - type: string - example: - - name - timeZone: - description: The time zone to be applied to any range query related to dates. - type: string - example: America/Chicago - innerHit: - description: The innerHit query object returns a flattened list of results for the specified nested type. - type: object - required: - - query - - type - properties: - query: - description: 'The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.' - type: string - example: 'source.name:\"Active Directory\"' - type: - description: 'The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document "nested" within another document. For example, an identity can have nested documents for access, accounts, and apps.' - type: string - example: access - queryDsl: - description: 'The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax.' - type: object - example: - match: - name: john.doe - textQuery: - type: object - description: Query parameters used to construct an Elasticsearch text query object. - required: - - terms - - fields - properties: - terms: - description: Words or characters that specify a particular thing to be searched for. - type: array - items: - type: string - example: - - The quick brown fox - - '3141592' - - '7' - fields: - description: The fields to be searched. - type: array - items: - type: string - example: - - displayName - - employeeNumber - - roleCount - matchAny: - description: 'Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found.' - type: boolean - default: false - example: false - contains: - description: 'Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms.' - type: boolean - default: false - example: true - typeAheadQuery: - type: object - description: 'Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing "Jo" results in top hits matching "Jo." Typing "Job" results in top hits matching "Job." ' - required: - - query - - field - properties: - query: - description: The type ahead query string used to construct a phrase prefix match query. - type: string - example: Work - field: - description: The field on which to perform the type ahead search. - type: string - example: source.name - nestedType: - description: The nested type. - type: string - example: access - maxExpansions: - description: |- - The number of suffixes the last term will be expanded into. - Influences the performance of the query and the number results returned. - Valid values: 1 to 1000. - type: integer - format: int32 - minimum: 1 - maximum: 1000 - default: 10 - example: 10 - includeNested: - description: Indicates whether nested objects from returned search results should be included. - type: boolean - default: true - example: true - queryResultFilter: - type: object - description: Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents. - properties: - includes: - description: The list of field names to include in the result documents. - type: array - items: - type: string - example: - - name - - displayName - excludes: - description: The list of field names to exclude from the result documents. - type: array - items: - type: string - example: - - stacktrace - aggregationType: - description: | - Enum representing the currently available query languages for aggregations, which are used to perform calculations or groupings on search results. - - Additional values may be added in the future without notice. - type: string - enum: - - DSL - - SAILPOINT - default: DSL - example: DSL - aggregationsVersion: - allOf: - - description: The current Elasticserver version. - type: string - default: '5.2' - example: '5.2' - - type: string - description: |- - The version of the language being used for aggregation queries. - This version number will map to the version of Elasticsearch for the aggregation query object. - aggregationsDsl: - description: 'The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax.' - type: object - example: {} - aggregations: - description: | - The aggregation’s specifications, such as the groupings and calculations to be performed. - allOf: - - type: object - properties: - nested: - type: object - description: The nested aggregation object. - required: - - name - - type - properties: - name: - description: The name of the nested aggregate to be included in the result. - type: string - example: id - type: - description: The type of the nested object. - type: string - example: access - metric: - type: object - description: The calculation done on the results of the query - required: - - name - - field - properties: - name: - description: |- - The name of the metric aggregate to be included in the result. - If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. - type: string - example: Access Name Count - type: - description: |- - Enum representing the currently supported metric aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - COUNT - - UNIQUE_COUNT - - AVG - - SUM - - MEDIAN - - MIN - - MAX - default: UNIQUE_COUNT - example: COUNT - field: - description: | - The field the calculation is performed on. - - Prefix the field name with '@' to reference a nested object. - type: string - example: '@access.name' - filter: - type: object - description: An additional filter to constrain the results of the search query. - required: - - name - - field - - value - properties: - name: - description: The name of the filter aggregate to be included in the result. - type: string - example: Entitlements - type: - description: |- - Enum representing the currently supported filter aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERM - default: TERM - example: TERM - field: - description: | - The search field to apply the filter to. - - Prefix the field name with '@' to reference a nested object. - type: string - example: access.type - value: - description: The value to filter on. - type: string - example: ENTITLEMENT - bucket: - type: object - description: The bucket to group the results of the aggregation query by. - required: - - name - - field - properties: - name: - description: The name of the bucket aggregate to be included in the result. - type: string - example: Identity Locations - type: - description: |- - Enum representing the currently supported bucket aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERMS - default: TERMS - example: TERMS - field: - description: |- - The field to bucket on. - Prefix the field name with '@' to reference a nested object. - type: string - example: attributes.city - size: - description: Maximum number of buckets to include. - type: integer - format: int32 - example: 100 - minDocCount: - description: Minimum number of documents a bucket should have. - type: integer - format: int32 - example: 2 - - type: object - properties: - subAggregation: - description: Aggregation to be performed on the result of the parent bucket aggregation. - allOf: - - type: object - properties: - nested: - type: object - description: The nested aggregation object. - required: - - name - - type - properties: - name: - description: The name of the nested aggregate to be included in the result. - type: string - example: id - type: - description: The type of the nested object. - type: string - example: access - metric: - type: object - description: The calculation done on the results of the query - required: - - name - - field - properties: - name: - description: |- - The name of the metric aggregate to be included in the result. - If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. - type: string - example: Access Name Count - type: - description: |- - Enum representing the currently supported metric aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - COUNT - - UNIQUE_COUNT - - AVG - - SUM - - MEDIAN - - MIN - - MAX - default: UNIQUE_COUNT - example: COUNT - field: - description: | - The field the calculation is performed on. - - Prefix the field name with '@' to reference a nested object. - type: string - example: '@access.name' - filter: - type: object - description: An additional filter to constrain the results of the search query. - required: - - name - - field - - value - properties: - name: - description: The name of the filter aggregate to be included in the result. - type: string - example: Entitlements - type: - description: |- - Enum representing the currently supported filter aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERM - default: TERM - example: TERM - field: - description: | - The search field to apply the filter to. - - Prefix the field name with '@' to reference a nested object. - type: string - example: access.type - value: - description: The value to filter on. - type: string - example: ENTITLEMENT - bucket: - type: object - description: The bucket to group the results of the aggregation query by. - required: - - name - - field - properties: - name: - description: The name of the bucket aggregate to be included in the result. - type: string - example: Identity Locations - type: - description: |- - Enum representing the currently supported bucket aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERMS - default: TERMS - example: TERMS - field: - description: |- - The field to bucket on. - Prefix the field name with '@' to reference a nested object. - type: string - example: attributes.city - size: - description: Maximum number of buckets to include. - type: integer - format: int32 - example: 100 - minDocCount: - description: Minimum number of documents a bucket should have. - type: integer - format: int32 - example: 2 - - type: object - properties: - subAggregation: - description: Aggregation to be performed on the result of the parent bucket aggregation. - type: object - properties: - nested: - type: object - description: The nested aggregation object. - required: - - name - - type - properties: - name: - description: The name of the nested aggregate to be included in the result. - type: string - example: id - type: - description: The type of the nested object. - type: string - example: access - metric: - type: object - description: The calculation done on the results of the query - required: - - name - - field - properties: - name: - description: |- - The name of the metric aggregate to be included in the result. - If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. - type: string - example: Access Name Count - type: - description: |- - Enum representing the currently supported metric aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - COUNT - - UNIQUE_COUNT - - AVG - - SUM - - MEDIAN - - MIN - - MAX - default: UNIQUE_COUNT - example: COUNT - field: - description: | - The field the calculation is performed on. - - Prefix the field name with '@' to reference a nested object. - type: string - example: '@access.name' - filter: - type: object - description: An additional filter to constrain the results of the search query. - required: - - name - - field - - value - properties: - name: - description: The name of the filter aggregate to be included in the result. - type: string - example: Entitlements - type: - description: |- - Enum representing the currently supported filter aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERM - default: TERM - example: TERM - field: - description: | - The search field to apply the filter to. - - Prefix the field name with '@' to reference a nested object. - type: string - example: access.type - value: - description: The value to filter on. - type: string - example: ENTITLEMENT - bucket: - type: object - description: The bucket to group the results of the aggregation query by. - required: - - name - - field - properties: - name: - description: The name of the bucket aggregate to be included in the result. - type: string - example: Identity Locations - type: - description: |- - Enum representing the currently supported bucket aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERMS - default: TERMS - example: TERMS - field: - description: |- - The field to bucket on. - Prefix the field name with '@' to reference a nested object. - type: string - example: attributes.city - size: - description: Maximum number of buckets to include. - type: integer - format: int32 - example: 100 - minDocCount: - description: Minimum number of documents a bucket should have. - type: integer - format: int32 - example: 2 - sort: - description: The fields to be used to sort the search results. Use + or - to specify the sort direction. - type: array - items: - type: string - example: - - displayName - - +id - searchAfter: - description: |- - Used to begin the search window at the values specified. - This parameter consists of the last values of the sorted fields in the current record set. - This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. - It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging. - For example, when searching for identities, if you are sorting by displayName you will also want to include ID, for example ["displayName", "id"]. - If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is "John Doe", then using that displayName and ID will start a new search after this identity. - The searchAfter value will look like ["John Doe","2c91808375d8e80a0175e1f88a575221"] - type: array - items: - type: string - example: - - John Doe - - 2c91808375d8e80a0175e1f88a575221 - filters: - description: The filters to be applied for each filtered field name. - type: object - additionalProperties: - type: object - properties: - type: - description: |- - Enum representing the currently supported filter types. - Additional values may be added in the future without notice. - type: string - enum: - - EXISTS - - RANGE - - TERMS - example: RANGE - range: - type: object - description: The range of values to be filtered. - properties: - lower: - description: The lower bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - example: '1' - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - example: false - upper: - description: The upper bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - example: '1' - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - example: false - terms: - description: The terms to be filtered. - type: array - items: - type: string - example: account_count - exclude: - description: Indicates if the filter excludes results. - type: boolean - default: false - example: false - example: {} - examples: - query-fields: - summary: Query with Fields - value: - indices: - - identities - query: - query: '"John Doe"' - fields: - - name - query-timeZone: - summary: Query with TimeZone - value: - indices: - - identities - query: - query: 'created: [2022-05-19T19:26:03.351Z TO now]' - timeZone: America/Los_Angeles - query-innerHit: - summary: Query with InnerHit - value: - indices: - - identities - query: - query: '"John Doe"' - innerHit: - type: access - query: 'source.name:\"Active Directory\"' - typeAheadQuery: - summary: TypeAheadQuery - value: - indices: - - identities - queryType: TYPEAHEAD - typeAheadQuery: - field: name - query: Jo - maxExpansions: 50 - typeAheadQuery-nestedType: - summary: TypeAheadQuery with NestedType - value: - indices: - - identities - queryType: TYPEAHEAD - typeAheadQuery: - field: source.name - nestedType: access - query: Work - maxExpansions: 50 - filter-exists: - summary: Filter with Exists - value: - indices: - - identities - query: - query: 'attributes.city:London' - filters: - attributes.cloudAuthoritativeSource: - type: EXISTS - exclude: true - filter-range: - summary: Filter with Range - value: - indices: - - identities - query: - query: 'attributes.city:London' - timeZone: Europe/London - filters: - accessCount: - type: RANGE - range: - lower: - value: '3' - created: - type: RANGE - range: - lower: - value: '2019-12-01' - inclusive: true - upper: - value: '2020-01-01' - filter-terms: - summary: Filter with Terms - value: - indices: - - identities - query: - query: 'attributes.city:London' - filters: - source.name: - type: TERMS - terms: - - HR Employees - - Corporate Active Directory - exclude: true - protected: - type: TERMS - terms: - - 'true' - required: true - responses: - '200': - description: List of matching documents. - content: - application/json: - schema: - type: array - items: - discriminator: - propertyName: _type - mapping: - accessprofile: ../model/access/profile/AccessProfileDocument.yaml - accountactivity: ../model/account/activity/AccountActivityDocument.yaml - account: ../model/account/AccountDocument.yaml - aggregation: ../model/aggregation/AggregationDocument.yaml - entitlement: ../model/entitlement/EntitlementDocument.yaml - event: ../model/event/EventDocument.yaml - identity: ../model/identity/IdentityDocument.yaml - role: ../model/role/RoleDocument.yaml - oneOf: - - description: 'This is more of a complete representation of an access profile. ' - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - name: - type: string - example: john.doe - _type: - description: |- - Enum representing the currently supported document types. - - Additional values may be added in the future without notice. - type: string - enum: - - accessprofile - - accountactivity - - account - - aggregation - - entitlement - - event - - identity - - role - example: identity - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - description: - type: string - description: The description of the access item - example: The admin role - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - enabled: - type: boolean - example: true - requestable: - type: boolean - example: true - description: Indicates if the access can be requested - requestCommentsRequired: - type: boolean - description: Indicates if comments are required when requesting access - example: false - owner: - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - - type: object - properties: - email: - type: string - example: john.doe@sailpoint.com - description: The email of the identity - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - entitlements: - type: array - items: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - description: - type: string - description: A description of the entitlement - example: The admin privilege - attribute: - type: string - description: The name of the entitlement attribute - example: admin - value: - type: string - description: The value of the entitlement - example: 'true' - entitlementCount: - type: integer - example: 5 - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - - description: AccountActivity - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - name: - type: string - example: john.doe - _type: - description: |- - Enum representing the currently supported document types. - - Additional values may be added in the future without notice. - type: string - enum: - - accessprofile - - accountactivity - - account - - aggregation - - entitlement - - event - - identity - - role - example: identity - - type: object - properties: - action: - type: string - description: The type of action that this activity performed - externalDocs: - description: Learn more about account activity action types - url: 'https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data' - example: Identity Refresh. - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - stage: - type: string - description: The current stage of the activity - example: Completed - origin: - type: string - nullable: true - example: null - status: - type: string - description: the current status of the activity - example: Complete - requester: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - recipient: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - trackingNumber: - type: string - example: 61aad0c9e8134eca89e76a35e0cabe3f - errors: - type: array - items: - type: string - nullable: true - example: null - warnings: - type: array - items: - type: string - nullable: true - example: null - approvals: - type: array - items: - type: object - properties: - comments: - type: array - items: - type: object - properties: - comment: - type: string - description: The comment text - example: This request was autoapproved by our automated ETS subscriber. - commenter: - type: string - description: The name of the commenter - example: Automated AR Approval - date: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - result: - type: string - description: The result of the approval - example: Finished - type: - type: string - nullable: true - example: null - originalRequests: - type: array - items: - type: object - properties: - accountId: - type: string - description: the account id - example: 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com' - attributeRequests: - type: array - items: - type: object - properties: - name: - type: string - description: The attribute name - example: groups - op: - type: string - description: The operation to perform - example: Add - value: - type: string - description: The value of the attribute - example: '3203537556531076' - op: - type: string - description: the operation that was used - example: add - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - expansionItems: - type: array - items: - type: object - properties: - accountId: - type: string - description: The ID of the account - example: 2c91808981f58ea601821c3e93482e6f - cause: - type: string - example: Role - name: - type: string - description: The name of the item - example: smartsheet-role - attributeRequests: - type: array - items: - type: object - properties: - name: - type: string - description: The attribute name - example: groups - op: - type: string - description: The operation to perform - example: Add - value: - type: string - description: The value of the attribute - example: '3203537556531076' - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - accountRequests: - type: array - items: - type: object - properties: - accountId: - type: string - description: Unique ID of the account - example: John.Doe - attributeRequests: - type: array - items: - type: object - properties: - name: - type: string - description: The attribute name - example: groups - op: - type: string - description: The operation to perform - example: Add - value: - type: string - description: The value of the attribute - example: '3203537556531076' - op: - type: string - example: Modify - description: The operation that was performed - provisioningTarget: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - result: - type: object - properties: - errors: - type: array - items: - type: string - example: |- - [ConnectorError] [ - { - "code": "unrecognized_keys", - "keys": [ - "groups" - ], - "path": [], - "message": "Unrecognized key(s) in object: 'groups'" - } - ] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e) - status: - type: string - description: The status of the account request - example: failed - ticketId: - type: string - nullable: true - example: null - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - sources: - type: string - example: 'smartsheet-test, airtable-v4, IdentityNow' - - description: Account - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - name: - type: string - example: john.doe - _type: - description: |- - Enum representing the currently supported document types. - - Additional values may be added in the future without notice. - type: string - enum: - - accessprofile - - accountactivity - - account - - aggregation - - entitlement - - event - - identity - - role - example: identity - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - accountId: - type: string - description: The ID of the account - example: john.doe - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - disabled: - type: boolean - description: Indicates if the account is disabled - example: false - locked: - type: boolean - description: Indicates if the account is locked - example: false - privileged: - type: boolean - example: false - manuallyCorrelated: - type: boolean - description: Indicates if the account has been manually correlated to an identity - example: false - passwordLastSet: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - entitlementAttributes: - type: object - nullable: true - description: a map or dictionary of key/value pairs - additionalProperties: true - example: - moderator: true - admin: true - trust_level: '4' - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - - type: object - properties: - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - attributes: - type: object - description: a map or dictionary of key/value pairs - additionalProperties: true - example: - firstName: John - lastName: Doe - displayName: John.Doe - identity: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe - access: - type: array - items: - description: EntitlementReference - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - example: null - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - privileged: - type: boolean - example: false - attribute: - type: string - example: memberOf - value: - type: string - example: 'CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' - standalone: - type: boolean - example: false - entitlementCount: - type: integer - description: The number of entitlements assigned to the account - format: int32 - example: 2 - uncorrelated: - type: boolean - description: Indicates if the account is not correlated to an identity - example: false - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - - description: Aggregation - allOf: - - type: object - required: - - id - - name - - _type + access: + type: object properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - name: - type: string - example: john.doe - _type: - description: |- - Enum representing the currently supported document types. - - Additional values may be added in the future without notice. + type: + description: The type of item being certified type: string enum: - - accessprofile - - accountactivity - - account - - aggregation - - entitlement - - event - - identity - - role - example: identity - - type: object - properties: - status: - type: string - example: Success - duration: - type: integer - format: int32 - example: 20 - avgDuration: - type: integer - format: int32 - example: 20 - changedAccounts: - type: integer - format: int32 - example: 1 - nextScheduled: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - startTime: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - sourceOwner: - type: string - description: John Doe - - description: Entitlement - allOf: - - type: object - required: - - id - - name - - _type - properties: + - 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 + - WORKGROUP + example: IDENTITY id: type: string - example: 2c91808375d8e80a0175e1f88a575222 + description: The ID of the item being certified + example: 2c9180867160846801719932c5153fb7 name: type: string - example: john.doe - _type: - description: |- - Enum representing the currently supported document types. - - Additional values may be added in the future without notice. - type: string - enum: - - accessprofile - - accountactivity - - account - - aggregation - - entitlement - - event - - identity - - role - example: identity - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - description: - type: string - description: A description of the entitlement - example: The admin privilege - attribute: - type: string - description: The name of the entitlement attribute - example: admin - value: - type: string - description: The value of the entitlement - example: 'true' - - type: object + description: The name of the item being certified + example: Entitlement for Company Database + entitlement: + type: object + nullable: true properties: - modified: + id: type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: + description: The id for the entitlement + example: 2c918085718230600171993742c63558 + name: type: string + description: The name of the entitlement + example: CN=entitlement.bbb7c650 + description: nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - displayName: type: string - description: The display name of the entitlement - example: Admin - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. + description: Information about the entitlement + example: Gives read/write access to the company database privileged: type: boolean example: false - identityCount: - type: integer - format: int32 - example: 3 - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - - description: Event - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - name: - type: string - example: john.doe - _type: - description: |- - Enum representing the currently supported document types. - - Additional values may be added in the future without notice. - type: string - enum: - - accessprofile - - accountactivity - - account - - aggregation - - entitlement - - event - - identity - - role - example: identity - - type: object - properties: - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - action: - type: string - description: The action that was performed - example: update - type: - type: string - description: The type of event - example: SYSTEM_CONFIG - actor: - type: object - properties: - name: - type: string - example: John Doe - description: the actor or target name - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - target: + description: Indicates if the entitlement is a privileged entitlement + owner: type: object + nullable: true properties: - name: - type: string - example: John Doe - description: the actor or target name 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + description: The type can only be IDENTITY. This is read-only example: IDENTITY - stack: - type: string - example: tpe - trackingNumber: - type: string - example: 63f891e0735f4cc8bf1968144a1e7440 - ipAddress: - type: string - example: 52.52.97.85 - details: - type: string - example: 73b65dfbed1842548c207432a18c84b0 - attributes: - type: object - additionalProperties: true - example: - pod: stg03-useast1 - org: acme - sourceName: SailPoint - objects: - type: array - items: - type: string - example: AUTHENTICATION - operation: - type: string - example: REQUEST - status: - type: string - example: PASSED - technicalName: - type: string - example: AUTHENTICATION_REQUEST_PASSED - - description: Identity - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - name: - type: string - example: john.doe - _type: - description: |- - Enum representing the currently supported document types. - - Additional values may be added in the future without notice. - type: string - enum: - - accessprofile - - accountactivity - - account - - aggregation - - entitlement - - event - - identity - - role - example: identity - - allOf: - - type: object - properties: id: type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. + description: Identity id. + example: 5168015d32f890ca15812c9180835d2e name: type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: + description: Human-readable display name of identity. This is read-only + example: Alison Ferguso + email: type: string - example: John Q. Doe - - type: object - properties: - firstName: - type: string - description: The first name of the identity - example: Carol - lastName: - type: string - description: The last name of the identity - example: Adams - displayName: - type: string - example: Carol.Adams - description: The display name of the identity - email: + description: Email address of identity. This is read-only + example: alison.ferguso@identitysoon.com + attributeName: type: string - description: The identity's primary email address - example: Carol.Adams@sailpointdemo.com - created: + description: The name of the attribute on the source + example: memberOf + attributeValue: type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: + description: The value of the attribute on the source + example: CN=entitlement.bbb7c650 + sourceSchemaObjectType: type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: + description: The schema object type on the source used to represent the entitlement and its attributes + example: groups + sourceName: type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - phone: + description: The name of the source for which this entitlement belongs + example: ODS-AD-Source + sourceType: type: string - description: The phone number of the identity - example: +1 440-527-3672 - inactive: + description: The type of the source for which the entitlement belongs + example: Active Directory - Direct + hasPermissions: type: boolean - description: Indicates if the identity is inactive + description: Indicates if the entitlement has permissions example: false - protected: + isPermission: type: boolean + description: Indicates if the entitlement is a representation of an account permission example: false - status: - type: string - description: The identity's status in SailPoint - example: UNREGISTERED - employeeNumber: - type: string - example: 1a2a3d4e - manager: - nullable: true - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe - isManager: + revocable: type: boolean - description: Indicates if this identity is a manager of other identities - example: false - identityProfile: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - attributes: + description: Indicates whether the entitlement can be revoked + example: true + cloudGoverned: + type: boolean + description: True if the entitlement is cloud governed + example: false + account: type: object - description: a map or dictionary of key/value pairs - additionalProperties: true - example: - country: US - firstname: Carol - cloudStatus: UNREGISTERED - processingState: - type: string - nullable: true - example: null - processingDetails: nullable: true - type: object + description: Information about the status of the entitlement properties: - date: + nativeIdentity: + type: string + description: The native identity for this account + example: CN=Alison Ferguso + disabled: + type: boolean + example: false + description: Indicates whether this account is currently disabled + locked: + type: boolean + example: false + description: Indicates whether this account is currently locked + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + id: nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - stage: type: string - example: In Process - retryCount: - type: integer - example: 0 - format: int32 - stackTrace: + description: The id associated with the account + example: 2c9180857182305e0171993737eb29e6 + name: + nullable: true type: string - example: - message: + description: The account name + example: Alison Ferguso + created: + nullable: true type: string - example: - accounts: - type: array - description: List of accounts associated with the identity - items: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - accountId: - type: string - description: The ID of the account - example: john.doe - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - disabled: - type: boolean - description: Indicates if the account is disabled - example: false - locked: - type: boolean - description: Indicates if the account is locked - example: false - privileged: - type: boolean - example: false - manuallyCorrelated: - type: boolean - description: Indicates if the account has been manually correlated to an identity - example: false - passwordLastSet: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - entitlementAttributes: - type: object - nullable: true - description: a map or dictionary of key/value pairs - additionalProperties: true - example: - moderator: true - admin: true - trust_level: '4' - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - accountCount: - type: integer - description: Number of accounts associated with the identity - format: int32 - example: 3 - apps: - type: array - description: The list of applications the identity has access to - items: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - account: - type: object - properties: - id: - type: string - description: The SailPoint generated unique ID - example: 2c9180837dfe6949017e21f3d8cd6d49 - accountId: - type: string - description: The account ID generated by the source - example: 'CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' - appCount: - type: integer - format: int32 - description: The number of applications the identity has access to - example: 2 - access: - type: array - description: The list of access items assigned to the identity - items: - discriminator: - propertyName: type - mapping: - ACCESS_PROFILE: ../access/AccessProfileSummary.yaml - ENTITLEMENT: ../access/AccessProfileEntitlement.yaml - ROLE: ../access/AccessProfileRole.yaml - oneOf: - - description: This is a summary representation of an access profile. - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - example: null - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe - revocable: - type: boolean - example: true - - description: EntitlementReference - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - example: null - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - privileged: - type: boolean - example: false - attribute: - type: string - example: memberOf - value: - type: string - example: 'CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' - standalone: - type: boolean - example: false - - description: Role - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - example: null - - type: object - properties: - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe - disabled: - type: boolean - revocable: - type: boolean - accessCount: - type: integer - format: int32 - description: The number of access items assigned to the identity - example: 5 - accessProfileCount: - type: integer - description: The number of access profiles assigned to the identity - example: 1 - entitlementCount: - type: integer - description: The number of entitlements assigned to the identity - example: 10 - roleCount: - type: integer - description: The number of roles assigned to the identity - example: 1 - owns: + format: date-time + description: When the account was created + example: '2020-04-20T20:11:05.067Z' + modified: + nullable: true + type: string + format: date-time + description: When the account was last modified + example: '2020-05-20T18:57:16.987Z' + accessProfile: + type: object + properties: + id: + type: string + description: The id of the Access Profile + example: 2c91808a7190d06e01719938fcd20792 + name: + type: string + description: Name of the Access Profile + example: Employee-database-read-write + description: + type: string + description: Information about the Access Profile + example: Collection of entitlements to read/write the employee database + privileged: + type: boolean + description: Indicates if the entitlement is a privileged entitlement + example: false + cloudGoverned: + type: boolean + description: True if the entitlement is cloud governed + example: false + endDate: + nullable: true + type: string + format: date-time + description: The date at which a user's access expires + example: '2021-12-25T00:00:00.000Z' + owner: + description: Owner of the Access Profile type: object + nullable: true properties: - sources: - type: array - items: + type: + type: string + description: The type can only be IDENTITY. This is read-only + example: IDENTITY + id: + type: string + description: Identity id. + example: 5168015d32f890ca15812c9180835d2e + name: + type: string + description: Human-readable display name of identity. This is read-only + example: Alison Ferguso + email: + type: string + description: Email address of identity. This is read-only + example: alison.ferguso@identitysoon.com + entitlements: + type: array + description: A list of entitlements associated with this Access Profile + items: + type: object + nullable: true + properties: + id: + type: string + description: The id for the entitlement + example: 2c918085718230600171993742c63558 + name: + type: string + description: The name of the entitlement + example: CN=entitlement.bbb7c650 + description: + nullable: true + type: string + description: Information about the entitlement + example: Gives read/write access to the company database + privileged: + type: boolean + example: false + description: Indicates if the entitlement is a privileged entitlement + owner: type: object + nullable: true properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: + type: type: string - example: John Doe - description: The human readable name of the referenced object. - entitlements: - type: array - items: - type: object - properties: + description: The type can only be IDENTITY. This is read-only + example: IDENTITY id: type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. + description: Identity id. + example: 5168015d32f890ca15812c9180835d2e name: type: string - example: John Doe - description: The human readable name of the referenced object. - accessProfiles: - type: array - items: + description: Human-readable display name of identity. This is read-only + example: Alison Ferguso + email: + type: string + description: Email address of identity. This is read-only + example: alison.ferguso@identitysoon.com + attributeName: + type: string + description: The name of the attribute on the source + example: memberOf + attributeValue: + type: string + description: The value of the attribute on the source + example: CN=entitlement.bbb7c650 + sourceSchemaObjectType: + type: string + description: The schema object type on the source used to represent the entitlement and its attributes + example: groups + sourceName: + type: string + description: The name of the source for which this entitlement belongs + example: ODS-AD-Source + sourceType: + type: string + description: The type of the source for which the entitlement belongs + example: Active Directory - Direct + hasPermissions: + type: boolean + description: Indicates if the entitlement has permissions + example: false + isPermission: + type: boolean + description: Indicates if the entitlement is a representation of an account permission + example: false + revocable: + type: boolean + description: Indicates whether the entitlement can be revoked + example: true + cloudGoverned: + type: boolean + description: True if the entitlement is cloud governed + example: false + account: type: object + nullable: true + description: Information about the status of the entitlement properties: - id: + nativeIdentity: type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: + description: The native identity for this account + example: CN=Alison Ferguso + disabled: + type: boolean + example: false + description: Indicates whether this account is currently disabled + locked: + type: boolean + example: false + description: Indicates whether this account is currently locked + type: type: string - example: John Doe - description: The human readable name of the referenced object. - roles: - type: array - items: - type: object - properties: + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY id: + nullable: true type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. + description: The id associated with the account + example: 2c9180857182305e0171993737eb29e6 name: + nullable: true type: string - example: John Doe - description: The human readable name of the referenced object. - apps: - type: array - items: - type: object - properties: - id: + description: The account name + example: Alison Ferguso + created: + nullable: true type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: + format: date-time + description: When the account was created + example: '2020-04-20T20:11:05.067Z' + modified: + nullable: true type: string - example: John Doe - description: The human readable name of the referenced object. - governanceGroups: - type: array - items: + format: date-time + description: When the account was last modified + example: '2020-05-20T18:57:16.987Z' + created: + type: string + description: Date the Access Profile was created. + format: date-time + example: '2021-01-01T22:32:58.104Z' + modified: + type: string + description: Date the Access Profile was last modified. + format: date-time + example: '2021-02-01T22:32:58.104Z' + role: + type: object + nullable: true + properties: + id: + type: string + description: The id for the Role + example: 2c91808a7190d06e0171993907fd0794 + name: + type: string + description: The name of the Role + example: Accounting-Employees + description: + type: string + description: Information about the Role + example: Role for members of the accounting department with the necessary Access Profiles + privileged: + type: boolean + description: Indicates if the entitlement is a privileged entitlement + example: false + owner: + type: object + nullable: true + properties: + type: + type: string + description: The type can only be IDENTITY. This is read-only + example: IDENTITY + id: + type: string + description: Identity id. + example: 5168015d32f890ca15812c9180835d2e + name: + type: string + description: Human-readable display name of identity. This is read-only + example: Alison Ferguso + email: + type: string + description: Email address of identity. This is read-only + example: alison.ferguso@identitysoon.com + revocable: + type: boolean + description: Indicates whether the Role can be revoked or requested + example: false + endDate: + type: string + format: date-time + description: The date when a user's access expires. + example: '2021-12-25T00:00:00.000Z' + accessProfiles: + type: array + description: The list of Access Profiles associated with this Role + items: + type: object + properties: + id: + type: string + description: The id of the Access Profile + example: 2c91808a7190d06e01719938fcd20792 + name: + type: string + description: Name of the Access Profile + example: Employee-database-read-write + description: + type: string + description: Information about the Access Profile + example: Collection of entitlements to read/write the employee database + privileged: + type: boolean + description: Indicates if the entitlement is a privileged entitlement + example: false + cloudGoverned: + type: boolean + description: True if the entitlement is cloud governed + example: false + endDate: + nullable: true + type: string + format: date-time + description: The date at which a user's access expires + example: '2021-12-25T00:00:00.000Z' + owner: + description: Owner of the Access Profile type: object + nullable: true properties: + type: + type: string + description: The type can only be IDENTITY. This is read-only + example: IDENTITY id: type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. + description: Identity id. + example: 5168015d32f890ca15812c9180835d2e name: type: string - example: John Doe - description: The human readable name of the referenced object. - fallbackApprover: - type: boolean - example: false - tags: - type: array - items: + description: Human-readable display name of identity. This is read-only + example: Alison Ferguso + email: + type: string + description: Email address of identity. This is read-only + example: alison.ferguso@identitysoon.com + entitlements: + type: array + description: A list of entitlements associated with this Access Profile + items: + type: object + nullable: true + properties: + id: + type: string + description: The id for the entitlement + example: 2c918085718230600171993742c63558 + name: + type: string + description: The name of the entitlement + example: CN=entitlement.bbb7c650 + description: + nullable: true + type: string + description: Information about the entitlement + example: Gives read/write access to the company database + privileged: + type: boolean + example: false + description: Indicates if the entitlement is a privileged entitlement + owner: + type: object + nullable: true + properties: + type: + type: string + description: The type can only be IDENTITY. This is read-only + example: IDENTITY + id: + type: string + description: Identity id. + example: 5168015d32f890ca15812c9180835d2e + name: + type: string + description: Human-readable display name of identity. This is read-only + example: Alison Ferguso + email: + type: string + description: Email address of identity. This is read-only + example: alison.ferguso@identitysoon.com + attributeName: + type: string + description: The name of the attribute on the source + example: memberOf + attributeValue: + type: string + description: The value of the attribute on the source + example: CN=entitlement.bbb7c650 + sourceSchemaObjectType: + type: string + description: The schema object type on the source used to represent the entitlement and its attributes + example: groups + sourceName: + type: string + description: The name of the source for which this entitlement belongs + example: ODS-AD-Source + sourceType: + type: string + description: The type of the source for which the entitlement belongs + example: Active Directory - Direct + hasPermissions: + type: boolean + description: Indicates if the entitlement has permissions + example: false + isPermission: + type: boolean + description: Indicates if the entitlement is a representation of an account permission + example: false + revocable: + type: boolean + description: Indicates whether the entitlement can be revoked + example: true + cloudGoverned: + type: boolean + description: True if the entitlement is cloud governed + example: false + account: + type: object + nullable: true + description: Information about the status of the entitlement + properties: + nativeIdentity: + type: string + description: The native identity for this account + example: CN=Alison Ferguso + disabled: + type: boolean + example: false + description: Indicates whether this account is currently disabled + locked: + type: boolean + example: false + description: Indicates whether this account is currently locked + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + id: + nullable: true + type: string + description: The id associated with the account + example: 2c9180857182305e0171993737eb29e6 + name: + nullable: true + type: string + description: The account name + example: Alison Ferguso + created: + nullable: true + type: string + format: date-time + description: When the account was created + example: '2020-04-20T20:11:05.067Z' + modified: + nullable: true + type: string + format: date-time + description: When the account was last modified + example: '2020-05-20T18:57:16.987Z' + created: + type: string + description: Date the Access Profile was created. + format: date-time + example: '2021-01-01T22:32:58.104Z' + modified: + type: string + description: Date the Access Profile was last modified. + format: date-time + example: '2021-02-01T22:32:58.104Z' + identitySummary: + type: object + properties: + id: + type: string + description: The ID of the identity summary + example: 2c91808772a504f50172a9540e501ba7 + name: + type: string + description: Name of the linked identity + example: Alison Ferguso + identityId: + type: string + description: The ID of the identity being certified + example: 2c9180857182306001719937377a33de + completed: + type: boolean + description: Indicates whether the review items for the linked identity's certification have been completed + example: true + id: + type: string + description: The review item's id + example: ef38f94347e94562b5bb8424a56397d8 + completed: + type: boolean + description: Whether the review item is complete + example: false + newAccess: + type: boolean + description: Indicates whether the review item is for new access to a source + example: false + decision: + type: string + description: The decision to approve or revoke the review item + enum: + - APPROVE + - REVOKE + example: APPROVE + comments: + nullable: true + type: string + description: Comments for this review item + example: This user still needs access to this source + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + '/certifications/{id}/decide': + post: + operationId: makeIdentityDecision + tags: + - Certifications + summary: Decide on a Certification Item + description: The API makes a decision to approve or revoke one or more identity campaign certification items. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + parameters: + - in: path + name: id + schema: + type: string + required: true + description: The ID of the identity campaign certification on which to make decisions + example: ef38f94347e94562b5bb8424a56397d8 + requestBody: + required: true + description: A non-empty array of decisions to be made. + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: string + description: The id of the review decision + example: ef38f94347e94562b5bb8424a56397d8 + decision: + type: string + description: The decision to approve or revoke the review item + enum: + - APPROVE + - REVOKE + example: APPROVE + proposedEndDate: + type: string + format: date-time + example: '2017-07-11T18:45:37.098Z' + description: The date at which a user's access should be taken away. Should only be set for `REVOKE` decisions. + bulk: + type: boolean + description: Indicates whether decision should be marked as part of a larger bulk decision + example: true + recommendation: + nullable: true + type: object + properties: + recommendation: + type: string + description: The recommendation from IAI at the time of the decision. This field will be null if no recommendation was made. + example: null + nullable: true + reasons: + type: array + items: + type: string + description: A list of reasons for the recommendation. + example: + - Reason 1 + - Reason 2 + timestamp: + type: string + format: date-time + description: The time at which the recommendation was recorded. + example: '2020-06-01T13:49:37.385Z' + comments: + type: string + description: Comments recorded when the decision was made + example: This user no longer needs access to this source + required: + - id + - decision + - bulk + minItems: 1 + maxItems: 250 + example: + - id: ef38f94347e94562b5bb8424a56396b5 + decision: APPROVE + bulk: true + comments: This user still needs access to this source. + - id: ef38f94347e94562b5bb8424a56397d8 + decision: APPROVE + bulk: true + comments: This user still needs access to this source too. + responses: + '200': + description: An identity campaign certification object + content: + application/json: + schema: + type: object + properties: + id: + example: 2c9180835d2e5168015d32f890ca1581 + type: string + description: id of the certification + name: + example: 'Source Owner Access Review for Employees [source]' + type: string + description: name of the certification + campaign: + type: object + required: + - id + - name + - type + - campaignType + - description + - correlatedStatus + - mandatoryCommentRequirement + properties: + id: + type: string + description: The unique ID of the campaign. + example: ef38f94347e94562b5bb8424a56397d8 + name: + type: string + description: The name of the campaign. + example: Campaign Name + type: + type: string + enum: + - CAMPAIGN + description: The type of object that is being referenced. + example: CAMPAIGN + campaignType: + type: string + enum: + - MANAGER + - SOURCE_OWNER + - SEARCH + description: The type of the campaign. + example: MANAGER + description: + type: string + description: The description of the campaign set by the admin who created it. + nullable: true + example: A description of the campaign + 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 + 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 + completed: + type: boolean + description: Have all decisions been made? + example: true + identitiesCompleted: + type: integer + description: The number of identities for whom all decisions have been made and are complete. + example: 5 + format: int32 + identitiesTotal: + type: integer + description: 'The total number of identities in the Certification, both complete and incomplete.' + example: 10 + format: int32 + created: + example: '2018-06-25T20:22:28.104Z' + format: date-time + type: string + description: created date + modified: + example: '2018-06-25T20:22:28.104Z' + format: date-time + type: string + description: modified date + decisionsMade: + type: integer + description: The number of approve/revoke/acknowledge decisions that have been made. + example: 20 + format: int32 + decisionsTotal: + type: integer + description: The total number of approve/revoke/acknowledge decisions. + example: 40 + format: int32 + due: + type: string + format: date-time + description: The due date of the certification. + example: '2018-10-19T13:49:37.385Z' + signed: + type: string + format: date-time + nullable: true + description: The date the reviewer signed off on the Certification. + example: '2018-10-19T13:49:37.385Z' + reviewer: + type: object + properties: + id: + type: string + description: The id of the reviewer. + example: ef38f94347e94562b5bb8424a56397d8 + name: + type: string + description: The name of the reviewer. + example: Reviewer Name + email: + type: string + description: The email of the reviewing identity. + example: reviewer@test.com + type: + type: string + enum: + - IDENTITY + description: The type of the reviewing identity. + example: IDENTITY + created: + nullable: true + example: '2018-06-25T20:22:28.104Z' + format: date-time + type: string + description: The created date of the reviewing identity. + modified: + nullable: true + example: '2018-06-25T20:22:28.104Z' + format: date-time + type: string + description: The modified date of the reviewing identity. + reassignment: + type: object + nullable: true + properties: + from: + type: object + properties: + id: + type: string + description: The id of the certification. + example: ef38f94347e94562b5bb8424a56397d8 + name: + type: string + description: The name of the certification. + example: Certification Name + type: + type: string + enum: + - CERTIFICATION + example: CERTIFICATION + reviewer: + type: object + properties: + id: + type: string + description: The id of the reviewer. + example: ef38f94347e94562b5bb8424a56397d8 + name: + type: string + description: The name of the reviewer. + example: Reviewer Name + email: + type: string + description: The email of the reviewing identity. + example: reviewer@test.com + type: + type: string + enum: + - IDENTITY + description: The type of the reviewing identity. + example: IDENTITY + created: + nullable: true + example: '2018-06-25T20:22:28.104Z' + format: date-time + type: string + description: The created date of the reviewing identity. + modified: + nullable: true + example: '2018-06-25T20:22:28.104Z' + format: date-time + type: string + description: The modified date of the reviewing identity. + comment: + type: string + description: The comment entered when the Certification was reassigned + example: Reassigned for a reason + hasErrors: + description: Identifies if the certification has an error + type: boolean + example: false + errorMessage: + description: Description of the certification error + nullable: true + type: string + example: The certification has an error + phase: + type: string + description: | + The current phase of the campaign. + * `STAGED`: The campaign is waiting to be activated. + * `ACTIVE`: The campaign is active. + * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. + enum: + - STAGED + - ACTIVE + - SIGNED + example: ACTIVE + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + '/certifications/{id}/reassign': + post: + operationId: reassignIdentityCertifications + tags: + - Certifications + summary: Reassign Identities or Items + description: This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + parameters: + - in: path + name: id + schema: + type: string + required: true + description: The identity campaign certification ID + example: ef38f94347e94562b5bb8424a56397d8 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + reassign: + type: array + items: + type: object + properties: + id: + type: string + description: The ID of item or identity being reassigned. + example: ef38f94347e94562b5bb8424a56397d8 + type: + type: string + description: The type of item or identity being reassigned. + enum: + - TARGET_SUMMARY + - ITEM + - IDENTITY_SUMMARY + example: ITEM + required: + - id + - type + reassignTo: + type: string + description: The ID of the identity to which the certification is reassigned + example: ef38f94347e94562b5bb8424a56397d8 + reason: + type: string + description: The reason comment for why the reassign was made + example: reassigned for some reason + required: + - reassign + - reassignTo + - reason + responses: + '200': + description: An identity campaign certification details after completing the reassignment. + content: + application/json: + schema: + type: object + properties: + id: + example: 2c9180835d2e5168015d32f890ca1581 + type: string + description: id of the certification + name: + example: 'Source Owner Access Review for Employees [source]' + type: string + description: name of the certification + campaign: + type: object + required: + - id + - name + - type + - campaignType + - description + - correlatedStatus + - mandatoryCommentRequirement + properties: + id: + type: string + description: The unique ID of the campaign. + example: ef38f94347e94562b5bb8424a56397d8 + name: + type: string + description: The name of the campaign. + example: Campaign Name + type: + type: string + enum: + - CAMPAIGN + description: The type of object that is being referenced. + example: CAMPAIGN + campaignType: + type: string + enum: + - MANAGER + - SOURCE_OWNER + - SEARCH + description: The type of the campaign. + example: MANAGER + description: + type: string + description: The description of the campaign set by the admin who created it. + nullable: true + example: A description of the campaign + 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 + 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 + completed: + type: boolean + description: Have all decisions been made? + example: true + identitiesCompleted: + type: integer + description: The number of identities for whom all decisions have been made and are complete. + example: 5 + format: int32 + identitiesTotal: + type: integer + description: 'The total number of identities in the Certification, both complete and incomplete.' + example: 10 + format: int32 + created: + example: '2018-06-25T20:22:28.104Z' + format: date-time + type: string + description: created date + modified: + example: '2018-06-25T20:22:28.104Z' + format: date-time + type: string + description: modified date + decisionsMade: + type: integer + description: The number of approve/revoke/acknowledge decisions that have been made. + example: 20 + format: int32 + decisionsTotal: + type: integer + description: The total number of approve/revoke/acknowledge decisions. + example: 40 + format: int32 + due: + type: string + format: date-time + description: The due date of the certification. + example: '2018-10-19T13:49:37.385Z' + signed: + type: string + format: date-time + nullable: true + description: The date the reviewer signed off on the Certification. + example: '2018-10-19T13:49:37.385Z' + reviewer: + type: object + properties: + id: + type: string + description: The id of the reviewer. + example: ef38f94347e94562b5bb8424a56397d8 + name: + type: string + description: The name of the reviewer. + example: Reviewer Name + email: + type: string + description: The email of the reviewing identity. + example: reviewer@test.com + type: + type: string + enum: + - IDENTITY + description: The type of the reviewing identity. + example: IDENTITY + created: + nullable: true + example: '2018-06-25T20:22:28.104Z' + format: date-time + type: string + description: The created date of the reviewing identity. + modified: + nullable: true + example: '2018-06-25T20:22:28.104Z' + format: date-time + type: string + description: The modified date of the reviewing identity. + reassignment: + type: object + nullable: true + properties: + from: + type: object + properties: + id: + type: string + description: The id of the certification. + example: ef38f94347e94562b5bb8424a56397d8 + name: + type: string + description: The name of the certification. + example: Certification Name + type: + type: string + enum: + - CERTIFICATION + example: CERTIFICATION + reviewer: + type: object + properties: + id: + type: string + description: The id of the reviewer. + example: ef38f94347e94562b5bb8424a56397d8 + name: + type: string + description: The name of the reviewer. + example: Reviewer Name + email: + type: string + description: The email of the reviewing identity. + example: reviewer@test.com + type: + type: string + enum: + - IDENTITY + description: The type of the reviewing identity. + example: IDENTITY + created: + nullable: true + example: '2018-06-25T20:22:28.104Z' + format: date-time + type: string + description: The created date of the reviewing identity. + modified: + nullable: true + example: '2018-06-25T20:22:28.104Z' + format: date-time + type: string + description: The modified date of the reviewing identity. + comment: + type: string + description: The comment entered when the Certification was reassigned + example: Reassigned for a reason + hasErrors: + description: Identifies if the certification has an error + type: boolean + example: false + errorMessage: + description: Description of the certification error + nullable: true + type: string + example: The certification has an error + phase: + type: string + description: | + The current phase of the campaign. + * `STAGED`: The campaign is waiting to be activated. + * `ACTIVE`: The campaign is active. + * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. + enum: + - STAGED + - ACTIVE + - SIGNED + example: ACTIVE + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + '/certifications/{id}/sign-off': + post: + operationId: signOffIdentityCertification + tags: + - Certifications + summary: Finalize Identity Certification Decisions + description: This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + parameters: + - in: path + name: id + schema: + type: string + required: true + description: The identity campaign certification ID + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '200': + description: An identity campaign certification object + content: + application/json: + schema: + type: object + properties: + id: + example: 2c9180835d2e5168015d32f890ca1581 + type: string + description: id of the certification + name: + example: 'Source Owner Access Review for Employees [source]' + type: string + description: name of the certification + campaign: + type: object + required: + - id + - name + - type + - campaignType + - description + - correlatedStatus + - mandatoryCommentRequirement + properties: + id: + type: string + description: The unique ID of the campaign. + example: ef38f94347e94562b5bb8424a56397d8 + name: + type: string + description: The name of the campaign. + example: Campaign Name + type: + type: string + enum: + - CAMPAIGN + description: The type of object that is being referenced. + example: CAMPAIGN + campaignType: + type: string + enum: + - MANAGER + - SOURCE_OWNER + - SEARCH + description: The type of the campaign. + example: MANAGER + description: + type: string + description: The description of the campaign set by the admin who created it. + nullable: true + example: A description of the campaign + 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 + 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 + completed: + type: boolean + description: Have all decisions been made? + example: true + identitiesCompleted: + type: integer + description: The number of identities for whom all decisions have been made and are complete. + example: 5 + format: int32 + identitiesTotal: + type: integer + description: 'The total number of identities in the Certification, both complete and incomplete.' + example: 10 + format: int32 + created: + example: '2018-06-25T20:22:28.104Z' + format: date-time + type: string + description: created date + modified: + example: '2018-06-25T20:22:28.104Z' + format: date-time + type: string + description: modified date + decisionsMade: + type: integer + description: The number of approve/revoke/acknowledge decisions that have been made. + example: 20 + format: int32 + decisionsTotal: + type: integer + description: The total number of approve/revoke/acknowledge decisions. + example: 40 + format: int32 + due: + type: string + format: date-time + description: The due date of the certification. + example: '2018-10-19T13:49:37.385Z' + signed: + type: string + format: date-time + nullable: true + description: The date the reviewer signed off on the Certification. + example: '2018-10-19T13:49:37.385Z' + reviewer: + type: object + properties: + id: + type: string + description: The id of the reviewer. + example: ef38f94347e94562b5bb8424a56397d8 + name: + type: string + description: The name of the reviewer. + example: Reviewer Name + email: + type: string + description: The email of the reviewing identity. + example: reviewer@test.com + type: + type: string + enum: + - IDENTITY + description: The type of the reviewing identity. + example: IDENTITY + created: + nullable: true + example: '2018-06-25T20:22:28.104Z' + format: date-time + type: string + description: The created date of the reviewing identity. + modified: + nullable: true + example: '2018-06-25T20:22:28.104Z' + format: date-time + type: string + description: The modified date of the reviewing identity. + reassignment: + type: object + nullable: true + properties: + from: + type: object + properties: + id: + type: string + description: The id of the certification. + example: ef38f94347e94562b5bb8424a56397d8 + name: + type: string + description: The name of the certification. + example: Certification Name + type: + type: string + enum: + - CERTIFICATION + example: CERTIFICATION + reviewer: + type: object + properties: + id: + type: string + description: The id of the reviewer. + example: ef38f94347e94562b5bb8424a56397d8 + name: + type: string + description: The name of the reviewer. + example: Reviewer Name + email: + type: string + description: The email of the reviewing identity. + example: reviewer@test.com + type: + type: string + enum: + - IDENTITY + description: The type of the reviewing identity. + example: IDENTITY + created: + nullable: true + example: '2018-06-25T20:22:28.104Z' + format: date-time + type: string + description: The created date of the reviewing identity. + modified: + nullable: true + example: '2018-06-25T20:22:28.104Z' + format: date-time + type: string + description: The modified date of the reviewing identity. + comment: + type: string + description: The comment entered when the Certification was reassigned + example: Reassigned for a reason + hasErrors: + description: Identifies if the certification has an error + type: boolean + example: false + errorMessage: + description: Description of the certification error + nullable: true + type: string + example: The certification has an error + phase: + type: string + description: | + The current phase of the campaign. + * `STAGED`: The campaign is waiting to be activated. + * `ACTIVE`: The campaign is active. + * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. + enum: + - STAGED + - ACTIVE + - SIGNED + example: ACTIVE + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + '/certifications/{id}/decision-summary': + get: + operationId: getIdentityDecisionSummary + tags: + - Certification Summaries + summary: Summary of Certification Decisions + description: This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + parameters: + - in: path + name: id + schema: + type: string + required: true + description: The certification ID + example: ef38f94347e94562b5bb8424a56397d8 + - in: query + name: filters + required: false + schema: + type: string + example: identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8" + 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: + + **identitySummary.id**: *eq, in* + responses: + '200': + description: Summary of the decisions made + content: + application/json: + schema: + type: object + properties: + entitlementDecisionsMade: + type: integer + description: Number of entitlement decisions that have been made + example: 3 + format: int32 + accessProfileDecisionsMade: + type: integer + description: Number of access profile decisions that have been made + example: 5 + format: int32 + roleDecisionsMade: + type: integer + description: Number of role decisions that have been made + example: 2 + format: int32 + accountDecisionsMade: + type: integer + description: Number of account decisions that have been made + example: 4 + format: int32 + entitlementDecisionsTotal: + type: integer + description: 'The total number of entitlement decisions on the certification, both complete and incomplete' + example: 6 + format: int32 + accessProfileDecisionsTotal: + type: integer + description: 'The total number of access profile decisions on the certification, both complete and incomplete' + example: 10 + format: int32 + roleDecisionsTotal: + type: integer + description: 'The total number of role decisions on the certification, both complete and incomplete' + example: 4 + format: int32 + accountDecisionsTotal: + type: integer + description: 'The total number of account decisions on the certification, both complete and incomplete' + example: 8 + format: int32 + entitlementsApproved: + type: integer + description: The number of entitlement decisions that have been made which were approved + example: 2 + format: int32 + entitlementsRevoked: + type: integer + description: The number of entitlement decisions that have been made which were revoked + example: 1 + format: int32 + accessProfilesApproved: + type: integer + description: The number of access profile decisions that have been made which were approved + example: 3 + format: int32 + accessProfilesRevoked: + type: integer + description: The number of access profile decisions that have been made which were revoked + example: 2 + format: int32 + rolesApproved: + type: integer + description: The number of role decisions that have been made which were approved + example: 2 + format: int32 + rolesRevoked: + type: integer + description: The number of role decisions that have been made which were revoked + example: 0 + format: int32 + accountsApproved: + type: integer + description: The number of account decisions that have been made which were approved + example: 1 + format: int32 + accountsRevoked: + type: integer + description: The number of account decisions that have been made which were revoked + example: 3 + format: int32 + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + '/certifications/{id}/identity-summaries': + get: + operationId: getIdentitySummaries + tags: + - Certification Summaries + summary: Identity Summaries for Campaign Certification + description: This API returns a list of the identity summaries for a specific identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + parameters: + - in: path + name: id + schema: + type: string + required: true + description: The identity campaign certification ID + example: ef38f94347e94562b5bb8424a56397d8 + - 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 + required: false + schema: + type: string + example: id eq "ef38f94347e94562b5bb8424a56397d8" + 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* + + **completed**: *eq, ne* + + **name**: *eq, sw* + - in: query + name: sorters + required: false + schema: + type: string + format: comma-separated + example: name + 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** + responses: + '200': + description: List of identity summaries + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: string + description: The ID of the identity summary + example: 2c91808772a504f50172a9540e501ba7 + name: + type: string + description: Name of the linked identity + example: Alison Ferguso + identityId: + type: string + description: The ID of the identity being certified + example: 2c9180857182306001719937377a33de + completed: + type: boolean + description: Indicates whether the review items for the linked identity's certification have been completed + example: true + example: + - id: 2c91808772a504f50172a9540e501ba7 + name: Aaron Grey + identityId: 2c9180857182306001719937379633e4 + completed: false + - id: 2c91808772a504f50172a9540e501ba8 + name: Aglae Wilson + identityId: 2c9180857182306001719937377a33de + completed: true + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + '/certifications/{id}/access-summaries/{type}': + get: + operationId: getIdentityAccessSummaries + tags: + - Certification Summaries + summary: Access Summaries + description: This API returns a list of access summaries for the specified identity campaign certification and type. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + parameters: + - in: path + name: id + schema: + type: string + required: true + description: The identity campaign certification ID + example: ef38f94347e94562b5bb8424a56397d8 + - in: path + name: type + schema: + type: string + enum: + - ROLE + - ACCESS_PROFILE + - ENTITLEMENT + required: true + description: The type of access review item to retrieve summaries for + example: ACCESS_PROFILE + - 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 + required: false + schema: + type: string + example: access.id eq "ef38f94347e94562b5bb8424a56397d8" + 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: + + **completed**: *eq, ne* + + **access.id**: *eq, in* + + **access.name**: *eq, sw* + + **entitlement.sourceName**: *eq, sw* + + **accessProfile.sourceName**: *eq, sw* + - in: query + name: sorters + required: false + schema: + type: string + format: comma-separated + example: access.name + 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: **access.name** + responses: + '200': + description: List of access summaries + content: + application/json: + schema: + type: array + items: + type: object + description: An object holding the access that is being reviewed + properties: + access: + type: object + properties: + type: + description: The type of item being certified + 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 + - WORKGROUP + example: IDENTITY + id: + type: string + description: The ID of the item being certified + example: 2c9180867160846801719932c5153fb7 + name: + type: string + description: The name of the item being certified + example: Entitlement for Company Database + entitlement: + type: object + nullable: true + properties: + id: + type: string + description: The id for the entitlement + example: 2c918085718230600171993742c63558 + name: + type: string + description: The name of the entitlement + example: CN=entitlement.bbb7c650 + description: + nullable: true + type: string + description: Information about the entitlement + example: Gives read/write access to the company database + privileged: + type: boolean + example: false + description: Indicates if the entitlement is a privileged entitlement + owner: + type: object + nullable: true + properties: + type: + type: string + description: The type can only be IDENTITY. This is read-only + example: IDENTITY + id: + type: string + description: Identity id. + example: 5168015d32f890ca15812c9180835d2e + name: + type: string + description: Human-readable display name of identity. This is read-only + example: Alison Ferguso + email: + type: string + description: Email address of identity. This is read-only + example: alison.ferguso@identitysoon.com + attributeName: + type: string + description: The name of the attribute on the source + example: memberOf + attributeValue: + type: string + description: The value of the attribute on the source + example: CN=entitlement.bbb7c650 + sourceSchemaObjectType: + type: string + description: The schema object type on the source used to represent the entitlement and its attributes + example: groups + sourceName: + type: string + description: The name of the source for which this entitlement belongs + example: ODS-AD-Source + sourceType: + type: string + description: The type of the source for which the entitlement belongs + example: Active Directory - Direct + hasPermissions: + type: boolean + description: Indicates if the entitlement has permissions + example: false + isPermission: + type: boolean + description: Indicates if the entitlement is a representation of an account permission + example: false + revocable: + type: boolean + description: Indicates whether the entitlement can be revoked + example: true + cloudGoverned: + type: boolean + description: True if the entitlement is cloud governed + example: false + account: + type: object + nullable: true + description: Information about the status of the entitlement + properties: + nativeIdentity: + type: string + description: The native identity for this account + example: CN=Alison Ferguso + disabled: + type: boolean + example: false + description: Indicates whether this account is currently disabled + locked: + type: boolean + example: false + description: Indicates whether this account is currently locked + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + id: + nullable: true + type: string + description: The id associated with the account + example: 2c9180857182305e0171993737eb29e6 + name: + nullable: true + type: string + description: The account name + example: Alison Ferguso + created: + nullable: true + type: string + format: date-time + description: When the account was created + example: '2020-04-20T20:11:05.067Z' + modified: + nullable: true + type: string + format: date-time + description: When the account was last modified + example: '2020-05-20T18:57:16.987Z' + accessProfile: + type: object + properties: + id: + type: string + description: The id of the Access Profile + example: 2c91808a7190d06e01719938fcd20792 + name: + type: string + description: Name of the Access Profile + example: Employee-database-read-write + description: + type: string + description: Information about the Access Profile + example: Collection of entitlements to read/write the employee database + privileged: + type: boolean + description: Indicates if the entitlement is a privileged entitlement + example: false + cloudGoverned: + type: boolean + description: True if the entitlement is cloud governed + example: false + endDate: + nullable: true + type: string + format: date-time + description: The date at which a user's access expires + example: '2021-12-25T00:00:00.000Z' + owner: + description: Owner of the Access Profile + type: object + nullable: true + properties: + type: + type: string + description: The type can only be IDENTITY. This is read-only + example: IDENTITY + id: + type: string + description: Identity id. + example: 5168015d32f890ca15812c9180835d2e + name: + type: string + description: Human-readable display name of identity. This is read-only + example: Alison Ferguso + email: + type: string + description: Email address of identity. This is read-only + example: alison.ferguso@identitysoon.com + entitlements: + type: array + description: A list of entitlements associated with this Access Profile + items: + type: object + nullable: true + properties: + id: type: string - example: - - TAG_1 - - TAG_2 - - description: Role - allOf: - - type: object - required: - - id - - name - - _type + description: The id for the entitlement + example: 2c918085718230600171993742c63558 + name: + type: string + description: The name of the entitlement + example: CN=entitlement.bbb7c650 + description: + nullable: true + type: string + description: Information about the entitlement + example: Gives read/write access to the company database + privileged: + type: boolean + example: false + description: Indicates if the entitlement is a privileged entitlement + owner: + type: object + nullable: true + properties: + type: + type: string + description: The type can only be IDENTITY. This is read-only + example: IDENTITY + id: + type: string + description: Identity id. + example: 5168015d32f890ca15812c9180835d2e + name: + type: string + description: Human-readable display name of identity. This is read-only + example: Alison Ferguso + email: + type: string + description: Email address of identity. This is read-only + example: alison.ferguso@identitysoon.com + attributeName: + type: string + description: The name of the attribute on the source + example: memberOf + attributeValue: + type: string + description: The value of the attribute on the source + example: CN=entitlement.bbb7c650 + sourceSchemaObjectType: + type: string + description: The schema object type on the source used to represent the entitlement and its attributes + example: groups + sourceName: + type: string + description: The name of the source for which this entitlement belongs + example: ODS-AD-Source + sourceType: + type: string + description: The type of the source for which the entitlement belongs + example: Active Directory - Direct + hasPermissions: + type: boolean + description: Indicates if the entitlement has permissions + example: false + isPermission: + type: boolean + description: Indicates if the entitlement is a representation of an account permission + example: false + revocable: + type: boolean + description: Indicates whether the entitlement can be revoked + example: true + cloudGoverned: + type: boolean + description: True if the entitlement is cloud governed + example: false + account: + type: object + nullable: true + description: Information about the status of the entitlement + properties: + nativeIdentity: + type: string + description: The native identity for this account + example: CN=Alison Ferguso + disabled: + type: boolean + example: false + description: Indicates whether this account is currently disabled + locked: + type: boolean + example: false + description: Indicates whether this account is currently locked + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + id: + nullable: true + type: string + description: The id associated with the account + example: 2c9180857182305e0171993737eb29e6 + name: + nullable: true + type: string + description: The account name + example: Alison Ferguso + created: + nullable: true + type: string + format: date-time + description: When the account was created + example: '2020-04-20T20:11:05.067Z' + modified: + nullable: true + type: string + format: date-time + description: When the account was last modified + example: '2020-05-20T18:57:16.987Z' + created: + type: string + description: Date the Access Profile was created. + format: date-time + example: '2021-01-01T22:32:58.104Z' + modified: + type: string + description: Date the Access Profile was last modified. + format: date-time + example: '2021-02-01T22:32:58.104Z' + role: + type: object + nullable: true + properties: + id: + type: string + description: The id for the Role + example: 2c91808a7190d06e0171993907fd0794 + name: + type: string + description: The name of the Role + example: Accounting-Employees + description: + type: string + description: Information about the Role + example: Role for members of the accounting department with the necessary Access Profiles + privileged: + type: boolean + description: Indicates if the entitlement is a privileged entitlement + example: false + owner: + type: object + nullable: true properties: + type: + type: string + description: The type can only be IDENTITY. This is read-only + example: IDENTITY id: type: string - example: 2c91808375d8e80a0175e1f88a575222 + description: Identity id. + example: 5168015d32f890ca15812c9180835d2e name: type: string - example: john.doe - _type: - description: |- - Enum representing the currently supported document types. - - Additional values may be added in the future without notice. + description: Human-readable display name of identity. This is read-only + example: Alison Ferguso + email: type: string - enum: - - accessprofile - - accountactivity - - account - - aggregation - - entitlement - - event - - identity - - role - example: identity - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - description: - type: string - description: The description of the access item - example: The admin role - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string + description: Email address of identity. This is read-only + example: alison.ferguso@identitysoon.com + revocable: + type: boolean + description: Indicates whether the Role can be revoked or requested + example: false + endDate: + type: string + format: date-time + description: The date when a user's access expires. + example: '2021-12-25T00:00:00.000Z' + accessProfiles: + type: array + description: The list of Access Profiles associated with this Role + items: + type: object + properties: + id: + type: string + description: The id of the Access Profile + example: 2c91808a7190d06e01719938fcd20792 + name: + type: string + description: Name of the Access Profile + example: Employee-database-read-write + description: + type: string + description: Information about the Access Profile + example: Collection of entitlements to read/write the employee database + privileged: + type: boolean + description: Indicates if the entitlement is a privileged entitlement + example: false + cloudGoverned: + type: boolean + description: True if the entitlement is cloud governed + example: false + endDate: + nullable: true + type: string + format: date-time + description: The date at which a user's access expires + example: '2021-12-25T00:00:00.000Z' + owner: + description: Owner of the Access Profile + type: object + nullable: true + properties: + type: + type: string + description: The type can only be IDENTITY. This is read-only + example: IDENTITY + id: + type: string + description: Identity id. + example: 5168015d32f890ca15812c9180835d2e + name: + type: string + description: Human-readable display name of identity. This is read-only + example: Alison Ferguso + email: + type: string + description: Email address of identity. This is read-only + example: alison.ferguso@identitysoon.com + entitlements: + type: array + description: A list of entitlements associated with this Access Profile + items: + type: object nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - enabled: - type: boolean - example: true - requestable: - type: boolean - example: true - description: Indicates if the access can be requested - requestCommentsRequired: - type: boolean - description: Indicates if comments are required when requesting access - example: false - owner: - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - - type: object + properties: + id: + type: string + description: The id for the entitlement + example: 2c918085718230600171993742c63558 + name: + type: string + description: The name of the entitlement + example: CN=entitlement.bbb7c650 + description: + nullable: true + type: string + description: Information about the entitlement + example: Gives read/write access to the company database + privileged: + type: boolean + example: false + description: Indicates if the entitlement is a privileged entitlement + owner: + type: object + nullable: true properties: + type: + type: string + description: The type can only be IDENTITY. This is read-only + example: IDENTITY + id: + type: string + description: Identity id. + example: 5168015d32f890ca15812c9180835d2e + name: + type: string + description: Human-readable display name of identity. This is read-only + example: Alison Ferguso email: type: string - example: john.doe@sailpoint.com - description: The email of the identity - - type: object - properties: - accessProfiles: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - accessProfileCount: - type: integer - tags: - type: array - items: + description: Email address of identity. This is read-only + example: alison.ferguso@identitysoon.com + attributeName: + type: string + description: The name of the attribute on the source + example: memberOf + attributeValue: + type: string + description: The value of the attribute on the source + example: CN=entitlement.bbb7c650 + sourceSchemaObjectType: + type: string + description: The schema object type on the source used to represent the entitlement and its attributes + example: groups + sourceName: + type: string + description: The name of the source for which this entitlement belongs + example: ODS-AD-Source + sourceType: + type: string + description: The type of the source for which the entitlement belongs + example: Active Directory - Direct + hasPermissions: + type: boolean + description: Indicates if the entitlement has permissions + example: false + isPermission: + type: boolean + description: Indicates if the entitlement is a representation of an account permission + example: false + revocable: + type: boolean + description: Indicates whether the entitlement can be revoked + example: true + cloudGoverned: + type: boolean + description: True if the entitlement is cloud governed + example: false + account: + type: object + nullable: true + description: Information about the status of the entitlement + properties: + nativeIdentity: + type: string + description: The native identity for this account + example: CN=Alison Ferguso + disabled: + type: boolean + example: false + description: Indicates whether this account is currently disabled + locked: + type: boolean + example: false + description: Indicates whether this account is currently locked + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + id: + nullable: true + type: string + description: The id associated with the account + example: 2c9180857182305e0171993737eb29e6 + name: + nullable: true + type: string + description: The account name + example: Alison Ferguso + created: + nullable: true + type: string + format: date-time + description: When the account was created + example: '2020-04-20T20:11:05.067Z' + modified: + nullable: true + type: string + format: date-time + description: When the account was last modified + example: '2020-05-20T18:57:16.987Z' + created: type: string - example: - - TAG_1 - - TAG_2 + description: Date the Access Profile was created. + format: date-time + example: '2021-01-01T22:32:58.104Z' + modified: + type: string + description: Date the Access Profile was last modified. + format: date-time + example: '2021-02-01T22:32:58.104Z' + example: + - access: + type: ENTITLEMENT + id: 2c9180857182305e01719937429e2bad + name: CN=Engineering + entitlement: + id: 2c9180857182305e01719937429e2bad + name: CN=Engineering + description: Access to the engineering database + privileged: false + owner: + email: brandon.gray@acme-solar.com + type: IDENTITY + id: 2c9180867160846801719932c5153fb7 + name: Brandon Gray + attributeName: memberOf + attributeValue: CN=Engineering + sourceName: ODS-AD-Source + hasPermissions: true + revocable: true + '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: - accessProfiles: - summary: A collection of AccessProfiles - value: - - id: 2c9180825a6c1adc015a71c9023f0818 - name: Cloud Eng - _type: accessprofile - description: Cloud Eng - created: '2017-02-24T20:21:23.145Z' - modified: '2019-05-24T20:36:04.312Z' - synced: '2020-02-18T05:30:20.414Z' - enabled: true - requestable: true - requestCommentsRequired: false - owner: - id: ff8081815757d36a015757d42e56031e - name: SailPoint Support - type: IDENTITY - email: cloud-support@sailpoint.com - source: - id: ff8081815757d4fb0157588f3d9d008f - name: Employees - entitlements: - - id: 2c918084575812550157589064f33b89 - name: 'CN=Cloud Engineering,DC=sailpoint,DC=COM' - description: mull - attribute: memberOf - value: 'CN=Cloud Engineering,DC=sailpoint,DC=COM' - entitlementCount: 1 - tags: - - TAG_1 - - TAG_2 - entitlements: - summary: A collection of Entitlements - value: - - id: 2c9180946ed0c43d016eec1a80892fbd - name: entitlement.aa415ae7 - _type: entitlement - description: 'null' - attribute: groups - value: entitlement.aa415ae7 - modified: '2019-12-09T19:19:50.154Z' - synced: '2020-02-19T04:30:32.906Z' - displayName: entitlement.aa415ae7 - source: - id: 2c91808b6e9e6fb8016eec1a2b6f7b5f - name: ODS-HR-Employees - privileged: false - identityCount: 68 - tags: - - TAG_1 - - TAG_2 - events: - summary: A collection of Events + '403': + summary: An example of a 403 response object value: - - id: e092842f-c904-4b59-aac8-2544abeeef4b - name: Update Task Schedule Passed - _type: event - created: '2020-02-17T16:23:18.327Z' - synced: '2020-02-17T16:23:18.388Z' - action: TASK_SCHEDULE_UPDATE_PASSED - type: SYSTEM_CONFIG - actor: - name: MantisTaskScheduler - target: - name: Perform provisioning activity search delete synchronization - stack: tpe - trackingNumber: c6b98bc39ece48b080826d16c76b166c - ipAddress: 207.189.160.158 - details: 'null' - attributes: - sourceName: SailPoint - objects: - - TASK - - SCHEDULE - operation: UPDATE - status: PASSED - technicalName: TASK_SCHEDULE_UPDATE_PASSED - identities: - summary: A collection of Identities + detailCode: 403 Forbidden + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server understood the request but refuses to authorize it. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object value: - - id: 2c9180865c45e7e3015c46c434a80622 - name: ad.admin - _type: identity - firstName: AD - lastName: Admin - displayName: AD Admin - email: SLPT.CLOUD.SAILPOINT.TEST+AD-ADMIN@GMAIL.COM - created: '2018-08-22T19:54:54.302Z' - modified: '2018-08-22T19:54:54.302Z' - synced: '2018-08-22T19:54:54.302Z' - phone: 512-942-7578 - inactive: false - protected: false - status: UNREGISTERED - employeeNumber: O349804 - manager: null - isManager: false - identityProfile: - id: 2c918085605c8d0601606f357cb231e6 - name: E2E AD - source: - id: 2c9180855c45b230015c46c19b9c0202 - name: EndToEnd-ADSource - attributes: - uid: ad.admin - firstname: AD - cloudAuthoritativeSource: 2c9180855c45b230015c46c19b9c0202 - cloudStatus: UNREGISTERED - iplanet-am-user-alias-list: null - displayName: AD Admin - internalCloudStatus: UNREGISTERED - workPhone: 512-942-7578 - email: SLPT.CLOUD.SAILPOINT.TEST+AD-ADMIN@GMAIL.COM - lastname: Admin - processingState: null - processingDetails: null - accounts: - - id: 2c9180865c45e7e3015c46c434a80623 - name: ad.admin - accountId: 'CN=AD Admin,OU=slpt-automation,DC=TestAutomationAD,DC=local' - source: - id: 2c9180855c45b230015c46c19b9c0202 - name: EndToEnd-ADSource - type: Active Directory - Direct - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - passwordLastSet: '2018-08-22T19:54:54.302Z' - entitlementAttributes: - memberOf: - - 'CN=Group Policy Creator Owners,CN=Users,DC=TestAutomationAD,DC=local' - - 'CN=Domain Guests,CN=Users,DC=TestAutomationAD,DC=local' - - 'CN=Domain Admins,CN=Users,DC=TestAutomationAD,DC=local' - - 'CN=Enterprise Admins,CN=Users,DC=TestAutomationAD,DC=local' - - 'CN=Schema Admins,CN=Users,DC=TestAutomationAD,DC=local' - - 'CN=Guests,CN=Builtin,DC=TestAutomationAD,DC=local' - - 'CN=Administrators,CN=Builtin,DC=TestAutomationAD,DC=local' - created: '2018-08-22T19:54:54.302Z' - - id: 2c918083606d670c01606f35a30a0349 - name: ad.admin - accountId: ad.admin - source: - id: ff8081815c46b85b015c46b90c7c02a6 - name: IdentityNow - type: IdentityNowConnector - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - passwordLastSet: null - entitlementAttributes: null - created: '2018-08-22T19:54:54.302Z' - accountCount: 2 - apps: - - id: '22751' - name: ADP Workforce Now - source: - id: 2c9180855c45b230015c46e2f6a8026a - name: Corporate Active Directory - account: - id: 2c9180865c45efa4015c470be0de1606 - accountId: 'CN=Bob Wilson,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com' - appCount: 1 - access: - - id: 2c918083634bc6cb01639808d40270ba - name: 'test [AccessProfile-1527264105448]' - displayName: test - type: ACCESS_PROFILE - description: test - source: - id: 2c9180855c45b230015c46c19b9c0202 - name: EndToEnd-ADSource - owner: - id: 2c9180865c45e7e3015c46c434a80622 - name: ad.admin - displayName: AD Admin - - id: 2c9180865c45e7e3015c46c457c50755 - name: Administrators - displayName: Administrators - type: ENTITLEMENT - description: null - source: - id: 2c9180855c45b230015c46c19b9c0202 - name: EndToEnd-ADSource - privileged: false - attribute: memberOf - value: 'CN=Administrators,CN=Builtin,DC=TestAutomationAD,DC=local' - standalone: false - - id: 2c9180865decdaa5015e06598b293108 - name: 'test [cloudRole-1503345085223]' - displayName: test - type: ROLE - description: test - owner: - id: 2c9180865c45e7e3015c46c5030707a0 - name: will.albin - displayName: Albin Will - disabled: false - accessCount: 3 - accessProfileCount: 1 - entitlementCount: 1 - roleCount: 1 - tags: - - TAG_1 - - TAG_2 - roles: - summary: A collection of Roles + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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: - - id: 2c91808c6faadea6016fb4f2bc69077b - name: IT Role - _type: role - description: IT role - created: '2020-01-17T19:20:15.040Z' - modified: null - synced: '2020-02-18T05:30:20.145Z' - enabled: true - requestable: false - requestCommentsRequired: false - owner: - id: 2c9180a46faadee4016fb4e018c20639 - name: Cloud Support - type: IDENTITY - email: thomas.edison@acme-solar.com - accessProfiles: - - id: 2c91809c6faade77016fb4f0b63407ae - name: Admin Access - accessProfileCount: 1 - tags: - - TAG_1 - - TAG_2 - headers: - X-Total-Count: + detailCode: 500.0 Internal Fault + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: An internal fault occurred. + '/certifications/{id}/identity-summaries/{identitySummaryId}': + get: + operationId: getIdentitySummary + tags: + - Certification Summaries + summary: Summary for Identity + description: This API returns the summary for an identity on a specified identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + parameters: + - in: path + name: id + schema: + type: string + required: true + description: The identity campaign certification ID + example: ef38f94347e94562b5bb8424a56397d8 + - in: path + name: identitySummaryId + schema: + type: string + required: true + description: The identity summary ID + example: 2c91808772a504f50172a9540e501ba8 + responses: + '200': + description: An identity summary + content: + application/json: schema: - type: integer - description: The total result count (returned only if the *count* parameter is specified as *true*). - example: 30 + type: object + properties: + id: + type: string + description: The ID of the identity summary + example: 2c91808772a504f50172a9540e501ba7 + name: + type: string + description: Name of the linked identity + example: Alison Ferguso + identityId: + type: string + description: The ID of the identity being certified + example: 2c9180857182306001719937377a33de + completed: + type: boolean + description: Indicates whether the review items for the linked identity's certification have been completed + example: true '400': description: Client Error - Returned if the request body is invalid. content: @@ -63788,6 +28572,73 @@ paths: - locale: en-US localeOrigin: DEFAULT text: The server understood the request but refuses to authorize it. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. '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: @@ -63865,695 +28716,1302 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - /search/count: + '/identities/{identity-id}/set-lifecycle-state': post: + operationId: setLifecycleState tags: - - Search - description: Performs a search with a provided query and returns the count of results in the X-Total-Count header. - operationId: searchCount - summary: Count Documents Satisfying a Query + - Lifecycle States + summary: Set Lifecycle State + description: |- + This endpoint will set/update an identity's lifecycle state to the one provided and updates the corresponding Identity Profile. + A token with ORG_ADMIN or API authority is required to call this API. + security: + - UserContextAuth: + - 'idn:identity-lifecycle-state:update' + parameters: + - in: path + name: identity-id + description: The ID of the identity to update + required: true + example: 2c9180857893f1290178944561990364 + schema: + type: string requestBody: + required: true content: application/json: schema: type: object properties: - indices: - description: 'The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched.' - externalDocs: - description: Learn more about search indices here. - url: 'https://documentation.sailpoint.com/saas/help/search/searchable-fields.html' - type: array - items: - description: |- - Enum representing the currently supported indices. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofiles - - accountactivities - - entitlements - - events - - identities - - roles - - '*' - example: identities - example: - - identities - queryType: - description: |- - The type of query to use. By default, the `SAILPOINT` query type is used, which requires the `query` object to be defined in the request body. - To use the `queryDsl` or `typeAheadQuery` objects in the request, you must set the type to `DSL` or `TYPEAHEAD` accordingly. - Additional values may be added in the future without notice. + lifecycleStateId: type: string - enum: - - DSL - - SAILPOINT - - TEXT - - TYPEAHEAD - default: SAILPOINT - example: SAILPOINT - queryVersion: - allOf: - - description: The current Elasticserver version. - type: string - default: '5.2' - example: '5.2' - - type: string - description: |- - The version of the query object. - This version number will map to the version of Elasticsearch for the query strings and objects being used. - query: - type: object - description: Query parameters used to construct an Elasticsearch query object. - properties: - query: - description: 'The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.' - type: string - example: 'name:a*' - fields: - description: The fields to which the specified query will be applied. The available fields are dependent on the indice(s) being searched on. Please refer to the response schema of this API for a list of available fields. - type: array - items: - type: string - example: - - name - timeZone: - description: The time zone to be applied to any range query related to dates. - type: string - example: America/Chicago - innerHit: - description: The innerHit query object returns a flattened list of results for the specified nested type. + description: The ID of the lifecycle state to set + example: 2c9180877a86e408017a8c19fefe046c + responses: + '200': + description: The request was successfully accepted into the system. + content: + application/json: + schema: + type: object + properties: + accountActivityId: + type: string + example: 2c9180837ab5b716017ab7c6c9ef1e20 + description: The ID of the IdentityRequest object that was generated when the workflow launches + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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 - required: - - query - - type properties: - query: - description: 'The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.' + locale: type: string - example: 'source.name:\"Active Directory\"' - type: - description: 'The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document "nested" within another document. For example, an identity can have nested documents for access, accounts, and apps.' + description: 'The locale for the message text, a BCP 47 language tag.' + example: en-US + localeOrigin: type: string - example: access - queryDsl: - description: 'The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax.' - type: object - example: - match: - name: john.doe - textQuery: - type: object - description: Query parameters used to construct an Elasticsearch text query object. - required: - - terms - - fields - properties: - terms: - description: Words or characters that specify a particular thing to be searched for. - type: array - items: - type: string - example: - - The quick brown fox - - '3141592' - - '7' - fields: - description: The fields to be searched. - type: array - items: - type: string - example: - - displayName - - employeeNumber - - roleCount - matchAny: - description: 'Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found.' - type: boolean - default: false - example: false - contains: - description: 'Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms.' - type: boolean - default: false - example: true - typeAheadQuery: - type: object - description: 'Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing "Jo" results in top hits matching "Jo." Typing "Job" results in top hits matching "Job." ' - required: - - query - - field - properties: - query: - description: The type ahead query string used to construct a phrase prefix match query. - type: string - example: Work - field: - description: The field on which to perform the type ahead search. - type: string - example: source.name - nestedType: - description: The nested type. - type: string - example: access - maxExpansions: - description: |- - The number of suffixes the last term will be expanded into. - Influences the performance of the query and the number results returned. - Valid values: 1 to 1000. - type: integer - format: int32 - minimum: 1 - maximum: 1000 - default: 10 - example: 10 - includeNested: - description: Indicates whether nested objects from returned search results should be included. - type: boolean - default: true - example: true - queryResultFilter: - type: object - description: Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents. - properties: - includes: - description: The list of field names to include in the result documents. - type: array - items: - type: string - example: - - name - - displayName - excludes: - description: The list of field names to exclude from the result documents. - type: array - items: - type: string - example: - - stacktrace - aggregationType: - description: | - Enum representing the currently available query languages for aggregations, which are used to perform calculations or groupings on search results. - - Additional values may be added in the future without notice. - type: string - enum: - - DSL - - SAILPOINT - default: DSL - example: DSL - aggregationsVersion: - allOf: - - description: The current Elasticserver version. - type: string - default: '5.2' - example: '5.2' - - type: string - description: |- - The version of the language being used for aggregation queries. - This version number will map to the version of Elasticsearch for the aggregation query object. - aggregationsDsl: - description: 'The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax.' - type: object - example: {} - aggregations: - description: | - The aggregation’s specifications, such as the groupings and calculations to be performed. - allOf: - - type: object - properties: - nested: - type: object - description: The nested aggregation object. - required: - - name - - type - properties: - name: - description: The name of the nested aggregate to be included in the result. - type: string - example: id - type: - description: The type of the nested object. - type: string - example: access - metric: - type: object - description: The calculation done on the results of the query - required: - - name - - field - properties: - name: - description: |- - The name of the metric aggregate to be included in the result. - If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. - type: string - example: Access Name Count - type: - description: |- - Enum representing the currently supported metric aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - COUNT - - UNIQUE_COUNT - - AVG - - SUM - - MEDIAN - - MIN - - MAX - default: UNIQUE_COUNT - example: COUNT - field: - description: | - The field the calculation is performed on. - - Prefix the field name with '@' to reference a nested object. - type: string - example: '@access.name' - filter: - type: object - description: An additional filter to constrain the results of the search query. - required: - - name - - field - - value - properties: - name: - description: The name of the filter aggregate to be included in the result. - type: string - example: Entitlements - type: - description: |- - Enum representing the currently supported filter aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERM - default: TERM - example: TERM - field: - description: | - The search field to apply the filter to. - - Prefix the field name with '@' to reference a nested object. - type: string - example: access.type - value: - description: The value to filter on. - type: string - example: ENTITLEMENT - bucket: - type: object - description: The bucket to group the results of the aggregation query by. - required: - - name - - field - properties: - name: - description: The name of the bucket aggregate to be included in the result. - type: string - example: Identity Locations - type: - description: |- - Enum representing the currently supported bucket aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERMS - default: TERMS - example: TERMS - field: - description: |- - The field to bucket on. - Prefix the field name with '@' to reference a nested object. - type: string - example: attributes.city - size: - description: Maximum number of buckets to include. - type: integer - format: int32 - example: 100 - minDocCount: - description: Minimum number of documents a bucket should have. - type: integer - format: int32 - example: 2 - - type: object + 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: - subAggregation: - description: Aggregation to be performed on the result of the parent bucket aggregation. - allOf: - - type: object - properties: - nested: - type: object - description: The nested aggregation object. - required: - - name - - type - properties: - name: - description: The name of the nested aggregate to be included in the result. - type: string - example: id - type: - description: The type of the nested object. - type: string - example: access - metric: - type: object - description: The calculation done on the results of the query - required: - - name - - field - properties: - name: - description: |- - The name of the metric aggregate to be included in the result. - If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. - type: string - example: Access Name Count - type: - description: |- - Enum representing the currently supported metric aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - COUNT - - UNIQUE_COUNT - - AVG - - SUM - - MEDIAN - - MIN - - MAX - default: UNIQUE_COUNT - example: COUNT - field: - description: | - The field the calculation is performed on. - - Prefix the field name with '@' to reference a nested object. - type: string - example: '@access.name' - filter: - type: object - description: An additional filter to constrain the results of the search query. - required: - - name - - field - - value - properties: - name: - description: The name of the filter aggregate to be included in the result. - type: string - example: Entitlements - type: - description: |- - Enum representing the currently supported filter aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERM - default: TERM - example: TERM - field: - description: | - The search field to apply the filter to. - - Prefix the field name with '@' to reference a nested object. - type: string - example: access.type - value: - description: The value to filter on. - type: string - example: ENTITLEMENT - bucket: - type: object - description: The bucket to group the results of the aggregation query by. - required: - - name - - field - properties: - name: - description: The name of the bucket aggregate to be included in the result. - type: string - example: Identity Locations - type: - description: |- - Enum representing the currently supported bucket aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERMS - default: TERMS - example: TERMS - field: - description: |- - The field to bucket on. - Prefix the field name with '@' to reference a nested object. - type: string - example: attributes.city - size: - description: Maximum number of buckets to include. - type: integer - format: int32 - example: 100 - minDocCount: - description: Minimum number of documents a bucket should have. - type: integer - format: int32 - example: 2 - - type: object - properties: - subAggregation: - description: Aggregation to be performed on the result of the parent bucket aggregation. - type: object - properties: - nested: - type: object - description: The nested aggregation object. - required: - - name - - type - properties: - name: - description: The name of the nested aggregate to be included in the result. - type: string - example: id - type: - description: The type of the nested object. - type: string - example: access - metric: - type: object - description: The calculation done on the results of the query - required: - - name - - field - properties: - name: - description: |- - The name of the metric aggregate to be included in the result. - If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. - type: string - example: Access Name Count - type: - description: |- - Enum representing the currently supported metric aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - COUNT - - UNIQUE_COUNT - - AVG - - SUM - - MEDIAN - - MIN - - MAX - default: UNIQUE_COUNT - example: COUNT - field: - description: | - The field the calculation is performed on. + 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. + '/identity-profiles/{identity-profile-id}/lifecycle-states': + get: + operationId: listLifecycleStates + tags: + - Lifecycle States + summary: Lists LifecycleStates + description: |- + This end-point lists all the LifecycleStates associated with IdentityProfiles. + A token with API, or ORG_ADMIN authority is required to call this API. + security: + - UserContextAuth: + - 'idn:identity-profile-lifecycle-state:read' + parameters: + - in: path + name: identity-profile-id + description: The IdentityProfile id + required: true + schema: + type: string + example: ef38f94347e94562b5bb8424a56397d8 + - 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. - Prefix the field name with '@' to reference a nested object. - type: string - example: '@access.name' - filter: - type: object - description: An additional filter to constrain the results of the search query. - required: - - name - - field - - value - properties: - name: - description: The name of the filter aggregate to be included in the result. - type: string - example: Entitlements - type: - description: |- - Enum representing the currently supported filter aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERM - default: TERM - example: TERM - field: - description: | - The search field to apply the filter to. + 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. - Prefix the field name with '@' to reference a nested object. - type: string - example: access.type - value: - description: The value to filter on. - type: string - example: ENTITLEMENT - bucket: - type: object - description: The bucket to group the results of the aggregation query by. - required: - - name - - field - properties: - name: - description: The name of the bucket aggregate to be included in the result. - type: string - example: Identity Locations - type: - description: |- - Enum representing the currently supported bucket aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERMS - default: TERMS - example: TERMS - field: - description: |- - The field to bucket on. - Prefix the field name with '@' to reference a nested object. - type: string - example: attributes.city - size: - description: Maximum number of buckets to include. - type: integer - format: int32 - example: 100 - minDocCount: - description: Minimum number of documents a bucket should have. - type: integer - format: int32 - example: 2 - sort: - description: The fields to be used to sort the search results. Use + or - to specify the sort direction. - type: array - items: + 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: sorters + required: false + schema: + type: string + format: comma-separated + example: 'created,modified' + 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: **created, modified** + responses: + '200': + description: List of LifecycleState objects + content: + application/json: + schema: + type: array + items: + allOf: + - type: object + required: + - name + properties: + id: + description: System-generated unique ID of the Object + type: string + example: id12345 + readOnly: true + name: + description: Name of the Object + type: string + example: aName + created: + description: Creation date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + modified: + description: Last modification date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + - type: object + required: + - technicalName + properties: + enabled: + type: boolean + example: true + description: Whether the lifecycle state is enabled or disabled. + technicalName: + type: string + example: Technical Name + description: The technical name for lifecycle state. This is for internal use. + description: + type: string + example: Lifecycle description + description: Lifecycle state description. + identityCount: + type: integer + format: int32 + example: 42 + readOnly: true + description: Number of identities that have the lifecycle state. + emailNotificationOption: + type: object + description: This is used for representing email configuration for a lifecycle state + properties: + notifyManagers: + type: boolean + example: true + description: 'If true, then the manager is notified of the lifecycle state change.' + notifyAllAdmins: + type: boolean + example: true + description: 'If true, then all the admins are notified of the lifecycle state change.' + notifySpecificUsers: + type: boolean + example: true + description: 'If true, then the users specified in "emailAddressList" below are notified of lifecycle state change.' + emailAddressList: + type: array + example: + - test@test.com + - test2@test.com + items: + type: string + description: 'List of user email addresses. If "notifySpecificUsers" option is true, then these users are notified of lifecycle state change.' + accountActions: + type: array + items: + type: object + description: Object for specifying Actions to be performed on a specified list of sources' account. + properties: + action: + example: ENABLE + type: string + description: Describes if action will be enabled or disabled + enum: + - ENABLE + - DISABLE + sourceIds: + type: array + items: + type: string + uniqueItems: true + example: + - 2c918084660f45d6016617daa9210584 + - 2c918084660f45d6016617daa9210500 + description: List of unique source IDs. The sources must have the ENABLE feature or flat file source. See "/sources" endpoint for source features. + accessProfileIds: + type: array + items: + type: string + uniqueItems: true + example: + - 2c918084660f45d6016617daa9210584 + - 2c918084660f45d6016617daa9210500 + description: List of unique access-profile IDs that are associated with the lifecycle state. + '400': + description: Client Error - Returned if the request body is invalid. + content: + application/json: + schema: + type: object + properties: + detailCode: type: string - example: - - displayName - - +id - searchAfter: - description: |- - Used to begin the search window at the values specified. - This parameter consists of the last values of the sorted fields in the current record set. - This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. - It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging. - For example, when searching for identities, if you are sorting by displayName you will also want to include ID, for example ["displayName", "id"]. - If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is "John Doe", then using that displayName and ID will start a new search after this identity. - The searchAfter value will look like ["John Doe","2c91808375d8e80a0175e1f88a575221"] - type: array - items: + description: Fine-grained error code providing more detail of the error. + example: 400.1 Bad Request Content + trackingId: type: string - example: - - John Doe - - 2c91808375d8e80a0175e1f88a575221 - filters: - description: The filters to be applied for each filtered field name. - type: object - additionalProperties: - type: object + 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: createLifecycleState + tags: + - Lifecycle States + summary: Create Lifecycle State + description: |- + This API creates a new Lifecycle State. + A token with ORG_ADMIN or API authority is required to call this API. + security: + - UserContextAuth: + - 'idn:identity-profile-lifecycle-state:manage' + parameters: + - in: path + name: identity-profile-id + description: Identity Profile ID + required: true + schema: + type: string + example: ef38f94347e94562b5bb8424a56397d8 + requestBody: + description: Lifecycle State + required: true + content: + application/json: + schema: + allOf: + - type: object + required: + - name + properties: + id: + description: System-generated unique ID of the Object + type: string + example: id12345 + readOnly: true + name: + description: Name of the Object + type: string + example: aName + created: + description: Creation date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + modified: + description: Last modification date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + - type: object + required: + - technicalName + properties: + enabled: + type: boolean + example: true + description: Whether the lifecycle state is enabled or disabled. + technicalName: + type: string + example: Technical Name + description: The technical name for lifecycle state. This is for internal use. + description: + type: string + example: Lifecycle description + description: Lifecycle state description. + identityCount: + type: integer + format: int32 + example: 42 + readOnly: true + description: Number of identities that have the lifecycle state. + emailNotificationOption: + type: object + description: This is used for representing email configuration for a lifecycle state + properties: + notifyManagers: + type: boolean + example: true + description: 'If true, then the manager is notified of the lifecycle state change.' + notifyAllAdmins: + type: boolean + example: true + description: 'If true, then all the admins are notified of the lifecycle state change.' + notifySpecificUsers: + type: boolean + example: true + description: 'If true, then the users specified in "emailAddressList" below are notified of lifecycle state change.' + emailAddressList: + type: array + example: + - test@test.com + - test2@test.com + items: + type: string + description: 'List of user email addresses. If "notifySpecificUsers" option is true, then these users are notified of lifecycle state change.' + accountActions: + type: array + items: + type: object + description: Object for specifying Actions to be performed on a specified list of sources' account. + properties: + action: + example: ENABLE + type: string + description: Describes if action will be enabled or disabled + enum: + - ENABLE + - DISABLE + sourceIds: + type: array + items: + type: string + uniqueItems: true + example: + - 2c918084660f45d6016617daa9210584 + - 2c918084660f45d6016617daa9210500 + description: List of unique source IDs. The sources must have the ENABLE feature or flat file source. See "/sources" endpoint for source features. + accessProfileIds: + type: array + items: + type: string + uniqueItems: true + example: + - 2c918084660f45d6016617daa9210584 + - 2c918084660f45d6016617daa9210500 + description: List of unique access-profile IDs that are associated with the lifecycle state. + responses: + '201': + description: Created LifecycleState object. + content: + application/json: + schema: + allOf: + - type: object + required: + - name properties: - type: - description: |- - Enum representing the currently supported filter types. - Additional values may be added in the future without notice. + id: + description: System-generated unique ID of the Object type: string - enum: - - EXISTS - - RANGE - - TERMS - example: RANGE - range: + example: id12345 + readOnly: true + name: + description: Name of the Object + type: string + example: aName + created: + description: Creation date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + modified: + description: Last modification date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + - type: object + required: + - technicalName + properties: + enabled: + type: boolean + example: true + description: Whether the lifecycle state is enabled or disabled. + technicalName: + type: string + example: Technical Name + description: The technical name for lifecycle state. This is for internal use. + description: + type: string + example: Lifecycle description + description: Lifecycle state description. + identityCount: + type: integer + format: int32 + example: 42 + readOnly: true + description: Number of identities that have the lifecycle state. + emailNotificationOption: type: object - description: The range of values to be filtered. + description: This is used for representing email configuration for a lifecycle state properties: - lower: - description: The lower bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. + notifyManagers: + type: boolean + example: true + description: 'If true, then the manager is notified of the lifecycle state change.' + notifyAllAdmins: + type: boolean + example: true + description: 'If true, then all the admins are notified of the lifecycle state change.' + notifySpecificUsers: + type: boolean + example: true + description: 'If true, then the users specified in "emailAddressList" below are notified of lifecycle state change.' + emailAddressList: + type: array + example: + - test@test.com + - test2@test.com + items: + type: string + description: 'List of user email addresses. If "notifySpecificUsers" option is true, then these users are notified of lifecycle state change.' + accountActions: + type: array + items: + type: object + description: Object for specifying Actions to be performed on a specified list of sources' account. + properties: + action: + example: ENABLE + type: string + description: Describes if action will be enabled or disabled + enum: + - ENABLE + - DISABLE + sourceIds: + type: array + items: type: string - example: '1' - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - example: false - upper: - description: The upper bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. + uniqueItems: true + example: + - 2c918084660f45d6016617daa9210584 + - 2c918084660f45d6016617daa9210500 + description: List of unique source IDs. The sources must have the ENABLE feature or flat file source. See "/sources" endpoint for source features. + accessProfileIds: + type: array + items: + type: string + uniqueItems: true + example: + - 2c918084660f45d6016617daa9210584 + - 2c918084660f45d6016617daa9210500 + description: List of unique access-profile IDs that are associated with the lifecycle state. + '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. + '/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}': + get: + operationId: getLifecycleState + tags: + - Lifecycle States + summary: Retrieves Lifecycle State + description: |- + This endpoint retrieves a Lifecycle State. + A token with ORG_ADMIN or API authority is required to call this API. + security: + - UserContextAuth: + - 'idn:identity-profile-lifecycle-state:read' + parameters: + - in: path + name: identity-profile-id + description: Identity Profile ID + required: true + schema: + type: string + example: 2b838de9-db9b-abcf-e646-d4f274ad4238 + - in: path + name: lifecycle-state-id + description: Lifecycle State ID + required: true + schema: + type: string + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '200': + description: The requested LifecycleState was successfully retrieved. + content: + application/json: + schema: + allOf: + - type: object + required: + - name + properties: + id: + description: System-generated unique ID of the Object + type: string + example: id12345 + readOnly: true + name: + description: Name of the Object + type: string + example: aName + created: + description: Creation date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + modified: + description: Last modification date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + - type: object + required: + - technicalName + properties: + enabled: + type: boolean + example: true + description: Whether the lifecycle state is enabled or disabled. + technicalName: + type: string + example: Technical Name + description: The technical name for lifecycle state. This is for internal use. + description: + type: string + example: Lifecycle description + description: Lifecycle state description. + identityCount: + type: integer + format: int32 + example: 42 + readOnly: true + description: Number of identities that have the lifecycle state. + emailNotificationOption: + type: object + description: This is used for representing email configuration for a lifecycle state + properties: + notifyManagers: + type: boolean + example: true + description: 'If true, then the manager is notified of the lifecycle state change.' + notifyAllAdmins: + type: boolean + example: true + description: 'If true, then all the admins are notified of the lifecycle state change.' + notifySpecificUsers: + type: boolean + example: true + description: 'If true, then the users specified in "emailAddressList" below are notified of lifecycle state change.' + emailAddressList: + type: array + example: + - test@test.com + - test2@test.com + items: + type: string + description: 'List of user email addresses. If "notifySpecificUsers" option is true, then these users are notified of lifecycle state change.' + accountActions: + type: array + items: + type: object + description: Object for specifying Actions to be performed on a specified list of sources' account. + properties: + action: + example: ENABLE + type: string + description: Describes if action will be enabled or disabled + enum: + - ENABLE + - DISABLE + sourceIds: + type: array + items: type: string - example: '1' - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - example: false - terms: - description: The terms to be filtered. + uniqueItems: true + example: + - 2c918084660f45d6016617daa9210584 + - 2c918084660f45d6016617daa9210500 + description: List of unique source IDs. The sources must have the ENABLE feature or flat file source. See "/sources" endpoint for source features. + accessProfileIds: type: array items: type: string - example: account_count - exclude: - description: Indicates if the filter excludes results. - type: boolean - default: false - example: false - example: {} - examples: - query-timeZone: - summary: Query with TimeZone - value: - indices: - - identities - query: - query: 'created: [2022-05-19T19:26:03.351Z TO now]' - timeZone: America/Los_Angeles - required: true - responses: - '204': - description: No content - indicates the request was successful but there is no content to be returned in the response. - headers: - X-Total-Count: - description: The total result count. - schema: - type: integer - example: 5 + uniqueItems: true + example: + - 2c918084660f45d6016617daa9210584 + - 2c918084660f45d6016617daa9210500 + description: List of unique access-profile IDs that are associated with the lifecycle state. '400': description: Client Error - Returned if the request body is invalid. content: @@ -64688,18 +30146,8 @@ paths: - 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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist content: application/json: schema: @@ -64756,2884 +30204,18913 @@ paths: 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 + '404': + summary: An example of a 404 response object value: - detailCode: 500.0 Internal Fault + detailCode: 404 Not found trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: An internal fault occurred. - /search/aggregate: - post: - tags: - - Search - description: 'Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. ' - operationId: searchAggregate - summary: Perform a Search Query Aggregation - parameters: - - 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: 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: 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 - requestBody: - content: - application/json: - schema: - type: object - properties: - indices: - description: 'The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched.' - externalDocs: - description: Learn more about search indices here. - url: 'https://documentation.sailpoint.com/saas/help/search/searchable-fields.html' - type: array - items: - description: |- - Enum representing the currently supported indices. - Additional values may be added in the future without notice. + text: The server did not find a current representation for the target resource. + '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 - enum: - - accessprofiles - - accountactivities - - entitlements - - events - - identities - - roles - - '*' - example: identities - example: - - identities - queryType: - description: |- - The type of query to use. By default, the `SAILPOINT` query type is used, which requires the `query` object to be defined in the request body. - To use the `queryDsl` or `typeAheadQuery` objects in the request, you must set the type to `DSL` or `TYPEAHEAD` accordingly. - Additional values may be added in the future without notice. - type: string - enum: - - DSL - - SAILPOINT - - TEXT - - TYPEAHEAD - default: SAILPOINT - example: SAILPOINT - queryVersion: - allOf: - - description: The current Elasticserver version. - type: string - default: '5.2' - example: '5.2' - - type: string - description: |- - The version of the query object. - This version number will map to the version of Elasticsearch for the query strings and objects being used. - query: - type: object - description: Query parameters used to construct an Elasticsearch query object. - properties: - query: - description: 'The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.' - type: string - example: 'name:a*' - fields: - description: The fields to which the specified query will be applied. The available fields are dependent on the indice(s) being searched on. Please refer to the response schema of this API for a list of available fields. - type: array - items: - type: string - example: - - name - timeZone: - description: The time zone to be applied to any range query related to dates. - type: string - example: America/Chicago - innerHit: - description: The innerHit query object returns a flattened list of results for the specified nested type. - type: object - required: - - query - - type - properties: - query: - description: 'The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.' - type: string - example: 'source.name:\"Active Directory\"' - type: - description: 'The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document "nested" within another document. For example, an identity can have nested documents for access, accounts, and apps.' - type: string - example: access - queryDsl: - description: 'The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax.' - type: object - example: - match: - name: john.doe - textQuery: - type: object - description: Query parameters used to construct an Elasticsearch text query object. - required: - - terms - - fields - properties: - terms: - description: Words or characters that specify a particular thing to be searched for. - type: array - items: - type: string - example: - - The quick brown fox - - '3141592' - - '7' - fields: - description: The fields to be searched. - type: array - items: - type: string - example: - - displayName - - employeeNumber - - roleCount - matchAny: - description: 'Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found.' - type: boolean - default: false - example: false - contains: - description: 'Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms.' - type: boolean - default: false - example: true - typeAheadQuery: - type: object - description: 'Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing "Jo" results in top hits matching "Jo." Typing "Job" results in top hits matching "Job." ' - required: - - query - - field - properties: - query: - description: The type ahead query string used to construct a phrase prefix match query. - type: string - example: Work - field: - description: The field on which to perform the type ahead search. - type: string - example: source.name - nestedType: - description: The nested type. - type: string - example: access - maxExpansions: - description: |- - The number of suffixes the last term will be expanded into. - Influences the performance of the query and the number results returned. - Valid values: 1 to 1000. - type: integer - format: int32 - minimum: 1 - maximum: 1000 - default: 10 - example: 10 - includeNested: - description: Indicates whether nested objects from returned search results should be included. - type: boolean - default: true - example: true - queryResultFilter: - type: object - description: Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents. - properties: - includes: - description: The list of field names to include in the result documents. - type: array - items: - type: string - example: - - name - - displayName - excludes: - description: The list of field names to exclude from the result documents. - type: array - items: - type: string - example: - - stacktrace - aggregationType: - description: | - Enum representing the currently available query languages for aggregations, which are used to perform calculations or groupings on search results. - - Additional values may be added in the future without notice. - type: string - enum: - - DSL - - SAILPOINT - default: DSL - example: DSL - aggregationsVersion: - allOf: - - description: The current Elasticserver version. - type: string - default: '5.2' - example: '5.2' - - type: string - description: |- - The version of the language being used for aggregation queries. - This version number will map to the version of Elasticsearch for the aggregation query object. - aggregationsDsl: - description: 'The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax.' - type: object - example: {} - aggregations: - description: | - The aggregation’s specifications, such as the groupings and calculations to be performed. - allOf: - - type: object - properties: - nested: - type: object - description: The nested aggregation object. - required: - - name - - type - properties: - name: - description: The name of the nested aggregate to be included in the result. - type: string - example: id - type: - description: The type of the nested object. - type: string - example: access - metric: - type: object - description: The calculation done on the results of the query - required: - - name - - field - properties: - name: - description: |- - The name of the metric aggregate to be included in the result. - If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. - type: string - example: Access Name Count - type: - description: |- - Enum representing the currently supported metric aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - COUNT - - UNIQUE_COUNT - - AVG - - SUM - - MEDIAN - - MIN - - MAX - default: UNIQUE_COUNT - example: COUNT - field: - description: | - The field the calculation is performed on. - - Prefix the field name with '@' to reference a nested object. - type: string - example: '@access.name' - filter: - type: object - description: An additional filter to constrain the results of the search query. - required: - - name - - field - - value - properties: - name: - description: The name of the filter aggregate to be included in the result. - type: string - example: Entitlements - type: - description: |- - Enum representing the currently supported filter aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERM - default: TERM - example: TERM - field: - description: | - The search field to apply the filter to. - - Prefix the field name with '@' to reference a nested object. - type: string - example: access.type - value: - description: The value to filter on. - type: string - example: ENTITLEMENT - bucket: - type: object - description: The bucket to group the results of the aggregation query by. - required: - - name - - field - properties: - name: - description: The name of the bucket aggregate to be included in the result. - type: string - example: Identity Locations - type: - description: |- - Enum representing the currently supported bucket aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERMS - default: TERMS - example: TERMS - field: - description: |- - The field to bucket on. - Prefix the field name with '@' to reference a nested object. - type: string - example: attributes.city - size: - description: Maximum number of buckets to include. - type: integer - format: int32 - example: 100 - minDocCount: - description: Minimum number of documents a bucket should have. - type: integer - format: int32 - example: 2 - - type: object + 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: - subAggregation: - description: Aggregation to be performed on the result of the parent bucket aggregation. - allOf: - - type: object - properties: - nested: - type: object - description: The nested aggregation object. - required: - - name - - type - properties: - name: - description: The name of the nested aggregate to be included in the result. - type: string - example: id - type: - description: The type of the nested object. - type: string - example: access - metric: - type: object - description: The calculation done on the results of the query - required: - - name - - field - properties: - name: - description: |- - The name of the metric aggregate to be included in the result. - If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. - type: string - example: Access Name Count - type: - description: |- - Enum representing the currently supported metric aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - COUNT - - UNIQUE_COUNT - - AVG - - SUM - - MEDIAN - - MIN - - MAX - default: UNIQUE_COUNT - example: COUNT - field: - description: | - The field the calculation is performed on. - - Prefix the field name with '@' to reference a nested object. - type: string - example: '@access.name' - filter: - type: object - description: An additional filter to constrain the results of the search query. - required: - - name - - field - - value - properties: - name: - description: The name of the filter aggregate to be included in the result. - type: string - example: Entitlements - type: - description: |- - Enum representing the currently supported filter aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERM - default: TERM - example: TERM - field: - description: | - The search field to apply the filter to. - - Prefix the field name with '@' to reference a nested object. - type: string - example: access.type - value: - description: The value to filter on. - type: string - example: ENTITLEMENT - bucket: - type: object - description: The bucket to group the results of the aggregation query by. - required: - - name - - field - properties: - name: - description: The name of the bucket aggregate to be included in the result. - type: string - example: Identity Locations - type: - description: |- - Enum representing the currently supported bucket aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERMS - default: TERMS - example: TERMS - field: - description: |- - The field to bucket on. - Prefix the field name with '@' to reference a nested object. - type: string - example: attributes.city - size: - description: Maximum number of buckets to include. - type: integer - format: int32 - example: 100 - minDocCount: - description: Minimum number of documents a bucket should have. - type: integer - format: int32 - example: 2 - - type: object - properties: - subAggregation: - description: Aggregation to be performed on the result of the parent bucket aggregation. - type: object - properties: - nested: - type: object - description: The nested aggregation object. - required: - - name - - type - properties: - name: - description: The name of the nested aggregate to be included in the result. - type: string - example: id - type: - description: The type of the nested object. - type: string - example: access - metric: - type: object - description: The calculation done on the results of the query - required: - - name - - field - properties: - name: - description: |- - The name of the metric aggregate to be included in the result. - If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. - type: string - example: Access Name Count - type: - description: |- - Enum representing the currently supported metric aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - COUNT - - UNIQUE_COUNT - - AVG - - SUM - - MEDIAN - - MIN - - MAX - default: UNIQUE_COUNT - example: COUNT - field: - description: | - The field the calculation is performed on. - - Prefix the field name with '@' to reference a nested object. - type: string - example: '@access.name' - filter: - type: object - description: An additional filter to constrain the results of the search query. - required: - - name - - field - - value - properties: - name: - description: The name of the filter aggregate to be included in the result. - type: string - example: Entitlements - type: - description: |- - Enum representing the currently supported filter aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERM - default: TERM - example: TERM - field: - description: | - The search field to apply the filter to. + 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. + patch: + operationId: updateLifecycleStates + tags: + - Lifecycle States + summary: Update Lifecycle State + description: |- + This endpoint updates individual Lifecycle State fields using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + A token with ORG_ADMIN or API authority is required to call this API. + security: + - UserContextAuth: + - 'idn:identity-profile-lifecycle-state:manage' + parameters: + - in: path + name: identity-profile-id + description: Identity Profile ID + required: true + schema: + type: string + example: 2b838de9-db9b-abcf-e646-d4f274ad4238 + - in: path + name: lifecycle-state-id + description: Lifecycle State ID + required: true + schema: + type: string + example: ef38f94347e94562b5bb8424a56397d8 + requestBody: + required: true + description: | + A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - Prefix the field name with '@' to reference a nested object. - type: string - example: access.type - value: - description: The value to filter on. - type: string - example: ENTITLEMENT - bucket: - type: object - description: The bucket to group the results of the aggregation query by. - required: - - name - - field - properties: - name: - description: The name of the bucket aggregate to be included in the result. - type: string - example: Identity Locations - type: - description: |- - Enum representing the currently supported bucket aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERMS - default: TERMS - example: TERMS - field: - description: |- - The field to bucket on. - Prefix the field name with '@' to reference a nested object. - type: string - example: attributes.city - size: - description: Maximum number of buckets to include. - type: integer - format: int32 - example: 100 - minDocCount: - description: Minimum number of documents a bucket should have. - type: integer - format: int32 - example: 2 - sort: - description: The fields to be used to sort the search results. Use + or - to specify the sort direction. - type: array - items: + The following fields can be updated: + * enabled + * description + * accountActions + * accessProfileIds + * emailNotificationOption + content: + application/json-patch+json: + schema: + type: array + items: + type: object + description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' + required: + - op + - path + properties: + op: type: string - example: - - displayName - - +id - searchAfter: - description: |- - Used to begin the search window at the values specified. - This parameter consists of the last values of the sorted fields in the current record set. - This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. - It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging. - For example, when searching for identities, if you are sorting by displayName you will also want to include ID, for example ["displayName", "id"]. - If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is "John Doe", then using that displayName and ID will start a new search after this identity. - The searchAfter value will look like ["John Doe","2c91808375d8e80a0175e1f88a575221"] - type: array - items: + description: The operation to be performed + enum: + - add + - remove + - replace + - move + - copy + - test + example: replace + path: type: string - example: - - John Doe - - 2c91808375d8e80a0175e1f88a575221 - filters: - description: The filters to be applied for each filtered field name. - type: object - additionalProperties: - type: object + description: A string JSON Pointer representing the target path to an element to be affected by the operation + example: /description + value: + anyOf: + - type: string + - type: integer + - type: object + - type: array + items: + anyOf: + - type: string + - type: integer + - type: object + description: 'The value to be used for the operation, required for "add" and "replace" operations' + example: New description + example: + - op: replace + path: /description + value: Updated description! + - op: replace + path: /accessProfileIds + value: + - 2c918087742bab150174407a80f3125e + - 2c918087742bab150174407a80f3124f + - op: replace + path: /accountActions + value: + - action: ENABLE + sourceIds: + - 2c9180846a2f82fb016a481c1b1560c5 + - 2c9180846a2f82fb016a481c1b1560cc + - action: DISABLE + sourceIds: + - 2c91808869a0c9980169a207258513fb + - op: replace + path: /emailNotificationOption + value: + notifyManagers: true + notifyAllAdmins: false + notifySpecificUsers: false + emailAddressList: [] + responses: + '200': + description: The LifecycleState was successfully updated. + content: + application/json: + schema: + allOf: + - type: object + required: + - name properties: - type: - description: |- - Enum representing the currently supported filter types. - Additional values may be added in the future without notice. + id: + description: System-generated unique ID of the Object type: string - enum: - - EXISTS - - RANGE - - TERMS - example: RANGE - range: + example: id12345 + readOnly: true + name: + description: Name of the Object + type: string + example: aName + created: + description: Creation date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + modified: + description: Last modification date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + - type: object + required: + - technicalName + properties: + enabled: + type: boolean + example: true + description: Whether the lifecycle state is enabled or disabled. + technicalName: + type: string + example: Technical Name + description: The technical name for lifecycle state. This is for internal use. + description: + type: string + example: Lifecycle description + description: Lifecycle state description. + identityCount: + type: integer + format: int32 + example: 42 + readOnly: true + description: Number of identities that have the lifecycle state. + emailNotificationOption: type: object - description: The range of values to be filtered. + description: This is used for representing email configuration for a lifecycle state properties: - lower: - description: The lower bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - example: '1' - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - example: false - upper: - description: The upper bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. + notifyManagers: + type: boolean + example: true + description: 'If true, then the manager is notified of the lifecycle state change.' + notifyAllAdmins: + type: boolean + example: true + description: 'If true, then all the admins are notified of the lifecycle state change.' + notifySpecificUsers: + type: boolean + example: true + description: 'If true, then the users specified in "emailAddressList" below are notified of lifecycle state change.' + emailAddressList: + type: array + example: + - test@test.com + - test2@test.com + items: + type: string + description: 'List of user email addresses. If "notifySpecificUsers" option is true, then these users are notified of lifecycle state change.' + accountActions: + type: array + items: + type: object + description: Object for specifying Actions to be performed on a specified list of sources' account. + properties: + action: + example: ENABLE + type: string + description: Describes if action will be enabled or disabled + enum: + - ENABLE + - DISABLE + sourceIds: + type: array + items: type: string - example: '1' - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - example: false - terms: - description: The terms to be filtered. + uniqueItems: true + example: + - 2c918084660f45d6016617daa9210584 + - 2c918084660f45d6016617daa9210500 + description: List of unique source IDs. The sources must have the ENABLE feature or flat file source. See "/sources" endpoint for source features. + accessProfileIds: type: array items: type: string - example: account_count - exclude: - description: Indicates if the filter excludes results. - type: boolean - default: false - example: false - example: {} - examples: - metricAggregation: - summary: MetricAggregation - value: - indices: - - aggregations - aggregationType: SAILPOINT - aggregations: - metric: - name: How Many Locations - type: UNIQUE_COUNT - field: attributes.city - metricAggregation-dsl: - summary: MetricAggregation using DSL - value: - indices: - - aggregations - aggregationType: DSL - aggregationsDsl: - How Many Locations: - cardinality: - field: attributes.city.exact - bucketAggregation: - summary: BucketAggregation - value: - indices: - - aggregations - aggregationType: SAILPOINT - aggregations: - bucket: - name: Identity Locations - type: TERMS - field: attributes.city - bucketAggregation-dsl: - summary: BucketAggregation using DSL - value: - indices: - - aggregations - aggregationType: DSL - aggregationsDsl: - Identity Locations: - terms: - field: attributes.city.exact - nestedAggregation-bucketAggregation: - summary: NestedAggregation with BucketAggregation - value: - indices: - - aggregations - aggregationType: SAILPOINT - aggregations: - nested: - name: Access - field: access - type: TERMS - bucket: - name: Access Source Name - type: TERMS - field: access.source.name - nestedAggregation-bucketAggregation-dsl: - summary: NestedAggregation with BucketAggregation using DSL - value: - indices: - - aggregations - aggregationType: DSL - aggregationsDsl: - access: - nested: - path: access - aggs: - Access Source Name: - terms: - field: access.source.name.exact - nestedAggregation-filterAggregation-bucketAggregation: - summary: NestedAggregation with FilterAggregation and BucketAggregation - value: - indices: - - aggregations - aggregationType: SAILPOINT - aggregations: - nested: - name: Access - field: access - type: TERMS - filter: - name: Entitlements - field: access.type - value: ENTITLEMENT - bucket: - name: Access Name - type: TERMS - field: access.name - nestedAggregation-filterAggregation-bucketAggregation-dsl: - summary: NestedAggregation with FilterAggregation and BucketAggregation using DSL - value: - indices: - - aggregations - aggregationType: DSL - aggregationsDsl: - access: - nested: - path: access - aggs: - Entitlements: - filter: - term: - access.type: ENTITLEMENT - aggs: - Access Name: - terms: - field: access.name.exact - bucketAggregation-subAggregation: - summary: BucketAggregation with SubAggregation - value: - indices: - - aggregations - aggregationType: SAILPOINT - aggregations: - bucket: - name: Identity Department - type: TERMS - field: attributes.department - subAggregation: - bucket: - name: Identity Locations - type: TERMS - field: attributes.city - bucketAggregation-subAggregation-dsl: - summary: BucketAggregation with SubAggregation using DSL - value: - indices: - - aggregations - aggregationType: DSL - aggregationsDsl: - Identity Department: - terms: - field: attributes.department.exact - aggs: - Identity Locations: - terms: - field: attributes.city.exact - required: true - responses: - '200': - description: Aggregation results. + uniqueItems: true + example: + - 2c918084660f45d6016617daa9210584 + - 2c918084660f45d6016617daa9210500 + description: List of unique access-profile IDs that are associated with the lifecycle state. + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + delete: + operationId: deleteLifecycleState + tags: + - Lifecycle States + summary: Delete Lifecycle State by ID + description: |- + This endpoint deletes the Lifecycle State using it's ID. + A token with API, or ORG_ADMIN authority is required to call this API. + security: + - UserContextAuth: + - 'idn:identity-profile-lifecycle-state:manage' + parameters: + - in: path + name: identity-profile-id + description: Identity Profile ID + required: true + schema: + type: string + example: 2b838de9-db9b-abcf-e646-d4f274ad4238 + - in: path + name: lifecycle-state-id + description: Lifecycle State ID + required: true + schema: + type: string + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '202': + description: The request was successfully accepted into the system. + content: + application/json: + schema: + 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 + - WORKGROUP + 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 + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist content: application/json: schema: type: object properties: - aggregations: - type: object - description: | - The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run. - - See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information. - example: - Identity Locations: - buckets: - - key: Austin - doc_count: 109 - - key: London - doc_count: 64 - - key: San Jose - doc_count: 27 - - key: Brussels - doc_count: 26 - - key: Sao Paulo - doc_count: 24 - - key: Munich - doc_count: 23 - - key: Singapore - doc_count: 22 - - key: Tokyo - doc_count: 20 - - key: Taipei - doc_count: 16 - hits: - description: | - The results of the aggregation search query. + 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: - discriminator: - propertyName: _type - mapping: - accessprofile: ../model/access/profile/AccessProfileDocument.yaml - accountactivity: ../model/account/activity/AccountActivityDocument.yaml - account: ../model/account/AccountDocument.yaml - aggregation: ../model/aggregation/AggregationDocument.yaml - entitlement: ../model/entitlement/EntitlementDocument.yaml - event: ../model/event/EventDocument.yaml - identity: ../model/identity/IdentityDocument.yaml - role: ../model/role/RoleDocument.yaml - oneOf: - - description: 'This is more of a complete representation of an access profile. ' - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - name: - type: string - example: john.doe - _type: - description: |- - Enum representing the currently supported document types. - - Additional values may be added in the future without notice. - type: string - enum: - - accessprofile - - accountactivity - - account - - aggregation - - entitlement - - event - - identity - - role - example: identity - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - description: - type: string - description: The description of the access item - example: The admin role - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - enabled: - type: boolean - example: true - requestable: - type: boolean - example: true - description: Indicates if the access can be requested - requestCommentsRequired: - type: boolean - description: Indicates if comments are required when requesting access - example: false - owner: - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - - type: object - properties: - email: - type: string - example: john.doe@sailpoint.com - description: The email of the identity - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - entitlements: - type: array - items: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - description: - type: string - description: A description of the entitlement - example: The admin privilege - attribute: - type: string - description: The name of the entitlement attribute - example: admin - value: - type: string - description: The value of the entitlement - example: 'true' - entitlementCount: - type: integer - example: 5 - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - - description: AccountActivity - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - name: - type: string - example: john.doe - _type: - description: |- - Enum representing the currently supported document types. + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + /identity-profiles: + get: + operationId: listIdentityProfiles + tags: + - Identity Profiles + summary: Identity Profiles List + description: |- + This returns a list of Identity Profiles based on the specified query parameters. + A token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles. + parameters: + - 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. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofile - - accountactivity - - account - - aggregation - - entitlement - - event - - identity - - role - example: identity - - type: object - properties: - action: - type: string - description: The type of action that this activity performed - externalDocs: - description: Learn more about account activity action types - url: 'https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data' - example: Identity Refresh. - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - stage: - type: string - description: The current stage of the activity - example: Completed - origin: - type: string - nullable: true - example: null - status: - type: string - description: the current status of the activity - example: Complete - requester: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - recipient: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - trackingNumber: - type: string - example: 61aad0c9e8134eca89e76a35e0cabe3f - errors: - type: array - items: - type: string - nullable: true - example: null - warnings: - type: array - items: + 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 + required: false + schema: + type: string + example: id eq "ef38f94347e94562b5bb8424a56397d8" + 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, ne* + + **name**: *eq, ne* + + **priority**: *eq, ne* + - in: query + name: sorters + required: false + schema: + type: string + format: comma-separated + example: 'id,name' + 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: **id**, **name**, **priority** + responses: + '200': + description: List of identityProfiles. + content: + application/json: + schema: + type: array + items: + allOf: + - type: object + required: + - name + properties: + id: + description: System-generated unique ID of the Object + type: string + example: id12345 + readOnly: true + name: + description: Name of the Object + type: string + example: aName + created: + description: Creation date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + modified: + description: Last modification date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + - type: object + required: + - authoritativeSource + properties: + description: + type: string + description: The description of the Identity Profile. + example: My custom flat file profile + nullable: true + owner: + type: object + description: The owner of the Identity Profile. + nullable: true + properties: + type: + type: string + enum: + - IDENTITY + description: Type of the object to which this reference applies + example: IDENTITY + id: + type: string + description: ID of the object to which this reference applies + example: 2c9180835d191a86015d28455b4b232a + name: + type: string + description: Human-readable display name of the object to which this reference applies + example: William Wilson + priority: + type: integer + format: int64 + description: The priority for an Identity Profile. + example: 10 + authoritativeSource: + type: object + properties: + type: + type: string + enum: + - SOURCE + description: Type of the object to which this reference applies + example: SOURCE + id: + type: string + description: ID of the object to which this reference applies + example: 2c9180835d191a86015d28455b4b232a + name: + type: string + description: Human-readable display name of the object to which this reference applies + example: HR Active Directory + identityRefreshRequired: + type: boolean + default: false + description: True if a identity refresh is needed. Typically triggered when a change on the source has been made. + example: true + identityCount: + type: integer + description: The number of identities that belong to the Identity Profile. + format: int32 + example: 8 + identityAttributeConfig: + type: object + description: Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. + properties: + enabled: + description: The backend will only promote values if the profile/mapping is enabled. + type: boolean + default: false + example: true + attributeTransforms: + type: array + items: + type: object + description: Defines a transformation definition for an identity attribute. + properties: + identityAttributeName: type: string - nullable: true - example: null - approvals: - type: array - items: - type: object - properties: - comments: - type: array - items: - type: object - properties: - comment: - type: string - description: The comment text - example: This request was autoapproved by our automated ETS subscriber. - commenter: - type: string - description: The name of the commenter - example: Automated AR Approval - date: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - result: - type: string - description: The result of the approval - example: Finished - type: - type: string - nullable: true - example: null - originalRequests: - type: array - items: - type: object - properties: - accountId: - type: string - description: the account id - example: 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com' - attributeRequests: - type: array - items: - type: object - properties: - name: - type: string - description: The attribute name - example: groups - op: - type: string - description: The operation to perform - example: Add - value: - type: string - description: The value of the attribute - example: '3203537556531076' - op: - type: string - description: the operation that was used - example: add - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - expansionItems: - type: array - items: - type: object - properties: - accountId: - type: string - description: The ID of the account - example: 2c91808981f58ea601821c3e93482e6f - cause: - type: string - example: Role - name: - type: string - description: The name of the item - example: smartsheet-role - attributeRequests: - type: array - items: - type: object - properties: - name: - type: string - description: The attribute name - example: groups - op: - type: string - description: The operation to perform - example: Add - value: - type: string - description: The value of the attribute - example: '3203537556531076' - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - accountRequests: - type: array - items: - type: object - properties: - accountId: - type: string - description: Unique ID of the account - example: John.Doe - attributeRequests: - type: array - items: - type: object - properties: - name: - type: string - description: The attribute name - example: groups - op: - type: string - description: The operation to perform - example: Add - value: - type: string - description: The value of the attribute - example: '3203537556531076' - op: + description: Name of the identity attribute. + example: email + transformDefinition: + description: The seaspray transformation definition. + type: object + properties: + type: type: string - example: Modify - description: The operation that was performed - provisioningTarget: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - result: + description: The type of the transform definition. + example: accountAttribute + attributes: type: object - properties: - errors: - type: array - items: - type: string - example: |- - [ConnectorError] [ - { - "code": "unrecognized_keys", - "keys": [ - "groups" - ], - "path": [], - "message": "Unrecognized key(s) in object: 'groups'" - } - ] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e) - status: - type: string - description: The status of the account request - example: failed - ticketId: - type: string - nullable: true - example: null - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - sources: - type: string - example: 'smartsheet-test, airtable-v4, IdentityNow' - - description: Account - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - name: - type: string - example: john.doe - _type: - description: |- - Enum representing the currently supported document types. + additionalProperties: + anyOf: + - type: string + - type: object + description: Arbitrary key-value pairs to store any metadata for the object + example: + attributeName: e-mail + sourceName: MySource + sourceId: 2c9180877a826e68017a8c0b03da1a53 + identityExceptionReportReference: + type: object + nullable: true + properties: + taskResultId: + type: string + format: uuid + description: The id of the task result. + example: 2b838de9-db9b-abcf-e646-d4f274ad4238 + reportName: + type: string + example: My annual report + description: The name of the report. + hasTimeBasedAttr: + description: Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. + type: boolean + default: false + example: true + '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. + security: + - UserContextAuth: + - 'idn:identity-profile:read' + /identity-profiles/bulk-delete: + post: + operationId: deleteIdentityProfiles + tags: + - Identity Profiles + summary: Delete Identity Profiles + description: |- + This deletes multiple Identity Profiles via a list of supplied IDs. + + On success, this endpoint will return a reference to the bulk delete task result. + + A token with ORG_ADMIN authority is required to call this API. + + The following rights are required to access this endpoint: idn:identity-profile:delete + requestBody: + description: Identity Profile bulk delete request body. + required: true + content: + application/json: + schema: + description: List of Identity Profile IDs to delete. + type: array + items: + type: string + example: + - 2c9180867b2a34e0017b3078d60b0699 + - 2c9180867b2a34e0017b3078d60b0698 + responses: + '202': + description: Accepted - Returns a TaskResult object referencing the bulk delete job created. + content: + application/json: + schema: + description: An object with a TaskResult reference of the bulk delete job + type: object + properties: + id: + type: string + description: Task identifier + example: ff8081814d977c21014da056804a0af3 + name: + type: string + description: Task name + example: Background Object Terminator c8f030f2-b1a6-4e33-99e8-6935bc18735d + description: + type: string + description: Task description + example: 'Generic task for terminating data in the overlay, used by the TerminationService.' + launcher: + type: string + description: User or process who launched the task + example: support + completed: + type: string + format: date-time + description: Date time of completion + example: 'Mon Aug 21 14:57:39 CDT 2023' + launched: + type: string + format: date-time + description: Date time when the task was launched + example: 'Mon Aug 21 14:55:39 CDT 2023' + completionStatus: + type: string + enum: + - Success + - Warning + - Error + - Terminated + - TempError + description: Task result status + example: Success + '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. + security: + - UserContextAuth: + - 'idn:identity-profile:delete' + /identity-profiles/export: + get: + operationId: exportIdentityProfiles + tags: + - Identity Profiles + summary: Export Identity Profiles + description: This exports existing identity profiles in the format specified by the sp-config service. + parameters: + - 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. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofile - - accountactivity - - account - - aggregation - - entitlement - - event - - identity - - role - example: identity - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - accountId: - type: string - description: The ID of the account - example: john.doe - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - disabled: - type: boolean - description: Indicates if the account is disabled - example: false - locked: - type: boolean - description: Indicates if the account is locked - example: false - privileged: - type: boolean - example: false - manuallyCorrelated: - type: boolean - description: Indicates if the account has been manually correlated to an identity - example: false - passwordLastSet: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - entitlementAttributes: - type: object - nullable: true - description: a map or dictionary of key/value pairs - additionalProperties: true - example: - moderator: true - admin: true - trust_level: '4' - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - - type: object - properties: - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - attributes: - type: object - description: a map or dictionary of key/value pairs - additionalProperties: true - example: - firstName: John - lastName: Doe - displayName: John.Doe - identity: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe - access: - type: array - items: - description: EntitlementReference - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - example: null - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - privileged: - type: boolean - example: false - attribute: - type: string - example: memberOf - value: - type: string - example: 'CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' - standalone: - type: boolean - example: false - entitlementCount: - type: integer - description: The number of entitlements assigned to the account - format: int32 - example: 2 - uncorrelated: - type: boolean - description: Indicates if the account is not correlated to an identity - example: false - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - - description: Aggregation - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - name: - type: string - example: john.doe - _type: - description: |- - Enum representing the currently supported document types. + 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. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofile - - accountactivity - - account - - aggregation - - entitlement - - event - - identity - - role - example: identity - - type: object - properties: - status: - type: string - example: Success - duration: - type: integer - format: int32 - example: 20 - avgDuration: - type: integer - format: int32 - example: 20 - changedAccounts: - type: integer - format: int32 - example: 1 - nextScheduled: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - startTime: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - sourceOwner: - type: string - description: John Doe - - description: Entitlement - allOf: - - type: object - required: - - id - - name - - _type + 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 + required: false + schema: + type: string + example: id eq "ef38f94347e94562b5bb8424a56397d8" + 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, ne* + + **name**: *eq, ne* + + **priority**: *eq, ne* + - in: query + name: sorters + required: false + schema: + type: string + format: comma-separated + example: 'id,name' + 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: **id**, **name**, **priority** + responses: + '200': + description: List of export objects with identity profiles. + content: + application/json: + schema: + type: array + items: + type: object + description: Identity Profile exported object + properties: + version: + type: integer + example: 1 + description: Version or object from the target service. + format: int32 + self: + 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 + - WORKGROUP + 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 + object: + allOf: + - type: object + required: + - name + properties: + id: + description: System-generated unique ID of the Object + type: string + example: id12345 + readOnly: true + name: + description: Name of the Object + type: string + example: aName + created: + description: Creation date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + modified: + description: Last modification date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + - type: object + required: + - authoritativeSource + properties: + description: + type: string + description: The description of the Identity Profile. + example: My custom flat file profile + nullable: true + owner: + type: object + description: The owner of the Identity Profile. + nullable: true properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - name: - type: string - example: john.doe - _type: - description: |- - Enum representing the currently supported document types. - - Additional values may be added in the future without notice. + type: type: string enum: - - accessprofile - - accountactivity - - account - - aggregation - - entitlement - - event - - identity - - role - example: identity - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - description: - type: string - description: A description of the entitlement - example: The admin privilege - attribute: - type: string - description: The name of the entitlement attribute - example: admin - value: - type: string - description: The value of the entitlement - example: 'true' - - type: object - properties: - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - displayName: - type: string - description: The display name of the entitlement - example: Admin - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - privileged: - type: boolean - example: false - identityCount: - type: integer - format: int32 - example: 3 - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - - description: Event - allOf: - - type: object - required: - - id - - name - - _type - properties: + - IDENTITY + description: Type of the object to which this reference applies + example: IDENTITY id: type: string - example: 2c91808375d8e80a0175e1f88a575222 + description: ID of the object to which this reference applies + example: 2c9180835d191a86015d28455b4b232a name: type: string - example: john.doe - _type: - description: |- - Enum representing the currently supported document types. - - Additional values may be added in the future without notice. - type: string - enum: - - accessprofile - - accountactivity - - account - - aggregation - - entitlement - - event - - identity - - role - example: identity - - type: object + description: Human-readable display name of the object to which this reference applies + example: William Wilson + priority: + type: integer + format: int64 + description: The priority for an Identity Profile. + example: 10 + authoritativeSource: + type: object properties: - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - action: - type: string - description: The action that was performed - example: update type: type: string - description: The type of event - example: SYSTEM_CONFIG - actor: - type: object - properties: - name: - type: string - example: John Doe - description: the actor or target name - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - target: - type: object - properties: - name: - type: string - example: John Doe - description: the actor or target name - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - stack: - type: string - example: tpe - trackingNumber: - type: string - example: 63f891e0735f4cc8bf1968144a1e7440 - ipAddress: - type: string - example: 52.52.97.85 - details: - type: string - example: 73b65dfbed1842548c207432a18c84b0 - attributes: - type: object - additionalProperties: true - example: - pod: stg03-useast1 - org: acme - sourceName: SailPoint - objects: - type: array - items: - type: string - example: AUTHENTICATION - operation: - type: string - example: REQUEST - status: - type: string - example: PASSED - technicalName: - type: string - example: AUTHENTICATION_REQUEST_PASSED - - description: Identity - allOf: - - type: object - required: - - id - - name - - _type - properties: + enum: + - SOURCE + description: Type of the object to which this reference applies + example: SOURCE id: type: string - example: 2c91808375d8e80a0175e1f88a575222 + description: ID of the object to which this reference applies + example: 2c9180835d191a86015d28455b4b232a name: type: string - example: john.doe - _type: - description: |- - Enum representing the currently supported document types. - - Additional values may be added in the future without notice. - type: string - enum: - - accessprofile - - accountactivity - - account - - aggregation - - entitlement - - event - - identity - - role - example: identity - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object + description: Human-readable display name of the object to which this reference applies + example: HR Active Directory + identityRefreshRequired: + type: boolean + default: false + description: True if a identity refresh is needed. Typically triggered when a change on the source has been made. + example: true + identityCount: + type: integer + description: The number of identities that belong to the Identity Profile. + format: int32 + example: 8 + identityAttributeConfig: + type: object + description: Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. properties: - firstName: - type: string - description: The first name of the identity - example: Carol - lastName: - type: string - description: The last name of the identity - example: Adams - displayName: - type: string - example: Carol.Adams - description: The display name of the identity - email: - type: string - description: The identity's primary email address - example: Carol.Adams@sailpointdemo.com - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - phone: - type: string - description: The phone number of the identity - example: +1 440-527-3672 - inactive: - type: boolean - description: Indicates if the identity is inactive - example: false - protected: - type: boolean - example: false - status: - type: string - description: The identity's status in SailPoint - example: UNREGISTERED - employeeNumber: - type: string - example: 1a2a3d4e - manager: - nullable: true - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe - isManager: + enabled: + description: The backend will only promote values if the profile/mapping is enabled. type: boolean - description: Indicates if this identity is a manager of other identities - example: false - identityProfile: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - attributes: - type: object - description: a map or dictionary of key/value pairs - additionalProperties: true - example: - country: US - firstname: Carol - cloudStatus: UNREGISTERED - processingState: - type: string - nullable: true - example: null - processingDetails: - nullable: true - type: object - properties: - date: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - stage: - type: string - example: In Process - retryCount: - type: integer - example: 0 - format: int32 - stackTrace: - type: string - example: - message: - type: string - example: - accounts: + default: false + example: true + attributeTransforms: type: array - description: List of accounts associated with the identity items: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object + type: object + description: Defines a transformation definition for an identity attribute. + properties: + identityAttributeName: + type: string + description: Name of the identity attribute. + example: email + transformDefinition: + description: The seaspray transformation definition. + type: object properties: - accountId: - type: string - description: The ID of the account - example: john.doe - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - disabled: - type: boolean - description: Indicates if the account is disabled - example: false - locked: - type: boolean - description: Indicates if the account is locked - example: false - privileged: - type: boolean - example: false - manuallyCorrelated: - type: boolean - description: Indicates if the account has been manually correlated to an identity - example: false - passwordLastSet: + type: type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - entitlementAttributes: + description: The type of the transform definition. + example: accountAttribute + attributes: type: object - nullable: true - description: a map or dictionary of key/value pairs - additionalProperties: true + additionalProperties: + anyOf: + - type: string + - type: object + description: Arbitrary key-value pairs to store any metadata for the object example: - moderator: true - admin: true - trust_level: '4' - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - accountCount: - type: integer - description: Number of accounts associated with the identity - format: int32 - example: 3 - apps: - type: array - description: The list of applications the identity has access to - items: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - account: - type: object - properties: - id: - type: string - description: The SailPoint generated unique ID - example: 2c9180837dfe6949017e21f3d8cd6d49 - accountId: - type: string - description: The account ID generated by the source - example: 'CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' - appCount: - type: integer - format: int32 - description: The number of applications the identity has access to - example: 2 - access: - type: array - description: The list of access items assigned to the identity - items: - discriminator: - propertyName: type - mapping: - ACCESS_PROFILE: ../access/AccessProfileSummary.yaml - ENTITLEMENT: ../access/AccessProfileEntitlement.yaml - ROLE: ../access/AccessProfileRole.yaml - oneOf: - - description: This is a summary representation of an access profile. - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - example: null - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe - revocable: - type: boolean - example: true - - description: EntitlementReference - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - example: null - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - privileged: - type: boolean - example: false - attribute: - type: string - example: memberOf - value: - type: string - example: 'CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' - standalone: - type: boolean - example: false - - description: Role - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe + attributeName: e-mail + sourceName: MySource + sourceId: 2c9180877a826e68017a8c0b03da1a53 + identityExceptionReportReference: + type: object + nullable: true + properties: + taskResultId: + type: string + format: uuid + description: The id of the task result. + example: 2b838de9-db9b-abcf-e646-d4f274ad4238 + reportName: + type: string + example: My annual report + description: The name of the report. + hasTimeBasedAttr: + description: Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. + type: boolean + default: false + example: true + '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. + security: + - UserContextAuth: + - 'idn:identity-profile:read' + /identity-profiles/import: + post: + operationId: importIdentityProfiles + summary: Import Identity Profiles + description: This imports previously exported identity profiles. + tags: + - Identity Profiles + requestBody: + description: Previously exported Identity Profiles. + required: true + content: + application/json: + schema: + type: array + items: + type: object + description: Identity Profile exported object + properties: + version: + type: integer + example: 1 + description: Version or object from the target service. + format: int32 + self: + 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 + - WORKGROUP + 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 + object: + allOf: + - type: object + required: + - name + properties: + id: + description: System-generated unique ID of the Object + type: string + example: id12345 + readOnly: true + name: + description: Name of the Object + type: string + example: aName + created: + description: Creation date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + modified: + description: Last modification date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + - type: object + required: + - authoritativeSource + properties: + description: + type: string + description: The description of the Identity Profile. + example: My custom flat file profile + nullable: true + owner: + type: object + description: The owner of the Identity Profile. + nullable: true + properties: + type: + type: string + enum: + - IDENTITY + description: Type of the object to which this reference applies + example: IDENTITY + id: + type: string + description: ID of the object to which this reference applies + example: 2c9180835d191a86015d28455b4b232a + name: + type: string + description: Human-readable display name of the object to which this reference applies + example: William Wilson + priority: + type: integer + format: int64 + description: The priority for an Identity Profile. + example: 10 + authoritativeSource: + type: object + properties: + type: + type: string + enum: + - SOURCE + description: Type of the object to which this reference applies + example: SOURCE + id: + type: string + description: ID of the object to which this reference applies + example: 2c9180835d191a86015d28455b4b232a + name: + type: string + description: Human-readable display name of the object to which this reference applies + example: HR Active Directory + identityRefreshRequired: + type: boolean + default: false + description: True if a identity refresh is needed. Typically triggered when a change on the source has been made. + example: true + identityCount: + type: integer + description: The number of identities that belong to the Identity Profile. + format: int32 + example: 8 + identityAttributeConfig: + type: object + description: Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. + properties: + enabled: + description: The backend will only promote values if the profile/mapping is enabled. + type: boolean + default: false + example: true + attributeTransforms: + type: array + items: + type: object + description: Defines a transformation definition for an identity attribute. + properties: + identityAttributeName: + type: string + description: Name of the identity attribute. + example: email + transformDefinition: + description: The seaspray transformation definition. + type: object + properties: + type: + type: string + description: The type of the transform definition. + example: accountAttribute + attributes: + type: object + additionalProperties: + anyOf: + - type: string - type: object - properties: - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - example: null - - type: object - properties: - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe - disabled: - type: boolean - revocable: - type: boolean - accessCount: - type: integer - format: int32 - description: The number of access items assigned to the identity - example: 5 - accessProfileCount: - type: integer - description: The number of access profiles assigned to the identity - example: 1 - entitlementCount: - type: integer - description: The number of entitlements assigned to the identity - example: 10 - roleCount: - type: integer - description: The number of roles assigned to the identity - example: 1 - owns: + description: Arbitrary key-value pairs to store any metadata for the object + example: + attributeName: e-mail + sourceName: MySource + sourceId: 2c9180877a826e68017a8c0b03da1a53 + identityExceptionReportReference: + type: object + nullable: true + properties: + taskResultId: + type: string + format: uuid + description: The id of the task result. + example: 2b838de9-db9b-abcf-e646-d4f274ad4238 + reportName: + type: string + example: My annual report + description: The name of the report. + hasTimeBasedAttr: + description: Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. + type: boolean + default: false + example: true + responses: + '200': + description: The result of importing Identity Profiles. + content: + application/json: + schema: + type: object + title: Import Object Response Body + description: Response model for import of a single object. + properties: + infos: + description: Informational messages returned from the target service on import. + type: array + items: + type: object + title: Config Import/Export Message + description: Message model for Config Import/Export. + properties: + key: + type: string + description: Message key. + example: UNKNOWN_REFERENCE_RESOLVER + text: + type: string + description: Message text. + example: 'Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]' + details: + type: object + description: 'Message details if any, in key:value pairs.' + additionalProperties: true + example: + details: message details + required: + - key + - text + - details + warnings: + description: Warning messages returned from the target service on import. + type: array + items: + type: object + title: Config Import/Export Message + description: Message model for Config Import/Export. + properties: + key: + type: string + description: Message key. + example: UNKNOWN_REFERENCE_RESOLVER + text: + type: string + description: Message text. + example: 'Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]' + details: + type: object + description: 'Message details if any, in key:value pairs.' + additionalProperties: true + example: + details: message details + required: + - key + - text + - details + errors: + description: Error messages returned from the target service on import. + type: array + items: + type: object + title: Config Import/Export Message + description: Message model for Config Import/Export. + properties: + key: + type: string + description: Message key. + example: UNKNOWN_REFERENCE_RESOLVER + text: + type: string + description: Message text. + example: 'Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]' + details: + type: object + description: 'Message details if any, in key:value pairs.' + additionalProperties: true + example: + details: message details + required: + - key + - text + - details + importedObjects: + description: References to objects that were created or updated by the import. + type: array + items: + 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 + - WORKGROUP + 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 + required: + - infos + - warnings + - errors + - importedObjects + '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. + security: + - UserContextAuth: + - 'idn:identity-profile:manage' + '/identity-profiles/{identity-profile-id}': + get: + operationId: getIdentityProfile + tags: + - Identity Profiles + summary: Get single Identity Profile + description: |- + This returns a single Identity Profile based on ID. + A token with ORG_ADMIN or API authority is required to call this API. + parameters: + - in: path + name: identity-profile-id + schema: + type: string + format: uuid + required: true + description: The Identity Profile ID. + example: 2b838de9-db9b-abcf-e646-d4f274ad4238 + responses: + '200': + description: An Identity Profile object. + content: + application/json: + schema: + allOf: + - type: object + required: + - name + properties: + id: + description: System-generated unique ID of the Object + type: string + example: id12345 + readOnly: true + name: + description: Name of the Object + type: string + example: aName + created: + description: Creation date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + modified: + description: Last modification date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + - type: object + required: + - authoritativeSource + properties: + description: + type: string + description: The description of the Identity Profile. + example: My custom flat file profile + nullable: true + owner: + type: object + description: The owner of the Identity Profile. + nullable: true + properties: + type: + type: string + enum: + - IDENTITY + description: Type of the object to which this reference applies + example: IDENTITY + id: + type: string + description: ID of the object to which this reference applies + example: 2c9180835d191a86015d28455b4b232a + name: + type: string + description: Human-readable display name of the object to which this reference applies + example: William Wilson + priority: + type: integer + format: int64 + description: The priority for an Identity Profile. + example: 10 + authoritativeSource: + type: object + properties: + type: + type: string + enum: + - SOURCE + description: Type of the object to which this reference applies + example: SOURCE + id: + type: string + description: ID of the object to which this reference applies + example: 2c9180835d191a86015d28455b4b232a + name: + type: string + description: Human-readable display name of the object to which this reference applies + example: HR Active Directory + identityRefreshRequired: + type: boolean + default: false + description: True if a identity refresh is needed. Typically triggered when a change on the source has been made. + example: true + identityCount: + type: integer + description: The number of identities that belong to the Identity Profile. + format: int32 + example: 8 + identityAttributeConfig: + type: object + description: Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. + properties: + enabled: + description: The backend will only promote values if the profile/mapping is enabled. + type: boolean + default: false + example: true + attributeTransforms: + type: array + items: + type: object + description: Defines a transformation definition for an identity attribute. + properties: + identityAttributeName: + type: string + description: Name of the identity attribute. + example: email + transformDefinition: + description: The seaspray transformation definition. type: object properties: - sources: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - entitlements: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - accessProfiles: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - roles: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - apps: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - governanceGroups: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - fallbackApprover: - type: boolean - example: false - tags: - type: array - items: + type: + type: string + description: The type of the transform definition. + example: accountAttribute + attributes: + type: object + additionalProperties: + anyOf: + - type: string + - type: object + description: Arbitrary key-value pairs to store any metadata for the object + example: + attributeName: e-mail + sourceName: MySource + sourceId: 2c9180877a826e68017a8c0b03da1a53 + identityExceptionReportReference: + type: object + nullable: true + properties: + taskResultId: + type: string + format: uuid + description: The id of the task result. + example: 2b838de9-db9b-abcf-e646-d4f274ad4238 + reportName: + type: string + example: My annual report + description: The name of the report. + hasTimeBasedAttr: + description: Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. + type: boolean + default: false + example: true + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + security: + - UserContextAuth: + - 'idn:identity-profile:read' + delete: + operationId: deleteIdentityProfile + tags: + - Identity Profiles + summary: Delete an Identity Profile + description: |- + This deletes an Identity Profile based on ID. + + On success, this endpoint will return a reference to the bulk delete task result. + + A token with ORG_ADMIN authority is required to call this API. + + The following rights are required to access this endpoint: idn:identity-profile:delete + parameters: + - in: path + name: identity-profile-id + schema: + type: string + format: uuid + required: true + description: The Identity Profile ID. + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '202': + description: Accepted - Returns a TaskResult object referencing the bulk delete job created. + content: + application/json: + schema: + description: An object with a TaskResult reference of the delete job. + type: object + properties: + id: + type: string + description: Task identifier + example: ff8081814d977c21014da056804a0af3 + name: + type: string + description: Task name + example: Background Object Terminator c8f030f2-b1a6-4e33-99e8-6935bc18735d + description: + type: string + description: Task description + example: 'Generic task for terminating data in the overlay, used by the TerminationService.' + launcher: + type: string + description: User or process who launched the task + example: support + completed: + type: string + format: date-time + description: Date time of completion + example: 'Mon Aug 21 14:57:39 CDT 2023' + launched: + type: string + format: date-time + description: Date time when the task was launched + example: 'Mon Aug 21 14:55:39 CDT 2023' + completionStatus: + type: string + enum: + - Success + - Warning + - Error + - Terminated + - TempError + description: Task result status + example: Success + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + security: + - UserContextAuth: + - 'idn:identity-profile:delete' + '/identity-profiles/{identity-profile-id}/default-identity-attribute-config': + get: + operationId: getDefaultIdentityAttributeConfig + tags: + - Identity Profiles + summary: Get default Identity Attribute Config + description: |- + This returns the default identity attribute config. + A token with ORG_ADMIN authority is required to call this API to get the default identity attribute config. + parameters: + - in: path + name: identity-profile-id + schema: + type: string + format: uuid + required: true + description: The Identity Profile ID. + example: 2b838de9-db9b-abcf-e646-d4f274ad4238 + responses: + '200': + description: An Identity Attribute Config object. + content: + application/json: + schema: + type: object + description: Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. + properties: + enabled: + description: The backend will only promote values if the profile/mapping is enabled. + type: boolean + default: false + example: true + attributeTransforms: + type: array + items: + type: object + description: Defines a transformation definition for an identity attribute. + properties: + identityAttributeName: + type: string + description: Name of the identity attribute. + example: email + transformDefinition: + description: The seaspray transformation definition. + type: object + properties: + type: + type: string + description: The type of the transform definition. + example: accountAttribute + attributes: + type: object + additionalProperties: + anyOf: + - type: string + - type: object + description: Arbitrary key-value pairs to store any metadata for the object + example: + attributeName: e-mail + sourceName: MySource + sourceId: 2c9180877a826e68017a8c0b03da1a53 + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + security: + - UserContextAuth: + - 'idn:identity-profile:manage' + '/identity-profiles/{identity-profile-id}/process-identities': + post: + operationId: syncIdentityProfile + tags: + - Identity Profiles + summary: Process identities under profile + description: |- + Process identities under the profile + + A token with ORG_ADMIN authority is required to call this API. + parameters: + - in: path + name: identity-profile-id + schema: + type: string + format: uuid + required: true + description: The Identity Profile ID to be processed + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '202': + description: Accepted status after refresh has launched + content: + application/json: + schema: + type: object + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + security: + - UserContextAuth: + - 'idn:identity-profile:refresh' + /non-employee-records: + post: + operationId: createNonEmployeeRecord + tags: + - Non-Employee Lifecycle Management + summary: Create Non-Employee Record + description: |- + This request will create a non-employee record. + Requires role context of `idn:nesr:create` + requestBody: + description: Non-Employee record creation request body. + required: true + content: + application/json: + schema: + type: object + properties: + accountName: + type: string + description: Requested identity account name. + example: william.smith + firstName: + type: string + description: Non-Employee's first name. + example: William + lastName: + type: string + description: Non-Employee's last name. + example: Smith + email: + type: string + description: Non-Employee's email. + example: william.smith@example.com + phone: + type: string + description: Non-Employee's phone. + example: '5555555555' + manager: + type: string + description: The account ID of a valid identity to serve as this non-employee's manager. + example: jane.doe + sourceId: + type: string + description: Non-Employee's source id. + example: 2c91808568c529c60168cca6f90c1313 + data: + type: object + additionalProperties: + type: string + description: 'Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported.' + example: + description: Auditing + startDate: + type: string + format: date-time + description: Non-Employee employment start date. + example: '2020-03-24T00:00:00-05:00' + endDate: + type: string + format: date-time + description: Non-Employee employment end date. + example: '2021-03-25T00:00:00-05:00' + required: + - accountName + - firstName + - lastName + - email + - phone + - manager + - sourceId + - startDate + - endDate + responses: + '200': + description: Created non-employee record. + content: + application/json: + schema: + type: object + properties: + id: + type: string + format: UUID + description: Non-Employee record id. + example: ef38f94347e94562b5bb8424a56397d8 + accountName: + type: string + description: Requested identity account name. + example: Abby.Smith + firstName: + type: string + description: Non-Employee's first name. + example: William + lastName: + type: string + description: Non-Employee's last name. + example: Smith + email: + type: string + description: Non-Employee's email. + example: william.smith@example.com + phone: + type: string + description: Non-Employee's phone. + example: '5555555555' + manager: + type: string + description: The account ID of a valid identity to serve as this non-employee's manager. + example: jane.doe + sourceId: + type: string + description: Non-Employee's source id. + example: 2c91808568c529c60168cca6f90c1313 + data: + type: object + additionalProperties: + type: string + description: Attribute blob/bag for a non-employee. + example: + description: Auditing + startDate: + type: string + format: date-time + description: Non-Employee employment start date. + example: '2019-08-23T18:52:59.162Z' + endDate: + type: string + format: date-time + description: Non-Employee employment end date. + example: '2020-08-23T18:52:59.162Z' + modified: + type: string + format: date-time + description: When the request was last modified. + example: '2019-08-23T18:52:59.162Z' + created: + type: string + format: date-time + description: When the request was created. + example: '2019-08-23T18:40:35.772Z' + '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. + get: + operationId: listNonEmployeeRecords + security: + - UserContextAuth: [] + tags: + - Non-Employee Lifecycle Management + summary: List Non-Employee Records + description: |- + This gets a list of non-employee records. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. + 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. + parameters: + - 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: sorters + required: false + schema: + type: string + format: comma-separated + example: 'accountName,sourceId' + description: 'Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified**' + - in: query + name: filters + required: false + schema: + type: string + example: sourceId eq "2c91808568c529c60168cca6f90c1313" + description: 'Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407) Filtering is supported for the following fields and operators: **sourceId**: *eq* *Example:* sourceId eq "2c91808568c529c60168cca6f90c1313"' + responses: + '200': + description: Non-Employee record objects + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: string + format: UUID + description: Non-Employee record id. + example: ef38f94347e94562b5bb8424a56397d8 + accountName: + type: string + description: Requested identity account name. + example: Abby.Smith + firstName: + type: string + description: Non-Employee's first name. + example: William + lastName: + type: string + description: Non-Employee's last name. + example: Smith + email: + type: string + description: Non-Employee's email. + example: william.smith@example.com + phone: + type: string + description: Non-Employee's phone. + example: '5555555555' + manager: + type: string + description: The account ID of a valid identity to serve as this non-employee's manager. + example: jane.doe + sourceId: + type: string + description: Non-Employee's source id. + example: 2c91808568c529c60168cca6f90c1313 + data: + type: object + additionalProperties: + type: string + description: Attribute blob/bag for a non-employee. + example: + description: Auditing + startDate: + type: string + format: date-time + description: Non-Employee employment start date. + example: '2019-08-23T18:52:59.162Z' + endDate: + type: string + format: date-time + description: Non-Employee employment end date. + example: '2020-08-23T18:52:59.162Z' + modified: + type: string + format: date-time + description: When the request was last modified. + example: '2019-08-23T18:52:59.162Z' + created: + type: string + format: date-time + description: When the request was created. + example: '2019-08-23T18:40:35.772Z' + '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. + '/non-employee-records/{id}': + get: + operationId: getNonEmployeeRecord + tags: + - Non-Employee Lifecycle Management + summary: Get a Non-Employee Record + description: |- + This gets a non-employee record. + Requires role context of `idn:nesr:read` + parameters: + - in: path + name: id + description: Non-Employee record id (UUID) + required: true + example: ef38f94347e94562b5bb8424a56397d8 + schema: + type: string + responses: + '200': + description: Non-Employee record object + content: + application/json: + schema: + type: object + properties: + id: + type: string + format: UUID + description: Non-Employee record id. + example: ef38f94347e94562b5bb8424a56397d8 + accountName: + type: string + description: Requested identity account name. + example: Abby.Smith + firstName: + type: string + description: Non-Employee's first name. + example: William + lastName: + type: string + description: Non-Employee's last name. + example: Smith + email: + type: string + description: Non-Employee's email. + example: william.smith@example.com + phone: + type: string + description: Non-Employee's phone. + example: '5555555555' + manager: + type: string + description: The account ID of a valid identity to serve as this non-employee's manager. + example: jane.doe + sourceId: + type: string + description: Non-Employee's source id. + example: 2c91808568c529c60168cca6f90c1313 + data: + type: object + additionalProperties: + type: string + description: Attribute blob/bag for a non-employee. + example: + description: Auditing + startDate: + type: string + format: date-time + description: Non-Employee employment start date. + example: '2019-08-23T18:52:59.162Z' + endDate: + type: string + format: date-time + description: Non-Employee employment end date. + example: '2020-08-23T18:52:59.162Z' + modified: + type: string + format: date-time + description: When the request was last modified. + example: '2019-08-23T18:52:59.162Z' + created: + type: string + format: date-time + description: When the request was created. + example: '2019-08-23T18:40:35.772Z' + '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. + put: + operationId: updateNonEmployeeRecord + security: + - UserContextAuth: [] + tags: + - Non-Employee Lifecycle Management + summary: Update Non-Employee Record + description: |- + This request will update a non-employee record. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:update`, in which case they + update all available fields. + 2. The user is owner of the source, in this case they can only update the + end date. + parameters: + - in: path + name: id + description: Non-employee record id (UUID) + example: ef38f94347e94562b5bb8424a56397d8 + required: true + schema: + type: string + requestBody: + description: Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + required: true + content: + application/json: + schema: + type: object + properties: + accountName: + type: string + description: Requested identity account name. + example: william.smith + firstName: + type: string + description: Non-Employee's first name. + example: William + lastName: + type: string + description: Non-Employee's last name. + example: Smith + email: + type: string + description: Non-Employee's email. + example: william.smith@example.com + phone: + type: string + description: Non-Employee's phone. + example: '5555555555' + manager: + type: string + description: The account ID of a valid identity to serve as this non-employee's manager. + example: jane.doe + sourceId: + type: string + description: Non-Employee's source id. + example: 2c91808568c529c60168cca6f90c1313 + data: + type: object + additionalProperties: + type: string + description: 'Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported.' + example: + description: Auditing + startDate: + type: string + format: date-time + description: Non-Employee employment start date. + example: '2020-03-24T00:00:00-05:00' + endDate: + type: string + format: date-time + description: Non-Employee employment end date. + example: '2021-03-25T00:00:00-05:00' + required: + - accountName + - firstName + - lastName + - email + - phone + - manager + - sourceId + - startDate + - endDate + responses: + '200': + description: An updated non-employee record. + content: + application/json: + schema: + type: object + properties: + id: + type: string + format: UUID + description: Non-Employee record id. + example: ef38f94347e94562b5bb8424a56397d8 + accountName: + type: string + description: Requested identity account name. + example: Abby.Smith + firstName: + type: string + description: Non-Employee's first name. + example: William + lastName: + type: string + description: Non-Employee's last name. + example: Smith + email: + type: string + description: Non-Employee's email. + example: william.smith@example.com + phone: + type: string + description: Non-Employee's phone. + example: '5555555555' + manager: + type: string + description: The account ID of a valid identity to serve as this non-employee's manager. + example: jane.doe + sourceId: + type: string + description: Non-Employee's source id. + example: 2c91808568c529c60168cca6f90c1313 + data: + type: object + additionalProperties: + type: string + description: Attribute blob/bag for a non-employee. + example: + description: Auditing + startDate: + type: string + format: date-time + description: Non-Employee employment start date. + example: '2019-08-23T18:52:59.162Z' + endDate: + type: string + format: date-time + description: Non-Employee employment end date. + example: '2020-08-23T18:52:59.162Z' + modified: + type: string + format: date-time + description: When the request was last modified. + example: '2019-08-23T18:52:59.162Z' + created: + type: string + format: date-time + description: When the request was created. + example: '2019-08-23T18:40:35.772Z' + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + patch: + operationId: patchNonEmployeeRecord + security: + - UserContextAuth: [] + tags: + - Non-Employee Lifecycle Management + summary: Patch Non-Employee Record + description: |- + This request will patch a non-employee record. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:update`, in which case they + update all available fields. + 2. The user is owner of the source, in this case they can only update the + end date. + parameters: + - in: path + name: id + description: Non-employee record id (UUID) + example: ef38f94347e94562b5bb8424a56397d8 + required: true + schema: + type: string + requestBody: + description: 'A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.' + required: true + content: + application/json-patch+json: + schema: + type: array + items: + type: object + description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' + required: + - op + - path + properties: + op: + type: string + description: The operation to be performed + enum: + - add + - remove + - replace + - move + - copy + - test + example: replace + path: + type: string + description: A string JSON Pointer representing the target path to an element to be affected by the operation + example: /description + value: + anyOf: + - type: string + - type: integer + - type: object + - type: array + items: + anyOf: + - type: string + - type: integer + - type: object + description: 'The value to be used for the operation, required for "add" and "replace" operations' + example: New description + example: + - op: replace + path: /endDate + value: '2019-08-23T18:40:35.772Z' + responses: + '200': + description: A patched non-employee record. + content: + application/json: + schema: + type: object + properties: + id: + type: string + format: UUID + description: Non-Employee record id. + example: ef38f94347e94562b5bb8424a56397d8 + accountName: + type: string + description: Requested identity account name. + example: Abby.Smith + firstName: + type: string + description: Non-Employee's first name. + example: William + lastName: + type: string + description: Non-Employee's last name. + example: Smith + email: + type: string + description: Non-Employee's email. + example: william.smith@example.com + phone: + type: string + description: Non-Employee's phone. + example: '5555555555' + manager: + type: string + description: The account ID of a valid identity to serve as this non-employee's manager. + example: jane.doe + sourceId: + type: string + description: Non-Employee's source id. + example: 2c91808568c529c60168cca6f90c1313 + data: + type: object + additionalProperties: + type: string + description: Attribute blob/bag for a non-employee. + example: + description: Auditing + startDate: + type: string + format: date-time + description: Non-Employee employment start date. + example: '2019-08-23T18:52:59.162Z' + endDate: + type: string + format: date-time + description: Non-Employee employment end date. + example: '2020-08-23T18:52:59.162Z' + modified: + type: string + format: date-time + description: When the request was last modified. + example: '2019-08-23T18:52:59.162Z' + created: + type: string + format: date-time + description: When the request was created. + example: '2019-08-23T18:40:35.772Z' + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + delete: + operationId: deleteNonEmployeeRecord + tags: + - Non-Employee Lifecycle Management + summary: Delete Non-Employee Record + description: |- + This request will delete a non-employee record. + Requires role context of `idn:nesr:delete` + parameters: + - in: path + name: id + description: Non-Employee record id (UUID) + example: ef38f94347e94562b5bb8424a56397d8 + required: true + schema: + type: string + responses: + '204': + description: No content - indicates the request was successful but there is no content to be returned in the response. + '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. + /non-employee-records/bulk-delete: + post: + operationId: deleteNonEmployeeRecordsInBulk + tags: + - Non-Employee Lifecycle Management + summary: Delete Multiple Non-Employee Records + description: 'This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete`' + requestBody: + description: Non-Employee bulk delete request body. + required: true + content: + application/json: + schema: + type: object + properties: + ids: + description: List of non-employee ids. + type: array + items: + type: string + format: uuid + example: + - 2b838de9-db9b-abcf-e646-d4f274ad4238 + - 2d838de9-db9b-abcf-e646-d4f274ad4238 + required: + - ids + responses: + '204': + description: No content - indicates the request was successful but there is no content to be returned in the response. + '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. + /non-employee-requests: + post: + operationId: createNonEmployeeRequest + security: + - UserContextAuth: [] + tags: + - Non-Employee Lifecycle Management + summary: Create Non-Employee Request + description: 'This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source.' + requestBody: + description: Non-Employee creation request body + required: true + content: + application/json: + schema: + type: object + properties: + accountName: + type: string + description: Requested identity account name. + example: william.smith + firstName: + type: string + description: Non-Employee's first name. + example: William + lastName: + type: string + description: Non-Employee's last name. + example: Smith + email: + type: string + description: Non-Employee's email. + example: william.smith@example.com + phone: + type: string + description: Non-Employee's phone. + example: '5555555555' + manager: + type: string + description: The account ID of a valid identity to serve as this non-employee's manager. + example: jane.doe + sourceId: + type: string + description: Non-Employee's source id. + example: 2c91808568c529c60168cca6f90c1313 + data: + type: object + additionalProperties: + type: string + description: 'Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported.' + example: + description: Auditing + startDate: + type: string + format: date-time + description: Non-Employee employment start date. + example: '2020-03-24T00:00:00-05:00' + endDate: + type: string + format: date-time + description: Non-Employee employment end date. + example: '2021-03-25T00:00:00-05:00' + required: + - accountName + - firstName + - lastName + - email + - phone + - manager + - sourceId + - startDate + - endDate + responses: + '200': + description: Non-Employee request creation object + content: + application/json: + schema: + allOf: + - type: object + properties: + id: + type: string + format: UUID + description: Non-Employee source id. + example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 + sourceId: + type: string + description: Source Id associated with this non-employee source. + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Source name associated with this non-employee source. + example: Retail + description: + type: string + description: Source description associated with this non-employee source. + example: Source description + - type: object + properties: + accountName: + type: string + description: Requested identity account name. + example: william.smith + firstName: + type: string + description: Non-Employee's first name. + example: William + lastName: + type: string + description: Non-Employee's last name. + example: Smith + email: + type: string + description: Non-Employee's email. + example: william.smith@example.com + phone: + type: string + description: Non-Employee's phone. + example: '5555555555' + manager: + type: string + description: The account ID of a valid identity to serve as this non-employee's manager. + example: jane.doe + nonEmployeeSource: + type: object + properties: + id: + type: string + format: UUID + description: Non-Employee source id. + example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 + sourceId: + type: string + description: Source Id associated with this non-employee source. + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Source name associated with this non-employee source. + example: Retail + description: + type: string + description: Source description associated with this non-employee source. + example: Source description + data: + type: object + additionalProperties: + type: string + description: Attribute blob/bag for a non-employee. + example: + description: Auditing + approvalItems: + description: List of approval item for the request + type: array + items: + type: object + properties: + id: + type: string + format: UUID + description: Non-Employee approval item id + example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c + approver: + description: Reference to the associated Identity + type: object + properties: + type: + type: string + enum: + - GOVERNANCE_GROUP + - IDENTITY + example: IDENTITY + description: Identifies if the identity is a normal identity or a governance group + id: + type: string + description: Identity id + example: 5168015d32f890ca15812c9180835d2e + accountName: + type: string + description: Requested identity account name + example: test.account + approvalStatus: + type: string + enum: + - APPROVED + - REJECTED + - PENDING + - NOT_READY + - CANCELLED + description: Enum representing the non-employee request approval status + example: APPROVED + approvalOrder: + type: number + description: Approval order + example: 1 + format: float + comment: + type: string + description: comment of approver + example: I approve + modified: + type: string + format: date-time + description: When the request was last modified. + example: '2019-08-23T18:52:59.162Z' + created: + type: string + format: date-time + description: When the request was created. + example: '2019-08-23T18:40:35.772Z' + approvalStatus: + type: string + enum: + - APPROVED + - REJECTED + - PENDING + - NOT_READY + - CANCELLED + description: Enum representing the non-employee request approval status + example: APPROVED + comment: + type: string + description: comment of requester + example: approved + completionDate: + type: string + format: date-time + description: When the request was completely approved. + example: '2020-03-24T11:11:41.139-05:00' + startDate: + type: string + format: date-time + description: Non-Employee employment start date. + example: '2020-03-24T00:00:00-05:00' + endDate: + type: string + format: date-time + description: Non-Employee employment end date. + example: '2021-03-25T00:00:00-05:00' + modified: + type: string + format: date-time + description: When the request was last modified. + example: '2020-03-24T11:11:41.139-05:00' + created: + type: string + format: date-time + description: When the request was created. + example: '2020-03-24T11:11:41.139-05:00' + '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. + examples: + 400.1 Bad Request Content: + description: Response for bad request content + value: + detailCode: 400.1 Bad Request Content + trackingId: e7eab60924f64aa284175b9fa3309599 + messages: + - locale: en + localeOrigin: REQUEST + text: firstName is required; accountName is required; + 400.1.409 Reference conflict: + description: Response for reference conflict + value: + detailCode: 400.1.409 Reference conflict + trackingId: e7eab60924f64aa284175b9fa3309599 + messages: + - locale: en + localeOrigin: REQUEST + text: Unable to create Non-Employee because the accountName "existed" is already being used. + '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. + get: + operationId: listNonEmployeeRequests + security: + - UserContextAuth: [] + tags: + - Non-Employee Lifecycle Management + summary: List Non-Employee Requests + description: |- + This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or + she may request a list non-employee requests assigned to a particular account manager by passing in that manager's id. + 2. The current user is an account manager, in which case "me" should be + provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. + parameters: + - 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: requested-for + required: true + schema: + type: string + example: e136567de87e4d029e60b3c3c55db56d + description: The identity for whom the request was made. *me* indicates the current user. + - in: query + name: sorters + required: false + schema: + type: string + format: comma-separated + example: 'created,approvalStatus' + description: 'Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate**' + - in: query + name: filters + required: false + schema: + type: string + example: sourceId eq "2c91808568c529c60168cca6f90c1313" + description: 'Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407) Filtering is supported for the following fields and operators: **sourceId**: *eq* *Example:* sourceId eq "2c91808568c529c60168cca6f90c1313"' + responses: + '200': + description: List of non-employee request objects. + content: + application/json: + schema: + type: array + items: + allOf: + - type: object + properties: + id: + type: string + format: UUID + description: Non-Employee source id. + example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 + sourceId: + type: string + description: Source Id associated with this non-employee source. + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Source name associated with this non-employee source. + example: Retail + description: + type: string + description: Source description associated with this non-employee source. + example: Source description + - type: object + properties: + accountName: + type: string + description: Requested identity account name. + example: william.smith + firstName: + type: string + description: Non-Employee's first name. + example: William + lastName: + type: string + description: Non-Employee's last name. + example: Smith + email: + type: string + description: Non-Employee's email. + example: william.smith@example.com + phone: + type: string + description: Non-Employee's phone. + example: '5555555555' + manager: + type: string + description: The account ID of a valid identity to serve as this non-employee's manager. + example: jane.doe + nonEmployeeSource: + type: object + properties: + id: + type: string + format: UUID + description: Non-Employee source id. + example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 + sourceId: + type: string + description: Source Id associated with this non-employee source. + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Source name associated with this non-employee source. + example: Retail + description: + type: string + description: Source description associated with this non-employee source. + example: Source description + data: + type: object + additionalProperties: + type: string + description: Attribute blob/bag for a non-employee. + example: + description: Auditing + approvalItems: + description: List of approval item for the request + type: array + items: + type: object + properties: + id: + type: string + format: UUID + description: Non-Employee approval item id + example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c + approver: + description: Reference to the associated Identity + type: object + properties: + type: + type: string + enum: + - GOVERNANCE_GROUP + - IDENTITY + example: IDENTITY + description: Identifies if the identity is a normal identity or a governance group + id: + type: string + description: Identity id + example: 5168015d32f890ca15812c9180835d2e + accountName: + type: string + description: Requested identity account name + example: test.account + approvalStatus: + type: string + enum: + - APPROVED + - REJECTED + - PENDING + - NOT_READY + - CANCELLED + description: Enum representing the non-employee request approval status + example: APPROVED + approvalOrder: + type: number + description: Approval order + example: 1 + format: float + comment: + type: string + description: comment of approver + example: I approve + modified: + type: string + format: date-time + description: When the request was last modified. + example: '2019-08-23T18:52:59.162Z' + created: + type: string + format: date-time + description: When the request was created. + example: '2019-08-23T18:40:35.772Z' + approvalStatus: + type: string + enum: + - APPROVED + - REJECTED + - PENDING + - NOT_READY + - CANCELLED + description: Enum representing the non-employee request approval status + example: APPROVED + comment: + type: string + description: comment of requester + example: approved + completionDate: + type: string + format: date-time + description: When the request was completely approved. + example: '2020-03-24T11:11:41.139-05:00' + startDate: + type: string + format: date-time + description: Non-Employee employment start date. + example: '2020-03-24T00:00:00-05:00' + endDate: + type: string + format: date-time + description: Non-Employee employment end date. + example: '2021-03-25T00:00:00-05:00' + modified: + type: string + format: date-time + description: When the request was last modified. + example: '2020-03-24T11:11:41.139-05:00' + created: + type: string + format: date-time + description: When the request was created. + example: '2020-03-24T11:11:41.139-05:00' + '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. + '/non-employee-requests/{id}': + get: + operationId: getNonEmployeeRequest + security: + - UserContextAuth: [] + tags: + - Non-Employee Lifecycle Management + summary: Get a Non-Employee Request + description: |- + This gets a non-employee request. + There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in this case the user + can get the non-employee request for any user. + 2. The user must be the owner of the non-employee request. + parameters: + - in: path + name: id + description: Non-Employee request id (UUID) + example: ac110005-7156-1150-8171-5b292e3e0084 + required: true + schema: + type: string + responses: + '200': + description: Non-Employee request object. + content: + application/json: + schema: + allOf: + - type: object + properties: + id: + type: string + format: UUID + description: Non-Employee source id. + example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 + sourceId: + type: string + description: Source Id associated with this non-employee source. + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Source name associated with this non-employee source. + example: Retail + description: + type: string + description: Source description associated with this non-employee source. + example: Source description + - type: object + properties: + accountName: + type: string + description: Requested identity account name. + example: william.smith + firstName: + type: string + description: Non-Employee's first name. + example: William + lastName: + type: string + description: Non-Employee's last name. + example: Smith + email: + type: string + description: Non-Employee's email. + example: william.smith@example.com + phone: + type: string + description: Non-Employee's phone. + example: '5555555555' + manager: + type: string + description: The account ID of a valid identity to serve as this non-employee's manager. + example: jane.doe + nonEmployeeSource: + type: object + properties: + id: + type: string + format: UUID + description: Non-Employee source id. + example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 + sourceId: + type: string + description: Source Id associated with this non-employee source. + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Source name associated with this non-employee source. + example: Retail + description: + type: string + description: Source description associated with this non-employee source. + example: Source description + data: + type: object + additionalProperties: + type: string + description: Attribute blob/bag for a non-employee. + example: + description: Auditing + approvalItems: + description: List of approval item for the request + type: array + items: + type: object + properties: + id: + type: string + format: UUID + description: Non-Employee approval item id + example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c + approver: + description: Reference to the associated Identity + type: object + properties: + type: + type: string + enum: + - GOVERNANCE_GROUP + - IDENTITY + example: IDENTITY + description: Identifies if the identity is a normal identity or a governance group + id: + type: string + description: Identity id + example: 5168015d32f890ca15812c9180835d2e + accountName: + type: string + description: Requested identity account name + example: test.account + approvalStatus: + type: string + enum: + - APPROVED + - REJECTED + - PENDING + - NOT_READY + - CANCELLED + description: Enum representing the non-employee request approval status + example: APPROVED + approvalOrder: + type: number + description: Approval order + example: 1 + format: float + comment: + type: string + description: comment of approver + example: I approve + modified: + type: string + format: date-time + description: When the request was last modified. + example: '2019-08-23T18:52:59.162Z' + created: + type: string + format: date-time + description: When the request was created. + example: '2019-08-23T18:40:35.772Z' + approvalStatus: + type: string + enum: + - APPROVED + - REJECTED + - PENDING + - NOT_READY + - CANCELLED + description: Enum representing the non-employee request approval status + example: APPROVED + comment: + type: string + description: comment of requester + example: approved + completionDate: + type: string + format: date-time + description: When the request was completely approved. + example: '2020-03-24T11:11:41.139-05:00' + startDate: + type: string + format: date-time + description: Non-Employee employment start date. + example: '2020-03-24T00:00:00-05:00' + endDate: + type: string + format: date-time + description: Non-Employee employment end date. + example: '2021-03-25T00:00:00-05:00' + modified: + type: string + format: date-time + description: When the request was last modified. + example: '2020-03-24T11:11:41.139-05:00' + created: + type: string + format: date-time + description: When the request was created. + example: '2020-03-24T11:11:41.139-05:00' + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + delete: + operationId: deleteNonEmployeeRequest + tags: + - Non-Employee Lifecycle Management + summary: Delete Non-Employee Request + description: |- + This request will delete a non-employee request. + Requires role context of `idn:nesr:delete` + parameters: + - in: path + name: id + description: Non-Employee request id in the UUID format + required: true + schema: + type: string + format: uuid + example: ac110005-7156-1150-8171-5b292e3e0084 + responses: + '204': + description: No content - indicates the request was successful but there is no content to be returned in the response. + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + '/non-employee-requests/summary/{requested-for}': + get: + operationId: getNonEmployeeRequestSummary + security: + - UserContextAuth: [] + tags: + - Non-Employee Lifecycle Management + summary: Get Summary of Non-Employee Requests + description: |- + This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or + she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id. + 2. The current user is an account manager, in which case "me" should be + provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. + parameters: + - in: path + name: requested-for + description: The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use "me" instead to indicate the current user. + required: true + schema: + type: string + format: uuid (if user is Org Admin) + example: 2c91808280430dfb0180431a59440460 + responses: + '200': + description: Non-Employee request summary object. + content: + application/json: + schema: + type: object + properties: + approved: + type: integer + description: The number of approved non-employee requests on all sources that *requested-for* user manages. + example: 2 + format: int32 + rejected: + type: integer + description: The number of rejected non-employee requests on all sources that *requested-for* user manages. + example: 2 + format: int32 + pending: + type: integer + description: The number of pending non-employee requests on all sources that *requested-for* user manages. + example: 2 + format: int32 + nonEmployeeCount: + type: integer + description: The number of non-employee records on all sources that *requested-for* user manages. + example: 2 + format: int32 + '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. + /non-employee-sources: + post: + operationId: createNonEmployeeSource + tags: + - Non-Employee Lifecycle Management + summary: Create Non-Employee Source + description: 'This request will create a non-employee source. Requires role context of `idn:nesr:create`' + requestBody: + description: Non-Employee source creation request body. + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: Name of non-employee source. + example: Retail + description: + type: string + description: Description of non-employee source. + example: Source description + owner: + description: Owner of non-employee source. + type: object + properties: + id: + type: string + format: UUID + description: Identity id. + example: 2c91808570313110017040b06f344ec9 + required: + - id + managementWorkgroup: + type: string + description: The ID for the management workgroup that contains source sub-admins + example: '123299' + approvers: + description: List of approvers. + type: array + items: + type: object + properties: + id: + type: string + format: UUID + description: Identity id. + example: 2c91808570313110017040b06f344ec9 + required: + - id + maxItems: 3 + accountManagers: + description: List of account managers. + type: array + items: + type: object + properties: + id: + type: string + format: UUID + description: Identity id. + example: 2c91808570313110017040b06f344ec9 + required: + - id + maxItems: 10 + required: + - owner + - name + - description + responses: + '200': + description: Created non-employee source. + content: + application/json: + schema: + allOf: + - allOf: + - type: object + properties: + id: + type: string + format: UUID + description: Non-Employee source id. + example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 + sourceId: + type: string + description: Source Id associated with this non-employee source. + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Source name associated with this non-employee source. + example: Retail + description: + type: string + description: Source description associated with this non-employee source. + example: Source description + - type: object + properties: + approvers: + description: List of approvers + type: array + items: + type: object + properties: + type: + type: string + enum: + - GOVERNANCE_GROUP + - IDENTITY + example: IDENTITY + description: Identifies if the identity is a normal identity or a governance group + id: + type: string + description: Identity id + example: 5168015d32f890ca15812c9180835d2e + accountManagers: + description: List of account managers + type: array + items: + type: object + properties: + type: + type: string + enum: + - GOVERNANCE_GROUP + - IDENTITY + example: IDENTITY + description: Identifies if the identity is a normal identity or a governance group + id: + type: string + description: Identity id + example: 5168015d32f890ca15812c9180835d2e + modified: + type: string + format: date-time + description: When the request was last modified. + example: '2019-08-23T18:52:59.162Z' + created: + type: string + format: date-time + description: When the request was created. + example: '2019-08-23T18:40:35.772Z' + - type: object + properties: + cloudExternalId: + type: string + description: Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present. + example: '99999' + '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. + get: + operationId: listNonEmployeeSources + security: + - UserContextAuth: [] + tags: + - Non-Employee Lifecycle Management + summary: List Non-Employee Sources + description: |- + This gets a list of non-employee sources. There are two contextual uses for the requested-for path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or + she may request a list sources assigned to a particular account manager by passing in that manager's id. + 2. The current user is an account manager, in which case "me" should be + provided as the `requested-for` value. This will provide the user with a list of the sources that he or she owns. + parameters: + - 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: requested-for + required: true + schema: + type: string + example: me + description: The identity for whom the request was made. *me* indicates the current user. + - in: query + name: non-employee-count + required: false + example: true + schema: + type: boolean + description: The flag to determine whether return a non-employee count associate with source. + - in: query + name: sorters + required: false + schema: + type: string + format: comma-separated + example: 'name,created' + description: 'Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949) Sorting is supported for the following fields: **name, created**' + responses: + '200': + description: List of non-employee sources objects. + content: + application/json: + schema: + type: array + items: + allOf: + - allOf: + - type: object + properties: + id: + type: string + format: UUID + description: Non-Employee source id. + example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 + sourceId: + type: string + description: Source Id associated with this non-employee source. + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Source name associated with this non-employee source. + example: Retail + description: + type: string + description: Source description associated with this non-employee source. + example: Source description + - type: object + properties: + approvers: + description: List of approvers + type: array + items: + type: object + properties: + type: + type: string + enum: + - GOVERNANCE_GROUP + - IDENTITY + example: IDENTITY + description: Identifies if the identity is a normal identity or a governance group + id: + type: string + description: Identity id + example: 5168015d32f890ca15812c9180835d2e + accountManagers: + description: List of account managers + type: array + items: + type: object + properties: + type: + type: string + enum: + - GOVERNANCE_GROUP + - IDENTITY + example: IDENTITY + description: Identifies if the identity is a normal identity or a governance group + id: + type: string + description: Identity id + example: 5168015d32f890ca15812c9180835d2e + modified: + type: string + format: date-time + description: When the request was last modified. + example: '2019-08-23T18:52:59.162Z' + created: + type: string + format: date-time + description: When the request was created. + example: '2019-08-23T18:40:35.772Z' + - type: object + properties: + nonEmployeeCount: + type: integer + description: Number of non-employee records associated with this source. + format: int32 + example: 120 + '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. + '/non-employee-sources/{sourceId}': + get: + operationId: getNonEmployeeSource + security: + - UserContextAuth: [] + tags: + - Non-Employee Lifecycle Management + summary: Get a Non-Employee Source + description: |- + This gets a non-employee source. There are two contextual uses for the requested-for path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or + she may request any source. + 2. The current user is an account manager, in which case the user can only + request sources that they own. + parameters: + - in: path + name: sourceId + description: Source Id + example: 2c91808b7c28b350017c2a2ec5790aa1 + required: true + schema: + type: string + responses: + '200': + description: Non-Employee source object. + content: + application/json: + schema: + allOf: + - type: object + properties: + id: + type: string + format: UUID + description: Non-Employee source id. + example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 + sourceId: + type: string + description: Source Id associated with this non-employee source. + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Source name associated with this non-employee source. + example: Retail + description: + type: string + description: Source description associated with this non-employee source. + example: Source description + - type: object + properties: + approvers: + description: List of approvers + type: array + items: + type: object + properties: + type: + type: string + enum: + - GOVERNANCE_GROUP + - IDENTITY + example: IDENTITY + description: Identifies if the identity is a normal identity or a governance group + id: + type: string + description: Identity id + example: 5168015d32f890ca15812c9180835d2e + accountManagers: + description: List of account managers + type: array + items: + type: object + properties: + type: + type: string + enum: + - GOVERNANCE_GROUP + - IDENTITY + example: IDENTITY + description: Identifies if the identity is a normal identity or a governance group + id: + type: string + description: Identity id + example: 5168015d32f890ca15812c9180835d2e + modified: + type: string + format: date-time + description: When the request was last modified. + example: '2019-08-23T18:52:59.162Z' + created: + type: string + format: date-time + description: When the request was created. + example: '2019-08-23T18:40:35.772Z' + '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. + patch: + operationId: patchNonEmployeeSource + tags: + - Non-Employee Lifecycle Management + summary: Patch a Non-Employee Source + description: 'patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`.' + parameters: + - in: path + name: sourceId + description: Source Id + required: true + schema: + type: string + example: e136567de87e4d029e60b3c3c55db56d + requestBody: + description: 'A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.' + required: true + content: + application/json-patch+json: + schema: + type: array + items: + type: object + description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' + required: + - op + - path + properties: + op: + type: string + description: The operation to be performed + enum: + - add + - remove + - replace + - move + - copy + - test + example: replace + path: + type: string + description: A string JSON Pointer representing the target path to an element to be affected by the operation + example: /description + value: + anyOf: + - type: string + - type: integer + - type: object + - type: array + items: + anyOf: + - type: string + - type: integer + - type: object + description: 'The value to be used for the operation, required for "add" and "replace" operations' + example: New description + example: + - op: replace + path: /name + value: + new name: null + - op: replace + path: /approvers + value: + - 2c91809f703bb37a017040a2fe8748c7 + - 48b1f463c9e8427db5a5071bd81914b8 + responses: + '200': + description: A patched non-employee source object. + content: + application/json: + schema: + allOf: + - type: object + properties: + id: + type: string + format: UUID + description: Non-Employee source id. + example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 + sourceId: + type: string + description: Source Id associated with this non-employee source. + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Source name associated with this non-employee source. + example: Retail + description: + type: string + description: Source description associated with this non-employee source. + example: Source description + - type: object + properties: + approvers: + description: List of approvers + type: array + items: + type: object + properties: + type: + type: string + enum: + - GOVERNANCE_GROUP + - IDENTITY + example: IDENTITY + description: Identifies if the identity is a normal identity or a governance group + id: + type: string + description: Identity id + example: 5168015d32f890ca15812c9180835d2e + accountManagers: + description: List of account managers + type: array + items: + type: object + properties: + type: + type: string + enum: + - GOVERNANCE_GROUP + - IDENTITY + example: IDENTITY + description: Identifies if the identity is a normal identity or a governance group + id: + type: string + description: Identity id + example: 5168015d32f890ca15812c9180835d2e + modified: + type: string + format: date-time + description: When the request was last modified. + example: '2019-08-23T18:52:59.162Z' + created: + type: string + format: date-time + description: When the request was created. + example: '2019-08-23T18:40:35.772Z' + '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. + delete: + operationId: deleteNonEmployeeSource + tags: + - Non-Employee Lifecycle Management + summary: Delete Non-Employee Source + description: 'This request will delete a non-employee source. Requires role context of `idn:nesr:delete`.' + parameters: + - in: path + name: sourceId + description: Source Id + required: true + schema: + type: string + example: e136567de87e4d029e60b3c3c55db56d + responses: + '204': + description: No content - indicates the request was successful but there is no content to be returned in the response. + '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. + '/non-employee-sources/{id}/non-employees/download': + get: + operationId: exportNonEmployeeRecords + tags: + - Non-Employee Lifecycle Management + summary: Exports Non-Employee Records to CSV + description: 'This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read`' + parameters: + - in: path + name: id + description: Source Id (UUID) + required: true + schema: + type: string + example: e136567de87e4d029e60b3c3c55db56d + responses: + '200': + description: Exported CSV + content: + text/csv: + example: | + accountName,firstName,lastName,phone,email,manager,startDate,endDate + Jon.Smith, Jon, Smith, 555-555-5555, jon@jon.doe.nope.com, Jim Smith, 2020-04-05T08:00:00-10:00,2020-08-07T19:00:00-10:00 + William.Chaffin, William, Chaffin, 555-555-5555, william@chaffins.nope.com, Bertram Chaffin, 2020-04-05T08:00:00-10:00,2020-08-07T19:00:00-10:00 + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + '/non-employee-sources/{id}/non-employee-bulk-upload': + post: + operationId: importNonEmployeeRecordsInBulk + security: + - UserContextAuth: + - 'idn:nelm:manage' + tags: + - Non-Employee Lifecycle Management + summary: 'Imports, or Updates, Non-Employee Records' + description: 'This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create`' + parameters: + - in: path + name: id + description: Source Id (UUID) + required: true + schema: + type: string + example: e136567de87e4d029e60b3c3c55db56d + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + data: + type: string + format: binary + required: + - data + responses: + '202': + description: The CSV was accepted to be bulk inserted now or at a later time. + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: The bulk upload job's ID. (UUID) + example: 2c91808568c529c60168cca6f90cffff + sourceId: + type: string + description: The ID of the source to bulk-upload non-employees to. (UUID) + example: 2c91808568c529c60168cca6f90c1313 + created: + type: string + format: date-time + description: The date-time the job was submitted. + example: '2019-08-23T18:52:59.162Z' + modified: + type: string + format: date-time + description: The date-time that the job was last updated. + example: '2019-08-23T18:52:59.162Z' + status: + type: string + enum: + - PENDING + - IN_PROGRESS + - COMPLETED + - ERROR + description: | + Returns the following values indicating the progress or result of the bulk upload job. + "PENDING" means the job is queued and waiting to be processed. + "IN_PROGRESS" means the job is currently being processed. + "COMPLETED" means the job has been completed without any errors. + "ERROR" means the job failed to process with errors. + example: PENDING + '400': + description: | + Client Error - Returned if the request body is invalid. + The response body will contain the list of specific errors with one on each line. + 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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + '/non-employee-sources/{id}/non-employee-bulk-upload/status': + get: + operationId: getNonEmployeeBulkUploadStatus + tags: + - Non-Employee Lifecycle Management + summary: Obtain the status of bulk upload on the source + description: | + The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. + Requires role context of `idn:nesr:read` + parameters: + - in: path + name: id + description: Source ID (UUID) + required: true + schema: + type: string + example: e136567de87e4d029e60b3c3c55db56d + responses: + '200': + description: 'Status of the newest bulk-upload job, if any.' + content: + application/json: + schema: + type: object + properties: + status: + type: string + enum: + - PENDING + - IN_PROGRESS + - COMPLETED + - ERROR + description: | + Returns the following values indicating the progress or result of the bulk upload job. + "PENDING" means the job is queued and waiting to be processed. + "IN_PROGRESS" means the job is currently being processed. + "COMPLETED" means the job has been completed without any errors. + "ERROR" means the job failed to process with errors. + null means job has been submitted to the source. + example: PENDING + '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. + '/non-employee-sources/{id}/schema-attributes-template/download': + get: + operationId: exportNonEmployeeSourceSchemaTemplate + tags: + - Non-Employee Lifecycle Management + summary: Exports Source Schema Template + description: 'This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read`' + parameters: + - in: path + name: id + description: Source Id (UUID) + required: true + example: ef38f94347e94562b5bb8424a56397d8 + schema: + type: string + responses: + '200': + description: Exported Source Schema Template + content: + text/csv: + example: | + accountName,firstName,lastName,phone,email,manager,startDate,endDate + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + /non-employee-approvals: + get: + operationId: listNonEmployeeApprovals + security: + - UserContextAuth: [] + tags: + - Non-Employee Lifecycle Management + summary: Get List of Non-Employee Approval Requests + description: |- + This gets a list of non-employee approval requests. + There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in which case they + can list the approvals for any approver. + 2. The user owns the requested approval. + parameters: + - in: query + name: requested-for + schema: + type: string + description: The identity for whom the request was made. *me* indicates the current user. + required: false + example: 2c91808280430dfb0180431a59440460 + - 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 + description: 'Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* *Example:* approvalStatus eq "PENDING"' + example: approvalStatus eq "Pending" + required: false + - in: query + name: sorters + schema: + type: string + format: comma-separated + description: 'Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949) Sorting is supported for the following fields: **created, modified**' + required: false + example: created + responses: + '200': + description: List of approval items. + content: + application/json: + schema: + type: array + items: + allOf: + - type: object + properties: + id: + type: string + format: UUID + description: Non-Employee approval item id + example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c + approver: + description: Reference to the associated Identity + type: object + properties: + type: + type: string + enum: + - GOVERNANCE_GROUP + - IDENTITY + example: IDENTITY + description: Identifies if the identity is a normal identity or a governance group + id: + type: string + description: Identity id + example: 5168015d32f890ca15812c9180835d2e + accountName: + type: string + description: Requested identity account name + example: test.account + approvalStatus: + type: string + enum: + - APPROVED + - REJECTED + - PENDING + - NOT_READY + - CANCELLED + description: Enum representing the non-employee request approval status + example: APPROVED + approvalOrder: + type: number + description: Approval order + example: 1 + format: float + comment: + type: string + description: comment of approver + example: I approve + modified: + type: string + format: date-time + description: When the request was last modified. + example: '2019-08-23T18:52:59.162Z' + created: + type: string + format: date-time + description: When the request was created. + example: '2019-08-23T18:40:35.772Z' + - type: object + properties: + nonEmployeeRequest: + type: object + properties: + id: + type: string + format: UUID + description: Non-Employee request id. + example: ac110005-7156-1150-8171-5b292e3e0084 + requester: + example: + type: IDENTITY + id: 2c9180866166b5b0016167c32ef31a66 + name: William Smith + type: object + properties: + type: + type: string + enum: + - GOVERNANCE_GROUP + - IDENTITY + example: IDENTITY + description: Identifies if the identity is a normal identity or a governance group + id: + type: string + description: Identity id + example: 5168015d32f890ca15812c9180835d2e + '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. + '/non-employee-approvals/{id}': + get: + operationId: getNonEmployeeApproval + security: + - UserContextAuth: [] + tags: + - Non-Employee Lifecycle Management + summary: Get a non-employee approval item detail + description: |- + Gets a non-employee approval item detail. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in which case they + can get any approval. + 2. The user owns the requested approval. + parameters: + - in: path + name: id + description: Non-Employee approval item id (UUID) + required: true + schema: + type: string + example: e136567de87e4d029e60b3c3c55db56d + - in: query + name: include-detail + description: The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* + required: false + schema: + type: boolean + example: true + responses: + '200': + description: Non-Employee approval item object. + content: + application/json: + schema: + allOf: + - type: object + properties: + id: + type: string + format: UUID + description: Non-Employee approval item id + example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c + approver: + description: Reference to the associated Identity + type: object + properties: + type: + type: string + enum: + - GOVERNANCE_GROUP + - IDENTITY + example: IDENTITY + description: Identifies if the identity is a normal identity or a governance group + id: + type: string + description: Identity id + example: 5168015d32f890ca15812c9180835d2e + accountName: + type: string + description: Requested identity account name + example: test.account + approvalStatus: + type: string + enum: + - APPROVED + - REJECTED + - PENDING + - NOT_READY + - CANCELLED + description: Enum representing the non-employee request approval status + example: APPROVED + approvalOrder: + type: number + description: Approval order + example: 1 + format: float + comment: + type: string + description: comment of approver + example: I approve + modified: + type: string + format: date-time + description: When the request was last modified. + example: '2019-08-23T18:52:59.162Z' + created: + type: string + format: date-time + description: When the request was created. + example: '2019-08-23T18:40:35.772Z' + - type: object + properties: + nonEmployeeRequest: + description: Non-Employee request associated to this approval + allOf: + - type: object + properties: + id: + type: string + format: UUID + description: Non-Employee request id. + example: ac110005-7156-1150-8171-5b292e3e0084 + requester: + example: + type: IDENTITY + id: 2c9180866166b5b0016167c32ef31a66 + name: William Smith + type: object + properties: + type: type: string - example: - - TAG_1 - - TAG_2 - - description: Role - allOf: + enum: + - GOVERNANCE_GROUP + - IDENTITY + example: IDENTITY + description: Identifies if the identity is a normal identity or a governance group + id: + type: string + description: Identity id + example: 5168015d32f890ca15812c9180835d2e + - type: object + properties: + accountName: + type: string + description: Requested identity account name. + example: william.smith + firstName: + type: string + description: Non-Employee's first name. + example: William + lastName: + type: string + description: Non-Employee's last name. + example: Smith + email: + type: string + description: Non-Employee's email. + example: william.smith@example.com + phone: + type: string + description: Non-Employee's phone. + example: '5555555555' + manager: + type: string + description: The account ID of a valid identity to serve as this non-employee's manager. + example: jane.doe + nonEmployeeSource: + allOf: + - type: object + properties: + id: + type: string + format: UUID + description: Non-Employee source id. + example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 + sourceId: + type: string + description: Source Id associated with this non-employee source. + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Source name associated with this non-employee source. + example: Retail + description: + type: string + description: Source description associated with this non-employee source. + example: Source description + - type: object + properties: + schemaAttributes: + description: List of schema attributes associated with this non-employee source. + type: array + items: + type: object + properties: + id: + type: string + format: UUID + example: ac110005-7156-1150-8171-5b292e3e0084 + description: Schema Attribute Id + system: + type: boolean + description: True if this schema attribute is mandatory on all non-employees sources. + example: true + modified: + type: string + format: date-time + description: When the schema attribute was last modified. + example: '2019-08-23T18:52:59.162Z' + created: + type: string + format: date-time + description: When the schema attribute was created. + example: '2019-08-23T18:40:35.772Z' + type: + type: string + enum: + - TEXT + - DATE + - IDENTITY + description: Enum representing the type of data a schema attribute accepts. + example: TEXT + label: + type: string + description: Label displayed on the UI for this schema attribute. + example: Account Name + technicalName: + type: string + description: The technical name of the attribute. Must be unique per source. + example: account.name + helpText: + type: string + description: help text displayed by UI. + example: The unique identifier for the account + placeholder: + type: string + description: Hint text that fills UI box. + example: Enter a unique user name for this account. + required: + type: boolean + description: 'If true, the schema attribute is required for all non-employees in the source' + example: true + required: + - type + - technicalName + - label + data: + type: object + additionalProperties: + type: string + description: Attribute blob/bag for a non-employee. + example: + description: Auditing + approvalStatus: + type: string + enum: + - APPROVED + - REJECTED + - PENDING + - NOT_READY + - CANCELLED + description: Enum representing the non-employee request approval status + example: APPROVED + comment: + type: string + description: comment of requester + example: approved + completionDate: + type: string + format: date-time + description: When the request was completely approved. + example: '2020-03-24T11:11:41.139-05:00' + startDate: + type: string + format: date + description: Non-Employee employment start date. + example: '2020-03-24' + endDate: + type: string + format: date + description: Non-Employee employment end date. + example: '2021-03-25' + modified: + type: string + format: date-time + description: When the request was last modified. + example: '2020-03-24T11:11:41.139-05:00' + created: + type: string + format: date-time + description: When the request was created. + example: '2020-03-24T11:11:41.139-05:00' + '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. + '/non-employee-approvals/{id}/approve': + post: + operationId: approveNonEmployeeRequest + security: + - UserContextAuth: [] + tags: + - Non-Employee Lifecycle Management + summary: Approve a Non-Employee Request + description: Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. + parameters: + - in: path + name: id + description: Non-Employee approval item id (UUID) + required: true + schema: + type: string + example: e136567de87e4d029e60b3c3c55db56d + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + comment: + type: string + description: Comment on the approval item. + maxLength: 4000 + example: Approved by manager + responses: + '200': + description: Non-Employee approval item object. + content: + application/json: + schema: + allOf: + - type: object + properties: + id: + type: string + format: UUID + description: Non-Employee approval item id + example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c + approver: + description: Reference to the associated Identity + type: object + properties: + type: + type: string + enum: + - GOVERNANCE_GROUP + - IDENTITY + example: IDENTITY + description: Identifies if the identity is a normal identity or a governance group + id: + type: string + description: Identity id + example: 5168015d32f890ca15812c9180835d2e + accountName: + type: string + description: Requested identity account name + example: test.account + approvalStatus: + type: string + enum: + - APPROVED + - REJECTED + - PENDING + - NOT_READY + - CANCELLED + description: Enum representing the non-employee request approval status + example: APPROVED + approvalOrder: + type: number + description: Approval order + example: 1 + format: float + comment: + type: string + description: comment of approver + example: I approve + modified: + type: string + format: date-time + description: When the request was last modified. + example: '2019-08-23T18:52:59.162Z' + created: + type: string + format: date-time + description: When the request was created. + example: '2019-08-23T18:40:35.772Z' + - type: object + properties: + nonEmployeeRequest: + type: object + properties: + id: + type: string + format: UUID + description: Non-Employee request id. + example: ac110005-7156-1150-8171-5b292e3e0084 + requester: + example: + type: IDENTITY + id: 2c9180866166b5b0016167c32ef31a66 + name: William Smith + type: object + properties: + type: + type: string + enum: + - GOVERNANCE_GROUP + - IDENTITY + example: IDENTITY + description: Identifies if the identity is a normal identity or a governance group + id: + type: string + description: Identity id + example: 5168015d32f890ca15812c9180835d2e + '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. + '/non-employee-approvals/{id}/reject': + post: + operationId: rejectNonEmployeeRequest + security: + - UserContextAuth: [] + tags: + - Non-Employee Lifecycle Management + summary: Reject a Non-Employee Request + description: This endpoint will reject an approval item request and notify user. The current user must be the requested approver. + parameters: + - in: path + name: id + description: Non-Employee approval item id (UUID) + required: true + schema: + type: string + example: e136567de87e4d029e60b3c3c55db56d + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + comment: + type: string + description: Comment on the approval item. + maxLength: 4000 + example: approved + required: + - comment + responses: + '200': + description: Non-Employee approval item object. + content: + application/json: + schema: + allOf: + - type: object + properties: + id: + type: string + format: UUID + description: Non-Employee approval item id + example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c + approver: + description: Reference to the associated Identity + type: object + properties: + type: + type: string + enum: + - GOVERNANCE_GROUP + - IDENTITY + example: IDENTITY + description: Identifies if the identity is a normal identity or a governance group + id: + type: string + description: Identity id + example: 5168015d32f890ca15812c9180835d2e + accountName: + type: string + description: Requested identity account name + example: test.account + approvalStatus: + type: string + enum: + - APPROVED + - REJECTED + - PENDING + - NOT_READY + - CANCELLED + description: Enum representing the non-employee request approval status + example: APPROVED + approvalOrder: + type: number + description: Approval order + example: 1 + format: float + comment: + type: string + description: comment of approver + example: I approve + modified: + type: string + format: date-time + description: When the request was last modified. + example: '2019-08-23T18:52:59.162Z' + created: + type: string + format: date-time + description: When the request was created. + example: '2019-08-23T18:40:35.772Z' + - type: object + properties: + nonEmployeeRequest: + type: object + properties: + id: + type: string + format: UUID + description: Non-Employee request id. + example: ac110005-7156-1150-8171-5b292e3e0084 + requester: + example: + type: IDENTITY + id: 2c9180866166b5b0016167c32ef31a66 + name: William Smith + type: object + properties: + type: + type: string + enum: + - GOVERNANCE_GROUP + - IDENTITY + example: IDENTITY + description: Identifies if the identity is a normal identity or a governance group + id: + type: string + description: Identity id + example: 5168015d32f890ca15812c9180835d2e + '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. + '/non-employee-approvals/summary/{requested-for}': + get: + operationId: getNonEmployeeApprovalSummary + security: + - UserContextAuth: [] + tags: + - Non-Employee Lifecycle Management + summary: Get Summary of Non-Employee Approval Requests + description: |- + This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or + she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id. + 2. The current user is an approver, in which case "me" should be provided + as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. + parameters: + - in: path + name: requested-for + schema: + type: string + description: The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use "me" instead to indicate the current user. + required: true + example: 2c91808280430dfb0180431a59440460 + responses: + '200': + description: summary of non-employee approval requests + content: + application/json: + schema: + type: object + properties: + approved: + type: integer + description: The number of approved non-employee approval requests. + format: int32 + example: 2 + pending: + type: integer + description: The number of pending non-employee approval requests. + format: int32 + example: 2 + rejected: + type: integer + description: The number of rejected non-employee approval requests. + format: int32 + example: 2 + '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. + '/non-employee-sources/{sourceId}/schema-attributes': + get: + operationId: getNonEmployeeSourceSchemaAttributes + security: + - UserContextAuth: [] + tags: + - Non-Employee Lifecycle Management + summary: List Schema Attributes Non-Employee Source + description: |- + This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. + Requires role context of `idn:nesr:read` or the user must be an account manager of the source. + parameters: + - in: path + name: sourceId + schema: + type: string + required: true + example: ef38f94347e94562b5bb8424a56397d8 + description: The Source id + responses: + '200': + description: A list of Schema Attributes + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: string + format: UUID + example: ac110005-7156-1150-8171-5b292e3e0084 + description: Schema Attribute Id + system: + type: boolean + description: True if this schema attribute is mandatory on all non-employees sources. + example: true + modified: + type: string + format: date-time + description: When the schema attribute was last modified. + example: '2019-08-23T18:52:59.162Z' + created: + type: string + format: date-time + description: When the schema attribute was created. + example: '2019-08-23T18:40:35.772Z' + type: + type: string + enum: + - TEXT + - DATE + - IDENTITY + description: Enum representing the type of data a schema attribute accepts. + example: TEXT + label: + type: string + description: Label displayed on the UI for this schema attribute. + example: Account Name + technicalName: + type: string + description: The technical name of the attribute. Must be unique per source. + example: account.name + helpText: + type: string + description: help text displayed by UI. + example: The unique identifier for the account + placeholder: + type: string + description: Hint text that fills UI box. + example: Enter a unique user name for this account. + required: + type: boolean + description: 'If true, the schema attribute is required for all non-employees in the source' + example: true + required: + - type + - technicalName + - label + maxItems: 18 + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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: createNonEmployeeSourceSchemaAttributes + tags: + - Non-Employee Lifecycle Management + summary: Create a new Schema Attribute for Non-Employee Source + description: |- + This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response. + Requires role context of `idn:nesr:create` + parameters: + - in: path + name: sourceId + schema: + type: string + required: true + description: The Source id + example: ef38f94347e94562b5bb8424a56397d8 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + type: + type: string + description: Type of the attribute. Only type 'TEXT' is supported for custom attributes. + example: TEXT + label: + type: string + description: Label displayed on the UI for this schema attribute. + example: Account Name + technicalName: + type: string + description: The technical name of the attribute. Must be unique per source. + example: account.name + helpText: + type: string + description: help text displayed by UI. + example: The unique identifier for the account + placeholder: + type: string + description: Hint text that fills UI box. + example: Enter a unique user name for this account. + required: + type: boolean + description: 'If true, the schema attribute is required for all non-employees in the source' + example: true + required: + - type + - technicalName + - label + responses: + '200': + description: Schema Attribute created. + content: + application/json: + schema: + type: object + properties: + id: + type: string + format: UUID + example: ac110005-7156-1150-8171-5b292e3e0084 + description: Schema Attribute Id + system: + type: boolean + description: True if this schema attribute is mandatory on all non-employees sources. + example: true + modified: + type: string + format: date-time + description: When the schema attribute was last modified. + example: '2019-08-23T18:52:59.162Z' + created: + type: string + format: date-time + description: When the schema attribute was created. + example: '2019-08-23T18:40:35.772Z' + type: + type: string + enum: + - TEXT + - DATE + - IDENTITY + description: Enum representing the type of data a schema attribute accepts. + example: TEXT + label: + type: string + description: Label displayed on the UI for this schema attribute. + example: Account Name + technicalName: + type: string + description: The technical name of the attribute. Must be unique per source. + example: account.name + helpText: + type: string + description: help text displayed by UI. + example: The unique identifier for the account + placeholder: + type: string + description: Hint text that fills UI box. + example: Enter a unique user name for this account. + required: + type: boolean + description: 'If true, the schema attribute is required for all non-employees in the source' + example: true + required: + - type + - technicalName + - label + '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. + delete: + operationId: deleteNonEmployeeSourceSchemaAttributes + tags: + - Non-Employee Lifecycle Management + summary: Delete all custom schema attributes for Non-Employee Source + description: 'This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete`' + parameters: + - in: path + name: sourceId + schema: + type: string + required: true + description: The Source id + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '204': + description: All custon Schema Attributes were successfully deleted. + '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. + '/non-employee-sources/{sourceId}/schema-attributes/{attributeId}': + get: + operationId: getNonEmployeeSchemaAttribute + security: + - UserContextAuth: [] + tags: + - Non-Employee Lifecycle Management + summary: Get Schema Attribute Non-Employee Source + description: 'This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source.' + parameters: + - in: path + name: attributeId + schema: + type: string + required: true + example: ef38f94347e94562b5bb8424a56397d8 + description: The Schema Attribute Id (UUID) + - in: path + name: sourceId + schema: + type: string + required: true + example: ef38f94347e94562b5bb8424a56397d8 + description: The Source id + responses: + '200': + description: The Schema Attribute + content: + application/json: + schema: + type: object + properties: + id: + type: string + format: UUID + example: ac110005-7156-1150-8171-5b292e3e0084 + description: Schema Attribute Id + system: + type: boolean + description: True if this schema attribute is mandatory on all non-employees sources. + example: true + modified: + type: string + format: date-time + description: When the schema attribute was last modified. + example: '2019-08-23T18:52:59.162Z' + created: + type: string + format: date-time + description: When the schema attribute was created. + example: '2019-08-23T18:40:35.772Z' + type: + type: string + enum: + - TEXT + - DATE + - IDENTITY + description: Enum representing the type of data a schema attribute accepts. + example: TEXT + label: + type: string + description: Label displayed on the UI for this schema attribute. + example: Account Name + technicalName: + type: string + description: The technical name of the attribute. Must be unique per source. + example: account.name + helpText: + type: string + description: help text displayed by UI. + example: The unique identifier for the account + placeholder: + type: string + description: Hint text that fills UI box. + example: Enter a unique user name for this account. + required: + type: boolean + description: 'If true, the schema attribute is required for all non-employees in the source' + example: true + required: + - type + - technicalName + - label + '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. + patch: + operationId: patchNonEmployeeSchemaAttribute + tags: + - Non-Employee Lifecycle Management + summary: Patch a Schema Attribute for Non-Employee Source + description: | + This end-point patches a specific schema attribute for a non-employee SourceId. + Requires role context of `idn:nesr:update` + parameters: + - in: path + name: attributeId + schema: + type: string + required: true + description: The Schema Attribute Id (UUID) + example: ef38f94347e94562b5bb8424a56397d8 + - in: path + name: sourceId + schema: + type: string + required: true + description: The Source id + example: ef38f94347e94562b5bb8424a56397d8 + requestBody: + description: 'A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update '':'' ''label'', ''helpText'', ''placeholder'', ''required''.' + content: + application/json-patch+json: + schema: + type: array + items: + type: object + description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' + required: + - op + - path + properties: + op: + type: string + description: The operation to be performed + enum: + - add + - remove + - replace + - move + - copy + - test + example: replace + path: + type: string + description: A string JSON Pointer representing the target path to an element to be affected by the operation + example: /description + value: + anyOf: + - type: string + - type: integer + - type: object + - type: array + items: + anyOf: + - type: string + - type: integer + - type: object + description: 'The value to be used for the operation, required for "add" and "replace" operations' + example: New description + example: + - op: replace + path: /label + value: + new attribute label: null + required: true + responses: + '200': + description: The Schema Attribute was successfully patched. + content: + application/json: + schema: + type: object + properties: + id: + type: string + format: UUID + example: ac110005-7156-1150-8171-5b292e3e0084 + description: Schema Attribute Id + system: + type: boolean + description: True if this schema attribute is mandatory on all non-employees sources. + example: true + modified: + type: string + format: date-time + description: When the schema attribute was last modified. + example: '2019-08-23T18:52:59.162Z' + created: + type: string + format: date-time + description: When the schema attribute was created. + example: '2019-08-23T18:40:35.772Z' + type: + type: string + enum: + - TEXT + - DATE + - IDENTITY + description: Enum representing the type of data a schema attribute accepts. + example: TEXT + label: + type: string + description: Label displayed on the UI for this schema attribute. + example: Account Name + technicalName: + type: string + description: The technical name of the attribute. Must be unique per source. + example: account.name + helpText: + type: string + description: help text displayed by UI. + example: The unique identifier for the account + placeholder: + type: string + description: Hint text that fills UI box. + example: Enter a unique user name for this account. + required: + type: boolean + description: 'If true, the schema attribute is required for all non-employees in the source' + example: true + required: + - type + - technicalName + - label + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + delete: + operationId: deleteNonEmployeeSchemaAttribute + tags: + - Non-Employee Lifecycle Management + summary: Delete a Schema Attribute for Non-Employee Source + description: | + This end-point deletes a specific schema attribute for a non-employee source. + Requires role context of `idn:nesr:delete` + parameters: + - in: path + name: attributeId + schema: + type: string + required: true + description: The Schema Attribute Id (UUID) + example: ef38f94347e94562b5bb8424a56397d8 + - in: path + name: sourceId + schema: + type: string + required: true + description: The Source id + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '204': + description: The Schema Attribute was successfully deleted. + '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. + /oauth-clients: + get: + operationId: listOauthClients + security: + - UserContextAuth: + - 'sp:oauth-client:manage' + tags: + - OAuth Clients + summary: List OAuth Clients + description: This gets a list of OAuth clients. + parameters: + - in: query + name: filters + required: false + schema: + type: string + 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: + + **lastUsed**: *le, isnull* + example: 'lastUsed le 2023-02-05T10:59:27.214Z' + responses: + '200': + description: List of OAuth clients. + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: string + description: ID of the OAuth client + example: 2c9180835d2e5168015d32f890ca1581 + businessName: + type: string + nullable: true + description: The name of the business the API Client should belong to + example: Acme-Solar + homepageUrl: + type: string + nullable: true + description: The homepage URL associated with the owner of the API Client + example: 'http://localhost:12345' + name: + type: string + description: A human-readable name for the API Client + example: Demo API Client + description: + type: string + nullable: true + description: A description of the API Client + example: 'An API client used for the authorization_code, refresh_token, and client_credentials flows' + accessTokenValiditySeconds: + type: integer + format: int32 + description: The number of seconds an access token generated for this API Client is valid for + example: 750 + refreshTokenValiditySeconds: + type: integer + format: int32 + description: The number of seconds a refresh token generated for this API Client is valid for + example: 86400 + redirectUris: + type: array + nullable: true + items: + type: string + description: A list of the approved redirect URIs used with the authorization_code flow + example: + - 'http://localhost:12345' + grantTypes: + type: array + items: + description: OAuth2 Grant Type + type: string + example: CLIENT_CREDENTIALS + enum: + - CLIENT_CREDENTIALS + - AUTHORIZATION_CODE + - REFRESH_TOKEN + description: A list of OAuth 2.0 grant types this API Client can be used with + example: + - AUTHORIZATION_CODE + - CLIENT_CREDENTIALS + - REFRESH_TOKEN + accessType: + description: The access type (online or offline) of this API Client + example: OFFLINE + type: string + enum: + - ONLINE + - OFFLINE + type: + description: The type of the API Client (public or confidential) + example: CONFIDENTIAL + type: string + enum: + - CONFIDENTIAL + - PUBLIC + internal: + type: boolean + description: An indicator of whether the API Client can be used for requests internal to IDN + example: false + enabled: + type: boolean + description: An indicator of whether the API Client is enabled for use + example: true + strongAuthSupported: + type: boolean + description: An indicator of whether the API Client supports strong authentication + example: false + claimsSupported: + type: boolean + description: An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow + example: false + created: + type: string + format: date-time + description: 'The date and time, down to the millisecond, when the API Client was created' + example: '2017-07-11T18:45:37.098Z' + modified: + type: string + format: date-time + description: 'The date and time, down to the millisecond, when the API Client was last updated' + example: '2018-06-25T20:22:28.104Z' + lastUsed: + type: string + nullable: true + format: date-time + description: 'The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed.' + example: '2017-07-11T18:45:37.098Z' + scope: + type: array + nullable: true + items: + type: string + default: 'sp:scopes:all' + description: Scopes of the API Client. + example: + - 'demo:api-client-scope:first' + - 'demo:api-client-scope:second' + required: + - id + - businessName + - homepageUrl + - name + - description + - accessTokenValiditySeconds + - refreshTokenValiditySeconds + - redirectUris + - grantTypes + - accessType + - type + - internal + - enabled + - strongAuthSupported + - claimsSupported + - created + - modified + - scope + '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: createOauthClient + security: + - UserContextAuth: + - 'sp:oauth-client:manage' + tags: + - OAuth Clients + summary: Create OAuth Client + description: This creates an OAuth client. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + businessName: + type: string + nullable: true + description: The name of the business the API Client should belong to + example: Acme-Solar + homepageUrl: + type: string + nullable: true + description: The homepage URL associated with the owner of the API Client + example: 'http://localhost:12345' + name: + type: string + nullable: true + description: A human-readable name for the API Client + example: Demo API Client + description: + type: string + nullable: true + description: A description of the API Client + example: 'An API client used for the authorization_code, refresh_token, and client_credentials flows' + accessTokenValiditySeconds: + description: The number of seconds an access token generated for this API Client is valid for + type: integer + format: int32 + example: 750 + refreshTokenValiditySeconds: + description: The number of seconds a refresh token generated for this API Client is valid for + example: 86400 + type: integer + format: int32 + redirectUris: + type: array + nullable: true + items: + type: string + description: A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. + example: + - 'http://localhost:12345' + grantTypes: + type: array + nullable: true + items: + description: OAuth2 Grant Type + type: string + example: CLIENT_CREDENTIALS + enum: + - CLIENT_CREDENTIALS + - AUTHORIZATION_CODE + - REFRESH_TOKEN + description: A list of OAuth 2.0 grant types this API Client can be used with + example: + - AUTHORIZATION_CODE + - CLIENT_CREDENTIALS + - REFRESH_TOKEN + accessType: + description: The access type (online or offline) of this API Client + example: OFFLINE + type: string + enum: + - ONLINE + - OFFLINE + type: + description: The type of the API Client (public or confidential) + example: CONFIDENTIAL + type: string + enum: + - CONFIDENTIAL + - PUBLIC + internal: + type: boolean + description: An indicator of whether the API Client can be used for requests internal within the product. + example: false + enabled: + type: boolean + description: An indicator of whether the API Client is enabled for use + example: true + strongAuthSupported: + type: boolean + description: An indicator of whether the API Client supports strong authentication + example: false + claimsSupported: + type: boolean + description: An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow + example: false + scope: + type: array + nullable: true + items: + type: string + default: 'sp:scopes:all' + description: 'Scopes of the API Client. If no scope is specified, the client will be created with the default scope "sp:scopes:all". This means the API Client will have all the rights of the owner who created it.' + example: + - 'demo:api-client-scope:first' + - 'demo:api-client-scope:second' + required: + - name + - description + - accessTokenValiditySeconds + - grantTypes + - accessType + - enabled + responses: + '200': + description: Request succeeded. + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: ID of the OAuth client + example: 2c9180835d2e5168015d32f890ca1581 + secret: + type: string + description: Secret of the OAuth client (This field is only returned on the intial create call.) + example: 5c32dd9b21adb51c77794d46e71de117a1d0ddb36a7ff941fa28014ab7de2cf3 + businessName: + type: string + description: The name of the business the API Client should belong to + example: Acme-Solar + homepageUrl: + type: string + description: The homepage URL associated with the owner of the API Client + example: 'http://localhost:12345' + name: + type: string + description: A human-readable name for the API Client + example: Demo API Client + description: + type: string + description: A description of the API Client + example: 'An API client used for the authorization_code, refresh_token, and client_credentials flows' + accessTokenValiditySeconds: + description: The number of seconds an access token generated for this API Client is valid for + example: 750 + type: integer + format: int32 + refreshTokenValiditySeconds: + description: The number of seconds a refresh token generated for this API Client is valid for + example: 86400 + type: integer + format: int32 + redirectUris: + type: array + items: + type: string + description: A list of the approved redirect URIs used with the authorization_code flow + example: + - 'http://localhost:12345' + grantTypes: + type: array + items: + description: OAuth2 Grant Type + type: string + example: CLIENT_CREDENTIALS + enum: + - CLIENT_CREDENTIALS + - AUTHORIZATION_CODE + - REFRESH_TOKEN + description: A list of OAuth 2.0 grant types this API Client can be used with + example: + - AUTHORIZATION_CODE + - CLIENT_CREDENTIALS + - REFRESH_TOKEN + accessType: + description: The access type (online or offline) of this API Client + example: OFFLINE + type: string + enum: + - ONLINE + - OFFLINE + type: + description: The type of the API Client (public or confidential) + example: CONFIDENTIAL + type: string + enum: + - CONFIDENTIAL + - PUBLIC + internal: + type: boolean + description: An indicator of whether the API Client can be used for requests internal to IDN + example: false + enabled: + type: boolean + description: An indicator of whether the API Client is enabled for use + example: true + strongAuthSupported: + type: boolean + description: An indicator of whether the API Client supports strong authentication + example: false + claimsSupported: + type: boolean + description: An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow + example: false + created: + type: string + format: date-time + description: 'The date and time, down to the millisecond, when the API Client was created' + example: '2017-07-11T18:45:37.098Z' + modified: + type: string + format: date-time + description: 'The date and time, down to the millisecond, when the API Client was last updated' + example: '2018-06-25T20:22:28.104Z' + scope: + type: array + nullable: true + items: + type: string + default: 'sp:scopes:all' + description: Scopes of the API Client. + example: + - 'demo:api-client-scope:first' + - 'demo:api-client-scope:second' + required: + - id + - secret + - businessName + - homepageUrl + - name + - description + - accessTokenValiditySeconds + - refreshTokenValiditySeconds + - redirectUris + - grantTypes + - accessType + - type + - internal + - enabled + - strongAuthSupported + - claimsSupported + - created + - modified + - scope + '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. + '/oauth-clients/{id}': + get: + operationId: getOauthClient + security: + - UserContextAuth: + - 'sp:oauth-client:manage' + - 'sp:oauth-client:read' + tags: + - OAuth Clients + summary: Get OAuth Client + description: This gets details of an OAuth client. + parameters: + - in: path + name: id + schema: + type: string + required: true + description: The OAuth client id + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '200': + description: Request succeeded. + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: ID of the OAuth client + example: 2c9180835d2e5168015d32f890ca1581 + businessName: + type: string + nullable: true + description: The name of the business the API Client should belong to + example: Acme-Solar + homepageUrl: + type: string + nullable: true + description: The homepage URL associated with the owner of the API Client + example: 'http://localhost:12345' + name: + type: string + description: A human-readable name for the API Client + example: Demo API Client + description: + type: string + nullable: true + description: A description of the API Client + example: 'An API client used for the authorization_code, refresh_token, and client_credentials flows' + accessTokenValiditySeconds: + type: integer + format: int32 + description: The number of seconds an access token generated for this API Client is valid for + example: 750 + refreshTokenValiditySeconds: + type: integer + format: int32 + description: The number of seconds a refresh token generated for this API Client is valid for + example: 86400 + redirectUris: + type: array + nullable: true + items: + type: string + description: A list of the approved redirect URIs used with the authorization_code flow + example: + - 'http://localhost:12345' + grantTypes: + type: array + items: + description: OAuth2 Grant Type + type: string + example: CLIENT_CREDENTIALS + enum: + - CLIENT_CREDENTIALS + - AUTHORIZATION_CODE + - REFRESH_TOKEN + description: A list of OAuth 2.0 grant types this API Client can be used with + example: + - AUTHORIZATION_CODE + - CLIENT_CREDENTIALS + - REFRESH_TOKEN + accessType: + description: The access type (online or offline) of this API Client + example: OFFLINE + type: string + enum: + - ONLINE + - OFFLINE + type: + description: The type of the API Client (public or confidential) + example: CONFIDENTIAL + type: string + enum: + - CONFIDENTIAL + - PUBLIC + internal: + type: boolean + description: An indicator of whether the API Client can be used for requests internal to IDN + example: false + enabled: + type: boolean + description: An indicator of whether the API Client is enabled for use + example: true + strongAuthSupported: + type: boolean + description: An indicator of whether the API Client supports strong authentication + example: false + claimsSupported: + type: boolean + description: An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow + example: false + created: + type: string + format: date-time + description: 'The date and time, down to the millisecond, when the API Client was created' + example: '2017-07-11T18:45:37.098Z' + modified: + type: string + format: date-time + description: 'The date and time, down to the millisecond, when the API Client was last updated' + example: '2018-06-25T20:22:28.104Z' + lastUsed: + type: string + nullable: true + format: date-time + description: 'The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed.' + example: '2017-07-11T18:45:37.098Z' + scope: + type: array + nullable: true + items: + type: string + default: 'sp:scopes:all' + description: Scopes of the API Client. + example: + - 'demo:api-client-scope:first' + - 'demo:api-client-scope:second' + required: + - id + - businessName + - homepageUrl + - name + - description + - accessTokenValiditySeconds + - refreshTokenValiditySeconds + - redirectUris + - grantTypes + - accessType + - type + - internal + - enabled + - strongAuthSupported + - claimsSupported + - created + - modified + - scope + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + delete: + operationId: deleteOauthClient + security: + - UserContextAuth: + - 'sp:oauth-client:manage' + tags: + - OAuth Clients + summary: Delete OAuth Client + description: This deletes an OAuth client. + parameters: + - in: path + name: id + schema: + type: string + required: true + description: The OAuth client id + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '204': + description: No content. + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + patch: + operationId: patchOauthClient + security: + - UserContextAuth: + - 'sp:oauth-client:manage' + tags: + - OAuth Clients + summary: Patch OAuth Client + description: This performs a targeted update to the field(s) of an OAuth client. + parameters: + - in: path + name: id + schema: + type: string + required: true + description: The OAuth client id + example: ef38f94347e94562b5bb8424a56397d8 + requestBody: + required: true + description: | + A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + The following fields are patchable: + * tenant + * businessName + * homepageUrl + * name + * description + * accessTokenValiditySeconds + * refreshTokenValiditySeconds + * redirectUris + * grantTypes + * accessType + * enabled + * strongAuthSupported + * claimsSupported + content: + application/json-patch+json: + schema: + type: array + items: + type: object + description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' + required: + - op + - path + properties: + op: + type: string + description: The operation to be performed + enum: + - add + - remove + - replace + - move + - copy + - test + example: replace + path: + type: string + description: A string JSON Pointer representing the target path to an element to be affected by the operation + example: /description + value: + anyOf: + - type: string + - type: integer + - type: object + - type: array + items: + anyOf: + - type: string + - type: integer - type: object - required: - - id - - name - - _type - properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - name: - type: string - example: john.doe - _type: - description: |- - Enum representing the currently supported document types. + description: 'The value to be used for the operation, required for "add" and "replace" operations' + example: New description + example: + - op: replace + path: /strongAuthSupported + value: true + - op: replace + path: /businessName + value: acme-solar + responses: + '200': + description: 'Indicates the PATCH operation succeeded, and returns the OAuth client''s new representation.' + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: ID of the OAuth client + example: 2c9180835d2e5168015d32f890ca1581 + businessName: + type: string + nullable: true + description: The name of the business the API Client should belong to + example: Acme-Solar + homepageUrl: + type: string + nullable: true + description: The homepage URL associated with the owner of the API Client + example: 'http://localhost:12345' + name: + type: string + description: A human-readable name for the API Client + example: Demo API Client + description: + type: string + nullable: true + description: A description of the API Client + example: 'An API client used for the authorization_code, refresh_token, and client_credentials flows' + accessTokenValiditySeconds: + type: integer + format: int32 + description: The number of seconds an access token generated for this API Client is valid for + example: 750 + refreshTokenValiditySeconds: + type: integer + format: int32 + description: The number of seconds a refresh token generated for this API Client is valid for + example: 86400 + redirectUris: + type: array + nullable: true + items: + type: string + description: A list of the approved redirect URIs used with the authorization_code flow + example: + - 'http://localhost:12345' + grantTypes: + type: array + items: + description: OAuth2 Grant Type + type: string + example: CLIENT_CREDENTIALS + enum: + - CLIENT_CREDENTIALS + - AUTHORIZATION_CODE + - REFRESH_TOKEN + description: A list of OAuth 2.0 grant types this API Client can be used with + example: + - AUTHORIZATION_CODE + - CLIENT_CREDENTIALS + - REFRESH_TOKEN + accessType: + description: The access type (online or offline) of this API Client + example: OFFLINE + type: string + enum: + - ONLINE + - OFFLINE + type: + description: The type of the API Client (public or confidential) + example: CONFIDENTIAL + type: string + enum: + - CONFIDENTIAL + - PUBLIC + internal: + type: boolean + description: An indicator of whether the API Client can be used for requests internal to IDN + example: false + enabled: + type: boolean + description: An indicator of whether the API Client is enabled for use + example: true + strongAuthSupported: + type: boolean + description: An indicator of whether the API Client supports strong authentication + example: false + claimsSupported: + type: boolean + description: An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow + example: false + created: + type: string + format: date-time + description: 'The date and time, down to the millisecond, when the API Client was created' + example: '2017-07-11T18:45:37.098Z' + modified: + type: string + format: date-time + description: 'The date and time, down to the millisecond, when the API Client was last updated' + example: '2018-06-25T20:22:28.104Z' + lastUsed: + type: string + nullable: true + format: date-time + description: 'The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed.' + example: '2017-07-11T18:45:37.098Z' + scope: + type: array + nullable: true + items: + type: string + default: 'sp:scopes:all' + description: Scopes of the API Client. + example: + - 'demo:api-client-scope:first' + - 'demo:api-client-scope:second' + required: + - id + - businessName + - homepageUrl + - name + - description + - accessTokenValiditySeconds + - refreshTokenValiditySeconds + - redirectUris + - grantTypes + - accessType + - type + - internal + - enabled + - strongAuthSupported + - claimsSupported + - created + - modified + - scope + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + /password-sync-groups: + get: + operationId: getPasswordSyncGroups + tags: + - Password Sync Groups + summary: Get Password Sync Group List + description: This API returns a list of password sync groups. A token with ORG_ADMIN authority is required to call this API. + security: + - UserContextAuth: + - 'idn:password-sync-group-management:read' + parameters: + - 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 + responses: + '200': + description: A list of password sync groups. + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: string + description: ID of the sync group + example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd + name: + description: Name of the sync group + type: string + example: Password Sync Group 1 + passwordPolicyId: + type: string + description: ID of the password policy + example: 2c91808d744ba0ce01746f93b6204501 + sourceIds: + type: array + description: List of password managed sources IDs + items: + type: string + example: + - 2c918084660f45d6016617daa9210584 + - 2c918084660f45d6016617daa9210500 + '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: createPasswordSyncGroup + tags: + - Password Sync Groups + summary: Create Password Sync Group + description: This API creates a password sync group based on the specifications provided. A token with ORG_ADMIN authority is required to call this API. + security: + - UserContextAuth: + - 'idn:password-sync-group-management:write' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: ID of the sync group + example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd + name: + description: Name of the sync group + type: string + example: Password Sync Group 1 + passwordPolicyId: + type: string + description: ID of the password policy + example: 2c91808d744ba0ce01746f93b6204501 + sourceIds: + type: array + description: List of password managed sources IDs + items: + type: string + example: + - 2c918084660f45d6016617daa9210584 + - 2c918084660f45d6016617daa9210500 + example: + name: Password Sync Group 2 + passwordPolicyId: 2c91808d744ba0ce01746f93b6204501 + sourceIds: + - 2c918084660f45d6016617daa9210584 + - 2c918084660f45d6016617daa9210500 + responses: + '200': + description: Reference to the password sync group. + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: ID of the sync group + example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd + name: + description: Name of the sync group + type: string + example: Password Sync Group 1 + passwordPolicyId: + type: string + description: ID of the password policy + example: 2c91808d744ba0ce01746f93b6204501 + sourceIds: + type: array + description: List of password managed sources IDs + items: + type: string + example: + - 2c918084660f45d6016617daa9210584 + - 2c918084660f45d6016617daa9210500 + example: + id: 6881f631-3bd5-4213-9c75-8e05cc3e35dd + name: Password Sync Group 2 + passwordPolicyId: 2c91808d744ba0ce01746f93b6204501 + sourceIds: + - 2c918084660f45d6016617daa9210584 + - 2c918084660f45d6016617daa9210500 + '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. + '/password-sync-groups/{id}': + get: + operationId: getPasswordSyncGroup + tags: + - Password Sync Groups + summary: Get Password Sync Group by ID + description: This API returns the sync group for the specified ID. A token with ORG_ADMIN authority is required to call this API. + security: + - UserContextAuth: + - 'idn:password-sync-group-management:read' + parameters: + - in: path + name: id + schema: + type: string + required: true + description: The ID of password sync group to retrieve. + example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd + responses: + '200': + description: Reference to the password sync group. + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: ID of the sync group + example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd + name: + description: Name of the sync group + type: string + example: Password Sync Group 1 + passwordPolicyId: + type: string + description: ID of the password policy + example: 2c91808d744ba0ce01746f93b6204501 + sourceIds: + type: array + description: List of password managed sources IDs + items: + type: string + example: + - 2c918084660f45d6016617daa9210584 + - 2c918084660f45d6016617daa9210500 + example: + id: 6881f631-3bd5-4213-9c75-8e05cc3e35dd + name: Password Sync Group 1 + passwordPolicyId: 2c91808d744ba0ce01746f93b6204501 + sourceIds: + - 2c918084660f45d6016617daa9210584 + - 2c918084660f45d6016617daa9210500 + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + put: + operationId: updatePasswordSyncGroup + tags: + - Password Sync Groups + summary: Update Password Sync Group by ID + description: This API updates the specified password sync group. A token with ORG_ADMIN authority is required to call this API. + security: + - UserContextAuth: + - 'idn:password-sync-group-management:write' + parameters: + - in: path + name: id + schema: + type: string + required: true + description: The ID of password sync group to update. + example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: ID of the sync group + example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd + name: + description: Name of the sync group + type: string + example: Password Sync Group 1 + passwordPolicyId: + type: string + description: ID of the password policy + example: 2c91808d744ba0ce01746f93b6204501 + sourceIds: + type: array + description: List of password managed sources IDs + items: + type: string + example: + - 2c918084660f45d6016617daa9210584 + - 2c918084660f45d6016617daa9210500 + example: + id: 6881f631-3bd5-4213-9c75-8e05cc3e35dd + name: Password Sync Group 2 + passwordPolicyId: 2c91808d744ba0ce01746f93b6204501 + sourceIds: + - 2c918084660f45d6016617daa9210584 + - 2c918084660f45d6016617daa9210500 + responses: + '200': + description: Reference to the password sync group. + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: ID of the sync group + example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd + name: + description: Name of the sync group + type: string + example: Password Sync Group 1 + passwordPolicyId: + type: string + description: ID of the password policy + example: 2c91808d744ba0ce01746f93b6204501 + sourceIds: + type: array + description: List of password managed sources IDs + items: + type: string + example: + - 2c918084660f45d6016617daa9210584 + - 2c918084660f45d6016617daa9210500 + example: + id: 6881f631-3bd5-4213-9c75-8e05cc3e35dd + name: Password Sync Group 2 + passwordPolicyId: 2c91808d744ba0ce01746f93b6204501 + sourceIds: + - 2c918084660f45d6016617daa9210584 + - 2c918084660f45d6016617daa9210500 + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + delete: + operationId: deletePasswordSyncGroup + tags: + - Password Sync Groups + summary: Delete Password Sync Group by ID + description: This API deletes the specified password sync group. A token with ORG_ADMIN authority is required to call this API. + security: + - UserContextAuth: + - 'idn:password-sync-group-management:write' + parameters: + - in: path + name: id + schema: + type: string + required: true + description: The ID of password sync group to delete. + example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd + responses: + '204': + description: No content - indicates the request was successful but there is no content to be returned in the response. + '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. + /personal-access-tokens: + get: + operationId: listPersonalAccessTokens + security: + - UserContextAuth: + - 'sp:my-personal-access-tokens:read' + - 'sp:my-personal-access-tokens:manage' + - 'sp:all-personal-access-tokens:read' + - 'sp:all-personal-access-tokens:manage' + tags: + - Personal Access Tokens + summary: List Personal Access Tokens + description: 'This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the ''idn:all-personal-access-tokens:read'' right.' + parameters: + - in: query + name: owner-id + description: |- + The identity ID of the owner whose personal access tokens should be listed. If "me", the caller should have the following right: 'idn:my-personal-access-tokens:read' + If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. + If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' + required: false + schema: + type: string + default: null + example: 2c9180867b50d088017b554662fb281e + - in: query + name: filters + required: false + schema: + type: string + 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) - Additional values may be added in the future without notice. - type: string - enum: - - accessprofile - - accountactivity - - account - - aggregation - - entitlement - - event - - identity - - role - example: identity - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - description: - type: string - description: The description of the access item - example: The admin role - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - enabled: - type: boolean - example: true - requestable: - type: boolean - example: true - description: Indicates if the access can be requested - requestCommentsRequired: - type: boolean - description: Indicates if comments are required when requesting access - example: false - owner: - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - - type: object - properties: - email: - type: string - example: john.doe@sailpoint.com - description: The email of the identity - - type: object - properties: - accessProfiles: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - accessProfileCount: - type: integer - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - text/csv: + Filtering is supported for the following fields and operators: + + **lastUsed**: *le, isnull* + example: 'lastUsed le 2023-02-05T10:59:27.214Z' + responses: + '200': + description: List of personal access tokens. + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: string + description: The ID of the personal access token (to be used as the username for Basic Auth). + example: 86f1dc6fe8f54414950454cbb11278fa + name: + type: string + description: The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. + example: NodeJS Integration + scope: + type: array + nullable: true + items: + type: string + default: 'sp:scopes:all' + description: Scopes of the personal access token. + example: + - 'demo:personal-access-token-scope:first' + - 'demo:personal-access-token-scope:second' + owner: + description: Details about the owner of the personal access token. + 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 + - WORKGROUP + 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 + created: + type: string + format: date-time + description: 'The date and time, down to the millisecond, when this personal access token was created.' + example: '2017-07-11T18:45:37.098Z' + lastUsed: + type: string + nullable: true + format: date-time + description: 'The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed.' + example: '2017-07-11T18:45:37.098Z' + required: + - id + - name + - scope + - owner + - created + '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: - description: | - If the *Accept:text/csv* header is specified and the *aggregationType* parameter in the request body is *SAILPOINT*, - - the aggregation result will be returned as a CSV document. - type: string - example: - - 'Identity Locations,Count' - - 'Munich,23' - - 'Brussels,26' - - 'Singapore,22' - - 'Tokyo,20' - - 'Taipei,16' - - 'London,64' - - 'Austin,109' - - 'Sao Paulo,24' - - 'San Jose,27' - headers: - X-Total-Count: - description: The total result count (returned only if the *count* parameter is specified as *true*). + 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: integer - example: 5 + 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: createPersonalAccessToken + security: + - UserContextAuth: + - 'sp:my-personal-access-tokens:manage' + - 'sp:all-personal-access-tokens:manage' + tags: + - Personal Access Tokens + summary: Create Personal Access Token + description: This creates a personal access token. + requestBody: + description: Name and scope of personal access token. + required: true + content: + application/json: + schema: + type: object + description: Object for specifying the name of a personal access token to create + properties: + name: + type: string + description: The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. + example: NodeJS Integration + scope: + type: array + nullable: true + items: + type: string + default: 'sp:scopes:all' + description: 'Scopes of the personal access token. If no scope is specified, the token will be created with the default scope "sp:scopes:all". This means the personal access token will have all the rights of the owner who created it.' + example: + - 'demo:personal-access-token-scope:first' + - 'demo:personal-access-token-scope:second' + required: + - name + responses: + '200': + description: Created. Note - this is the only time Personal Access Tokens' secret attribute will be displayed. + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: The ID of the personal access token (to be used as the username for Basic Auth). + example: 86f1dc6fe8f54414950454cbb11278fa + secret: + type: string + description: The secret of the personal access token (to be used as the password for Basic Auth). + example: 1d1bef2b9f426383447f64f69349fc7cac176042578d205c256ba3f37c59adb9 + scope: + type: array + nullable: true + items: + type: string + default: 'sp:scopes:all' + description: Scopes of the personal access token. + example: + - 'demo:personal-access-token-scope:first' + - 'demo:personal-access-token-scope:second' + name: + type: string + description: The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. + example: NodeJS Integration + owner: + description: Details about the owner of the personal access token. + 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 + - WORKGROUP + 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 + created: + type: string + format: date-time + description: 'The date and time, down to the millisecond, when this personal access token was created.' + example: '2017-07-11T18:45:37.098Z' + required: + - id + - secret + - scope + - name + - owner + - created '400': description: Client Error - Returned if the request body is invalid. content: @@ -67845,2229 +49322,4571 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/search/{index}/{id}': - get: + '/personal-access-tokens/{id}': + patch: + operationId: patchPersonalAccessToken + security: + - UserContextAuth: + - 'sp:my-personal-access-tokens:manage' tags: - - Search - description: 'Fetches a single document from the specified index, using the specified document ID.' - operationId: searchGet - summary: Get a Document by ID + - Personal Access Tokens + summary: Patch Personal Access Token + description: This performs a targeted update to the field(s) of a Personal Access Token. parameters: - - in: path - name: index - description: | - The index from which to fetch the specified document. - - The currently supported index names are: *accessprofiles*, *accountactivities*, *accounts*, *aggregations*, *entitlements*, *events*, *identities*, and *roles*. - schema: - type: string - required: true - example: accounts - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - example: 2c91808568c529c60168cca6f90c1313 - responses: - '200': - description: The requested document. - content: - application/json: - schema: - discriminator: - propertyName: _type - mapping: - accessprofile: ../model/access/profile/AccessProfileDocument.yaml - accountactivity: ../model/account/activity/AccountActivityDocument.yaml - account: ../model/account/AccountDocument.yaml - aggregation: ../model/aggregation/AggregationDocument.yaml - entitlement: ../model/entitlement/EntitlementDocument.yaml - event: ../model/event/EventDocument.yaml - identity: ../model/identity/IdentityDocument.yaml - role: ../model/role/RoleDocument.yaml - oneOf: - - description: 'This is more of a complete representation of an access profile. ' - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - name: - type: string - example: john.doe - _type: - description: |- - Enum representing the currently supported document types. - - Additional values may be added in the future without notice. - type: string - enum: - - accessprofile - - accountactivity - - account - - aggregation - - entitlement - - event - - identity - - role - example: identity - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - description: - type: string - description: The description of the access item - example: The admin role - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - enabled: - type: boolean - example: true - requestable: - type: boolean - example: true - description: Indicates if the access can be requested - requestCommentsRequired: - type: boolean - description: Indicates if comments are required when requesting access - example: false - owner: - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - - type: object - properties: - email: - type: string - example: john.doe@sailpoint.com - description: The email of the identity - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - entitlements: - type: array - items: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - description: - type: string - description: A description of the entitlement - example: The admin privilege - attribute: - type: string - description: The name of the entitlement attribute - example: admin - value: - type: string - description: The value of the entitlement - example: 'true' - entitlementCount: - type: integer - example: 5 - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - - description: AccountActivity - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - name: - type: string - example: john.doe - _type: - description: |- - Enum representing the currently supported document types. + - in: path + name: id + schema: + type: string + required: true + description: The Personal Access Token id + example: ef38f94347e94562b5bb8424a56397d8 + requestBody: + required: true + description: | + A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofile - - accountactivity - - account - - aggregation - - entitlement - - event - - identity - - role - example: identity - - type: object - properties: - action: - type: string - description: The type of action that this activity performed - externalDocs: - description: Learn more about account activity action types - url: 'https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data' - example: Identity Refresh. - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - stage: - type: string - description: The current stage of the activity - example: Completed - origin: - type: string - nullable: true - example: null - status: - type: string - description: the current status of the activity - example: Complete - requester: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - recipient: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - trackingNumber: - type: string - example: 61aad0c9e8134eca89e76a35e0cabe3f - errors: - type: array - items: - type: string - nullable: true - example: null - warnings: - type: array - items: - type: string - nullable: true - example: null - approvals: - type: array - items: - type: object - properties: - comments: - type: array - items: - type: object - properties: - comment: - type: string - description: The comment text - example: This request was autoapproved by our automated ETS subscriber. - commenter: - type: string - description: The name of the commenter - example: Automated AR Approval - date: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - result: - type: string - description: The result of the approval - example: Finished - type: - type: string - nullable: true - example: null - originalRequests: - type: array - items: - type: object - properties: - accountId: - type: string - description: the account id - example: 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com' - attributeRequests: - type: array - items: - type: object - properties: - name: - type: string - description: The attribute name - example: groups - op: - type: string - description: The operation to perform - example: Add - value: - type: string - description: The value of the attribute - example: '3203537556531076' - op: - type: string - description: the operation that was used - example: add - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - expansionItems: - type: array - items: - type: object - properties: - accountId: - type: string - description: The ID of the account - example: 2c91808981f58ea601821c3e93482e6f - cause: - type: string - example: Role - name: - type: string - description: The name of the item - example: smartsheet-role - attributeRequests: - type: array - items: - type: object - properties: - name: - type: string - description: The attribute name - example: groups - op: - type: string - description: The operation to perform - example: Add - value: - type: string - description: The value of the attribute - example: '3203537556531076' - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - accountRequests: - type: array - items: - type: object - properties: - accountId: - type: string - description: Unique ID of the account - example: John.Doe - attributeRequests: - type: array - items: - type: object - properties: - name: - type: string - description: The attribute name - example: groups - op: - type: string - description: The operation to perform - example: Add - value: - type: string - description: The value of the attribute - example: '3203537556531076' - op: - type: string - example: Modify - description: The operation that was performed - provisioningTarget: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - result: - type: object - properties: - errors: - type: array - items: - type: string - example: |- - [ConnectorError] [ - { - "code": "unrecognized_keys", - "keys": [ - "groups" - ], - "path": [], - "message": "Unrecognized key(s) in object: 'groups'" - } - ] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e) - status: - type: string - description: The status of the account request - example: failed - ticketId: - type: string - nullable: true - example: null - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - sources: - type: string - example: 'smartsheet-test, airtable-v4, IdentityNow' - - description: Account - allOf: + The following fields are patchable: + * name + * scope + content: + application/json-patch+json: + schema: + type: array + items: + type: object + description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' + required: + - op + - path + properties: + op: + type: string + description: The operation to be performed + enum: + - add + - remove + - replace + - move + - copy + - test + example: replace + path: + type: string + description: A string JSON Pointer representing the target path to an element to be affected by the operation + example: /description + value: + anyOf: + - type: string + - type: integer - type: object - required: - - id - - name - - _type - properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - name: - type: string - example: john.doe - _type: - description: |- - Enum representing the currently supported document types. + - type: array + items: + anyOf: + - type: string + - type: integer + - type: object + description: 'The value to be used for the operation, required for "add" and "replace" operations' + example: New description + example: + - op: replace + path: /name + value: New name + - op: replace + path: /scope + value: + - 'sp:scopes:all' + responses: + '200': + description: 'Indicates the PATCH operation succeeded, and returns the PAT''s new representation.' + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: The ID of the personal access token (to be used as the username for Basic Auth). + example: 86f1dc6fe8f54414950454cbb11278fa + name: + type: string + description: The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. + example: NodeJS Integration + scope: + type: array + nullable: true + items: + type: string + default: 'sp:scopes:all' + description: Scopes of the personal access token. + example: + - 'demo:personal-access-token-scope:first' + - 'demo:personal-access-token-scope:second' + owner: + description: Details about the owner of the personal access token. + 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 + - WORKGROUP + 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 + created: + type: string + format: date-time + description: 'The date and time, down to the millisecond, when this personal access token was created.' + example: '2017-07-11T18:45:37.098Z' + lastUsed: + type: string + nullable: true + format: date-time + description: 'The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed.' + example: '2017-07-11T18:45:37.098Z' + required: + - id + - name + - scope + - owner + - created + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + delete: + operationId: deletePersonalAccessToken + security: + - UserContextAuth: + - 'sp:my-personal-access-tokens:manage' + - 'sp:all-personal-access-tokens:manage' + tags: + - Personal Access Tokens + summary: Delete Personal Access Token + description: This deletes a personal access token. + parameters: + - in: path + name: id + schema: + type: string + required: true + description: The personal access token id + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '204': + description: No content. + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + /public-identities: + get: + operationId: getPublicIdentities + tags: + - Public Identities + summary: Get a list of public identities + parameters: + - 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. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofile - - accountactivity - - account - - aggregation - - entitlement - - event - - identity - - role - example: identity - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - accountId: - type: string - description: The ID of the account - example: john.doe - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - disabled: - type: boolean - description: Indicates if the account is disabled - example: false - locked: - type: boolean - description: Indicates if the account is locked - example: false - privileged: - type: boolean - example: false - manuallyCorrelated: - type: boolean - description: Indicates if the account has been manually correlated to an identity - example: false - passwordLastSet: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - entitlementAttributes: - type: object - nullable: true - description: a map or dictionary of key/value pairs - additionalProperties: true - example: - moderator: true - admin: true - trust_level: '4' - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - - type: object - properties: - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - attributes: - type: object - description: a map or dictionary of key/value pairs - additionalProperties: true - example: - firstName: John - lastName: Doe - displayName: John.Doe - identity: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe - access: - type: array - items: - description: EntitlementReference - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - example: null - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - privileged: - type: boolean - example: false - attribute: - type: string - example: memberOf - value: - type: string - example: 'CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' - standalone: - type: boolean - example: false - entitlementCount: - type: integer - description: The number of entitlements assigned to the account - format: int32 - example: 2 - uncorrelated: - type: boolean - description: Indicates if the account is not correlated to an identity - example: false - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - - description: Aggregation - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - name: - type: string - example: john.doe - _type: - description: |- - Enum representing the currently supported document types. + 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. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofile - - accountactivity - - account - - aggregation - - entitlement - - event - - identity - - role - example: identity - - type: object - properties: - status: - type: string - example: Success - duration: - type: integer - format: int32 - example: 20 - avgDuration: - type: integer - format: int32 - example: 20 - changedAccounts: - type: integer - format: int32 - example: 1 - nextScheduled: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - startTime: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - sourceOwner: - type: string - description: John Doe - - description: Entitlement - allOf: - - type: object - required: - - id - - name - - _type + 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* + + **alias**: *eq, sw* + + **email**: *eq, sw* + + **firstname**: *eq, sw* + + **lastname**: *eq, sw* + example: firstname eq "John" + - in: query + name: add-core-filters + description: |- + If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: + - Should be either correlated or protected. + - Should not be "spadmin" or "cloudadmin". + - uid should not be null. + - lastname should not be null. + - email should not be null. + required: false + example: false + schema: + type: boolean + default: false + - 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** + example: name + responses: + '200': + description: A list of public identity objects. + content: + application/json: + schema: + type: array + items: + type: object + title: Public Identity + description: Details about a public identity + properties: + id: + type: string + description: Identity id + example: 2c9180857182305e0171993735622948 + name: + type: string + description: Human-readable display name of identity. + example: Alison Ferguso + alias: + type: string + description: Alternate unique identifier for the identity. + example: alison.ferguso + email: + nullable: true + type: string + description: Email address of identity. + example: alison.ferguso@acme-solar.com + status: + nullable: true + type: string + description: The lifecycle status for the identity + example: Active + manager: + description: An identity reference to the manager of this identity + type: object + nullable: true + properties: + type: + example: IDENTITY + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + id: + type: string + description: Identity id + example: 2c9180a46faadee4016fb4e018c20639 + name: + type: string + description: Human-readable display name of identity. + example: Thomas Edison + attributes: + type: array + description: The public identity attributes of the identity + items: + type: object properties: - id: + key: type: string - example: 2c91808375d8e80a0175e1f88a575222 + description: The attribute key + example: country name: type: string - example: john.doe - _type: - description: |- - Enum representing the currently supported document types. + description: Human-readable display name of the attribute + example: Country + value: + type: string + description: The attribute value + example: US + example: + - id: 2c9180857182305e0171993735622948 + name: Alison Ferguso + alias: alison.ferguso + email: alison.ferguso@acme-solar.com + status: Active + manager: + type: IDENTITY + id: 2c9180a46faadee4016fb4e018c20639 + name: Thomas Edison + attributes: + - key: phone + name: Phone + value: '5125551234' + - key: country + name: Country + value: US + - id: 2c9180a46faadee4016fb4e018c20639 + name: Thomas Edison + alias: thomas.edison + email: thomas.edison@acme-solar.com + status: Active + manager: + type: IDENTITY + id: 2c918086676d3e0601677611dbde220f + name: Mister Manager + attributes: + - key: phone + name: Phone + value: '5125554321' + - key: country + name: Country + value: US + '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. + /public-identities-config: + get: + operationId: getPublicIdentityConfig + tags: + - Public Identities Config + summary: Get the Public Identities Configuration + description: Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. A token with ORG ADMIN authority is required to call this API. + responses: + '200': + description: Request succeeded. + content: + application/json: + schema: + type: object + description: Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org. + properties: + attributes: + type: array + description: Up to 5 identity attributes that will be available to everyone in the org for all users in the org. + items: + type: object + description: Used to map an attribute key for an Identity to its display name. + properties: + key: + type: string + description: The attribute key + example: country + name: + type: string + description: The attribute display name + example: Country + modified: + nullable: true + type: string + description: When this configuration was last modified. + format: date-time + example: '2018-06-25T20:22:28.104Z' + modifiedBy: + description: The identity who last modified this configuration. + type: object + nullable: true + properties: + type: + example: IDENTITY + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + id: + type: string + description: Identity id + example: 2c9180a46faadee4016fb4e018c20639 + name: + type: string + description: Human-readable display name of identity. + example: Thomas Edison + '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. + put: + operationId: updatePublicIdentityConfig + tags: + - Public Identities Config + summary: Update the Public Identities Configuration + description: Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. A token with ORG ADMIN authority is required to call this API. + requestBody: + required: true + content: + application/json: + schema: + type: object + description: Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org. + properties: + attributes: + type: array + description: Up to 5 identity attributes that will be available to everyone in the org for all users in the org. + items: + type: object + description: Used to map an attribute key for an Identity to its display name. + properties: + key: + type: string + description: The attribute key + example: country + name: + type: string + description: The attribute display name + example: Country + modified: + nullable: true + type: string + description: When this configuration was last modified. + format: date-time + example: '2018-06-25T20:22:28.104Z' + modifiedBy: + description: The identity who last modified this configuration. + type: object + nullable: true + properties: + type: + example: IDENTITY + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + id: + type: string + description: Identity id + example: 2c9180a46faadee4016fb4e018c20639 + name: + type: string + description: Human-readable display name of identity. + example: Thomas Edison + responses: + '200': + description: Request succeeded. + content: + application/json: + schema: + type: object + description: Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org. + properties: + attributes: + type: array + description: Up to 5 identity attributes that will be available to everyone in the org for all users in the org. + items: + type: object + description: Used to map an attribute key for an Identity to its display name. + properties: + key: + type: string + description: The attribute key + example: country + name: + type: string + description: The attribute display name + example: Country + modified: + nullable: true + type: string + description: When this configuration was last modified. + format: date-time + example: '2018-06-25T20:22:28.104Z' + modifiedBy: + description: The identity who last modified this configuration. + type: object + nullable: true + properties: + type: + example: IDENTITY + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + id: + type: string + description: Identity id + example: 2c9180a46faadee4016fb4e018c20639 + name: + type: string + description: Human-readable display name of identity. + example: Thomas Edison + '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. + /requestable-objects: + get: + operationId: listRequestableObjects + tags: + - Requestable Objects + summary: Requestable Objects List + description: |- + This endpoint returns a list of acccess items that that can be requested through the Access Request endpoints. Access items are marked with AVAILABLE, PENDING or ASSIGNED with respect to the identity provided using *identity-id* query param. + Any authenticated token can call this endpoint to see their requestable access items. A token with ORG_ADMIN authority is required to call this endpoint to return a list of all of the requestable access items for the org or for another identity. + parameters: + - in: query + name: identity-id + required: false + schema: + type: string + example: e7eab60924f64aa284175b9fa3309599 + description: |- + If present, the value returns only requestable objects for the specified identity. + * Admin users can call this with any identity ID value. + * Non-admin users can only specify *me* or pass their own identity ID value. + * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. + - in: query + name: types + description: 'Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice.' + required: false + schema: + type: array + items: + type: string + enum: + - ACCESS_PROFILE + - ROLE + description: 'The currently supported requestable object types. ' + example: ACCESS_PROFILE + example: 'ROLE,ACCESS_PROFILE' + explode: false + - in: query + name: term + required: false + schema: + type: string + example: Finance Role + description: 'It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored.' + - in: query + name: statuses + description: 'Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice.' + required: false + schema: + type: array + items: + type: string + enum: + - AVAILABLE + - PENDING + - ASSIGNED + description: 'Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results.' + example: AVAILABLE + explode: false + example: + - ASSIGNED + - PENDING + - 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. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofile - - accountactivity - - account - - aggregation - - entitlement - - event - - identity - - role - example: identity - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - description: - type: string - description: A description of the entitlement - example: The admin privilege - attribute: - type: string - description: The name of the entitlement attribute - example: admin - value: - type: string - description: The value of the entitlement - example: 'true' - - type: object - properties: - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - displayName: - type: string - description: The display name of the entitlement - example: Admin - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - privileged: - type: boolean - example: false - identityCount: - type: integer - format: int32 - example: 3 - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - - description: Event - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - name: - type: string - example: john.doe - _type: - description: |- - Enum representing the currently supported document types. + 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. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofile - - accountactivity - - account - - aggregation - - entitlement - - event - - identity - - role - example: identity - - type: object - properties: - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - action: - type: string - description: The action that was performed - example: update - type: - type: string - description: The type of event - example: SYSTEM_CONFIG - actor: - type: object - properties: - name: - type: string - example: John Doe - description: the actor or target name - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - target: - type: object - properties: - name: - type: string - example: John Doe - description: the actor or target name - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - stack: - type: string - example: tpe - trackingNumber: - type: string - example: 63f891e0735f4cc8bf1968144a1e7440 - ipAddress: - type: string - example: 52.52.97.85 - details: - type: string - example: 73b65dfbed1842548c207432a18c84b0 - attributes: - type: object - additionalProperties: true - example: - pod: stg03-useast1 - org: acme - sourceName: SailPoint - objects: - type: array - items: - type: string - example: AUTHENTICATION - operation: - type: string - example: REQUEST - status: - type: string - example: PASSED - technicalName: - type: string - example: AUTHENTICATION_REQUEST_PASSED - - description: Identity - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - name: - type: string - example: john.doe - _type: - description: |- - Enum representing the currently supported document types. + 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 + example: name sw "bob" + 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, in, sw* + required: false + - in: query + name: sorters + schema: + type: string + format: comma-separated + required: false + example: name + 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** + responses: + '200': + description: List of requestable objects + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: string + description: Id of the requestable object itself + example: 2c9180835d2e5168015d32f890ca1581 + name: + type: string + description: Human-readable display name of the requestable object + example: Applied Research Access + created: + type: string + format: date-time + example: '2017-07-11T18:45:37.098Z' + description: The time when the requestable object was created + modified: + nullable: true + type: string + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: The time when the requestable object was last modified + description: + type: string + description: Description of the requestable object. + example: 'Access to research information, lab results, and schematics.' + type: + type: string + enum: + - ACCESS_PROFILE + - ROLE + description: 'The currently supported requestable object types. ' + example: ACCESS_PROFILE + requestStatus: + type: string + enum: + - AVAILABLE + - PENDING + - ASSIGNED + description: 'Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results.' + example: AVAILABLE + identityRequestId: + type: string + description: 'If *requestStatus* is *PENDING*, indicates the id of the associated account activity.' + nullable: true + example: null + ownerRef: + type: object + nullable: true + properties: + type: + type: string + description: The type can only be IDENTITY. This is read-only + example: IDENTITY + id: + type: string + description: Identity id. + example: 5168015d32f890ca15812c9180835d2e + name: + type: string + description: Human-readable display name of identity. This is read-only + example: Alison Ferguso + email: + type: string + description: Email address of identity. This is read-only + example: alison.ferguso@identitysoon.com + requestCommentsRequired: + type: boolean + description: Whether the requester must provide comments when requesting the object. + example: 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. + /roles: + get: + operationId: listRoles + tags: + - Roles + summary: List Roles + description: |- + This API returns a list of Roles. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofile - - accountactivity - - account - - aggregation - - entitlement - - event - - identity - - role - example: identity - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - firstName: - type: string - description: The first name of the identity - example: Carol - lastName: - type: string - description: The last name of the identity - example: Adams - displayName: - type: string - example: Carol.Adams - description: The display name of the identity - email: - type: string - description: The identity's primary email address - example: Carol.Adams@sailpointdemo.com - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - phone: - type: string - description: The phone number of the identity - example: +1 440-527-3672 - inactive: - type: boolean - description: Indicates if the identity is inactive - example: false - protected: - type: boolean - example: false - status: - type: string - description: The identity's status in SailPoint - example: UNREGISTERED - employeeNumber: - type: string - example: 1a2a3d4e - manager: - nullable: true - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe - isManager: - type: boolean - description: Indicates if this identity is a manager of other identities - example: false - identityProfile: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - attributes: - type: object - description: a map or dictionary of key/value pairs - additionalProperties: true - example: - country: US - firstname: Carol - cloudStatus: UNREGISTERED - processingState: - type: string - nullable: true - example: null - processingDetails: - nullable: true - type: object - properties: - date: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - stage: - type: string - example: In Process - retryCount: - type: integer - example: 0 - format: int32 - stackTrace: - type: string - example: - message: - type: string - example: - accounts: - type: array - description: List of accounts associated with the identity - items: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - accountId: - type: string - description: The ID of the account - example: john.doe - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - type: - type: string - example: Delimited File - description: the type of source returned - disabled: - type: boolean - description: Indicates if the account is disabled - example: false - locked: - type: boolean - description: Indicates if the account is locked - example: false - privileged: - type: boolean - example: false - manuallyCorrelated: - type: boolean - description: Indicates if the account has been manually correlated to an identity - example: false - passwordLastSet: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - entitlementAttributes: - type: object - nullable: true - description: a map or dictionary of key/value pairs - additionalProperties: true - example: - moderator: true - admin: true - trust_level: '4' - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - accountCount: - type: integer - description: Number of accounts associated with the identity - format: int32 - example: 3 - apps: - type: array - description: The list of applications the identity has access to - items: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - account: + A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + parameters: + - in: query + name: for-subadmin + schema: + type: string + description: 'If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity''s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.' + example: 5168015d32f890ca15812c9180835d2e + required: false + - in: query + name: limit + description: |- + Note that for this API the maximum value for limit is 50. + See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + required: false + example: 50 + schema: + type: integer + format: int32 + minimum: 0 + maximum: 50 + default: 50 + - 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 + 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* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + example: requestable eq false + required: false + - in: query + name: sorters + schema: + type: string + format: comma-separated + 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, modified**' + example: 'name,-modified' + required: false + - in: query + name: for-segment-ids + schema: + type: string + format: comma-separated + description: |- + If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. + + If segmentation is currently unavailable, specifying this parameter results in an error. + example: '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' + required: false + - in: query + name: include-unsegmented + schema: + type: boolean + default: true + description: 'Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.' + example: false + required: false + responses: + '200': + description: List of Roles + content: + application/json: + schema: + type: array + items: + type: object + description: A Role + properties: + id: + type: string + description: 'The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result.' + example: 2c918086749d78830174a1a40e121518 + name: + type: string + description: The human-readable display name of the Role + maxLength: 128 + example: Role 2567 + created: + type: string + description: Date the Role was created + format: date-time + example: '2021-03-01T22:32:58.104Z' + readOnly: true + modified: + type: string + description: Date the Role was last modified. + format: date-time + example: '2021-03-02T20:22:28.104Z' + readOnly: true + description: + type: string + nullable: true + description: A human-readable description of the Role + example: Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor. + owner: + type: object + nullable: true + description: The owner of this object. + properties: + type: + description: 'Owner type. This field must be either left null or set to ''IDENTITY'' on input, otherwise a 400 Bad Request error will result.' + example: IDENTITY + 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 + - WORKGROUP + id: + type: string + description: Identity id + example: 2c9180a46faadee4016fb4e018c20639 + name: + type: string + description: 'Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner''s display name, otherwise a 400 Bad Request error will result.' + example: support + accessProfiles: + type: array + items: + type: object + properties: + id: + type: string + description: ID of the Access Profile + example: ff808081751e6e129f1518161919ecca + type: + type: string + description: 'Type of requested object. This field must be either left null or set to ''ACCESS_PROFILE'' when creating an Access Profile, otherwise a 400 Bad Request error will result.' + enum: + - ACCESS_PROFILE + example: ACCESS_PROFILE + name: + type: string + description: Human-readable display name of the Access Profile. This field is ignored on input. + example: Access Profile 2567 + nullable: true + membership: + nullable: true + type: object + description: 'When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities.' + properties: + type: + type: string + enum: + - STANDARD + - IDENTITY_LIST + description: |- + This enum characterizes the type of a Role's membership selector. Only the following two are fully supported: + + STANDARD: Indicates that Role membership is defined in terms of a criteria expression + + IDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed + example: IDENTITY_LIST + criteria: + nullable: true + type: object + description: Defines STANDARD type Role membership + properties: + operation: + type: string + enum: + - EQUALS + - NOT_EQUALS + - CONTAINS + - STARTS_WITH + - ENDS_WITH + - AND + - OR + description: An operation + example: EQUALS + key: + type: object + nullable: true + description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' + properties: + type: + type: string + enum: + - IDENTITY + - ACCOUNT + - ENTITLEMENT + description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' + example: ACCOUNT + property: + type: string + description: The name of the attribute or entitlement to which the associated criteria applies. + example: attribute.email + sourceId: + type: string + nullable: true + description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT + example: 2c9180867427f3a301745aec18211519 + required: + - type + - property + stringValue: + type: string + nullable: true + description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' + example: carlee.cert1c9f9b6fd@mailinator.com + children: + type: array + items: + type: object + nullable: true + description: Defines STANDARD type Role membership + properties: + operation: + type: string + enum: + - EQUALS + - NOT_EQUALS + - CONTAINS + - STARTS_WITH + - ENDS_WITH + - AND + - OR + description: An operation + example: EQUALS + key: + type: object + nullable: true + description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' + properties: + type: + type: string + enum: + - IDENTITY + - ACCOUNT + - ENTITLEMENT + description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' + example: ACCOUNT + property: + type: string + description: The name of the attribute or entitlement to which the associated criteria applies. + example: attribute.email + sourceId: + type: string + nullable: true + description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT + example: 2c9180867427f3a301745aec18211519 + required: + - type + - property + stringValue: + type: string + nullable: true + description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' + example: carlee.cert1c9f9b6fd@mailinator.com + children: + type: array + items: type: object + description: Defines STANDARD type Role membership properties: - id: - type: string - description: The SailPoint generated unique ID - example: 2c9180837dfe6949017e21f3d8cd6d49 - accountId: + operation: type: string - description: The account ID generated by the source - example: 'CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' - appCount: - type: integer - format: int32 - description: The number of applications the identity has access to - example: 2 - access: - type: array - description: The list of access items assigned to the identity - items: - discriminator: - propertyName: type - mapping: - ACCESS_PROFILE: ../access/AccessProfileSummary.yaml - ENTITLEMENT: ../access/AccessProfileEntitlement.yaml - ROLE: ../access/AccessProfileRole.yaml - oneOf: - - description: This is a summary representation of an access profile. - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - example: null - - type: object - properties: - source: + enum: + - EQUALS + - NOT_EQUALS + - CONTAINS + - STARTS_WITH + - ENDS_WITH + - AND + - OR + description: An operation + example: EQUALS + key: type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe - revocable: - type: boolean - example: true - - description: EntitlementReference - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object + nullable: true + description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' properties: 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - example: null - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - privileged: - type: boolean - example: false - attribute: - type: string - example: memberOf - value: - type: string - example: 'CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' - standalone: - type: boolean - example: false - - description: Role - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: + description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' + example: ACCOUNT + property: + type: string + description: The name of the attribute or entitlement to which the associated criteria applies. + example: attribute.email + sourceId: type: string nullable: true - example: null - - type: object - properties: - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object - properties: - displayName: - type: string - example: John Q. Doe - disabled: - type: boolean - revocable: - type: boolean - accessCount: - type: integer - format: int32 - description: The number of access items assigned to the identity - example: 5 - accessProfileCount: - type: integer - description: The number of access profiles assigned to the identity - example: 1 - entitlementCount: - type: integer - description: The number of entitlements assigned to the identity - example: 10 - roleCount: - type: integer - description: The number of roles assigned to the identity - example: 1 - owns: + description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT + example: 2c9180867427f3a301745aec18211519 + required: + - type + - property + stringValue: + type: string + description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' + example: carlee.cert1c9f9b6fd@mailinator.com + nullable: true + description: 'Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.' + nullable: true + description: 'Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.' + identities: + type: array + items: + type: object + description: A reference to an Identity in an IDENTITY_LIST role membership criteria. + properties: + type: + nullable: true + example: IDENTITY + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + id: + type: string + description: Identity id + example: 2c9180a46faadee4016fb4e018c20639 + name: + type: string + nullable: true + description: Human-readable display name of the Identity. + example: Thomas Edison + aliasName: + type: string + nullable: true + description: User name of the Identity + example: t.edison + nullable: true + description: 'Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST.' + legacyMembershipInfo: + type: object + nullable: true + description: 'This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.' + example: + type: IDENTITY_LIST + additionalProperties: true + enabled: + type: boolean + description: Whether the Role is enabled or not. + example: true + default: false + requestable: + type: boolean + description: Whether the Role can be the target of access requests. + example: true + default: false + accessRequestConfig: + nullable: true + description: Access request configuration for this object + type: object + properties: + commentsRequired: + type: boolean + description: Whether the requester of the containing object must provide comments justifying the request + example: true + nullable: true + default: false + denialCommentsRequired: + type: boolean + description: Whether an approver must provide comments when denying the request + example: true + nullable: true + default: false + approvalSchemes: + type: array + description: List describing the steps in approving the request + items: + type: object + properties: + approverType: + type: string + enum: + - OWNER + - MANAGER + - GOVERNANCE_GROUP + description: |- + Describes the individual or group that is responsible for an approval step. Values are as follows. + + **OWNER**: Owner of the associated Role + + **MANAGER**: Manager of the Identity making the request + + **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field + example: GOVERNANCE_GROUP + approverId: + type: string + nullable: true + description: 'Id of the specific approver, used only when approverType is GOVERNANCE_GROUP' + example: 46c79819-a69f-49a2-becb-12c971ae66c6 + revocationRequestConfig: + nullable: true + default: null + description: Revocation request configuration for this object. + type: object + properties: + commentsRequired: + type: boolean + description: Whether the requester of the containing object must provide comments justifying the request + example: false + nullable: true + default: false + denialCommentsRequired: + type: boolean + description: Whether an approver must provide comments when denying the request + example: false + nullable: true + default: false + approvalSchemes: + type: array + description: List describing the steps in approving the revocation request + items: + type: object + properties: + approverType: + type: string + enum: + - APP_OWNER + - OWNER + - SOURCE_OWNER + - MANAGER + - GOVERNANCE_GROUP + description: |- + Describes the individual or group that is responsible for an approval step. Values are as follows. + **APP_OWNER**: The owner of the Application + + **OWNER**: Owner of the associated Access Profile or Role + + **SOURCE_OWNER**: Owner of the Source associated with an Access Profile + + **MANAGER**: Manager of the Identity making the request + + **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field + example: GOVERNANCE_GROUP + approverId: + type: string + nullable: true + description: 'Id of the specific approver, used only when approverType is GOVERNANCE_GROUP' + example: 46c79819-a69f-49a2-becb-12c971ae66c6 + segments: + type: array + items: + type: string + nullable: true + description: 'List of IDs of segments, if any, to which this Role is assigned.' + example: + - f7b1b8a3-5fed-4fd4-ad29-82014e137e19 + - 29cb6c06-1da8-43ea-8be4-b3125f248f2a + required: + - name + - owner + '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. + security: + - UserContextAuth: + - 'idn:role-unchecked:read' + - 'idn:role-unchecked:manage' + - 'idn:role-checked:manage' + - 'idn:role-checked:read' + post: + operationId: createRole + tags: + - Roles + summary: Create a Role + description: |- + This API creates a role. + You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. + In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. + The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + requestBody: + required: true + content: + application/json: + schema: + type: object + description: A Role + properties: + id: + type: string + description: 'The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result.' + example: 2c918086749d78830174a1a40e121518 + name: + type: string + description: The human-readable display name of the Role + maxLength: 128 + example: Role 2567 + created: + type: string + description: Date the Role was created + format: date-time + example: '2021-03-01T22:32:58.104Z' + readOnly: true + modified: + type: string + description: Date the Role was last modified. + format: date-time + example: '2021-03-02T20:22:28.104Z' + readOnly: true + description: + type: string + nullable: true + description: A human-readable description of the Role + example: Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor. + owner: + type: object + nullable: true + description: The owner of this object. + properties: + type: + description: 'Owner type. This field must be either left null or set to ''IDENTITY'' on input, otherwise a 400 Bad Request error will result.' + example: IDENTITY + 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 + - WORKGROUP + id: + type: string + description: Identity id + example: 2c9180a46faadee4016fb4e018c20639 + name: + type: string + description: 'Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner''s display name, otherwise a 400 Bad Request error will result.' + example: support + accessProfiles: + type: array + items: + type: object + properties: + id: + type: string + description: ID of the Access Profile + example: ff808081751e6e129f1518161919ecca + type: + type: string + description: 'Type of requested object. This field must be either left null or set to ''ACCESS_PROFILE'' when creating an Access Profile, otherwise a 400 Bad Request error will result.' + enum: + - ACCESS_PROFILE + example: ACCESS_PROFILE + name: + type: string + description: Human-readable display name of the Access Profile. This field is ignored on input. + example: Access Profile 2567 + nullable: true + membership: + nullable: true + type: object + description: 'When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities.' + properties: + type: + type: string + enum: + - STANDARD + - IDENTITY_LIST + description: |- + This enum characterizes the type of a Role's membership selector. Only the following two are fully supported: + + STANDARD: Indicates that Role membership is defined in terms of a criteria expression + + IDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed + example: IDENTITY_LIST + criteria: + nullable: true + type: object + description: Defines STANDARD type Role membership + properties: + operation: + type: string + enum: + - EQUALS + - NOT_EQUALS + - CONTAINS + - STARTS_WITH + - ENDS_WITH + - AND + - OR + description: An operation + example: EQUALS + key: + type: object + nullable: true + description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' + properties: + type: + type: string + enum: + - IDENTITY + - ACCOUNT + - ENTITLEMENT + description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' + example: ACCOUNT + property: + type: string + description: The name of the attribute or entitlement to which the associated criteria applies. + example: attribute.email + sourceId: + type: string + nullable: true + description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT + example: 2c9180867427f3a301745aec18211519 + required: + - type + - property + stringValue: + type: string + nullable: true + description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' + example: carlee.cert1c9f9b6fd@mailinator.com + children: + type: array + items: type: object + nullable: true + description: Defines STANDARD type Role membership properties: - sources: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - entitlements: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - accessProfiles: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - roles: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - apps: + operation: + type: string + enum: + - EQUALS + - NOT_EQUALS + - CONTAINS + - STARTS_WITH + - ENDS_WITH + - AND + - OR + description: An operation + example: EQUALS + key: + type: object + nullable: true + description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' + properties: + type: + type: string + enum: + - IDENTITY + - ACCOUNT + - ENTITLEMENT + description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' + example: ACCOUNT + property: + type: string + description: The name of the attribute or entitlement to which the associated criteria applies. + example: attribute.email + sourceId: + type: string + nullable: true + description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT + example: 2c9180867427f3a301745aec18211519 + required: + - type + - property + stringValue: + type: string + nullable: true + description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' + example: carlee.cert1c9f9b6fd@mailinator.com + children: type: array items: type: object + description: Defines STANDARD type Role membership properties: - id: + operation: type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: + enum: + - EQUALS + - NOT_EQUALS + - CONTAINS + - STARTS_WITH + - ENDS_WITH + - AND + - OR + description: An operation + example: EQUALS + key: + type: object + nullable: true + description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' + properties: + type: + type: string + enum: + - IDENTITY + - ACCOUNT + - ENTITLEMENT + description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' + example: ACCOUNT + property: + type: string + description: The name of the attribute or entitlement to which the associated criteria applies. + example: attribute.email + sourceId: + type: string + nullable: true + description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT + example: 2c9180867427f3a301745aec18211519 + required: + - type + - property + stringValue: type: string - example: John Doe - description: The human readable name of the referenced object. - governanceGroups: - type: array - items: + description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' + example: carlee.cert1c9f9b6fd@mailinator.com + nullable: true + description: 'Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.' + nullable: true + description: 'Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.' + identities: + type: array + items: + type: object + description: A reference to an Identity in an IDENTITY_LIST role membership criteria. + properties: + type: + nullable: true + example: IDENTITY + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + id: + type: string + description: Identity id + example: 2c9180a46faadee4016fb4e018c20639 + name: + type: string + nullable: true + description: Human-readable display name of the Identity. + example: Thomas Edison + aliasName: + type: string + nullable: true + description: User name of the Identity + example: t.edison + nullable: true + description: 'Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST.' + legacyMembershipInfo: + type: object + nullable: true + description: 'This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.' + example: + type: IDENTITY_LIST + additionalProperties: true + enabled: + type: boolean + description: Whether the Role is enabled or not. + example: true + default: false + requestable: + type: boolean + description: Whether the Role can be the target of access requests. + example: true + default: false + accessRequestConfig: + nullable: true + description: Access request configuration for this object + type: object + properties: + commentsRequired: + type: boolean + description: Whether the requester of the containing object must provide comments justifying the request + example: true + nullable: true + default: false + denialCommentsRequired: + type: boolean + description: Whether an approver must provide comments when denying the request + example: true + nullable: true + default: false + approvalSchemes: + type: array + description: List describing the steps in approving the request + items: + type: object + properties: + approverType: + type: string + enum: + - OWNER + - MANAGER + - GOVERNANCE_GROUP + description: |- + Describes the individual or group that is responsible for an approval step. Values are as follows. + + **OWNER**: Owner of the associated Role + + **MANAGER**: Manager of the Identity making the request + + **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field + example: GOVERNANCE_GROUP + approverId: + type: string + nullable: true + description: 'Id of the specific approver, used only when approverType is GOVERNANCE_GROUP' + example: 46c79819-a69f-49a2-becb-12c971ae66c6 + revocationRequestConfig: + nullable: true + default: null + description: Revocation request configuration for this object. + type: object + properties: + commentsRequired: + type: boolean + description: Whether the requester of the containing object must provide comments justifying the request + example: false + nullable: true + default: false + denialCommentsRequired: + type: boolean + description: Whether an approver must provide comments when denying the request + example: false + nullable: true + default: false + approvalSchemes: + type: array + description: List describing the steps in approving the revocation request + items: + type: object + properties: + approverType: + type: string + enum: + - APP_OWNER + - OWNER + - SOURCE_OWNER + - MANAGER + - GOVERNANCE_GROUP + description: |- + Describes the individual or group that is responsible for an approval step. Values are as follows. + **APP_OWNER**: The owner of the Application + + **OWNER**: Owner of the associated Access Profile or Role + + **SOURCE_OWNER**: Owner of the Source associated with an Access Profile + + **MANAGER**: Manager of the Identity making the request + + **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field + example: GOVERNANCE_GROUP + approverId: + type: string + nullable: true + description: 'Id of the specific approver, used only when approverType is GOVERNANCE_GROUP' + example: 46c79819-a69f-49a2-becb-12c971ae66c6 + segments: + type: array + items: + type: string + nullable: true + description: 'List of IDs of segments, if any, to which this Role is assigned.' + example: + - f7b1b8a3-5fed-4fd4-ad29-82014e137e19 + - 29cb6c06-1da8-43ea-8be4-b3125f248f2a + required: + - name + - owner + responses: + '201': + description: Role created + content: + application/json: + schema: + type: object + description: A Role + properties: + id: + type: string + description: 'The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result.' + example: 2c918086749d78830174a1a40e121518 + name: + type: string + description: The human-readable display name of the Role + maxLength: 128 + example: Role 2567 + created: + type: string + description: Date the Role was created + format: date-time + example: '2021-03-01T22:32:58.104Z' + readOnly: true + modified: + type: string + description: Date the Role was last modified. + format: date-time + example: '2021-03-02T20:22:28.104Z' + readOnly: true + description: + type: string + nullable: true + description: A human-readable description of the Role + example: Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor. + owner: + type: object + nullable: true + description: The owner of this object. + properties: + type: + description: 'Owner type. This field must be either left null or set to ''IDENTITY'' on input, otherwise a 400 Bad Request error will result.' + example: IDENTITY + 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 + - WORKGROUP + id: + type: string + description: Identity id + example: 2c9180a46faadee4016fb4e018c20639 + name: + type: string + description: 'Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner''s display name, otherwise a 400 Bad Request error will result.' + example: support + accessProfiles: + type: array + items: + type: object + properties: + id: + type: string + description: ID of the Access Profile + example: ff808081751e6e129f1518161919ecca + type: + type: string + description: 'Type of requested object. This field must be either left null or set to ''ACCESS_PROFILE'' when creating an Access Profile, otherwise a 400 Bad Request error will result.' + enum: + - ACCESS_PROFILE + example: ACCESS_PROFILE + name: + type: string + description: Human-readable display name of the Access Profile. This field is ignored on input. + example: Access Profile 2567 + nullable: true + membership: + nullable: true + type: object + description: 'When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities.' + properties: + type: + type: string + enum: + - STANDARD + - IDENTITY_LIST + description: |- + This enum characterizes the type of a Role's membership selector. Only the following two are fully supported: + + STANDARD: Indicates that Role membership is defined in terms of a criteria expression + + IDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed + example: IDENTITY_LIST + criteria: + nullable: true + type: object + description: Defines STANDARD type Role membership + properties: + operation: + type: string + enum: + - EQUALS + - NOT_EQUALS + - CONTAINS + - STARTS_WITH + - ENDS_WITH + - AND + - OR + description: An operation + example: EQUALS + key: + type: object + nullable: true + description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' + properties: + type: + type: string + enum: + - IDENTITY + - ACCOUNT + - ENTITLEMENT + description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' + example: ACCOUNT + property: + type: string + description: The name of the attribute or entitlement to which the associated criteria applies. + example: attribute.email + sourceId: + type: string + nullable: true + description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT + example: 2c9180867427f3a301745aec18211519 + required: + - type + - property + stringValue: + type: string + nullable: true + description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' + example: carlee.cert1c9f9b6fd@mailinator.com + children: + type: array + items: + type: object + nullable: true + description: Defines STANDARD type Role membership + properties: + operation: + type: string + enum: + - EQUALS + - NOT_EQUALS + - CONTAINS + - STARTS_WITH + - ENDS_WITH + - AND + - OR + description: An operation + example: EQUALS + key: type: object + nullable: true + description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' properties: - id: + type: type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: + enum: + - IDENTITY + - ACCOUNT + - ENTITLEMENT + description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' + example: ACCOUNT + property: type: string - example: John Doe - description: The human readable name of the referenced object. - fallbackApprover: - type: boolean - example: false - tags: - type: array - items: + description: The name of the attribute or entitlement to which the associated criteria applies. + example: attribute.email + sourceId: + type: string + nullable: true + description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT + example: 2c9180867427f3a301745aec18211519 + required: + - type + - property + stringValue: + type: string + nullable: true + description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' + example: carlee.cert1c9f9b6fd@mailinator.com + children: + type: array + items: + type: object + description: Defines STANDARD type Role membership + properties: + operation: + type: string + enum: + - EQUALS + - NOT_EQUALS + - CONTAINS + - STARTS_WITH + - ENDS_WITH + - AND + - OR + description: An operation + example: EQUALS + key: + type: object + nullable: true + description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' + properties: + type: + type: string + enum: + - IDENTITY + - ACCOUNT + - ENTITLEMENT + description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' + example: ACCOUNT + property: + type: string + description: The name of the attribute or entitlement to which the associated criteria applies. + example: attribute.email + sourceId: + type: string + nullable: true + description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT + example: 2c9180867427f3a301745aec18211519 + required: + - type + - property + stringValue: + type: string + description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' + example: carlee.cert1c9f9b6fd@mailinator.com + nullable: true + description: 'Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.' + nullable: true + description: 'Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.' + identities: + type: array + items: + type: object + description: A reference to an Identity in an IDENTITY_LIST role membership criteria. + properties: + type: + nullable: true + example: IDENTITY type: string - example: - - TAG_1 - - TAG_2 - - description: Role - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - name: - type: string - example: john.doe - _type: - description: |- - Enum representing the currently supported document types. + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + id: + type: string + description: Identity id + example: 2c9180a46faadee4016fb4e018c20639 + name: + type: string + nullable: true + description: Human-readable display name of the Identity. + example: Thomas Edison + aliasName: + type: string + nullable: true + description: User name of the Identity + example: t.edison + nullable: true + description: 'Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST.' + legacyMembershipInfo: + type: object + nullable: true + description: 'This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.' + example: + type: IDENTITY_LIST + additionalProperties: true + enabled: + type: boolean + description: Whether the Role is enabled or not. + example: true + default: false + requestable: + type: boolean + description: Whether the Role can be the target of access requests. + example: true + default: false + accessRequestConfig: + nullable: true + description: Access request configuration for this object + type: object + properties: + commentsRequired: + type: boolean + description: Whether the requester of the containing object must provide comments justifying the request + example: true + nullable: true + default: false + denialCommentsRequired: + type: boolean + description: Whether an approver must provide comments when denying the request + example: true + nullable: true + default: false + approvalSchemes: + type: array + description: List describing the steps in approving the request + items: + type: object + properties: + approverType: + type: string + enum: + - OWNER + - MANAGER + - GOVERNANCE_GROUP + description: |- + Describes the individual or group that is responsible for an approval step. Values are as follows. + + **OWNER**: Owner of the associated Role + + **MANAGER**: Manager of the Identity making the request + + **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field + example: GOVERNANCE_GROUP + approverId: + type: string + nullable: true + description: 'Id of the specific approver, used only when approverType is GOVERNANCE_GROUP' + example: 46c79819-a69f-49a2-becb-12c971ae66c6 + revocationRequestConfig: + nullable: true + default: null + description: Revocation request configuration for this object. + type: object + properties: + commentsRequired: + type: boolean + description: Whether the requester of the containing object must provide comments justifying the request + example: false + nullable: true + default: false + denialCommentsRequired: + type: boolean + description: Whether an approver must provide comments when denying the request + example: false + nullable: true + default: false + approvalSchemes: + type: array + description: List describing the steps in approving the revocation request + items: + type: object + properties: + approverType: + type: string + enum: + - APP_OWNER + - OWNER + - SOURCE_OWNER + - MANAGER + - GOVERNANCE_GROUP + description: |- + Describes the individual or group that is responsible for an approval step. Values are as follows. + **APP_OWNER**: The owner of the Application + + **OWNER**: Owner of the associated Access Profile or Role + + **SOURCE_OWNER**: Owner of the Source associated with an Access Profile + + **MANAGER**: Manager of the Identity making the request + + **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field + example: GOVERNANCE_GROUP + approverId: + type: string + nullable: true + description: 'Id of the specific approver, used only when approverType is GOVERNANCE_GROUP' + example: 46c79819-a69f-49a2-becb-12c971ae66c6 + segments: + type: array + items: + type: string + nullable: true + description: 'List of IDs of segments, if any, to which this Role is assigned.' + example: + - f7b1b8a3-5fed-4fd4-ad29-82014e137e19 + - 29cb6c06-1da8-43ea-8be4-b3125f248f2a + required: + - name + - owner + '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. + security: + - UserContextAuth: + - 'idn:role-unchecked:manage' + - 'idn:role-checked:manage' + '/roles/{id}': + get: + operationId: getRole + tags: + - Roles + summary: Get a Role + description: |- + This API returns a Role by its ID. - Additional values may be added in the future without notice. + A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + parameters: + - in: path + name: id + required: true + schema: + type: string + description: ID of the Role + example: 2c91808a7813090a017814121e121518 + responses: + '200': + description: List of all Roles + content: + application/json: + schema: + type: object + description: A Role + properties: + id: + type: string + description: 'The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result.' + example: 2c918086749d78830174a1a40e121518 + name: + type: string + description: The human-readable display name of the Role + maxLength: 128 + example: Role 2567 + created: + type: string + description: Date the Role was created + format: date-time + example: '2021-03-01T22:32:58.104Z' + readOnly: true + modified: + type: string + description: Date the Role was last modified. + format: date-time + example: '2021-03-02T20:22:28.104Z' + readOnly: true + description: + type: string + nullable: true + description: A human-readable description of the Role + example: Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor. + owner: + type: object + nullable: true + description: The owner of this object. + properties: + type: + description: 'Owner type. This field must be either left null or set to ''IDENTITY'' on input, otherwise a 400 Bad Request error will result.' + example: IDENTITY + 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 + - WORKGROUP + id: + type: string + description: Identity id + example: 2c9180a46faadee4016fb4e018c20639 + name: + type: string + description: 'Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner''s display name, otherwise a 400 Bad Request error will result.' + example: support + accessProfiles: + type: array + items: + type: object + properties: + id: + type: string + description: ID of the Access Profile + example: ff808081751e6e129f1518161919ecca + type: + type: string + description: 'Type of requested object. This field must be either left null or set to ''ACCESS_PROFILE'' when creating an Access Profile, otherwise a 400 Bad Request error will result.' + enum: + - ACCESS_PROFILE + example: ACCESS_PROFILE + name: + type: string + description: Human-readable display name of the Access Profile. This field is ignored on input. + example: Access Profile 2567 + nullable: true + membership: + nullable: true + type: object + description: 'When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities.' + properties: + type: + type: string + enum: + - STANDARD + - IDENTITY_LIST + description: |- + This enum characterizes the type of a Role's membership selector. Only the following two are fully supported: + + STANDARD: Indicates that Role membership is defined in terms of a criteria expression + + IDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed + example: IDENTITY_LIST + criteria: + nullable: true + type: object + description: Defines STANDARD type Role membership + properties: + operation: type: string enum: - - accessprofile - - accountactivity - - account - - aggregation - - entitlement - - event - - identity - - role - example: identity - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object + - EQUALS + - NOT_EQUALS + - CONTAINS + - STARTS_WITH + - ENDS_WITH + - AND + - OR + description: An operation + example: EQUALS + key: + type: object + nullable: true + description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' properties: - description: - type: string - description: The description of the access item - example: The admin role - created: + type: type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: + enum: + - IDENTITY + - ACCOUNT + - ENTITLEMENT + description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' + example: ACCOUNT + property: type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: + description: The name of the attribute or entitlement to which the associated criteria applies. + example: attribute.email + sourceId: type: string nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - enabled: - type: boolean - example: true - requestable: - type: boolean - example: true - description: Indicates if the access can be requested - requestCommentsRequired: - type: boolean - description: Indicates if comments are required when requesting access - example: false - owner: - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - - type: object + description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT + example: 2c9180867427f3a301745aec18211519 + required: + - type + - property + stringValue: + type: string + nullable: true + description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' + example: carlee.cert1c9f9b6fd@mailinator.com + children: + type: array + items: + type: object + nullable: true + description: Defines STANDARD type Role membership + properties: + operation: + type: string + enum: + - EQUALS + - NOT_EQUALS + - CONTAINS + - STARTS_WITH + - ENDS_WITH + - AND + - OR + description: An operation + example: EQUALS + key: + type: object + nullable: true + description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' + properties: + type: + type: string + enum: + - IDENTITY + - ACCOUNT + - ENTITLEMENT + description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' + example: ACCOUNT + property: + type: string + description: The name of the attribute or entitlement to which the associated criteria applies. + example: attribute.email + sourceId: + type: string + nullable: true + description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT + example: 2c9180867427f3a301745aec18211519 + required: + - type + - property + stringValue: + type: string + nullable: true + description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' + example: carlee.cert1c9f9b6fd@mailinator.com + children: + type: array + items: + type: object + description: Defines STANDARD type Role membership + properties: + operation: + type: string + enum: + - EQUALS + - NOT_EQUALS + - CONTAINS + - STARTS_WITH + - ENDS_WITH + - AND + - OR + description: An operation + example: EQUALS + key: + type: object + nullable: true + description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' properties: type: type: string enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL + - IDENTITY - 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 - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - - type: object - properties: - email: + description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' + example: ACCOUNT + property: + type: string + description: The name of the attribute or entitlement to which the associated criteria applies. + example: attribute.email + sourceId: + type: string + nullable: true + description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT + example: 2c9180867427f3a301745aec18211519 + required: + - type + - property + stringValue: type: string - example: john.doe@sailpoint.com - description: The email of the identity - - type: object - properties: - accessProfiles: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - accessProfileCount: - type: integer - tags: - type: array - items: + description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' + example: carlee.cert1c9f9b6fd@mailinator.com + nullable: true + description: 'Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.' + nullable: true + description: 'Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.' + identities: + type: array + items: + type: object + description: A reference to an Identity in an IDENTITY_LIST role membership criteria. + properties: + type: + nullable: true + example: IDENTITY + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + id: + type: string + description: Identity id + example: 2c9180a46faadee4016fb4e018c20639 + name: + type: string + nullable: true + description: Human-readable display name of the Identity. + example: Thomas Edison + aliasName: + type: string + nullable: true + description: User name of the Identity + example: t.edison + nullable: true + description: 'Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST.' + legacyMembershipInfo: + type: object + nullable: true + description: 'This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.' + example: + type: IDENTITY_LIST + additionalProperties: true + enabled: + type: boolean + description: Whether the Role is enabled or not. + example: true + default: false + requestable: + type: boolean + description: Whether the Role can be the target of access requests. + example: true + default: false + accessRequestConfig: + nullable: true + description: Access request configuration for this object + type: object + properties: + commentsRequired: + type: boolean + description: Whether the requester of the containing object must provide comments justifying the request + example: true + nullable: true + default: false + denialCommentsRequired: + type: boolean + description: Whether an approver must provide comments when denying the request + example: true + nullable: true + default: false + approvalSchemes: + type: array + description: List describing the steps in approving the request + items: + type: object + properties: + approverType: + type: string + enum: + - OWNER + - MANAGER + - GOVERNANCE_GROUP + description: |- + Describes the individual or group that is responsible for an approval step. Values are as follows. + + **OWNER**: Owner of the associated Role + + **MANAGER**: Manager of the Identity making the request + + **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field + example: GOVERNANCE_GROUP + approverId: + type: string + nullable: true + description: 'Id of the specific approver, used only when approverType is GOVERNANCE_GROUP' + example: 46c79819-a69f-49a2-becb-12c971ae66c6 + revocationRequestConfig: + nullable: true + default: null + description: Revocation request configuration for this object. + type: object + properties: + commentsRequired: + type: boolean + description: Whether the requester of the containing object must provide comments justifying the request + example: false + nullable: true + default: false + denialCommentsRequired: + type: boolean + description: Whether an approver must provide comments when denying the request + example: false + nullable: true + default: false + approvalSchemes: + type: array + description: List describing the steps in approving the revocation request + items: + type: object + properties: + approverType: type: string - example: - - TAG_1 - - TAG_2 - examples: - accessProfile: - summary: AccessProfile - value: - id: 2c9180825a6c1adc015a71c9023f0818 - name: Cloud Eng - _type: accessprofile - description: Cloud Eng - created: '2017-02-24T20:21:23.145Z' - modified: '2019-05-24T20:36:04.312Z' - synced: '2020-02-18T05:30:20.414Z' - enabled: true - requestable: true - requestCommentsRequired: false - owner: - id: ff8081815757d36a015757d42e56031e - name: SailPoint Support - type: IDENTITY - email: cloud-support@sailpoint.com - source: - id: ff8081815757d4fb0157588f3d9d008f - name: Employees - entitlements: - - id: 2c918084575812550157589064f33b89 - name: 'CN=Cloud Engineering,DC=sailpoint,DC=COM' - description: mull - attribute: memberOf - value: 'CN=Cloud Engineering,DC=sailpoint,DC=COM' - entitlementCount: 1 - tags: - - TAG_1 - - TAG_2 - entitlement: - summary: Entitlement - value: - id: 2c9180946ed0c43d016eec1a80892fbd - name: entitlement.aa415ae7 - _type: entitlement - description: 'null' - attribute: groups - value: entitlement.aa415ae7 - modified: '2019-12-09T19:19:50.154Z' - created: '2018-12-07T01:07:48Z' - synced: '2020-02-19T04:30:32.906Z' - displayName: entitlement.aa415ae7 - source: - id: 2c91808b6e9e6fb8016eec1a2b6f7b5f - name: ODS-HR-Employees - owner: - type: IDENTITY - id: 2c9180858315595501831958427e5424 - name: Addie Lee - privileged: false - identityCount: 68 - tags: - - TAG_1 - - TAG_2 - event: - summary: Event - value: - id: e092842f-c904-4b59-aac8-2544abeeef4b - name: Update Task Schedule Passed - _type: event - created: '2020-02-17T16:23:18.327Z' - synced: '2020-02-17T16:23:18.388Z' - action: TASK_SCHEDULE_UPDATE_PASSED - type: SYSTEM_CONFIG - actor: - name: MantisTaskScheduler - target: - name: Perform provisioning activity search delete synchronization - stack: tpe - trackingNumber: c6b98bc39ece48b080826d16c76b166c - ipAddress: 207.189.160.158 - details: 'null' - attributes: - sourceName: SailPoint - objects: - - TASK - - SCHEDULE - operation: UPDATE - status: PASSED - technicalName: TASK_SCHEDULE_UPDATE_PASSED - identity: - summary: Identity - value: - id: 2c9180865c45e7e3015c46c434a80622 - name: ad.admin - _type: identity - firstName: AD - lastName: Admin - displayName: AD Admin - email: SLPT.CLOUD.SAILPOINT.TEST+AD-ADMIN@GMAIL.COM - created: '2018-08-22T19:54:54.302Z' - modified: '2018-08-22T19:54:54.302Z' - synced: '2018-08-22T19:54:54.302Z' - phone: 512-942-7578 - inactive: false - protected: false - status: UNREGISTERED - employeeNumber: O349804 - manager: null - isManager: false - identityProfile: - id: 2c918085605c8d0601606f357cb231e6 - name: E2E AD - source: - id: 2c9180855c45b230015c46c19b9c0202 - name: EndToEnd-ADSource - attributes: - uid: ad.admin - firstname: AD - cloudAuthoritativeSource: 2c9180855c45b230015c46c19b9c0202 - cloudStatus: UNREGISTERED - iplanet-am-user-alias-list: null - displayName: AD Admin - internalCloudStatus: UNREGISTERED - workPhone: 512-942-7578 - email: SLPT.CLOUD.SAILPOINT.TEST+AD-ADMIN@GMAIL.COM - lastname: Admin - processingState: null - processingDetails: null - accounts: - - id: 2c9180865c45e7e3015c46c434a80623 - name: ad.admin - accountId: 'CN=AD Admin,OU=slpt-automation,DC=TestAutomationAD,DC=local' - source: - id: 2c9180855c45b230015c46c19b9c0202 - name: EndToEnd-ADSource - type: Active Directory - Direct - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - passwordLastSet: '2018-08-22T19:54:54.302Z' - entitlementAttributes: - memberOf: - - 'CN=Group Policy Creator Owners,CN=Users,DC=TestAutomationAD,DC=local' - - 'CN=Domain Guests,CN=Users,DC=TestAutomationAD,DC=local' - - 'CN=Domain Admins,CN=Users,DC=TestAutomationAD,DC=local' - - 'CN=Enterprise Admins,CN=Users,DC=TestAutomationAD,DC=local' - - 'CN=Schema Admins,CN=Users,DC=TestAutomationAD,DC=local' - - 'CN=Guests,CN=Builtin,DC=TestAutomationAD,DC=local' - - 'CN=Administrators,CN=Builtin,DC=TestAutomationAD,DC=local' - created: '2018-08-22T19:54:54.302Z' - - id: 2c918083606d670c01606f35a30a0349 - name: ad.admin - accountId: ad.admin - source: - id: ff8081815c46b85b015c46b90c7c02a6 - name: IdentityNow - type: IdentityNowConnector - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - passwordLastSet: null - entitlementAttributes: null - created: '2018-08-22T19:54:54.302Z' - accountCount: 2 - apps: - - id: '22751' - name: ADP Workforce Now - source: - id: 2c9180855c45b230015c46e2f6a8026a - name: Corporate Active Directory - account: - id: 2c9180865c45efa4015c470be0de1606 - accountId: 'CN=Bob Wilson,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com' - appCount: 1 - access: - - id: 2c918083634bc6cb01639808d40270ba - name: 'test [AccessProfile-1527264105448]' - displayName: test - type: ACCESS_PROFILE - description: test - source: - id: 2c9180855c45b230015c46c19b9c0202 - name: EndToEnd-ADSource - owner: - id: 2c9180865c45e7e3015c46c434a80622 - name: ad.admin - displayName: AD Admin - - id: 2c9180865c45e7e3015c46c457c50755 - name: Administrators - displayName: Administrators - type: ENTITLEMENT - description: null - source: - id: 2c9180855c45b230015c46c19b9c0202 - name: EndToEnd-ADSource - privileged: false - attribute: memberOf - value: 'CN=Administrators,CN=Builtin,DC=TestAutomationAD,DC=local' - standalone: false - - id: 2c9180865decdaa5015e06598b293108 - name: 'test [cloudRole-1503345085223]' - displayName: test - type: ROLE - description: test - owner: - id: 2c9180865c45e7e3015c46c5030707a0 - name: will.albin - displayName: Albin Will - disabled: false - accessCount: 3 - accessProfileCount: 1 - entitlementCount: 1 - roleCount: 1 - tags: - - TAG_1 - - TAG_2 - role: - summary: Role - value: - id: 2c91808c6faadea6016fb4f2bc69077b - name: IT Role - _type: role - description: IT role - created: '2020-01-17T19:20:15.040Z' - modified: null - synced: '2020-02-18T05:30:20.145Z' - enabled: true - requestable: false - requestCommentsRequired: false - owner: - id: 2c9180a46faadee4016fb4e018c20639 - name: Cloud Support - type: IDENTITY - email: thomas.edison@acme-solar.com - accessProfiles: - - id: 2c91809c6faade77016fb4f0b63407ae - name: Admin Access - accessProfileCount: 1 - tags: - - TAG_1 - - TAG_2 + enum: + - APP_OWNER + - OWNER + - SOURCE_OWNER + - MANAGER + - GOVERNANCE_GROUP + description: |- + Describes the individual or group that is responsible for an approval step. Values are as follows. + **APP_OWNER**: The owner of the Application + + **OWNER**: Owner of the associated Access Profile or Role + + **SOURCE_OWNER**: Owner of the Source associated with an Access Profile + + **MANAGER**: Manager of the Identity making the request + + **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field + example: GOVERNANCE_GROUP + approverId: + type: string + nullable: true + description: 'Id of the specific approver, used only when approverType is GOVERNANCE_GROUP' + example: 46c79819-a69f-49a2-becb-12c971ae66c6 + segments: + type: array + items: + type: string + nullable: true + description: 'List of IDs of segments, if any, to which this Role is assigned.' + example: + - f7b1b8a3-5fed-4fd4-ad29-82014e137e19 + - 29cb6c06-1da8-43ea-8be4-b3125f248f2a + required: + - name + - owner '400': description: Client Error - Returned if the request body is invalid. content: @@ -70202,73 +54021,6 @@ paths: - locale: en-US localeOrigin: DEFAULT text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. '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: @@ -70346,173 +54098,160 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - /segments: - post: - operationId: createSegment security: - UserContextAuth: - - 'idn:segment:manage' + - 'idn:role-unchecked:read' + - 'idn:role-unchecked:manage' + - 'idn:role-checked:manage' + - 'idn:role-checked:read' + patch: + operationId: patchRole tags: - - Segments - summary: Create Segment + - Roles + summary: Patch a specified Role description: |- - This API creates a segment. - >**Note:** Segment definitions may take time to propagate to all identities. - A token with ORG_ADMIN or API authority is required to call this API. + This API updates an existing Role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + + The following fields are patchable: **name**, **description**, **enabled**, **owner**, **accessProfiles**, **membership**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments** + A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + parameters: + - name: id + in: path + description: ID of the Role to patch + required: true + schema: + type: string + example: 2c91808a7813090a017814121e121518 requestBody: - required: true content: - application/json: + application/json-patch+json: schema: - type: object - properties: - id: - type: string - description: The id of the Segment. - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - name: - type: string - description: Segment Business Name - example: segment-xyz - created: - type: string - format: date-time - description: The time when this Segment is created - example: '2020-01-01T00:00:00.000000Z' - modified: - type: string - format: date-time - description: The time when this Segment is modified - example: '2020-01-01T00:00:00.000000Z' - description: - type: string - description: Optional description of the Segment - example: This segment represents xyz - owner: - type: object - nullable: true - description: The owner of this object. - properties: - type: - description: 'Owner type. This field must be either left null or set to ''IDENTITY'' on input, otherwise a 400 Bad Request error will result.' - example: IDENTITY - 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 - - WORKGROUP - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: 'Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner''s display name, otherwise a 400 Bad Request error will result.' - example: support - visibilityCriteria: - type: object - properties: - expression: - type: object - properties: - operator: - type: string - description: Operator for the expression - enum: - - AND - - EQUALS - example: EQUALS - attribute: - type: string - description: Name for the attribute - example: location - value: - type: object - properties: - type: - type: string - description: The type of attribute value - example: STRING - value: - type: string - description: The attribute value - example: Austin + type: array + items: + type: object + description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' + required: + - op + - path + properties: + op: + type: string + description: The operation to be performed + enum: + - add + - remove + - replace + - move + - copy + - test + example: replace + path: + type: string + description: A string JSON Pointer representing the target path to an element to be affected by the operation + example: /description + value: + anyOf: + - type: string + - type: integer + - type: object + - type: array + items: + anyOf: + - type: string + - type: integer + - type: object + description: 'The value to be used for the operation, required for "add" and "replace" operations' + example: New description + examples: + Make a Role Requestable and Enable it in One Call: + description: This example shows how multiple fields may be updated with a single patch call. + value: + - op: replace + path: /requestable + value: true + - op: replace + path: /enabled + value: true + Assign a Role to a Segment: + description: This example illustrates the use of patch to assign a Role to a Segment by adding the Segment's ID to the Role's segments array. + value: + - op: add + path: /segments/- + value: f7b1b8a3-5fed-4fd4-ad29-82014e137e19 + Set the Membership Selection Criteria to a List of Identities: + description: 'This example shows how to define a Role''s membershp by providing a list of Identities, referenced by their IDs.' + value: + - op: replace + path: /membership + value: + type: IDENTITY_LIST + identities: + - id: 2c91808973fe906c0174262092014ed9 + - id: 2c918086262092014ed94fb8a47612f3 + Set the Membership Selection Criteria to a Standard Expression: + description: 'This example shows how to define a Role''s membership using STANDARD criteria. In this case, the Role will be granted to all Identities which have the *Engineering* attribute from the indicated Source.' + value: + - op: replace + path: /membership + value: + type: STANDARD + criteria: + operation: OR children: - type: array - nullable: true - description: List of expressions - items: - type: object - properties: - type: - type: string - description: The type of attribute value - example: STRING - value: - type: string - description: The attribute value - example: Austin - example: [] - active: - type: boolean - description: Whether the Segment is currently active. Inactive segments have no effect. - default: false - example: true + - operation: EQUALS + key: + type: ENTITLEMENT + property: attribute.memberOf + sourceId: 2c9180887701fb2014213e122092014e + stringValue: Engineering + Add a New Clause as the Child of an Existing Standard Expression: + description: This example shows how to add a child clause to an existing STANDARD criteria expression. + value: + - op: add + path: /membership/criteria/children/- + value: + operation: ENDS_WITH + key: + type: IDENTITY + property: attribute.email + stringValue: '@identitynow.com' + required: true responses: - '201': - description: Segment created + '200': + description: Responds with the Role as updated. content: application/json: schema: type: object + description: A Role properties: id: type: string - description: The id of the Segment. - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + description: 'The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result.' + example: 2c918086749d78830174a1a40e121518 name: type: string - description: Segment Business Name - example: segment-xyz + description: The human-readable display name of the Role + maxLength: 128 + example: Role 2567 created: type: string + description: Date the Role was created format: date-time - description: The time when this Segment is created - example: '2020-01-01T00:00:00.000000Z' + example: '2021-03-01T22:32:58.104Z' + readOnly: true modified: type: string + description: Date the Role was last modified. format: date-time - description: The time when this Segment is modified - example: '2020-01-01T00:00:00.000000Z' + example: '2021-03-02T20:22:28.104Z' + readOnly: true description: type: string - description: Optional description of the Segment - example: This segment represents xyz + nullable: true + description: A human-readable description of the Role + example: Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor. owner: type: object nullable: true @@ -70559,55 +54298,367 @@ paths: type: string description: 'Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner''s display name, otherwise a 400 Bad Request error will result.' example: support - visibilityCriteria: + accessProfiles: + type: array + items: + type: object + properties: + id: + type: string + description: ID of the Access Profile + example: ff808081751e6e129f1518161919ecca + type: + type: string + description: 'Type of requested object. This field must be either left null or set to ''ACCESS_PROFILE'' when creating an Access Profile, otherwise a 400 Bad Request error will result.' + enum: + - ACCESS_PROFILE + example: ACCESS_PROFILE + name: + type: string + description: Human-readable display name of the Access Profile. This field is ignored on input. + example: Access Profile 2567 + nullable: true + membership: + nullable: true type: object + description: 'When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities.' properties: - expression: + type: + type: string + enum: + - STANDARD + - IDENTITY_LIST + description: |- + This enum characterizes the type of a Role's membership selector. Only the following two are fully supported: + + STANDARD: Indicates that Role membership is defined in terms of a criteria expression + + IDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed + example: IDENTITY_LIST + criteria: + nullable: true type: object + description: Defines STANDARD type Role membership properties: - operator: + operation: type: string - description: Operator for the expression enum: - - AND - EQUALS + - NOT_EQUALS + - CONTAINS + - STARTS_WITH + - ENDS_WITH + - AND + - OR + description: An operation example: EQUALS - attribute: - type: string - description: Name for the attribute - example: location - value: + key: type: object + nullable: true + description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' properties: type: type: string - description: The type of attribute value - example: STRING - value: + enum: + - IDENTITY + - ACCOUNT + - ENTITLEMENT + description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' + example: ACCOUNT + property: type: string - description: The attribute value - example: Austin + description: The name of the attribute or entitlement to which the associated criteria applies. + example: attribute.email + sourceId: + type: string + nullable: true + description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT + example: 2c9180867427f3a301745aec18211519 + required: + - type + - property + stringValue: + type: string + nullable: true + description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' + example: carlee.cert1c9f9b6fd@mailinator.com children: type: array - nullable: true - description: List of expressions items: type: object + nullable: true + description: Defines STANDARD type Role membership properties: - type: + operation: type: string - description: The type of attribute value - example: STRING - value: + enum: + - EQUALS + - NOT_EQUALS + - CONTAINS + - STARTS_WITH + - ENDS_WITH + - AND + - OR + description: An operation + example: EQUALS + key: + type: object + nullable: true + description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' + properties: + type: + type: string + enum: + - IDENTITY + - ACCOUNT + - ENTITLEMENT + description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' + example: ACCOUNT + property: + type: string + description: The name of the attribute or entitlement to which the associated criteria applies. + example: attribute.email + sourceId: + type: string + nullable: true + description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT + example: 2c9180867427f3a301745aec18211519 + required: + - type + - property + stringValue: type: string - description: The attribute value - example: Austin - example: [] - active: + nullable: true + description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' + example: carlee.cert1c9f9b6fd@mailinator.com + children: + type: array + items: + type: object + description: Defines STANDARD type Role membership + properties: + operation: + type: string + enum: + - EQUALS + - NOT_EQUALS + - CONTAINS + - STARTS_WITH + - ENDS_WITH + - AND + - OR + description: An operation + example: EQUALS + key: + type: object + nullable: true + description: 'Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria' + properties: + type: + type: string + enum: + - IDENTITY + - ACCOUNT + - ENTITLEMENT + description: 'Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.' + example: ACCOUNT + property: + type: string + description: The name of the attribute or entitlement to which the associated criteria applies. + example: attribute.email + sourceId: + type: string + nullable: true + description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT + example: 2c9180867427f3a301745aec18211519 + required: + - type + - property + stringValue: + type: string + description: 'String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.' + example: carlee.cert1c9f9b6fd@mailinator.com + nullable: true + description: 'Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.' + nullable: true + description: 'Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.' + identities: + type: array + items: + type: object + description: A reference to an Identity in an IDENTITY_LIST role membership criteria. + properties: + type: + nullable: true + example: IDENTITY + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + id: + type: string + description: Identity id + example: 2c9180a46faadee4016fb4e018c20639 + name: + type: string + nullable: true + description: Human-readable display name of the Identity. + example: Thomas Edison + aliasName: + type: string + nullable: true + description: User name of the Identity + example: t.edison + nullable: true + description: 'Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST.' + legacyMembershipInfo: + type: object + nullable: true + description: 'This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.' + example: + type: IDENTITY_LIST + additionalProperties: true + enabled: type: boolean - description: Whether the Segment is currently active. Inactive segments have no effect. + description: Whether the Role is enabled or not. + example: true default: false + requestable: + type: boolean + description: Whether the Role can be the target of access requests. example: true + default: false + accessRequestConfig: + nullable: true + description: Access request configuration for this object + type: object + properties: + commentsRequired: + type: boolean + description: Whether the requester of the containing object must provide comments justifying the request + example: true + nullable: true + default: false + denialCommentsRequired: + type: boolean + description: Whether an approver must provide comments when denying the request + example: true + nullable: true + default: false + approvalSchemes: + type: array + description: List describing the steps in approving the request + items: + type: object + properties: + approverType: + type: string + enum: + - OWNER + - MANAGER + - GOVERNANCE_GROUP + description: |- + Describes the individual or group that is responsible for an approval step. Values are as follows. + + **OWNER**: Owner of the associated Role + + **MANAGER**: Manager of the Identity making the request + + **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field + example: GOVERNANCE_GROUP + approverId: + type: string + nullable: true + description: 'Id of the specific approver, used only when approverType is GOVERNANCE_GROUP' + example: 46c79819-a69f-49a2-becb-12c971ae66c6 + revocationRequestConfig: + nullable: true + default: null + description: Revocation request configuration for this object. + type: object + properties: + commentsRequired: + type: boolean + description: Whether the requester of the containing object must provide comments justifying the request + example: false + nullable: true + default: false + denialCommentsRequired: + type: boolean + description: Whether an approver must provide comments when denying the request + example: false + nullable: true + default: false + approvalSchemes: + type: array + description: List describing the steps in approving the revocation request + items: + type: object + properties: + approverType: + type: string + enum: + - APP_OWNER + - OWNER + - SOURCE_OWNER + - MANAGER + - GOVERNANCE_GROUP + description: |- + Describes the individual or group that is responsible for an approval step. Values are as follows. + **APP_OWNER**: The owner of the Application + + **OWNER**: Owner of the associated Access Profile or Role + + **SOURCE_OWNER**: Owner of the Source associated with an Access Profile + + **MANAGER**: Manager of the Identity making the request + + **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field + example: GOVERNANCE_GROUP + approverId: + type: string + nullable: true + description: 'Id of the specific approver, used only when approverType is GOVERNANCE_GROUP' + example: 46c79819-a69f-49a2-becb-12c971ae66c6 + segments: + type: array + items: + type: string + nullable: true + description: 'List of IDs of segments, if any, to which this Role is assigned.' + example: + - f7b1b8a3-5fed-4fd4-ad29-82014e137e19 + - 29cb6c06-1da8-43ea-8be4-b3125f248f2a + required: + - name + - owner '400': description: Client Error - Returned if the request body is invalid. content: @@ -70819,19 +54870,24 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - get: - operationId: listSegments security: - UserContextAuth: - - 'idn:segment:read' - - 'idn:segment:manage' + - 'idn:role-unchecked:manage' + - 'idn:role-checked:manage' + '/roles/{id}/assigned-identities': + get: + operationId: getRoleAssignedIdentities tags: - - Segments - summary: List Segments - description: |- - This API returns a list of all segments. - A token with ORG_ADMIN or API authority is required to call this API. + - Roles + summary: List Identities assigned a Role parameters: + - in: path + name: id + schema: + type: string + description: ID of the Role for which the assigned Identities are to be listed + example: 2c91808a7813090a017814121e121518 + required: true - in: query name: limit description: |- @@ -70860,143 +54916,77 @@ paths: - 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. + 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 + 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) - 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. + Filtering is supported for the following fields and operators: - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true + **id**: *eq, in* + + **aliasName**: *eq, sw* + + **email**: *eq, sw* + + **name**: *eq, sw, co* + example: name sw Joe + - in: query + name: sorters schema: - type: boolean - default: false + type: string + format: comma-separated + 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: **id**, **name**, **aliasName**, **email** + example: 'aliasName,name' responses: '200': - description: List of all segments + description: List of Identities assigned the Role content: application/json: schema: type: array items: type: object + description: A subset of the fields of an Identity which is a member of a Role. properties: id: type: string - description: The id of the Segment. - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - name: + description: The ID of the Identity + example: 2c9180a46faadee4016fb4e018c20639 + aliasName: type: string - description: Segment Business Name - example: segment-xyz - created: + description: The alias / username of the Identity + example: t.edison + name: type: string - format: date-time - description: The time when this Segment is created - example: '2020-01-01T00:00:00.000000Z' - modified: + description: The human-readable display name of the Identity + example: Thomas Edison + email: type: string - format: date-time - description: The time when this Segment is modified - example: '2020-01-01T00:00:00.000000Z' - description: + description: Email address of the Identity + example: t.edison@identitynow.com + roleAssignmentSource: type: string - description: Optional description of the Segment - example: This segment represents xyz - owner: - type: object - nullable: true - description: The owner of this object. - properties: - type: - description: 'Owner type. This field must be either left null or set to ''IDENTITY'' on input, otherwise a 400 Bad Request error will result.' - example: IDENTITY - 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 - - WORKGROUP - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: 'Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner''s display name, otherwise a 400 Bad Request error will result.' - example: support - visibilityCriteria: - type: object - properties: - expression: - type: object - properties: - operator: - type: string - description: Operator for the expression - enum: - - AND - - EQUALS - example: EQUALS - attribute: - type: string - description: Name for the attribute - example: location - value: - type: object - properties: - type: - type: string - description: The type of attribute value - example: STRING - value: - type: string - description: The attribute value - example: Austin - children: - type: array - nullable: true - description: List of expressions - items: - type: object - properties: - type: - type: string - description: The type of attribute value - example: STRING - value: - type: string - description: The attribute value - example: Austin - example: [] - active: - type: boolean - description: Whether the Segment is currently active. Inactive segments have no effect. - default: false - example: true + enum: + - ACCESS_REQUEST + - ROLE_MEMBERSHIP + description: Type which indicates how a particular Identity obtained a particular Role + example: ACCESS_REQUEST '400': description: Client Error - Returned if the request body is invalid. content: @@ -71208,152 +55198,484 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/segments/{id}': - get: - operationId: getSegment security: - UserContextAuth: - - 'idn:segment:read' - - 'idn:segment:manage' + - 'idn:role-unchecked:read' + - 'idn:role-unchecked:manage' + - 'idn:role-checked:manage' + - 'idn:role-checked:read' + /saved-searches: + post: tags: - - Segments - summary: Get Segment by ID - description: |- - This API returns the segment specified by the given ID. - A token with ORG_ADMIN or API authority is required to call this API. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The segment ID to retrieve. - example: ef38f94347e94562b5bb8424a56397d8 + - Saved Search + description: | + Creates a new saved search. + summary: Create a saved search + operationId: createSavedSearch + requestBody: + description: The saved search to persist. + content: + application/json: + schema: + allOf: + - type: object + properties: + name: + description: | + The name of the saved search. + type: string + example: Disabled accounts + description: + description: | + The description of the saved search. + type: string + nullable: true + example: Disabled accounts + - type: object + properties: + public: + description: | + Indicates if the saved search is public. + type: boolean + default: false + example: false + created: + description: | + The date the saved search was initially created. + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + modified: + description: | + The last date the saved search was modified. + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + indices: + description: | + The names of the Elasticsearch indices in which to search. + type: array + items: + description: |- + Enum representing the currently supported indices. + Additional values may be added in the future without notice. + type: string + enum: + - accessprofiles + - accountactivities + - entitlements + - events + - identities + - roles + - '*' + example: identities + example: + - identities + columns: + description: | + The columns to be returned (specifies the order in which they will be presented) for each document type. + + The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. + type: object + additionalProperties: + type: array + items: + type: object + properties: + field: + description: | + The name of the field. + type: string + example: email + header: + description: | + The value of the header. + type: string + example: Work Email + required: + - field + example: + identity: + - field: displayName + header: Display Name + - field: e-mail + header: Work Email + query: + description: | + The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. + type: string + example: '@accounts(disabled:true)' + fields: + description: | + The fields to be searched against in a multi-field query. + type: array + nullable: true + items: + type: string + example: + - disabled + sort: + description: | + The fields to be used to sort the search results. + type: array + items: + type: string + example: + - displayName + filters: + nullable: true + allOf: + - type: object + description: The filters to be applied for each filtered field name. + example: + attributes.cloudAuthoritativeSource: + type: EXISTS + exclude: true + accessCount: + type: RANGE + range: + lower: + value: '3' + created: + type: RANGE + range: + lower: + value: '2019-12-01' + inclusive: true + upper: + value: '2020-01-01' + source.name: + type: TERMS + terms: + - HR Employees + - Corporate Active Directory + exclude: true + protected: + type: TERMS + terms: + - 'true' + - type: object + properties: + type: + description: |- + Enum representing the currently supported filter types. + Additional values may be added in the future without notice. + type: string + enum: + - EXISTS + - RANGE + - TERMS + example: RANGE + range: + type: object + description: The range of values to be filtered. + properties: + lower: + description: The lower bound of the range. + type: object + required: + - value + properties: + value: + description: The value of the range's endpoint. + type: string + example: '1' + inclusive: + description: Indicates if the endpoint is included in the range. + type: boolean + default: false + example: false + upper: + description: The upper bound of the range. + type: object + required: + - value + properties: + value: + description: The value of the range's endpoint. + type: string + example: '1' + inclusive: + description: Indicates if the endpoint is included in the range. + type: boolean + default: false + example: false + terms: + description: The terms to be filtered. + type: array + items: + type: string + example: account_count + exclude: + description: Indicates if the filter excludes results. + type: boolean + default: false + example: false + required: + - indices + - query + required: true responses: - '200': - description: Segment + '201': + description: The persisted saved search. content: application/json: schema: type: object - properties: - id: - type: string - description: The id of the Segment. - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - name: - type: string - description: Segment Business Name - example: segment-xyz - created: - type: string - format: date-time - description: The time when this Segment is created - example: '2020-01-01T00:00:00.000000Z' - modified: - type: string - format: date-time - description: The time when this Segment is modified - example: '2020-01-01T00:00:00.000000Z' - description: - type: string - description: Optional description of the Segment - example: This segment represents xyz - owner: - type: object - nullable: true - description: The owner of this object. + allOf: + - type: object properties: - type: - description: 'Owner type. This field must be either left null or set to ''IDENTITY'' on input, otherwise a 400 Bad Request error will result.' - example: IDENTITY - 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 - - WORKGROUP id: + description: | + The saved search ID. type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 + example: 0de46054-fe90-434a-b84e-c6b3359d0c64 + owner: + description: | + The owner of the saved search. + type: object + properties: + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + id: + description: | + The id of the object. + type: string + example: 2c91808568c529c60168cca6f90c1313 + required: + - type + - id + - type: object + properties: name: + description: | + The name of the saved search. type: string - description: 'Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner''s display name, otherwise a 400 Bad Request error will result.' - example: support - visibilityCriteria: - type: object + example: Disabled accounts + description: + description: | + The description of the saved search. + type: string + nullable: true + example: Disabled accounts + - type: object properties: - expression: + public: + description: | + Indicates if the saved search is public. + type: boolean + default: false + example: false + created: + description: | + The date the saved search was initially created. + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + modified: + description: | + The last date the saved search was modified. + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + indices: + description: | + The names of the Elasticsearch indices in which to search. + type: array + items: + description: |- + Enum representing the currently supported indices. + Additional values may be added in the future without notice. + type: string + enum: + - accessprofiles + - accountactivities + - entitlements + - events + - identities + - roles + - '*' + example: identities + example: + - identities + columns: + description: | + The columns to be returned (specifies the order in which they will be presented) for each document type. + + The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. type: object - properties: - operator: - type: string - description: Operator for the expression - enum: - - AND - - EQUALS - example: EQUALS - attribute: - type: string - description: Name for the attribute - example: location - value: + additionalProperties: + type: array + items: type: object properties: - type: + field: + description: | + The name of the field. type: string - description: The type of attribute value - example: STRING - value: + example: email + header: + description: | + The value of the header. type: string - description: The attribute value - example: Austin - children: - type: array - nullable: true - description: List of expressions - items: - type: object - properties: - type: - type: string - description: The type of attribute value - example: STRING - value: + example: Work Email + required: + - field + example: + identity: + - field: displayName + header: Display Name + - field: e-mail + header: Work Email + query: + description: | + The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. + type: string + example: '@accounts(disabled:true)' + fields: + description: | + The fields to be searched against in a multi-field query. + type: array + nullable: true + items: + type: string + example: + - disabled + sort: + description: | + The fields to be used to sort the search results. + type: array + items: + type: string + example: + - displayName + filters: + nullable: true + allOf: + - type: object + description: The filters to be applied for each filtered field name. + example: + attributes.cloudAuthoritativeSource: + type: EXISTS + exclude: true + accessCount: + type: RANGE + range: + lower: + value: '3' + created: + type: RANGE + range: + lower: + value: '2019-12-01' + inclusive: true + upper: + value: '2020-01-01' + source.name: + type: TERMS + terms: + - HR Employees + - Corporate Active Directory + exclude: true + protected: + type: TERMS + terms: + - 'true' + - type: object + properties: + type: + description: |- + Enum representing the currently supported filter types. + Additional values may be added in the future without notice. + type: string + enum: + - EXISTS + - RANGE + - TERMS + example: RANGE + range: + type: object + description: The range of values to be filtered. + properties: + lower: + description: The lower bound of the range. + type: object + required: + - value + properties: + value: + description: The value of the range's endpoint. + type: string + example: '1' + inclusive: + description: Indicates if the endpoint is included in the range. + type: boolean + default: false + example: false + upper: + description: The upper bound of the range. + type: object + required: + - value + properties: + value: + description: The value of the range's endpoint. + type: string + example: '1' + inclusive: + description: Indicates if the endpoint is included in the range. + type: boolean + default: false + example: false + terms: + description: The terms to be filtered. + type: array + items: type: string - description: The attribute value - example: Austin - example: [] - active: - type: boolean - description: Whether the Segment is currently active. Inactive segments have no effect. - default: false - example: true + example: account_count + exclude: + description: Indicates if the filter excludes results. + type: boolean + default: false + example: false + required: + - indices + - query '400': description: Client Error - Returned if the request body is invalid. content: @@ -71411,16 +55733,6 @@ paths: 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: @@ -71488,8 +55800,340 @@ paths: - locale: en-US localeOrigin: DEFAULT text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist + get: + tags: + - Saved Search + description: | + Returns a list of saved searches. + summary: Return a list of Saved Searches + operationId: listSavedSearches + parameters: + - 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: 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: 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 + - name: filters + in: query + schema: + type: string + description: | + An expression used to constrain the result set using the filtering syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results). + + Allowed filter properties: *owner.id*, *public* + + Allowed filter operator: *eq* + + **Example filters**: + + ```owner.id eq "0de46054-fe90-434a-b84e-c6b3359d0c64"``` -- returns saved searches for the specified owner ID + + ```public eq true``` -- returns all public saved searches + + ```owner.id eq me or public eq true``` -- returns all of the current user's saved searches as well as all public saved searches belonging to other users in the current org + example: public eq true + responses: + '200': + description: The list of requested saved searches. + content: + application/json: + schema: + type: array + items: + type: object + allOf: + - type: object + properties: + id: + description: | + The saved search ID. + type: string + example: 0de46054-fe90-434a-b84e-c6b3359d0c64 + owner: + description: | + The owner of the saved search. + type: object + properties: + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + id: + description: | + The id of the object. + type: string + example: 2c91808568c529c60168cca6f90c1313 + required: + - type + - id + - type: object + properties: + name: + description: | + The name of the saved search. + type: string + example: Disabled accounts + description: + description: | + The description of the saved search. + type: string + nullable: true + example: Disabled accounts + - type: object + properties: + public: + description: | + Indicates if the saved search is public. + type: boolean + default: false + example: false + created: + description: | + The date the saved search was initially created. + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + modified: + description: | + The last date the saved search was modified. + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + indices: + description: | + The names of the Elasticsearch indices in which to search. + type: array + items: + description: |- + Enum representing the currently supported indices. + Additional values may be added in the future without notice. + type: string + enum: + - accessprofiles + - accountactivities + - entitlements + - events + - identities + - roles + - '*' + example: identities + example: + - identities + columns: + description: | + The columns to be returned (specifies the order in which they will be presented) for each document type. + + The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. + type: object + additionalProperties: + type: array + items: + type: object + properties: + field: + description: | + The name of the field. + type: string + example: email + header: + description: | + The value of the header. + type: string + example: Work Email + required: + - field + example: + identity: + - field: displayName + header: Display Name + - field: e-mail + header: Work Email + query: + description: | + The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. + type: string + example: '@accounts(disabled:true)' + fields: + description: | + The fields to be searched against in a multi-field query. + type: array + nullable: true + items: + type: string + example: + - disabled + sort: + description: | + The fields to be used to sort the search results. + type: array + items: + type: string + example: + - displayName + filters: + nullable: true + allOf: + - type: object + description: The filters to be applied for each filtered field name. + example: + attributes.cloudAuthoritativeSource: + type: EXISTS + exclude: true + accessCount: + type: RANGE + range: + lower: + value: '3' + created: + type: RANGE + range: + lower: + value: '2019-12-01' + inclusive: true + upper: + value: '2020-01-01' + source.name: + type: TERMS + terms: + - HR Employees + - Corporate Active Directory + exclude: true + protected: + type: TERMS + terms: + - 'true' + - type: object + properties: + type: + description: |- + Enum representing the currently supported filter types. + Additional values may be added in the future without notice. + type: string + enum: + - EXISTS + - RANGE + - TERMS + example: RANGE + range: + type: object + description: The range of values to be filtered. + properties: + lower: + description: The lower bound of the range. + type: object + required: + - value + properties: + value: + description: The value of the range's endpoint. + type: string + example: '1' + inclusive: + description: Indicates if the endpoint is included in the range. + type: boolean + default: false + example: false + upper: + description: The upper bound of the range. + type: object + required: + - value + properties: + value: + description: The value of the range's endpoint. + type: string + example: '1' + inclusive: + description: Indicates if the endpoint is included in the range. + type: boolean + default: false + example: false + terms: + description: The terms to be filtered. + type: array + items: + type: string + example: account_count + exclude: + description: Indicates if the filter excludes results. + type: boolean + default: false + example: false + required: + - indices + - query + headers: + X-Total-Count: + description: The total result count (returned only if the *count* parameter is specified as *true*). + schema: + type: integer + example: 5 + '400': + description: Client Error - Returned if the request body is invalid. content: application/json: schema: @@ -71545,28 +56189,8 @@ paths: 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. + '403': + description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' content: application/json: schema: @@ -71623,38 +56247,552 @@ paths: 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 + '403': + summary: An example of a 403 response object value: - detailCode: 500.0 Internal Fault + detailCode: 403 Forbidden trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: An internal fault occurred. - delete: - operationId: deleteSegment - security: - - UserContextAuth: - - 'idn:segment:manage' + text: The server understood the request but refuses to authorize it. + '/saved-searches/{id}': + put: tags: - - Segments - summary: Delete Segment by ID - description: |- - This API deletes the segment specified by the given ID. - >**Note:** that segment deletion may take some time to become effective. - A token with ORG_ADMIN or API authority is required to call this API. + - Saved Search + description: | + Updates an existing saved search. + + >**NOTE: You cannot update the `owner` of the saved search.** + summary: | + Updates an existing saved search + operationId: putSavedSearch parameters: - in: path name: id + description: ID of the requested document. schema: type: string required: true - description: The segment ID to delete. - example: ef38f94347e94562b5bb8424a56397d8 + example: 2c91808568c529c60168cca6f90c1313 + requestBody: + description: The saved search to persist. + content: + application/json: + schema: + type: object + allOf: + - type: object + properties: + id: + description: | + The saved search ID. + type: string + example: 0de46054-fe90-434a-b84e-c6b3359d0c64 + owner: + description: | + The owner of the saved search. + type: object + properties: + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + id: + description: | + The id of the object. + type: string + example: 2c91808568c529c60168cca6f90c1313 + required: + - type + - id + - type: object + properties: + name: + description: | + The name of the saved search. + type: string + example: Disabled accounts + description: + description: | + The description of the saved search. + type: string + nullable: true + example: Disabled accounts + - type: object + properties: + public: + description: | + Indicates if the saved search is public. + type: boolean + default: false + example: false + created: + description: | + The date the saved search was initially created. + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + modified: + description: | + The last date the saved search was modified. + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + indices: + description: | + The names of the Elasticsearch indices in which to search. + type: array + items: + description: |- + Enum representing the currently supported indices. + Additional values may be added in the future without notice. + type: string + enum: + - accessprofiles + - accountactivities + - entitlements + - events + - identities + - roles + - '*' + example: identities + example: + - identities + columns: + description: | + The columns to be returned (specifies the order in which they will be presented) for each document type. + + The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. + type: object + additionalProperties: + type: array + items: + type: object + properties: + field: + description: | + The name of the field. + type: string + example: email + header: + description: | + The value of the header. + type: string + example: Work Email + required: + - field + example: + identity: + - field: displayName + header: Display Name + - field: e-mail + header: Work Email + query: + description: | + The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. + type: string + example: '@accounts(disabled:true)' + fields: + description: | + The fields to be searched against in a multi-field query. + type: array + nullable: true + items: + type: string + example: + - disabled + sort: + description: | + The fields to be used to sort the search results. + type: array + items: + type: string + example: + - displayName + filters: + nullable: true + allOf: + - type: object + description: The filters to be applied for each filtered field name. + example: + attributes.cloudAuthoritativeSource: + type: EXISTS + exclude: true + accessCount: + type: RANGE + range: + lower: + value: '3' + created: + type: RANGE + range: + lower: + value: '2019-12-01' + inclusive: true + upper: + value: '2020-01-01' + source.name: + type: TERMS + terms: + - HR Employees + - Corporate Active Directory + exclude: true + protected: + type: TERMS + terms: + - 'true' + - type: object + properties: + type: + description: |- + Enum representing the currently supported filter types. + Additional values may be added in the future without notice. + type: string + enum: + - EXISTS + - RANGE + - TERMS + example: RANGE + range: + type: object + description: The range of values to be filtered. + properties: + lower: + description: The lower bound of the range. + type: object + required: + - value + properties: + value: + description: The value of the range's endpoint. + type: string + example: '1' + inclusive: + description: Indicates if the endpoint is included in the range. + type: boolean + default: false + example: false + upper: + description: The upper bound of the range. + type: object + required: + - value + properties: + value: + description: The value of the range's endpoint. + type: string + example: '1' + inclusive: + description: Indicates if the endpoint is included in the range. + type: boolean + default: false + example: false + terms: + description: The terms to be filtered. + type: array + items: + type: string + example: account_count + exclude: + description: Indicates if the filter excludes results. + type: boolean + default: false + example: false + required: + - indices + - query + required: true responses: - '204': - description: No content. + '200': + description: The persisted saved search. + content: + application/json: + schema: + type: object + allOf: + - type: object + properties: + id: + description: | + The saved search ID. + type: string + example: 0de46054-fe90-434a-b84e-c6b3359d0c64 + owner: + description: | + The owner of the saved search. + type: object + properties: + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + id: + description: | + The id of the object. + type: string + example: 2c91808568c529c60168cca6f90c1313 + required: + - type + - id + - type: object + properties: + name: + description: | + The name of the saved search. + type: string + example: Disabled accounts + description: + description: | + The description of the saved search. + type: string + nullable: true + example: Disabled accounts + - type: object + properties: + public: + description: | + Indicates if the saved search is public. + type: boolean + default: false + example: false + created: + description: | + The date the saved search was initially created. + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + modified: + description: | + The last date the saved search was modified. + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + indices: + description: | + The names of the Elasticsearch indices in which to search. + type: array + items: + description: |- + Enum representing the currently supported indices. + Additional values may be added in the future without notice. + type: string + enum: + - accessprofiles + - accountactivities + - entitlements + - events + - identities + - roles + - '*' + example: identities + example: + - identities + columns: + description: | + The columns to be returned (specifies the order in which they will be presented) for each document type. + + The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. + type: object + additionalProperties: + type: array + items: + type: object + properties: + field: + description: | + The name of the field. + type: string + example: email + header: + description: | + The value of the header. + type: string + example: Work Email + required: + - field + example: + identity: + - field: displayName + header: Display Name + - field: e-mail + header: Work Email + query: + description: | + The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. + type: string + example: '@accounts(disabled:true)' + fields: + description: | + The fields to be searched against in a multi-field query. + type: array + nullable: true + items: + type: string + example: + - disabled + sort: + description: | + The fields to be used to sort the search results. + type: array + items: + type: string + example: + - displayName + filters: + nullable: true + allOf: + - type: object + description: The filters to be applied for each filtered field name. + example: + attributes.cloudAuthoritativeSource: + type: EXISTS + exclude: true + accessCount: + type: RANGE + range: + lower: + value: '3' + created: + type: RANGE + range: + lower: + value: '2019-12-01' + inclusive: true + upper: + value: '2020-01-01' + source.name: + type: TERMS + terms: + - HR Employees + - Corporate Active Directory + exclude: true + protected: + type: TERMS + terms: + - 'true' + - type: object + properties: + type: + description: |- + Enum representing the currently supported filter types. + Additional values may be added in the future without notice. + type: string + enum: + - EXISTS + - RANGE + - TERMS + example: RANGE + range: + type: object + description: The range of values to be filtered. + properties: + lower: + description: The lower bound of the range. + type: object + required: + - value + properties: + value: + description: The value of the range's endpoint. + type: string + example: '1' + inclusive: + description: Indicates if the endpoint is included in the range. + type: boolean + default: false + example: false + upper: + description: The upper bound of the range. + type: object + required: + - value + properties: + value: + description: The value of the range's endpoint. + type: string + example: '1' + inclusive: + description: Indicates if the endpoint is included in the range. + type: boolean + default: false + example: false + terms: + description: The terms to be filtered. + type: array + items: + type: string + example: account_count + exclude: + description: Indicates if the filter excludes results. + type: boolean + default: false + example: false + required: + - indices + - query '400': description: Client Error - Returned if the request body is invalid. content: @@ -71789,73 +56927,6 @@ paths: - locale: en-US localeOrigin: DEFAULT text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. '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: @@ -71933,188 +57004,280 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - patch: - operationId: patchSegment - security: - - UserContextAuth: - - 'idn:segment:manage' + get: tags: - - Segments - summary: Update Segment - description: |- - Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - >**Note:** Changes to a segment may take some time to propagate to all identities. - A token with ORG_ADMIN or API authority is required to call this API. + - Saved Search + description: | + Returns the specified saved search. + summary: Return saved search by ID + operationId: getSavedSearch parameters: - in: path name: id + description: ID of the requested document. schema: type: string required: true - description: The segment ID to modify. - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - description: | - A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - The following fields are patchable: - * name - * description - * owner - * visibilityCriteria - * active - content: - application/json-patch+json: - schema: - type: array - items: - type: object - examples: - Set Visibility Criteria: - description: Set the visibility criteria - value: - - op: replace - path: /visibilityCriteria - value: - expression: - operator: AND - children: - - operator: EQUALS - attribute: location - value: - type: STRING - value: Philadelphia - - operator: EQUALS - attribute: department - value: - type: STRING - value: HR + example: 2c91808568c529c60168cca6f90c1313 responses: '200': - description: 'Indicates the PATCH operation succeeded, and returns the segment''s new representation.' + description: The requested saved search. content: application/json: schema: type: object - properties: - id: - type: string - description: The id of the Segment. - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - name: - type: string - description: Segment Business Name - example: segment-xyz - created: - type: string - format: date-time - description: The time when this Segment is created - example: '2020-01-01T00:00:00.000000Z' - modified: - type: string - format: date-time - description: The time when this Segment is modified - example: '2020-01-01T00:00:00.000000Z' - description: - type: string - description: Optional description of the Segment - example: This segment represents xyz - owner: - type: object - nullable: true - description: The owner of this object. + allOf: + - type: object properties: - type: - description: 'Owner type. This field must be either left null or set to ''IDENTITY'' on input, otherwise a 400 Bad Request error will result.' - example: IDENTITY - 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 - - WORKGROUP id: + description: | + The saved search ID. type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: 'Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner''s display name, otherwise a 400 Bad Request error will result.' - example: support - visibilityCriteria: - type: object - properties: - expression: + example: 0de46054-fe90-434a-b84e-c6b3359d0c64 + owner: + description: | + The owner of the saved search. type: object properties: - operator: + type: type: string - description: Operator for the expression enum: - - AND - - EQUALS - example: EQUALS - attribute: + - 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + id: + description: | + The id of the object. type: string - description: Name for the attribute - example: location - value: + example: 2c91808568c529c60168cca6f90c1313 + required: + - type + - id + - type: object + properties: + name: + description: | + The name of the saved search. + type: string + example: Disabled accounts + description: + description: | + The description of the saved search. + type: string + nullable: true + example: Disabled accounts + - type: object + properties: + public: + description: | + Indicates if the saved search is public. + type: boolean + default: false + example: false + created: + description: | + The date the saved search was initially created. + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + modified: + description: | + The last date the saved search was modified. + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + indices: + description: | + The names of the Elasticsearch indices in which to search. + type: array + items: + description: |- + Enum representing the currently supported indices. + Additional values may be added in the future without notice. + type: string + enum: + - accessprofiles + - accountactivities + - entitlements + - events + - identities + - roles + - '*' + example: identities + example: + - identities + columns: + description: | + The columns to be returned (specifies the order in which they will be presented) for each document type. + + The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. + type: object + additionalProperties: + type: array + items: type: object + properties: + field: + description: | + The name of the field. + type: string + example: email + header: + description: | + The value of the header. + type: string + example: Work Email + required: + - field + example: + identity: + - field: displayName + header: Display Name + - field: e-mail + header: Work Email + query: + description: | + The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. + type: string + example: '@accounts(disabled:true)' + fields: + description: | + The fields to be searched against in a multi-field query. + type: array + nullable: true + items: + type: string + example: + - disabled + sort: + description: | + The fields to be used to sort the search results. + type: array + items: + type: string + example: + - displayName + filters: + nullable: true + allOf: + - type: object + description: The filters to be applied for each filtered field name. + example: + attributes.cloudAuthoritativeSource: + type: EXISTS + exclude: true + accessCount: + type: RANGE + range: + lower: + value: '3' + created: + type: RANGE + range: + lower: + value: '2019-12-01' + inclusive: true + upper: + value: '2020-01-01' + source.name: + type: TERMS + terms: + - HR Employees + - Corporate Active Directory + exclude: true + protected: + type: TERMS + terms: + - 'true' + - type: object properties: type: + description: |- + Enum representing the currently supported filter types. + Additional values may be added in the future without notice. type: string - description: The type of attribute value - example: STRING - value: - type: string - description: The attribute value - example: Austin - children: - type: array - nullable: true - description: List of expressions - items: - type: object - properties: - type: - type: string - description: The type of attribute value - example: STRING - value: + enum: + - EXISTS + - RANGE + - TERMS + example: RANGE + range: + type: object + description: The range of values to be filtered. + properties: + lower: + description: The lower bound of the range. + type: object + required: + - value + properties: + value: + description: The value of the range's endpoint. + type: string + example: '1' + inclusive: + description: Indicates if the endpoint is included in the range. + type: boolean + default: false + example: false + upper: + description: The upper bound of the range. + type: object + required: + - value + properties: + value: + description: The value of the range's endpoint. + type: string + example: '1' + inclusive: + description: Indicates if the endpoint is included in the range. + type: boolean + default: false + example: false + terms: + description: The terms to be filtered. + type: array + items: type: string - description: The attribute value - example: Austin - example: [] - active: - type: boolean - description: Whether the Segment is currently active. Inactive segments have no effect. - default: false - example: true + example: account_count + exclude: + description: Indicates if the filter excludes results. + type: boolean + default: false + example: false + required: + - indices + - query '400': description: Client Error - Returned if the request body is invalid. content: @@ -72389,432 +57552,28 @@ paths: value: detailCode: 500.0 Internal Fault trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /service-desk-integrations: - get: - tags: - - Service Desk Integration - summary: List existing Service Desk Integrations - description: Get a list of ServiceDeskIntegrationDto for existing Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - operationId: getServiceDeskIntegrations - parameters: - - 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: 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 - - name: sorters - in: query - required: false - style: form - explode: true - schema: - type: string - 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** - example: name - - name: filters - in: query - required: false - style: form - explode: true - schema: - type: string - format: comma-separated - 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* - - **type**: *eq, in* - - **cluster**: *eq, in* - example: name eq "John Doe" - - 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 - responses: - '200': - description: List of ServiceDeskIntegrationDto - content: - application/json: - schema: - type: array - items: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - - type: object - description: Specification of a Service Desk integration - required: - - description - - type - - attributes - properties: - description: - description: Description of the Service Desk integration - type: string - example: A very nice Service Desk integration - type: - description: | - Service Desk integration types - - - ServiceNowSDIM - - ServiceNow - type: string - default: ServiceNowSDIM - example: ServiceNowSDIM - ownerRef: - 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 - - WORKGROUP - 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 - description: Reference to the identity that is the owner of this Service Desk integration - properties: - type: - description: The type of object being referenced - enum: - - IDENTITY - example: IDENTITY - id: - description: ID of the identity - example: 2c91808568c529c60168cca6f90c1313 - name: - description: Human-readable display name of the identity - example: MyName - clusterRef: - 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 - - WORKGROUP - 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 - description: Reference to the source cluster for this Service Desk integration - properties: - type: - description: The type of object being referenced - enum: - - CLUSTER - example: CLUSTER - id: - description: ID of the cluster - example: 2c9180866166b5b0016167c32ef31a66 - name: - description: Human-readable display name of the cluster - example: Corporate Cluster - cluster: - description: 'ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)' - type: string - example: xyzzy999 - deprecated: true - managedSources: - description: 'Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)' - type: array - items: - type: string - deprecated: true - example: - - 2c9180835d191a86015d28455b4a2329 - - 2c5680835d191a85765d28455b4a9823 - provisioningConfig: - description: The 'provisioningConfig' property specifies the configuration used to provision integrations. - type: object - properties: - universalManager: - description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' - type: boolean - readOnly: true - example: true - managedResourceRefs: - description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. - type: array - items: - 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 - - WORKGROUP - 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 - properties: - type: - description: The type of object being referenced - enum: - - SOURCE - example: SOURCE - id: - description: ID of the source - example: 2c91808568c529c60168cca6f90c1313 - name: - description: Human-readable display name of the source - example: My Source - example: - - type: SOURCE - id: 2c9180855d191c59015d291ceb051111 - name: My Source 1 - - type: SOURCE - id: 2c9180855d191c59015d291ceb052222 - name: My Source 2 - planInitializerScript: - description: This is a reference to a plan initializer script. - type: object - properties: - source: - description: This is a Rule that allows provisioning instruction changes. - type: string - example: | - \r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n - noProvisioningRequests: - description: Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. - type: boolean - example: true - provisioningRequestExpiration: - description: 'When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.' - type: integer - format: int32 - example: 7 - attributes: - description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation. - type: object - additionalProperties: true - example: - property: value - key: value - beforeProvisioningRule: - 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 - - WORKGROUP - 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 - description: Reference to beforeProvisioningRule for this Service Desk integration - properties: - type: - description: The type of object being referenced - enum: - - RULE - example: RULE - id: - description: ID of the rule - example: 2c91808568c529c60168cca6f90c1333 - name: - description: Human-readable display name of the rule - example: Example Rule + messages: + - locale: en-US + localeOrigin: DEFAULT + text: An internal fault occurred. + delete: + tags: + - Saved Search + description: | + Deletes the specified saved search. + summary: Delete document by ID + operationId: deleteSavedSearch + parameters: + - in: path + name: id + description: ID of the requested document. + schema: + type: string + required: true + example: 2c91808568c529c60168cca6f90c1313 + responses: + '204': + description: No Content - Indicates the request was successful but there is no content to be returned in the response. '400': description: Client Error - Returned if the request body is invalid. content: @@ -73093,698 +57852,974 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - security: - - UserContextAuth: - - 'idn:service-desk-admin:read' - - 'idn:service-desk-integration:read' + '/saved-searches/{id}/execute': post: tags: - - Service Desk Integration - summary: Create new Service Desk integration - description: Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - operationId: createServiceDeskIntegration + - Saved Search + description: | + Executes the specified saved search. + summary: Execute a saved search by ID + operationId: executeSavedSearch + parameters: + - in: path + name: id + description: ID of the requested document. + schema: + type: string + required: true + example: 2c91808568c529c60168cca6f90c1313 requestBody: - description: The specifics of a new integration to create + description: | + When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. + + If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. content: application/json: schema: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - - type: object - description: Specification of a Service Desk integration - required: - - description - - type - - attributes - properties: - description: - description: Description of the Service Desk integration - type: string - example: A very nice Service Desk integration - type: + type: object + properties: + scheduleId: + description: | + The ID of the scheduled search that triggered the saved search execution. + type: string + example: 7a724640-0c17-4ce9-a8c3-4a89738459c8 + owner: + description: | + The owner of the scheduled search being tested. + allOf: + - type: object description: | - Service Desk integration types - - - ServiceNowSDIM - - ServiceNow - type: string - default: ServiceNowSDIM - example: ServiceNowSDIM - ownerRef: - 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 - - WORKGROUP - 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 - description: Reference to the identity that is the owner of this Service Desk integration + A typed reference to the object. properties: type: - description: The type of object being referenced + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. example: IDENTITY id: - description: ID of the identity + description: | + The id of the object. + type: string example: 2c91808568c529c60168cca6f90c1313 - name: - description: Human-readable display name of the identity - example: MyName - clusterRef: - 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 - - WORKGROUP - 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 - description: Reference to the source cluster for this Service Desk integration + required: + - type + - id + recipients: + description: | + The email recipients of the scheduled search being tested. + type: array + items: + type: object + description: | + A typed reference to the object. + properties: + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + id: + description: | + The id of the object. + type: string + example: 2c91808568c529c60168cca6f90c1313 + required: + - type + - id + examples: + scheduled: + summary: Triggered by Scheduled Search + value: + scheduleId: 7a724640-0c17-4ce9-a8c3-4a89738459c8 + test: + summary: Triggered by UI Test + value: + owner: + type: IDENTITY + id: 2c91808568c529c60168cca6f90c1313 + recipients: + - type: IDENTITY + id: 2c91808568c529c60168cca6f90c1313 + required: true + responses: + '202': + description: Accepted - Returned if the request was successfully accepted into the system. + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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: - type: - description: The type of object being referenced + locale: + type: string + description: 'The locale for the message text, a BCP 47 language tag.' + example: en-US + localeOrigin: + type: string enum: - - CLUSTER - example: CLUSTER - id: - description: ID of the cluster - example: 2c9180866166b5b0016167c32ef31a66 - name: - description: Human-readable display name of the cluster - example: Corporate Cluster - cluster: - description: 'ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)' - type: string - example: xyzzy999 - deprecated: true - managedSources: - description: 'Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)' - type: array - items: - type: string - deprecated: true - example: - - 2c9180835d191a86015d28455b4a2329 - - 2c5680835d191a85765d28455b4a9823 - provisioningConfig: - description: The 'provisioningConfig' property specifies the configuration used to provision integrations. + - 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: - universalManager: - description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' - type: boolean - readOnly: true - example: true - managedResourceRefs: - description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. - type: array - items: - 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 - - WORKGROUP - 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 - properties: - type: - description: The type of object being referenced - enum: - - SOURCE - example: SOURCE - id: - description: ID of the source - example: 2c91808568c529c60168cca6f90c1313 - name: - description: Human-readable display name of the source - example: My Source - example: - - type: SOURCE - id: 2c9180855d191c59015d291ceb051111 - name: My Source 1 - - type: SOURCE - id: 2c9180855d191c59015d291ceb052222 - name: My Source 2 - planInitializerScript: - description: This is a reference to a plan initializer script. - type: object - properties: - source: - description: This is a Rule that allows provisioning instruction changes. - type: string - example: | - \r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n - noProvisioningRequests: - description: Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. - type: boolean - example: true - provisioningRequestExpiration: - description: 'When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.' - type: integer - format: int32 - example: 7 - attributes: - description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation. - type: object - additionalProperties: true - example: - property: value - key: value - beforeProvisioningRule: + 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. + /scheduled-searches: + post: + tags: + - Scheduled Search + description: | + Creates a new scheduled search. + summary: Create a new scheduled search + operationId: createScheduledSearch + requestBody: + description: The scheduled search to persist. + content: + application/json: + schema: + allOf: + - type: object + properties: + name: + description: | + The name of the scheduled search. + type: string + example: Daily disabled accounts + nullable: true + description: + description: | + The description of the scheduled search. + type: string + nullable: true + example: Daily disabled accounts + - type: object + properties: + savedSearchId: + description: The ID of the saved search that will be executed. + type: string + example: 554f1511-f0a1-4744-ab14-599514d3e57c + created: 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 - - WORKGROUP - 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 - description: Reference to beforeProvisioningRule for this Service Desk integration + - type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + description: The date the scheduled search was initially created. + readOnly: true + modified: + allOf: + - type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + description: The last date the scheduled search was modified. + readOnly: true + schedule: + type: object + description: The schedule information. properties: type: - description: The type of object being referenced + description: | + Enum representing the currently supported schedule types. + + Additional values may be added in the future without notice. + type: string enum: - - RULE - example: RULE - id: - description: ID of the rule - example: 2c91808568c529c60168cca6f90c1333 - name: - description: Human-readable display name of the rule - example: Example Rule + - DAILY + - WEEKLY + - MONTHLY + - CALENDAR + example: WEEKLY + days: + allOf: + - type: object + properties: + type: + description: | + Enum representing the currently supported selector types. + + LIST - the *values* array contains one or more distinct values. + + RANGE - the *values* array contains two values: the start and end of the range, inclusive. + + Additional values may be added in the future without notice. + type: string + enum: + - LIST + - RANGE + example: LIST + values: + description: | + The selected values. + type: array + items: + type: string + example: + - MON + - WED + interval: + nullable: true + description: | + The selected interval for RANGE selectors. + type: integer + format: int32 + example: 3 + required: + - type + - values + - description: | + The days to execute the search. + + If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. + + If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. + example: + type: LIST + values: + - MON + - WED + - FRI + nullable: true + hours: + allOf: + - type: object + properties: + type: + description: | + Enum representing the currently supported selector types. + + LIST - the *values* array contains one or more distinct values. + + RANGE - the *values* array contains two values: the start and end of the range, inclusive. + + Additional values may be added in the future without notice. + type: string + enum: + - LIST + - RANGE + example: LIST + values: + description: | + The selected values. + type: array + items: + type: string + example: + - MON + - WED + interval: + nullable: true + description: | + The selected interval for RANGE selectors. + type: integer + format: int32 + example: 3 + required: + - type + - values + - description: The hours selected. + example: + type: RANGE + values: + - '9' + - '18' + interval: 3 + expiration: + description: 'The schedule expiration date. Latest possible expiration date is ''2038-01-19T03:14:07+0000''' + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + timeZoneId: + description: 'The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org''s default timezone is used.' + nullable: true + type: string + example: 'GMT-06:00' + required: + - type + - hours + recipients: + description: A list of identities that should receive the scheduled search report via email. + type: array + items: + type: object + properties: + type: + type: string + description: The type of object being referenced + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: The ID of the referenced object + example: 2c9180867624cbd7017642d8c8c81f67 + required: + - type + - id + enabled: + description: | + Indicates if the scheduled search is enabled. + type: boolean + default: false + example: false + emailEmptyResults: + description: | + Indicates if email generation should not be suppressed if search returns no results. + type: boolean + default: false + example: false + displayQueryDetails: + description: | + Indicates if the generated email should include the query and search results preview (which could include PII). + type: boolean + default: false + example: false + required: + - savedSearchId + - schedule + - recipients + examples: + Daily Search: + description: A search that executes each day at a 9 AM + value: + savedSearchId: 9c620e13-cd33-4804-a13d-403bd7bcdbad + schedule: + type: DAILY + hours: + type: LIST + values: + - '9' + recipients: + - type: IDENTITY + id: 2c9180867624cbd7017642d8c8c81f67 + Weekly Search: + description: A search that executes each week on select days and times + value: + savedSearchId: 9c620e13-cd33-4804-a13d-403bd7bcdbad + schedule: + type: WEEKLY + days: + type: LIST + values: + - MON + - TUE + - WED + - THU + - FRI + - SAT + - SUN + hours: + type: LIST + values: + - '9' + recipients: + - type: IDENTITY + id: 2c9180867624cbd7017642d8c8c81f67 + Monthly Search: + description: A search that executes each month on select days and times + value: + savedSearchId: 9c620e13-cd33-4804-a13d-403bd7bcdbad + schedule: + type: MONTHLY + days: + type: LIST + values: + - '1' + - '7' + - '14' + - L + hours: + type: LIST + values: + - '9' + recipients: + - type: IDENTITY + id: 2c9180867624cbd7017642d8c8c81f67 + Calendar Search: + description: A search that executes on specific calendar days + value: + savedSearchId: 9c620e13-cd33-4804-a13d-403bd7bcdbad + schedule: + type: CALENDAR + days: + type: LIST + values: + - '2023-01-22' + - '2023-02-22' + hours: + type: LIST + values: + - '9' + recipients: + - type: IDENTITY + id: 2c9180867624cbd7017642d8c8c81f67 required: true responses: - '200': - description: details of the created integration + '201': + description: The persisted scheduled search. content: application/json: schema: + type: object allOf: - type: object - required: - - name properties: id: - description: System-generated unique ID of the Object + description: The scheduled search ID. type: string - example: id12345 + example: 0de46054-fe90-434a-b84e-c6b3359d0c64 readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time + owner: + description: The owner of the scheduled search readOnly: true - modified: - description: Last modification date of the Object + type: object + properties: + type: + type: string + description: The type of object being referenced + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: The ID of the referenced object + example: 2c9180867624cbd7017642d8c8c81f67 + required: + - type + - id + ownerId: + description: | + The ID of the scheduled search owner. + + Please use the `id` in the `owner` object instead. type: string - example: '2015-05-28T14:07:17Z' - format: date-time + example: 2c9180867624cbd7017642d8c8c81f67 readOnly: true + deprecated: true - type: object - description: Specification of a Service Desk integration - required: - - description - - type - - attributes properties: - description: - description: Description of the Service Desk integration + name: + description: | + The name of the scheduled search. type: string - example: A very nice Service Desk integration - type: + example: Daily disabled accounts + nullable: true + description: description: | - Service Desk integration types - - - ServiceNowSDIM - - ServiceNow + The description of the scheduled search. type: string - default: ServiceNowSDIM - example: ServiceNowSDIM - ownerRef: + nullable: true + example: Daily disabled accounts + - type: object + properties: + savedSearchId: + description: The ID of the saved search that will be executed. + type: string + example: 554f1511-f0a1-4744-ab14-599514d3e57c + created: 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 - - WORKGROUP - 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 - description: Reference to the identity that is the owner of this Service Desk integration - properties: - type: - description: The type of object being referenced - enum: - - IDENTITY - example: IDENTITY - id: - description: ID of the identity - example: 2c91808568c529c60168cca6f90c1313 - name: - description: Human-readable display name of the identity - example: MyName - clusterRef: + - type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + description: The date the scheduled search was initially created. + readOnly: true + modified: 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 - - WORKGROUP - 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 - description: Reference to the source cluster for this Service Desk integration + - type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + description: The last date the scheduled search was modified. + readOnly: true + schedule: + type: object + description: The schedule information. properties: type: - description: The type of object being referenced + description: | + Enum representing the currently supported schedule types. + + Additional values may be added in the future without notice. + type: string enum: - - CLUSTER - example: CLUSTER - id: - description: ID of the cluster - example: 2c9180866166b5b0016167c32ef31a66 - name: - description: Human-readable display name of the cluster - example: Corporate Cluster - cluster: - description: 'ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)' - type: string - example: xyzzy999 - deprecated: true - managedSources: - description: 'Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)' - type: array - items: - type: string - deprecated: true - example: - - 2c9180835d191a86015d28455b4a2329 - - 2c5680835d191a85765d28455b4a9823 - provisioningConfig: - description: The 'provisioningConfig' property specifies the configuration used to provision integrations. - type: object - properties: - universalManager: - description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' - type: boolean - readOnly: true - example: true - managedResourceRefs: - description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. - type: array - items: - 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 - - WORKGROUP - example: IDENTITY - id: + - DAILY + - WEEKLY + - MONTHLY + - CALENDAR + example: WEEKLY + days: + allOf: + - type: object + properties: + type: + description: | + Enum representing the currently supported selector types. + + LIST - the *values* array contains one or more distinct values. + + RANGE - the *values* array contains two values: the start and end of the range, inclusive. + + Additional values may be added in the future without notice. + type: string + enum: + - LIST + - RANGE + example: LIST + values: + description: | + The selected values. + type: array + items: type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: + example: + - MON + - WED + interval: + nullable: true + description: | + The selected interval for RANGE selectors. + type: integer + format: int32 + example: 3 + required: + - type + - values + - description: | + The days to execute the search. + + If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. + + If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. + example: + type: LIST + values: + - MON + - WED + - FRI + nullable: true + hours: + allOf: + - type: object + properties: + type: + description: | + Enum representing the currently supported selector types. + + LIST - the *values* array contains one or more distinct values. + + RANGE - the *values* array contains two values: the start and end of the range, inclusive. + + Additional values may be added in the future without notice. + type: string + enum: + - LIST + - RANGE + example: LIST + values: + description: | + The selected values. + type: array + items: type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - properties: - type: - description: The type of object being referenced - enum: - - SOURCE - example: SOURCE - id: - description: ID of the source - example: 2c91808568c529c60168cca6f90c1313 - name: - description: Human-readable display name of the source - example: My Source - example: - - type: SOURCE - id: 2c9180855d191c59015d291ceb051111 - name: My Source 1 - - type: SOURCE - id: 2c9180855d191c59015d291ceb052222 - name: My Source 2 - planInitializerScript: - description: This is a reference to a plan initializer script. - type: object - properties: - source: - description: This is a Rule that allows provisioning instruction changes. - type: string - example: | - \r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n - noProvisioningRequests: - description: Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. - type: boolean - example: true - provisioningRequestExpiration: - description: 'When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.' - type: integer - format: int32 - example: 7 - attributes: - description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation. - type: object - additionalProperties: true - example: - property: value - key: value - beforeProvisioningRule: - 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 - - WORKGROUP - 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 - description: Reference to beforeProvisioningRule for this Service Desk integration - properties: - type: - description: The type of object being referenced - enum: - - RULE - example: RULE - id: - description: ID of the rule - example: 2c91808568c529c60168cca6f90c1333 - name: - description: Human-readable display name of the rule - example: Example Rule + example: + - MON + - WED + interval: + nullable: true + description: | + The selected interval for RANGE selectors. + type: integer + format: int32 + example: 3 + required: + - type + - values + - description: The hours selected. + example: + type: RANGE + values: + - '9' + - '18' + interval: 3 + expiration: + description: 'The schedule expiration date. Latest possible expiration date is ''2038-01-19T03:14:07+0000''' + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + timeZoneId: + description: 'The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org''s default timezone is used.' + nullable: true + type: string + example: 'GMT-06:00' + required: + - type + - hours + recipients: + description: A list of identities that should receive the scheduled search report via email. + type: array + items: + type: object + properties: + type: + type: string + description: The type of object being referenced + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: The ID of the referenced object + example: 2c9180867624cbd7017642d8c8c81f67 + required: + - type + - id + enabled: + description: | + Indicates if the scheduled search is enabled. + type: boolean + default: false + example: false + emailEmptyResults: + description: | + Indicates if email generation should not be suppressed if search returns no results. + type: boolean + default: false + example: false + displayQueryDetails: + description: | + Indicates if the generated email should include the query and search results preview (which could include PII). + type: boolean + default: false + example: false + required: + - savedSearchId + - schedule + - recipients + required: + - id + - owner + - ownerId '400': description: Client Error - Returned if the request body is invalid. content: @@ -74063,368 +59098,328 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - security: - - UserContextAuth: - - 'idn:service-desk-admin:manage' - - 'idn:service-desk-integration:manage' - '/service-desk-integrations/{id}': get: tags: - - Service Desk Integration - summary: Get a Service Desk integration - description: Get an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - operationId: getServiceDeskIntegration + - Scheduled Search + description: | + Returns a list of scheduled searches. + summary: List scheduled searches + operationId: listScheduledSearch parameters: - - name: id - in: path - description: ID of the Service Desk integration to get - required: true - style: simple - explode: false + - 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: 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: 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 + - name: filters + in: query schema: type: string - example: anId + description: | + An expression used to constrain the result set using the filtering syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results). + + Allowed filter properties: *owner.id*, *savedSearchId* + + Allowed filter operator: *eq* + + **Example filters**: + + ```owner.id eq "0de46054-fe90-434a-b84e-c6b3359d0c64"``` -- returns scheduled searches for the specified owner ID + + ```savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"``` -- returns scheduled searches that reference the specified saved search + + ```owner.id eq me or savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"``` -- returns all of the current user's scheduled searches as well as all scheduled searches that reference the specified saved search + example: savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e" responses: '200': - description: ServiceDeskIntegrationDto with the given ID + description: The list of requested scheduled searches. content: application/json: schema: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - - type: object - description: Specification of a Service Desk integration - required: - - description - - type - - attributes - properties: - description: - description: Description of the Service Desk integration - type: string - example: A very nice Service Desk integration - type: - description: | - Service Desk integration types + type: array + items: + type: object + allOf: + - type: object + properties: + id: + description: The scheduled search ID. + type: string + example: 0de46054-fe90-434a-b84e-c6b3359d0c64 + readOnly: true + owner: + description: The owner of the scheduled search + readOnly: true + type: object + properties: + type: + type: string + description: The type of object being referenced + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: The ID of the referenced object + example: 2c9180867624cbd7017642d8c8c81f67 + required: + - type + - id + ownerId: + description: | + The ID of the scheduled search owner. - - ServiceNowSDIM - - ServiceNow - type: string - default: ServiceNowSDIM - example: ServiceNowSDIM - ownerRef: - 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 - - WORKGROUP - 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 - description: Reference to the identity that is the owner of this Service Desk integration - properties: - type: - description: The type of object being referenced - enum: - - IDENTITY - example: IDENTITY - id: - description: ID of the identity - example: 2c91808568c529c60168cca6f90c1313 - name: - description: Human-readable display name of the identity - example: MyName - clusterRef: - 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 - - WORKGROUP - 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 - description: Reference to the source cluster for this Service Desk integration - properties: - type: - description: The type of object being referenced - enum: - - CLUSTER - example: CLUSTER - id: - description: ID of the cluster - example: 2c9180866166b5b0016167c32ef31a66 - name: - description: Human-readable display name of the cluster - example: Corporate Cluster - cluster: - description: 'ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)' - type: string - example: xyzzy999 - deprecated: true - managedSources: - description: 'Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)' - type: array - items: + Please use the `id` in the `owner` object instead. type: string - deprecated: true - example: - - 2c9180835d191a86015d28455b4a2329 - - 2c5680835d191a85765d28455b4a9823 - provisioningConfig: - description: The 'provisioningConfig' property specifies the configuration used to provision integrations. - type: object - properties: - universalManager: - description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' - type: boolean - readOnly: true - example: true - managedResourceRefs: - description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. - type: array - items: + example: 2c9180867624cbd7017642d8c8c81f67 + readOnly: true + deprecated: true + - type: object + properties: + name: + description: | + The name of the scheduled search. + type: string + example: Daily disabled accounts + nullable: true + description: + description: | + The description of the scheduled search. + type: string + nullable: true + example: Daily disabled accounts + - type: object + properties: + savedSearchId: + description: The ID of the saved search that will be executed. + type: string + example: 554f1511-f0a1-4744-ab14-599514d3e57c + created: + allOf: + - type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + description: The date the scheduled search was initially created. + readOnly: true + modified: + allOf: + - type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + description: The last date the scheduled search was modified. + readOnly: true + schedule: + type: object + description: The schedule information. + properties: + type: + description: | + Enum representing the currently supported schedule types. + + Additional values may be added in the future without notice. + type: string + enum: + - DAILY + - WEEKLY + - MONTHLY + - CALENDAR + example: WEEKLY + days: allOf: - type: object properties: type: - description: DTO type + description: | + Enum representing the currently supported selector types. + + LIST - the *values* array contains one or more distinct values. + + RANGE - the *values* array contains two values: the start and end of the range, inclusive. + + Additional values may be added in the future without notice. 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 - - WORKGROUP - 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 - properties: - type: - description: The type of object being referenced - enum: - - SOURCE - example: SOURCE - id: - description: ID of the source - example: 2c91808568c529c60168cca6f90c1313 - name: - description: Human-readable display name of the source - example: My Source - example: - - type: SOURCE - id: 2c9180855d191c59015d291ceb051111 - name: My Source 1 - - type: SOURCE - id: 2c9180855d191c59015d291ceb052222 - name: My Source 2 - planInitializerScript: - description: This is a reference to a plan initializer script. + - LIST + - RANGE + example: LIST + values: + description: | + The selected values. + type: array + items: + type: string + example: + - MON + - WED + interval: + nullable: true + description: | + The selected interval for RANGE selectors. + type: integer + format: int32 + example: 3 + required: + - type + - values + - description: | + The days to execute the search. + + If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. + + If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. + example: + type: LIST + values: + - MON + - WED + - FRI + nullable: true + hours: + allOf: + - type: object + properties: + type: + description: | + Enum representing the currently supported selector types. + + LIST - the *values* array contains one or more distinct values. + + RANGE - the *values* array contains two values: the start and end of the range, inclusive. + + Additional values may be added in the future without notice. + type: string + enum: + - LIST + - RANGE + example: LIST + values: + description: | + The selected values. + type: array + items: + type: string + example: + - MON + - WED + interval: + nullable: true + description: | + The selected interval for RANGE selectors. + type: integer + format: int32 + example: 3 + required: + - type + - values + - description: The hours selected. + example: + type: RANGE + values: + - '9' + - '18' + interval: 3 + expiration: + description: 'The schedule expiration date. Latest possible expiration date is ''2038-01-19T03:14:07+0000''' + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + timeZoneId: + description: 'The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org''s default timezone is used.' + nullable: true + type: string + example: 'GMT-06:00' + required: + - type + - hours + recipients: + description: A list of identities that should receive the scheduled search report via email. + type: array + items: type: object - properties: - source: - description: This is a Rule that allows provisioning instruction changes. - type: string - example: | - \r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n - noProvisioningRequests: - description: Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. - type: boolean - example: true - provisioningRequestExpiration: - description: 'When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.' - type: integer - format: int32 - example: 7 - attributes: - description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation. - type: object - additionalProperties: true - example: - property: value - key: value - beforeProvisioningRule: - allOf: - - type: object properties: type: - description: DTO type type: string + description: The type of object being referenced 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 - - WORKGROUP 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 - description: Reference to beforeProvisioningRule for this Service Desk integration - properties: - type: - description: The type of object being referenced - enum: - - RULE - example: RULE - id: - description: ID of the rule - example: 2c91808568c529c60168cca6f90c1333 - name: - description: Human-readable display name of the rule - example: Example Rule + description: The ID of the referenced object + example: 2c9180867624cbd7017642d8c8c81f67 + required: + - type + - id + enabled: + description: | + Indicates if the scheduled search is enabled. + type: boolean + default: false + example: false + emailEmptyResults: + description: | + Indicates if email generation should not be suppressed if search returns no results. + type: boolean + default: false + example: false + displayQueryDetails: + description: | + Indicates if the generated email should include the query and search results preview (which could include PII). + type: boolean + default: false + example: false + required: + - savedSearchId + - schedule + - recipients + required: + - id + - owner + - ownerId + headers: + X-Total-Count: + description: The total result count (returned only if the *count* parameter is specified as *true*). + schema: + type: integer + example: 5 '400': description: Client Error - Returned if the request body is invalid. content: @@ -74656,755 +59651,567 @@ paths: 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. - security: - - UserContextAuth: - - 'idn:service-desk-admin:read' - - 'idn:service-desk-integration:read' - put: - tags: - - Service Desk Integration - summary: Update a Service Desk integration - description: Update an existing Service Desk integration by ID with updated value in JSON form as the request body. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - operationId: putServiceDeskIntegration - parameters: - - name: id - in: path - description: ID of the Service Desk integration to update - required: true - style: simple - explode: false - schema: - type: string - example: anId - requestBody: - description: The specifics of the integration to update - content: - application/json: - schema: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - - type: object - description: Specification of a Service Desk integration - required: - - description - - type - - attributes - properties: - description: - description: Description of the Service Desk integration - type: string - example: A very nice Service Desk integration - type: - description: | - Service Desk integration types - - - ServiceNowSDIM - - ServiceNow - type: string - default: ServiceNowSDIM - example: ServiceNowSDIM - ownerRef: - 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 - - WORKGROUP - 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 - description: Reference to the identity that is the owner of this Service Desk integration - properties: - type: - description: The type of object being referenced - enum: - - IDENTITY - example: IDENTITY - id: - description: ID of the identity - example: 2c91808568c529c60168cca6f90c1313 - name: - description: Human-readable display name of the identity - example: MyName - clusterRef: - 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 - - WORKGROUP - 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 - description: Reference to the source cluster for this Service Desk integration - properties: - type: - description: The type of object being referenced - enum: - - CLUSTER - example: CLUSTER - id: - description: ID of the cluster - example: 2c9180866166b5b0016167c32ef31a66 - name: - description: Human-readable display name of the cluster - example: Corporate Cluster - cluster: - description: 'ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)' - type: string - example: xyzzy999 - deprecated: true - managedSources: - description: 'Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)' - type: array - items: - type: string - deprecated: true - example: - - 2c9180835d191a86015d28455b4a2329 - - 2c5680835d191a85765d28455b4a9823 - provisioningConfig: - description: The 'provisioningConfig' property specifies the configuration used to provision integrations. - type: object - properties: - universalManager: - description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' - type: boolean - readOnly: true - example: true - managedResourceRefs: - description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. - type: array - items: - 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 - - WORKGROUP - 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 - properties: - type: - description: The type of object being referenced - enum: - - SOURCE - example: SOURCE - id: - description: ID of the source - example: 2c91808568c529c60168cca6f90c1313 - name: - description: Human-readable display name of the source - example: My Source - example: - - type: SOURCE - id: 2c9180855d191c59015d291ceb051111 - name: My Source 1 - - type: SOURCE - id: 2c9180855d191c59015d291ceb052222 - name: My Source 2 - planInitializerScript: - description: This is a reference to a plan initializer script. - type: object - properties: - source: - description: This is a Rule that allows provisioning instruction changes. - type: string - example: | - \r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n - noProvisioningRequests: - description: Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. - type: boolean - example: true - provisioningRequestExpiration: - description: 'When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.' - type: integer - format: int32 - example: 7 - attributes: - description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation. + 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. + '/scheduled-searches/{id}': + put: + tags: + - Scheduled Search + description: | + Updates an existing scheduled search. + summary: Update an existing Scheduled Search + operationId: updateScheduledSearch + parameters: + - in: path + name: id + description: ID of the requested document. + schema: + type: string + required: true + example: 2c91808568c529c60168cca6f90c1313 + requestBody: + description: The scheduled search to persist. + content: + application/json: + schema: + type: object + allOf: + - type: object + properties: + id: + description: The scheduled search ID. + type: string + example: 0de46054-fe90-434a-b84e-c6b3359d0c64 + readOnly: true + owner: + description: The owner of the scheduled search + readOnly: true type: object - additionalProperties: true - example: - property: value - key: value - beforeProvisioningRule: - 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 - - WORKGROUP - 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 - description: Reference to beforeProvisioningRule for this Service Desk integration properties: type: + type: string description: The type of object being referenced enum: - - RULE - example: RULE + - IDENTITY + example: IDENTITY id: - description: ID of the rule - example: 2c91808568c529c60168cca6f90c1333 - name: - description: Human-readable display name of the rule - example: Example Rule - required: true - responses: - '200': - description: ServiceDeskIntegrationDto as updated - content: - application/json: - schema: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - - type: object - description: Specification of a Service Desk integration - required: - - description - - type - - attributes - properties: - description: - description: Description of the Service Desk integration - type: string - example: A very nice Service Desk integration - type: - description: | - Service Desk integration types + type: string + description: The ID of the referenced object + example: 2c9180867624cbd7017642d8c8c81f67 + required: + - type + - id + ownerId: + description: | + The ID of the scheduled search owner. - - ServiceNowSDIM - - ServiceNow - type: string - default: ServiceNowSDIM - example: ServiceNowSDIM - ownerRef: - 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 - - WORKGROUP - 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 - description: Reference to the identity that is the owner of this Service Desk integration + Please use the `id` in the `owner` object instead. + type: string + example: 2c9180867624cbd7017642d8c8c81f67 + readOnly: true + deprecated: true + - type: object + properties: + name: + description: | + The name of the scheduled search. + type: string + example: Daily disabled accounts + nullable: true + description: + description: | + The description of the scheduled search. + type: string + nullable: true + example: Daily disabled accounts + - type: object + properties: + savedSearchId: + description: The ID of the saved search that will be executed. + type: string + example: 554f1511-f0a1-4744-ab14-599514d3e57c + created: + allOf: + - type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + description: The date the scheduled search was initially created. + readOnly: true + modified: + allOf: + - type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + description: The last date the scheduled search was modified. + readOnly: true + schedule: + type: object + description: The schedule information. + properties: + type: + description: | + Enum representing the currently supported schedule types. + + Additional values may be added in the future without notice. + type: string + enum: + - DAILY + - WEEKLY + - MONTHLY + - CALENDAR + example: WEEKLY + days: + allOf: + - type: object + properties: + type: + description: | + Enum representing the currently supported selector types. + + LIST - the *values* array contains one or more distinct values. + + RANGE - the *values* array contains two values: the start and end of the range, inclusive. + + Additional values may be added in the future without notice. + type: string + enum: + - LIST + - RANGE + example: LIST + values: + description: | + The selected values. + type: array + items: + type: string + example: + - MON + - WED + interval: + nullable: true + description: | + The selected interval for RANGE selectors. + type: integer + format: int32 + example: 3 + required: + - type + - values + - description: | + The days to execute the search. + + If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. + + If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. + example: + type: LIST + values: + - MON + - WED + - FRI + nullable: true + hours: + allOf: + - type: object + properties: + type: + description: | + Enum representing the currently supported selector types. + + LIST - the *values* array contains one or more distinct values. + + RANGE - the *values* array contains two values: the start and end of the range, inclusive. + + Additional values may be added in the future without notice. + type: string + enum: + - LIST + - RANGE + example: LIST + values: + description: | + The selected values. + type: array + items: + type: string + example: + - MON + - WED + interval: + nullable: true + description: | + The selected interval for RANGE selectors. + type: integer + format: int32 + example: 3 + required: + - type + - values + - description: The hours selected. + example: + type: RANGE + values: + - '9' + - '18' + interval: 3 + expiration: + description: 'The schedule expiration date. Latest possible expiration date is ''2038-01-19T03:14:07+0000''' + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + timeZoneId: + description: 'The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org''s default timezone is used.' + nullable: true + type: string + example: 'GMT-06:00' + required: + - type + - hours + recipients: + description: A list of identities that should receive the scheduled search report via email. + type: array + items: + type: object properties: type: + type: string description: The type of object being referenced enum: - IDENTITY example: IDENTITY id: - description: ID of the identity - example: 2c91808568c529c60168cca6f90c1313 - name: - description: Human-readable display name of the identity - example: MyName - clusterRef: - 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 - - WORKGROUP - 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 - description: Reference to the source cluster for this Service Desk integration + type: string + description: The ID of the referenced object + example: 2c9180867624cbd7017642d8c8c81f67 + required: + - type + - id + enabled: + description: | + Indicates if the scheduled search is enabled. + type: boolean + default: false + example: false + emailEmptyResults: + description: | + Indicates if email generation should not be suppressed if search returns no results. + type: boolean + default: false + example: false + displayQueryDetails: + description: | + Indicates if the generated email should include the query and search results preview (which could include PII). + type: boolean + default: false + example: false + required: + - savedSearchId + - schedule + - recipients + required: + - id + - owner + - ownerId + required: true + responses: + '200': + description: The persisted scheduled search. + content: + application/json: + schema: + type: object + allOf: + - type: object + properties: + id: + description: The scheduled search ID. + type: string + example: 0de46054-fe90-434a-b84e-c6b3359d0c64 + readOnly: true + owner: + description: The owner of the scheduled search + readOnly: true + type: object properties: type: + type: string description: The type of object being referenced enum: - - CLUSTER - example: CLUSTER + - IDENTITY + example: IDENTITY id: - description: ID of the cluster - example: 2c9180866166b5b0016167c32ef31a66 - name: - description: Human-readable display name of the cluster - example: Corporate Cluster - cluster: - description: 'ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)' + type: string + description: The ID of the referenced object + example: 2c9180867624cbd7017642d8c8c81f67 + required: + - type + - id + ownerId: + description: | + The ID of the scheduled search owner. + + Please use the `id` in the `owner` object instead. type: string - example: xyzzy999 - deprecated: true - managedSources: - description: 'Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)' - type: array - items: - type: string + example: 2c9180867624cbd7017642d8c8c81f67 + readOnly: true deprecated: true - example: - - 2c9180835d191a86015d28455b4a2329 - - 2c5680835d191a85765d28455b4a9823 - provisioningConfig: - description: The 'provisioningConfig' property specifies the configuration used to provision integrations. - type: object - properties: - universalManager: - description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' - type: boolean - readOnly: true - example: true - managedResourceRefs: - description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. - type: array - items: - 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 - - WORKGROUP - 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 - properties: - type: - description: The type of object being referenced - enum: - - SOURCE - example: SOURCE - id: - description: ID of the source - example: 2c91808568c529c60168cca6f90c1313 - name: - description: Human-readable display name of the source - example: My Source - example: - - type: SOURCE - id: 2c9180855d191c59015d291ceb051111 - name: My Source 1 - - type: SOURCE - id: 2c9180855d191c59015d291ceb052222 - name: My Source 2 - planInitializerScript: - description: This is a reference to a plan initializer script. - type: object - properties: - source: - description: This is a Rule that allows provisioning instruction changes. - type: string - example: | - \r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n - noProvisioningRequests: - description: Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. - type: boolean - example: true - provisioningRequestExpiration: - description: 'When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.' - type: integer - format: int32 - example: 7 - attributes: - description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation. - type: object - additionalProperties: true - example: - property: value - key: value - beforeProvisioningRule: + - type: object + properties: + name: + description: | + The name of the scheduled search. + type: string + example: Daily disabled accounts + nullable: true + description: + description: | + The description of the scheduled search. + type: string + nullable: true + example: Daily disabled accounts + - type: object + properties: + savedSearchId: + description: The ID of the saved search that will be executed. + type: string + example: 554f1511-f0a1-4744-ab14-599514d3e57c + created: 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 - - WORKGROUP - 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 - description: Reference to beforeProvisioningRule for this Service Desk integration + - type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + description: The date the scheduled search was initially created. + readOnly: true + modified: + allOf: + - type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + description: The last date the scheduled search was modified. + readOnly: true + schedule: + type: object + description: The schedule information. properties: type: - description: The type of object being referenced + description: | + Enum representing the currently supported schedule types. + + Additional values may be added in the future without notice. + type: string enum: - - RULE - example: RULE - id: - description: ID of the rule - example: 2c91808568c529c60168cca6f90c1333 - name: - description: Human-readable display name of the rule - example: Example Rule + - DAILY + - WEEKLY + - MONTHLY + - CALENDAR + example: WEEKLY + days: + allOf: + - type: object + properties: + type: + description: | + Enum representing the currently supported selector types. + + LIST - the *values* array contains one or more distinct values. + + RANGE - the *values* array contains two values: the start and end of the range, inclusive. + + Additional values may be added in the future without notice. + type: string + enum: + - LIST + - RANGE + example: LIST + values: + description: | + The selected values. + type: array + items: + type: string + example: + - MON + - WED + interval: + nullable: true + description: | + The selected interval for RANGE selectors. + type: integer + format: int32 + example: 3 + required: + - type + - values + - description: | + The days to execute the search. + + If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. + + If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. + example: + type: LIST + values: + - MON + - WED + - FRI + nullable: true + hours: + allOf: + - type: object + properties: + type: + description: | + Enum representing the currently supported selector types. + + LIST - the *values* array contains one or more distinct values. + + RANGE - the *values* array contains two values: the start and end of the range, inclusive. + + Additional values may be added in the future without notice. + type: string + enum: + - LIST + - RANGE + example: LIST + values: + description: | + The selected values. + type: array + items: + type: string + example: + - MON + - WED + interval: + nullable: true + description: | + The selected interval for RANGE selectors. + type: integer + format: int32 + example: 3 + required: + - type + - values + - description: The hours selected. + example: + type: RANGE + values: + - '9' + - '18' + interval: 3 + expiration: + description: 'The schedule expiration date. Latest possible expiration date is ''2038-01-19T03:14:07+0000''' + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + timeZoneId: + description: 'The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org''s default timezone is used.' + nullable: true + type: string + example: 'GMT-06:00' + required: + - type + - hours + recipients: + description: A list of identities that should receive the scheduled search report via email. + type: array + items: + type: object + properties: + type: + type: string + description: The type of object being referenced + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: The ID of the referenced object + example: 2c9180867624cbd7017642d8c8c81f67 + required: + - type + - id + enabled: + description: | + Indicates if the scheduled search is enabled. + type: boolean + default: false + example: false + emailEmptyResults: + description: | + Indicates if email generation should not be suppressed if search returns no results. + type: boolean + default: false + example: false + displayQueryDetails: + description: | + Indicates if the generated email should include the query and search results preview (which could include PII). + type: boolean + default: false + example: false + required: + - savedSearchId + - schedule + - recipients + required: + - id + - owner + - ownerId '400': description: Client Error - Returned if the request body is invalid. content: @@ -75683,29 +60490,269 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - security: - - UserContextAuth: - - 'idn:service-desk-admin:manage' - - 'idn:service-desk-integration:manage' - delete: + get: tags: - - Service Desk Integration - summary: Delete a Service Desk integration - description: Delete an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - operationId: deleteServiceDeskIntegration + - Scheduled Search + description: Returns the specified scheduled search. + summary: Get a Scheduled Search + operationId: getScheduledSearch parameters: - - name: id - in: path - description: ID of Service Desk integration to delete - required: true - style: simple - explode: false + - in: path + name: id + description: ID of the requested document. schema: type: string - example: anId + required: true + example: 2c91808568c529c60168cca6f90c1313 responses: - '204': - description: Service Desk integration with the given ID successfully deleted + '200': + description: The requested scheduled search. + content: + application/json: + schema: + type: object + allOf: + - type: object + properties: + id: + description: The scheduled search ID. + type: string + example: 0de46054-fe90-434a-b84e-c6b3359d0c64 + readOnly: true + owner: + description: The owner of the scheduled search + readOnly: true + type: object + properties: + type: + type: string + description: The type of object being referenced + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: The ID of the referenced object + example: 2c9180867624cbd7017642d8c8c81f67 + required: + - type + - id + ownerId: + description: | + The ID of the scheduled search owner. + + Please use the `id` in the `owner` object instead. + type: string + example: 2c9180867624cbd7017642d8c8c81f67 + readOnly: true + deprecated: true + - type: object + properties: + name: + description: | + The name of the scheduled search. + type: string + example: Daily disabled accounts + nullable: true + description: + description: | + The description of the scheduled search. + type: string + nullable: true + example: Daily disabled accounts + - type: object + properties: + savedSearchId: + description: The ID of the saved search that will be executed. + type: string + example: 554f1511-f0a1-4744-ab14-599514d3e57c + created: + allOf: + - type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + description: The date the scheduled search was initially created. + readOnly: true + modified: + allOf: + - type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + description: The last date the scheduled search was modified. + readOnly: true + schedule: + type: object + description: The schedule information. + properties: + type: + description: | + Enum representing the currently supported schedule types. + + Additional values may be added in the future without notice. + type: string + enum: + - DAILY + - WEEKLY + - MONTHLY + - CALENDAR + example: WEEKLY + days: + allOf: + - type: object + properties: + type: + description: | + Enum representing the currently supported selector types. + + LIST - the *values* array contains one or more distinct values. + + RANGE - the *values* array contains two values: the start and end of the range, inclusive. + + Additional values may be added in the future without notice. + type: string + enum: + - LIST + - RANGE + example: LIST + values: + description: | + The selected values. + type: array + items: + type: string + example: + - MON + - WED + interval: + nullable: true + description: | + The selected interval for RANGE selectors. + type: integer + format: int32 + example: 3 + required: + - type + - values + - description: | + The days to execute the search. + + If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. + + If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. + example: + type: LIST + values: + - MON + - WED + - FRI + nullable: true + hours: + allOf: + - type: object + properties: + type: + description: | + Enum representing the currently supported selector types. + + LIST - the *values* array contains one or more distinct values. + + RANGE - the *values* array contains two values: the start and end of the range, inclusive. + + Additional values may be added in the future without notice. + type: string + enum: + - LIST + - RANGE + example: LIST + values: + description: | + The selected values. + type: array + items: + type: string + example: + - MON + - WED + interval: + nullable: true + description: | + The selected interval for RANGE selectors. + type: integer + format: int32 + example: 3 + required: + - type + - values + - description: The hours selected. + example: + type: RANGE + values: + - '9' + - '18' + interval: 3 + expiration: + description: 'The schedule expiration date. Latest possible expiration date is ''2038-01-19T03:14:07+0000''' + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + timeZoneId: + description: 'The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org''s default timezone is used.' + nullable: true + type: string + example: 'GMT-06:00' + required: + - type + - hours + recipients: + description: A list of identities that should receive the scheduled search report via email. + type: array + items: + type: object + properties: + type: + type: string + description: The type of object being referenced + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: The ID of the referenced object + example: 2c9180867624cbd7017642d8c8c81f67 + required: + - type + - id + enabled: + description: | + Indicates if the scheduled search is enabled. + type: boolean + default: false + example: false + emailEmptyResults: + description: | + Indicates if email generation should not be suppressed if search returns no results. + type: boolean + default: false + example: false + displayQueryDetails: + description: | + Indicates if the generated email should include the query and search results preview (which could include PII). + type: boolean + default: false + example: false + required: + - savedSearchId + - schedule + - recipients + required: + - id + - owner + - ownerId '400': description: Client Error - Returned if the request body is invalid. content: @@ -75899,514 +60946,109 @@ paths: example: The request was syntactically correct but its content is semantically invalid. examples: '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - security: - - UserContextAuth: - - 'idn:service-desk-admin:manage' - - 'idn:service-desk-integration:manage' - patch: - operationId: patchServiceDeskIntegration - tags: - - Service Desk Integration - summary: Service Desk Integration Update PATCH - description: Update an existing ServiceDeskIntegration by ID with a PATCH request. - parameters: - - name: id - in: path - description: ID of the Service Desk integration to update - required: true - style: simple - explode: false - schema: - type: string - example: anId - requestBody: - required: true - description: | - A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - PATCH can only be applied to the following fields: - * `beforeProvisioningRule` - * `description` - * `ownerRef` - - A 403 Forbidden Error indicates that you attempted to PATCH a field that is not allowed. - content: - application/json-patch+json: - schema: - type: object - description: 'A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' - properties: - operations: - description: Operations to be applied - type: array - items: - type: object - description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' - required: - - op - - path - properties: - op: - type: string - description: The operation to be performed - enum: - - add - - remove - - replace - - move - - copy - - test - example: replace - path: - type: string - description: A string JSON Pointer representing the target path to an element to be affected by the operation - example: /description - value: - anyOf: - - type: string - - type: integer - - type: object - - type: array - items: - anyOf: - - type: string - - type: integer - - type: object - description: 'The value to be used for the operation, required for "add" and "replace" operations' - example: New description - example: - - op: replace - path: /ownerRef - value: - id: 2c9180867d05b227017d09921a205b4d - type: IDENTITY - name: Angelo2 tester - responses: - '200': - description: ServiceDeskIntegrationDto as updated - content: - application/json: - schema: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - - type: object - description: Specification of a Service Desk integration - required: - - description - - type - - attributes - properties: - description: - description: Description of the Service Desk integration - type: string - example: A very nice Service Desk integration - type: - description: | - Service Desk integration types - - - ServiceNowSDIM - - ServiceNow - type: string - default: ServiceNowSDIM - example: ServiceNowSDIM - ownerRef: - 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 - - WORKGROUP - 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 - description: Reference to the identity that is the owner of this Service Desk integration - properties: - type: - description: The type of object being referenced - enum: - - IDENTITY - example: IDENTITY - id: - description: ID of the identity - example: 2c91808568c529c60168cca6f90c1313 - name: - description: Human-readable display name of the identity - example: MyName - clusterRef: - 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 - - WORKGROUP - 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 - description: Reference to the source cluster for this Service Desk integration - properties: - type: - description: The type of object being referenced - enum: - - CLUSTER - example: CLUSTER - id: - description: ID of the cluster - example: 2c9180866166b5b0016167c32ef31a66 - name: - description: Human-readable display name of the cluster - example: Corporate Cluster - cluster: - description: 'ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)' - type: string - example: xyzzy999 - deprecated: true - managedSources: - description: 'Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)' - type: array - items: + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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 - deprecated: true - example: - - 2c9180835d191a86015d28455b4a2329 - - 2c5680835d191a85765d28455b4a9823 - provisioningConfig: - description: The 'provisioningConfig' property specifies the configuration used to provision integrations. - type: object - properties: - universalManager: - description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' - type: boolean - readOnly: true - example: true - managedResourceRefs: - description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. - type: array - items: - 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 - - WORKGROUP - 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 - properties: - type: - description: The type of object being referenced - enum: - - SOURCE - example: SOURCE - id: - description: ID of the source - example: 2c91808568c529c60168cca6f90c1313 - name: - description: Human-readable display name of the source - example: My Source - example: - - type: SOURCE - id: 2c9180855d191c59015d291ceb051111 - name: My Source 1 - - type: SOURCE - id: 2c9180855d191c59015d291ceb052222 - name: My Source 2 - planInitializerScript: - description: This is a reference to a plan initializer script. - type: object - properties: - source: - description: This is a Rule that allows provisioning instruction changes. - type: string - example: | - \r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n - noProvisioningRequests: - description: Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. - type: boolean - example: true - provisioningRequestExpiration: - description: 'When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.' - type: integer - format: int32 - example: 7 - attributes: - description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation. - type: object - additionalProperties: true - example: - property: value - key: value - beforeProvisioningRule: - 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 - - WORKGROUP - 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 - description: Reference to beforeProvisioningRule for this Service Desk integration - properties: - type: - description: The type of object being referenced - enum: - - RULE - example: RULE - id: - description: ID of the rule - example: 2c91808568c529c60168cca6f90c1333 - name: - description: Human-readable display name of the rule - example: Example Rule + 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. + delete: + tags: + - Scheduled Search + description: | + Deletes the specified scheduled search. + operationId: deleteScheduledSearch + summary: Delete a Scheduled Search + parameters: + - in: path + name: id + description: ID of the requested document. + schema: + type: string + required: true + example: 2c91808568c529c60168cca6f90c1313 + responses: + '204': + description: No Content - Indicates the request was successful but there is no content to be returned in the response. '400': description: Client Error - Returned if the request body is invalid. content: @@ -76685,43 +61327,77 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - security: - - UserContextAuth: - - 'idn:service-desk-admin:manage' - - 'idn:service-desk-integration:manage' - /service-desk-integrations/types: - get: + '/scheduled-searches/{id}/unsubscribe': + post: tags: - - Service Desk Integration - summary: Service Desk Integration Types List. - description: This API endpoint returns the current list of supported Service Desk integration types. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - operationId: getServiceDeskIntegrationTypes + - Scheduled Search + description: | + Unsubscribes a recipient from the specified scheduled search. + operationId: unsubscribeScheduledSearch + summary: Unsubscribe a recipient from Scheduled Search + parameters: + - in: path + name: id + description: ID of the requested document. + schema: + type: string + required: true + example: 2c91808568c529c60168cca6f90c1313 + requestBody: + description: | + The recipient to be removed from the scheduled search. + content: + application/json: + schema: + type: object + description: | + A typed reference to the object. + properties: + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + id: + description: | + The id of the object. + type: string + example: 2c91808568c529c60168cca6f90c1313 + required: + - type + - id + required: true responses: - '200': - description: Responds with an array of the currently supported Service Desk integration types. - content: - application/json: - schema: - type: array - items: - description: This represents a Service Desk Integration template type. - required: - - type - - scriptName - type: object - properties: - name: - description: This is the name of the type. - example: aName - type: string - type: - description: This is the type value for the type. - example: aType - type: string - scriptName: - description: This is the scriptName attribute value for the type. - example: aScriptName - type: string + '204': + description: No Content - Indicates the request was successful but there is no content to be returned in the response. '400': description: Client Error - Returned if the request body is invalid. content: @@ -76779,16 +61455,6 @@ paths: 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: @@ -76877,932 +61543,3066 @@ paths: items: type: object properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + /search: + post: + tags: + - Search + description: 'Performs a search with the provided query and returns a matching result collection. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. ' + externalDocs: + description: Learn more about search. + url: 'https://documentation.sailpoint.com/saas/help/search/index.html' + operationId: searchPost + summary: Perform Search + parameters: + - 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: 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: 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 + requestBody: + content: + application/json: + schema: + type: object + properties: + indices: + description: 'The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched.' + externalDocs: + description: Learn more about search indices here. + url: 'https://documentation.sailpoint.com/saas/help/search/searchable-fields.html' + type: array + items: + description: |- + Enum representing the currently supported indices. + Additional values may be added in the future without notice. + type: string + enum: + - accessprofiles + - accountactivities + - entitlements + - events + - identities + - roles + - '*' + example: identities + example: + - identities + queryType: + description: |- + The type of query to use. By default, the `SAILPOINT` query type is used, which requires the `query` object to be defined in the request body. + To use the `queryDsl` or `typeAheadQuery` objects in the request, you must set the type to `DSL` or `TYPEAHEAD` accordingly. + Additional values may be added in the future without notice. + type: string + enum: + - DSL + - SAILPOINT + - TEXT + - TYPEAHEAD + default: SAILPOINT + example: SAILPOINT + queryVersion: + allOf: + - description: The current Elasticserver version. + type: string + default: '5.2' + example: '5.2' + - type: string + description: |- + The version of the query object. + This version number will map to the version of Elasticsearch for the query strings and objects being used. + query: + type: object + description: Query parameters used to construct an Elasticsearch query object. + properties: + query: + description: 'The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.' + type: string + example: 'name:a*' + fields: + description: The fields to which the specified query will be applied. The available fields are dependent on the indice(s) being searched on. Please refer to the response schema of this API for a list of available fields. + type: array + items: + type: string + example: + - name + timeZone: + description: The time zone to be applied to any range query related to dates. + type: string + example: America/Chicago + innerHit: + description: The innerHit query object returns a flattened list of results for the specified nested type. + type: object + required: + - query + - type + properties: + query: + description: 'The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.' 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: + example: 'source.name:\"Active Directory\"' + type: + description: 'The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document "nested" within another document. For example, an identity can have nested documents for access, accounts, and apps.' 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 + example: access + queryDsl: + description: 'The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax.' + type: object + example: + match: + name: john.doe + textQuery: + type: object + description: Query parameters used to construct an Elasticsearch text query object. + required: + - terms + - fields + properties: + terms: + description: Words or characters that specify a particular thing to be searched for. + type: array + items: + type: string + example: + - The quick brown fox + - '3141592' + - '7' + fields: + description: The fields to be searched. + type: array + items: + type: string + example: + - displayName + - employeeNumber + - roleCount + matchAny: + description: 'Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found.' + type: boolean + default: false + example: false + contains: + description: 'Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms.' + type: boolean + default: false + example: true + typeAheadQuery: + type: object + description: 'Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing "Jo" results in top hits matching "Jo." Typing "Job" results in top hits matching "Job." ' + required: + - query + - field + properties: + query: + description: The type ahead query string used to construct a phrase prefix match query. + type: string + example: Work + field: + description: The field on which to perform the type ahead search. + type: string + example: source.name + nestedType: + description: The nested type. + type: string + example: access + maxExpansions: + description: |- + The number of suffixes the last term will be expanded into. + Influences the performance of the query and the number results returned. + Valid values: 1 to 1000. + type: integer + format: int32 + minimum: 1 + maximum: 1000 + default: 10 + example: 10 + includeNested: + description: Indicates whether nested objects from returned search results should be included. + type: boolean + default: true + example: true + queryResultFilter: + type: object + description: Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents. + properties: + includes: + description: The list of field names to include in the result documents. + type: array + items: + type: string + example: + - name + - displayName + excludes: + description: The list of field names to exclude from the result documents. + type: array + items: + type: string + example: + - stacktrace + aggregationType: + description: | + Enum representing the currently available query languages for aggregations, which are used to perform calculations or groupings on search results. + + Additional values may be added in the future without notice. + type: string + enum: + - DSL + - SAILPOINT + default: DSL + example: DSL + aggregationsVersion: + allOf: + - description: The current Elasticserver version. + type: string + default: '5.2' + example: '5.2' + - type: string + description: |- + The version of the language being used for aggregation queries. + This version number will map to the version of Elasticsearch for the aggregation query object. + aggregationsDsl: + description: 'The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax.' + type: object + example: {} + aggregations: + description: | + The aggregation’s specifications, such as the groupings and calculations to be performed. + allOf: + - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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: + nested: + type: object + description: The nested aggregation object. + required: + - name + - type + properties: + name: + description: The name of the nested aggregate to be included in the result. + type: string + example: id + type: + description: The type of the nested object. + type: string + example: access + metric: + type: object + description: The calculation done on the results of the query + required: + - name + - field + properties: + name: + description: |- + The name of the metric aggregate to be included in the result. + If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. + type: string + example: Access Name Count + type: + description: |- + Enum representing the currently supported metric aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - COUNT + - UNIQUE_COUNT + - AVG + - SUM + - MEDIAN + - MIN + - MAX + default: UNIQUE_COUNT + example: COUNT + field: + description: | + The field the calculation is performed on. + + Prefix the field name with '@' to reference a nested object. + type: string + example: '@access.name' + filter: + type: object + description: An additional filter to constrain the results of the search query. + required: + - name + - field + - value + properties: + name: + description: The name of the filter aggregate to be included in the result. + type: string + example: Entitlements + type: + description: |- + Enum representing the currently supported filter aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - TERM + default: TERM + example: TERM + field: + description: | + The search field to apply the filter to. + + Prefix the field name with '@' to reference a nested object. + type: string + example: access.type + value: + description: The value to filter on. + type: string + example: ENTITLEMENT + bucket: + type: object + description: The bucket to group the results of the aggregation query by. + required: + - name + - field + properties: + name: + description: The name of the bucket aggregate to be included in the result. + type: string + example: Identity Locations + type: + description: |- + Enum representing the currently supported bucket aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - TERMS + default: TERMS + example: TERMS + field: + description: |- + The field to bucket on. + Prefix the field name with '@' to reference a nested object. + type: string + example: attributes.city + size: + description: Maximum number of buckets to include. + type: integer + format: int32 + example: 100 + minDocCount: + description: Minimum number of documents a bucket should have. + type: integer + format: int32 + example: 2 + - type: object + properties: + subAggregation: + description: Aggregation to be performed on the result of the parent bucket aggregation. + allOf: + - type: object + properties: + nested: + type: object + description: The nested aggregation object. + required: + - name + - type + properties: + name: + description: The name of the nested aggregate to be included in the result. + type: string + example: id + type: + description: The type of the nested object. + type: string + example: access + metric: + type: object + description: The calculation done on the results of the query + required: + - name + - field + properties: + name: + description: |- + The name of the metric aggregate to be included in the result. + If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. + type: string + example: Access Name Count + type: + description: |- + Enum representing the currently supported metric aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - COUNT + - UNIQUE_COUNT + - AVG + - SUM + - MEDIAN + - MIN + - MAX + default: UNIQUE_COUNT + example: COUNT + field: + description: | + The field the calculation is performed on. + + Prefix the field name with '@' to reference a nested object. + type: string + example: '@access.name' + filter: + type: object + description: An additional filter to constrain the results of the search query. + required: + - name + - field + - value + properties: + name: + description: The name of the filter aggregate to be included in the result. + type: string + example: Entitlements + type: + description: |- + Enum representing the currently supported filter aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - TERM + default: TERM + example: TERM + field: + description: | + The search field to apply the filter to. + + Prefix the field name with '@' to reference a nested object. + type: string + example: access.type + value: + description: The value to filter on. + type: string + example: ENTITLEMENT + bucket: + type: object + description: The bucket to group the results of the aggregation query by. + required: + - name + - field + properties: + name: + description: The name of the bucket aggregate to be included in the result. + type: string + example: Identity Locations + type: + description: |- + Enum representing the currently supported bucket aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - TERMS + default: TERMS + example: TERMS + field: + description: |- + The field to bucket on. + Prefix the field name with '@' to reference a nested object. + type: string + example: attributes.city + size: + description: Maximum number of buckets to include. + type: integer + format: int32 + example: 100 + minDocCount: + description: Minimum number of documents a bucket should have. + type: integer + format: int32 + example: 2 + - type: object + properties: + subAggregation: + description: Aggregation to be performed on the result of the parent bucket aggregation. + type: object + properties: + nested: + type: object + description: The nested aggregation object. + required: + - name + - type + properties: + name: + description: The name of the nested aggregate to be included in the result. + type: string + example: id + type: + description: The type of the nested object. + type: string + example: access + metric: + type: object + description: The calculation done on the results of the query + required: + - name + - field + properties: + name: + description: |- + The name of the metric aggregate to be included in the result. + If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. + type: string + example: Access Name Count + type: + description: |- + Enum representing the currently supported metric aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - COUNT + - UNIQUE_COUNT + - AVG + - SUM + - MEDIAN + - MIN + - MAX + default: UNIQUE_COUNT + example: COUNT + field: + description: | + The field the calculation is performed on. + + Prefix the field name with '@' to reference a nested object. + type: string + example: '@access.name' + filter: + type: object + description: An additional filter to constrain the results of the search query. + required: + - name + - field + - value + properties: + name: + description: The name of the filter aggregate to be included in the result. + type: string + example: Entitlements + type: + description: |- + Enum representing the currently supported filter aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - TERM + default: TERM + example: TERM + field: + description: | + The search field to apply the filter to. + + Prefix the field name with '@' to reference a nested object. + type: string + example: access.type + value: + description: The value to filter on. + type: string + example: ENTITLEMENT + bucket: + type: object + description: The bucket to group the results of the aggregation query by. + required: + - name + - field + properties: + name: + description: The name of the bucket aggregate to be included in the result. + type: string + example: Identity Locations + type: + description: |- + Enum representing the currently supported bucket aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - TERMS + default: TERMS + example: TERMS + field: + description: |- + The field to bucket on. + Prefix the field name with '@' to reference a nested object. + type: string + example: attributes.city + size: + description: Maximum number of buckets to include. + type: integer + format: int32 + example: 100 + minDocCount: + description: Minimum number of documents a bucket should have. + type: integer + format: int32 + example: 2 + sort: + description: The fields to be used to sort the search results. Use + or - to specify the sort direction. + type: array + items: type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: + example: + - displayName + - +id + searchAfter: + description: |- + Used to begin the search window at the values specified. + This parameter consists of the last values of the sorted fields in the current record set. + This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. + It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging. + For example, when searching for identities, if you are sorting by displayName you will also want to include ID, for example ["displayName", "id"]. + If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is "John Doe", then using that displayName and ID will start a new search after this identity. + The searchAfter value will look like ["John Doe","2c91808375d8e80a0175e1f88a575221"] + type: array + items: 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: + example: + - John Doe + - 2c91808375d8e80a0175e1f88a575221 + filters: + description: The filters to be applied for each filtered field name. + type: object + additionalProperties: + type: object + properties: + type: + description: |- + Enum representing the currently supported filter types. + Additional values may be added in the future without notice. + type: string + enum: + - EXISTS + - RANGE + - TERMS + example: RANGE + range: + type: object + description: The range of values to be filtered. + properties: + lower: + description: The lower bound of the range. + type: object + required: + - value + properties: + value: + description: The value of the range's endpoint. + type: string + example: '1' + inclusive: + description: Indicates if the endpoint is included in the range. + type: boolean + default: false + example: false + upper: + description: The upper bound of the range. + type: object + required: + - value + properties: + value: + description: The value of the range's endpoint. + type: string + example: '1' + inclusive: + description: Indicates if the endpoint is included in the range. + type: boolean + default: false + example: false + terms: + description: The terms to be filtered. + type: array + items: 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. - security: - - UserContextAuth: - - 'idn:service-desk-admin:read' - - 'idn:service-desk-integration:read' - '/service-desk-integrations/templates/{scriptName}': - get: - tags: - - Service Desk Integration - summary: Service Desk integration template by scriptName. - description: This API endpoint returns an existing Service Desk integration template by scriptName. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - operationId: getServiceDeskIntegrationTemplate - parameters: - - name: scriptName - in: path - description: The scriptName value of the Service Desk integration template to get - required: true - style: simple - explode: false - schema: - type: string - example: aScriptName + example: account_count + exclude: + description: Indicates if the filter excludes results. + type: boolean + default: false + example: false + example: {} + examples: + query-fields: + summary: Query with Fields + value: + indices: + - identities + query: + query: '"John Doe"' + fields: + - name + query-timeZone: + summary: Query with TimeZone + value: + indices: + - identities + query: + query: 'created: [2022-05-19T19:26:03.351Z TO now]' + timeZone: America/Los_Angeles + query-innerHit: + summary: Query with InnerHit + value: + indices: + - identities + query: + query: '"John Doe"' + innerHit: + type: access + query: 'source.name:\"Active Directory\"' + typeAheadQuery: + summary: TypeAheadQuery + value: + indices: + - identities + queryType: TYPEAHEAD + typeAheadQuery: + field: name + query: Jo + maxExpansions: 50 + typeAheadQuery-nestedType: + summary: TypeAheadQuery with NestedType + value: + indices: + - identities + queryType: TYPEAHEAD + typeAheadQuery: + field: source.name + nestedType: access + query: Work + maxExpansions: 50 + filter-exists: + summary: Filter with Exists + value: + indices: + - identities + query: + query: 'attributes.city:London' + filters: + attributes.cloudAuthoritativeSource: + type: EXISTS + exclude: true + filter-range: + summary: Filter with Range + value: + indices: + - identities + query: + query: 'attributes.city:London' + timeZone: Europe/London + filters: + accessCount: + type: RANGE + range: + lower: + value: '3' + created: + type: RANGE + range: + lower: + value: '2019-12-01' + inclusive: true + upper: + value: '2020-01-01' + filter-terms: + summary: Filter with Terms + value: + indices: + - identities + query: + query: 'attributes.city:London' + filters: + source.name: + type: TERMS + terms: + - HR Employees + - Corporate Active Directory + exclude: true + protected: + type: TERMS + terms: + - 'true' + required: true responses: '200': - description: Responds with the ServiceDeskIntegrationTemplateDto with the specified scriptName. + description: List of matching documents. content: application/json: schema: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - - type: object - description: 'This is the model for a Service Desk integration template, used to create and edit Service Desk Integrations.' - required: - - type - - attributes - - provisioningConfig - properties: - type: - description: The 'type' property specifies the type of the Service Desk integration template. - type: string - example: Web Service SDIM - default: Web Service SDIM - attributes: - description: The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template. - type: object - additionalProperties: true - example: - property: value - key: value - provisioningConfig: - description: The 'provisioningConfig' property specifies the configuration used to provision integrations using the template. - type: object - properties: - universalManager: - description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' - type: boolean - readOnly: true - example: true - managedResourceRefs: - description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. - type: array - items: + type: array + items: + discriminator: + propertyName: _type + mapping: + accessprofile: ../model/access/profile/AccessProfileDocument.yaml + accountactivity: ../model/account/activity/AccountActivityDocument.yaml + account: ../model/account/AccountDocument.yaml + aggregation: ../model/aggregation/AggregationDocument.yaml + entitlement: ../model/entitlement/EntitlementDocument.yaml + event: ../model/event/EventDocument.yaml + identity: ../model/identity/IdentityDocument.yaml + role: ../model/role/RoleDocument.yaml + oneOf: + - description: 'This is more of a complete representation of an access profile. ' + allOf: + - type: object + required: + - id + - name + - _type + properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + name: + type: string + example: john.doe + _type: + description: |- + Enum representing the currently supported document types. + + Additional values may be added in the future without notice. + type: string + enum: + - accessprofile + - accountactivity + - account + - aggregation + - entitlement + - event + - identity + - role + example: identity + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + description: + type: string + description: The description of the access item + example: The admin role + created: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + modified: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + synced: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + enabled: + type: boolean + example: true + requestable: + type: boolean + example: true + description: Indicates if the access can be requested + requestCommentsRequired: + type: boolean + description: Indicates if comments are required when requesting access + example: false + owner: + allOf: + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + - type: object + properties: + email: + type: string + example: john.doe@sailpoint.com + description: The email of the identity + - type: object + properties: + source: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + entitlements: + type: array + items: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + description: + type: string + description: A description of the entitlement + example: The admin privilege + attribute: + type: string + description: The name of the entitlement attribute + example: admin + value: + type: string + description: The value of the entitlement + example: 'true' + entitlementCount: + type: integer + example: 5 + tags: + type: array + items: + type: string + example: + - TAG_1 + - TAG_2 + - description: AccountActivity + allOf: + - type: object + required: + - id + - name + - _type + properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + name: + type: string + example: john.doe + _type: + description: |- + Enum representing the currently supported document types. + + Additional values may be added in the future without notice. + type: string + enum: + - accessprofile + - accountactivity + - account + - aggregation + - entitlement + - event + - identity + - role + example: identity + - type: object + properties: + action: + type: string + description: The type of action that this activity performed + externalDocs: + description: Learn more about account activity action types + url: 'https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data' + example: Identity Refresh. + created: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + modified: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + stage: + type: string + description: The current stage of the activity + example: Completed + origin: + type: string + nullable: true + example: null + status: + type: string + description: the current status of the activity + example: Complete + requester: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + recipient: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + trackingNumber: + type: string + example: 61aad0c9e8134eca89e76a35e0cabe3f + errors: + type: array + items: + type: string + nullable: true + example: null + warnings: + type: array + items: + type: string + nullable: true + example: null + approvals: + type: array + items: + type: object + properties: + comments: + type: array + items: + type: object + properties: + comment: + type: string + description: The comment text + example: This request was autoapproved by our automated ETS subscriber. + commenter: + type: string + description: The name of the commenter + example: Automated AR Approval + date: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + created: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + modified: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + owner: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + result: + type: string + description: The result of the approval + example: Finished + type: + type: string + nullable: true + example: null + originalRequests: + type: array + items: + type: object + properties: + accountId: + type: string + description: the account id + example: 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com' + attributeRequests: + type: array + items: + type: object + properties: + name: + type: string + description: The attribute name + example: groups + op: + type: string + description: The operation to perform + example: Add + value: + type: string + description: The value of the attribute + example: '3203537556531076' + op: + type: string + description: the operation that was used + example: add + source: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + expansionItems: + type: array + items: + type: object + properties: + accountId: + type: string + description: The ID of the account + example: 2c91808981f58ea601821c3e93482e6f + cause: + type: string + example: Role + name: + type: string + description: The name of the item + example: smartsheet-role + attributeRequests: + type: array + items: + type: object + properties: + name: + type: string + description: The attribute name + example: groups + op: + type: string + description: The operation to perform + example: Add + value: + type: string + description: The value of the attribute + example: '3203537556531076' + source: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + accountRequests: + type: array + items: + type: object + properties: + accountId: + type: string + description: Unique ID of the account + example: John.Doe + attributeRequests: + type: array + items: + type: object + properties: + name: + type: string + description: The attribute name + example: groups + op: + type: string + description: The operation to perform + example: Add + value: + type: string + description: The value of the attribute + example: '3203537556531076' + op: + type: string + example: Modify + description: The operation that was performed + provisioningTarget: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + result: + type: object + properties: + errors: + type: array + items: + type: string + example: |- + [ConnectorError] [ + { + "code": "unrecognized_keys", + "keys": [ + "groups" + ], + "path": [], + "message": "Unrecognized key(s) in object: 'groups'" + } + ] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e) + status: + type: string + description: The status of the account request + example: failed + ticketId: + type: string + nullable: true + example: null + source: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + sources: + type: string + example: 'smartsheet-test, airtable-v4, IdentityNow' + - description: Account + allOf: + - type: object + required: + - id + - name + - _type + properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + name: + type: string + example: john.doe + _type: + description: |- + Enum representing the currently supported document types. + + Additional values may be added in the future without notice. + type: string + enum: + - accessprofile + - accountactivity + - account + - aggregation + - entitlement + - event + - identity + - role + example: identity + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + accountId: + type: string + description: The ID of the account + example: john.doe + source: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + disabled: + type: boolean + description: Indicates if the account is disabled + example: false + locked: + type: boolean + description: Indicates if the account is locked + example: false + privileged: + type: boolean + example: false + manuallyCorrelated: + type: boolean + description: Indicates if the account has been manually correlated to an identity + example: false + passwordLastSet: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + entitlementAttributes: + type: object + nullable: true + description: a map or dictionary of key/value pairs + additionalProperties: true + example: + moderator: true + admin: true + trust_level: '4' + created: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + - type: object + properties: + modified: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + attributes: + type: object + description: a map or dictionary of key/value pairs + additionalProperties: true + example: + firstName: John + lastName: Doe + displayName: John.Doe + identity: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + access: + type: array + items: + description: EntitlementReference + allOf: + - allOf: + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + - type: object + properties: + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + description: + type: string + nullable: true + example: null + - type: object + properties: + source: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + privileged: + type: boolean + example: false + attribute: + type: string + example: memberOf + value: + type: string + example: 'CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + standalone: + type: boolean + example: false + entitlementCount: + type: integer + description: The number of entitlements assigned to the account + format: int32 + example: 2 + uncorrelated: + type: boolean + description: Indicates if the account is not correlated to an identity + example: false + tags: + type: array + items: + type: string + example: + - TAG_1 + - TAG_2 + - description: Aggregation + allOf: + - type: object + required: + - id + - name + - _type + properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + name: + type: string + example: john.doe + _type: + description: |- + Enum representing the currently supported document types. + + Additional values may be added in the future without notice. + type: string + enum: + - accessprofile + - accountactivity + - account + - aggregation + - entitlement + - event + - identity + - role + example: identity + - type: object + properties: + status: + type: string + example: Success + duration: + type: integer + format: int32 + example: 20 + avgDuration: + type: integer + format: int32 + example: 20 + changedAccounts: + type: integer + format: int32 + example: 1 + nextScheduled: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + startTime: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + sourceOwner: + type: string + description: John Doe + - description: Entitlement + allOf: + - type: object + required: + - id + - name + - _type + properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + name: + type: string + example: john.doe + _type: + description: |- + Enum representing the currently supported document types. + + Additional values may be added in the future without notice. + type: string + enum: + - accessprofile + - accountactivity + - account + - aggregation + - entitlement + - event + - identity + - role + example: identity + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + description: + type: string + description: A description of the entitlement + example: The admin privilege + attribute: + type: string + description: The name of the entitlement attribute + example: admin + value: + type: string + description: The value of the entitlement + example: 'true' + - type: object + properties: + modified: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + synced: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + displayName: + type: string + description: The display name of the entitlement + example: Admin + source: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + privileged: + type: boolean + example: false + identityCount: + type: integer + format: int32 + example: 3 + tags: + type: array + items: + type: string + example: + - TAG_1 + - TAG_2 + - description: Event + allOf: + - type: object + required: + - id + - name + - _type + properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + name: + type: string + example: john.doe + _type: + description: |- + Enum representing the currently supported document types. + + Additional values may be added in the future without notice. + type: string + enum: + - accessprofile + - accountactivity + - account + - aggregation + - entitlement + - event + - identity + - role + example: identity + - type: object + properties: + created: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + synced: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + action: + type: string + description: The action that was performed + example: update + type: + type: string + description: The type of event + example: SYSTEM_CONFIG + actor: + type: object + properties: + name: + type: string + example: John Doe + description: the actor or target name + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + target: + type: object + properties: + name: + type: string + example: John Doe + description: the actor or target name + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + stack: + type: string + example: tpe + trackingNumber: + type: string + example: 63f891e0735f4cc8bf1968144a1e7440 + ipAddress: + type: string + example: 52.52.97.85 + details: + type: string + example: 73b65dfbed1842548c207432a18c84b0 + attributes: + type: object + additionalProperties: true + example: + pod: stg03-useast1 + org: acme + sourceName: SailPoint + objects: + type: array + items: + type: string + example: AUTHENTICATION + operation: + type: string + example: REQUEST + status: + type: string + example: PASSED + technicalName: + type: string + example: AUTHENTICATION_REQUEST_PASSED + - description: Identity + allOf: + - type: object + required: + - id + - name + - _type + properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + name: + type: string + example: john.doe + _type: + description: |- + Enum representing the currently supported document types. + + Additional values may be added in the future without notice. + type: string + enum: + - accessprofile + - accountactivity + - account + - aggregation + - entitlement + - event + - identity + - role + example: identity + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + - type: object + properties: + firstName: + type: string + description: The first name of the identity + example: Carol + lastName: + type: string + description: The last name of the identity + example: Adams + displayName: + type: string + example: Carol.Adams + description: The display name of the identity + email: + type: string + description: The identity's primary email address + example: Carol.Adams@sailpointdemo.com + created: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + modified: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + synced: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + phone: + type: string + description: The phone number of the identity + example: +1 440-527-3672 + inactive: + type: boolean + description: Indicates if the identity is inactive + example: false + protected: + type: boolean + example: false + status: + type: string + description: The identity's status in SailPoint + example: UNREGISTERED + employeeNumber: + type: string + example: 1a2a3d4e + manager: + nullable: true 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 - - WORKGROUP - example: IDENTITY id: type: string - description: ID of the object to which this reference applies example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. name: type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + isManager: + type: boolean + description: Indicates if this identity is a manager of other identities + example: false + identityProfile: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + source: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + attributes: + type: object + description: a map or dictionary of key/value pairs + additionalProperties: true + example: + country: US + firstname: Carol + cloudStatus: UNREGISTERED + processingState: + type: string + nullable: true + example: null + processingDetails: + nullable: true + type: object + properties: + date: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + stage: + type: string + example: In Process + retryCount: + type: integer + example: 0 + format: int32 + stackTrace: + type: string + example: + message: + type: string + example: + accounts: + type: array + description: List of accounts associated with the identity + items: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + accountId: + type: string + description: The ID of the account + example: john.doe + source: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + disabled: + type: boolean + description: Indicates if the account is disabled + example: false + locked: + type: boolean + description: Indicates if the account is locked + example: false + privileged: + type: boolean + example: false + manuallyCorrelated: + type: boolean + description: Indicates if the account has been manually correlated to an identity + example: false + passwordLastSet: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + entitlementAttributes: + type: object + nullable: true + description: a map or dictionary of key/value pairs + additionalProperties: true + example: + moderator: true + admin: true + trust_level: '4' + created: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + accountCount: + type: integer + description: Number of accounts associated with the identity + format: int32 + example: 3 + apps: + type: array + description: The list of applications the identity has access to + items: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + source: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + account: + type: object + properties: + id: + type: string + description: The SailPoint generated unique ID + example: 2c9180837dfe6949017e21f3d8cd6d49 + accountId: + type: string + description: The account ID generated by the source + example: 'CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + appCount: + type: integer + format: int32 + description: The number of applications the identity has access to + example: 2 + access: + type: array + description: The list of access items assigned to the identity + items: + discriminator: + propertyName: type + mapping: + ACCESS_PROFILE: ../access/AccessProfileSummary.yaml + ENTITLEMENT: ../access/AccessProfileEntitlement.yaml + ROLE: ../access/AccessProfileRole.yaml + oneOf: + - description: This is a summary representation of an access profile. + allOf: + - allOf: + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + - type: object + properties: + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + description: + type: string + nullable: true + example: null + - type: object + properties: + source: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + owner: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + revocable: + type: boolean + example: true + - description: EntitlementReference + allOf: + - allOf: + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + - type: object + properties: + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + description: + type: string + nullable: true + example: null + - type: object + properties: + source: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + privileged: + type: boolean + example: false + attribute: + type: string + example: memberOf + value: + type: string + example: 'CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + standalone: + type: boolean + example: false + - description: Role + allOf: + - allOf: + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + - type: object + properties: + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + description: + type: string + nullable: true + example: null + - type: object + properties: + owner: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + disabled: + type: boolean + revocable: + type: boolean + accessCount: + type: integer + format: int32 + description: The number of access items assigned to the identity + example: 5 + accessProfileCount: + type: integer + description: The number of access profiles assigned to the identity + example: 1 + entitlementCount: + type: integer + description: The number of entitlements assigned to the identity + example: 10 + roleCount: + type: integer + description: The number of roles assigned to the identity + example: 1 + owns: + type: object + properties: + sources: + type: array + items: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + entitlements: + type: array + items: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + accessProfiles: + type: array + items: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + roles: + type: array + items: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + apps: + type: array + items: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + governanceGroups: + type: array + items: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + fallbackApprover: + type: boolean + example: false + tags: + type: array + items: + type: string + example: + - TAG_1 + - TAG_2 + - description: Role + allOf: + - type: object + required: + - id + - name + - _type + properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + name: + type: string + example: john.doe + _type: + description: |- + Enum representing the currently supported document types. + + Additional values may be added in the future without notice. + type: string + enum: + - accessprofile + - accountactivity + - account + - aggregation + - entitlement + - event + - identity + - role + example: identity + - allOf: + - type: object properties: - type: - description: The type of object being referenced - enum: - - SOURCE - example: SOURCE id: - description: ID of the source + type: string example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. name: - description: Human-readable display name of the source - example: My Source - example: - - type: SOURCE - id: 2c9180855d191c59015d291ceb051111 - name: My Source 1 - - type: SOURCE - id: 2c9180855d191c59015d291ceb052222 - name: My Source 2 - planInitializerScript: - description: This is a reference to a plan initializer script. - type: object - properties: - source: - description: This is a Rule that allows provisioning instruction changes. - type: string - example: | - \r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n - noProvisioningRequests: - description: Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. - type: boolean - example: true - provisioningRequestExpiration: - description: 'When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.' - type: integer - format: int32 - example: 7 - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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. + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + description: + type: string + description: The description of the access item + example: The admin role + created: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + modified: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + synced: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + enabled: + type: boolean + example: true + requestable: + type: boolean + example: true + description: Indicates if the access can be requested + requestCommentsRequired: + type: boolean + description: Indicates if comments are required when requesting access + example: false + owner: + allOf: + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + - type: object + properties: + email: + type: string + example: john.doe@sailpoint.com + description: The email of the identity + - type: object + properties: + accessProfiles: + type: array + items: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + accessProfileCount: + type: integer + tags: + type: array + items: + type: string + example: + - TAG_1 + - TAG_2 examples: - '404': - summary: An example of a 404 response object + accessProfiles: + summary: A collection of AccessProfiles value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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 + - id: 2c9180825a6c1adc015a71c9023f0818 + name: Cloud Eng + _type: accessprofile + description: Cloud Eng + created: '2017-02-24T20:21:23.145Z' + modified: '2019-05-24T20:36:04.312Z' + synced: '2020-02-18T05:30:20.414Z' + enabled: true + requestable: true + requestCommentsRequired: false + owner: + id: ff8081815757d36a015757d42e56031e + name: SailPoint Support + type: IDENTITY + email: cloud-support@sailpoint.com + source: + id: ff8081815757d4fb0157588f3d9d008f + name: Employees + entitlements: + - id: 2c918084575812550157589064f33b89 + name: 'CN=Cloud Engineering,DC=sailpoint,DC=COM' + description: mull + attribute: memberOf + value: 'CN=Cloud Engineering,DC=sailpoint,DC=COM' + entitlementCount: 1 + tags: + - TAG_1 + - TAG_2 + entitlements: + summary: A collection of Entitlements value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - UserContextAuth: - - 'idn:service-desk-admin:read' - - 'idn:service-desk-integration:read' - /service-desk-integrations/status-check-configuration: - get: - tags: - - Service Desk Integration - summary: Get the time check configuration - description: Get the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - operationId: getStatusCheckDetails - responses: - '200': - description: QueuedCheckConfigDetails containing the configured values - content: - application/json: - schema: - description: Configuration of maximum number days and interval for checking Service Desk integration queue status - required: - - provisioningStatusCheckIntervalMinutes - - provisioningMaxStatusCheckDays - type: object - properties: - provisioningStatusCheckIntervalMinutes: - description: interval in minutes between status checks - type: string - example: '30' - provisioningMaxStatusCheckDays: - description: maximum number of days to check - type: string - example: '2' - '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 + - id: 2c9180946ed0c43d016eec1a80892fbd + name: entitlement.aa415ae7 + _type: entitlement + description: 'null' + attribute: groups + value: entitlement.aa415ae7 + modified: '2019-12-09T19:19:50.154Z' + synced: '2020-02-19T04:30:32.906Z' + displayName: entitlement.aa415ae7 + source: + id: 2c91808b6e9e6fb8016eec1a2b6f7b5f + name: ODS-HR-Employees + privileged: false + identityCount: 68 + tags: + - TAG_1 + - TAG_2 + events: + summary: A collection of Events value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object + - id: e092842f-c904-4b59-aac8-2544abeeef4b + name: Update Task Schedule Passed + _type: event + created: '2020-02-17T16:23:18.327Z' + synced: '2020-02-17T16:23:18.388Z' + action: TASK_SCHEDULE_UPDATE_PASSED + type: SYSTEM_CONFIG + actor: + name: MantisTaskScheduler + target: + name: Perform provisioning activity search delete synchronization + stack: tpe + trackingNumber: c6b98bc39ece48b080826d16c76b166c + ipAddress: 207.189.160.158 + details: 'null' + attributes: + sourceName: SailPoint + objects: + - TASK + - SCHEDULE + operation: UPDATE + status: PASSED + technicalName: TASK_SCHEDULE_UPDATE_PASSED + identities: + summary: A collection of Identities value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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 + - id: 2c9180865c45e7e3015c46c434a80622 + name: ad.admin + _type: identity + firstName: AD + lastName: Admin + displayName: AD Admin + email: SLPT.CLOUD.SAILPOINT.TEST+AD-ADMIN@GMAIL.COM + created: '2018-08-22T19:54:54.302Z' + modified: '2018-08-22T19:54:54.302Z' + synced: '2018-08-22T19:54:54.302Z' + phone: 512-942-7578 + inactive: false + protected: false + status: UNREGISTERED + employeeNumber: O349804 + manager: null + isManager: false + identityProfile: + id: 2c918085605c8d0601606f357cb231e6 + name: E2E AD + source: + id: 2c9180855c45b230015c46c19b9c0202 + name: EndToEnd-ADSource + attributes: + uid: ad.admin + firstname: AD + cloudAuthoritativeSource: 2c9180855c45b230015c46c19b9c0202 + cloudStatus: UNREGISTERED + iplanet-am-user-alias-list: null + displayName: AD Admin + internalCloudStatus: UNREGISTERED + workPhone: 512-942-7578 + email: SLPT.CLOUD.SAILPOINT.TEST+AD-ADMIN@GMAIL.COM + lastname: Admin + processingState: null + processingDetails: null + accounts: + - id: 2c9180865c45e7e3015c46c434a80623 + name: ad.admin + accountId: 'CN=AD Admin,OU=slpt-automation,DC=TestAutomationAD,DC=local' + source: + id: 2c9180855c45b230015c46c19b9c0202 + name: EndToEnd-ADSource + type: Active Directory - Direct + disabled: false + locked: false + privileged: false + manuallyCorrelated: false + passwordLastSet: '2018-08-22T19:54:54.302Z' + entitlementAttributes: + memberOf: + - 'CN=Group Policy Creator Owners,CN=Users,DC=TestAutomationAD,DC=local' + - 'CN=Domain Guests,CN=Users,DC=TestAutomationAD,DC=local' + - 'CN=Domain Admins,CN=Users,DC=TestAutomationAD,DC=local' + - 'CN=Enterprise Admins,CN=Users,DC=TestAutomationAD,DC=local' + - 'CN=Schema Admins,CN=Users,DC=TestAutomationAD,DC=local' + - 'CN=Guests,CN=Builtin,DC=TestAutomationAD,DC=local' + - 'CN=Administrators,CN=Builtin,DC=TestAutomationAD,DC=local' + created: '2018-08-22T19:54:54.302Z' + - id: 2c918083606d670c01606f35a30a0349 + name: ad.admin + accountId: ad.admin + source: + id: ff8081815c46b85b015c46b90c7c02a6 + name: IdentityNow + type: IdentityNowConnector + disabled: false + locked: false + privileged: false + manuallyCorrelated: false + passwordLastSet: null + entitlementAttributes: null + created: '2018-08-22T19:54:54.302Z' + accountCount: 2 + apps: + - id: '22751' + name: ADP Workforce Now + source: + id: 2c9180855c45b230015c46e2f6a8026a + name: Corporate Active Directory + account: + id: 2c9180865c45efa4015c470be0de1606 + accountId: 'CN=Bob Wilson,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com' + appCount: 1 + access: + - id: 2c918083634bc6cb01639808d40270ba + name: 'test [AccessProfile-1527264105448]' + displayName: test + type: ACCESS_PROFILE + description: test + source: + id: 2c9180855c45b230015c46c19b9c0202 + name: EndToEnd-ADSource + owner: + id: 2c9180865c45e7e3015c46c434a80622 + name: ad.admin + displayName: AD Admin + - id: 2c9180865c45e7e3015c46c457c50755 + name: Administrators + displayName: Administrators + type: ENTITLEMENT + description: null + source: + id: 2c9180855c45b230015c46c19b9c0202 + name: EndToEnd-ADSource + privileged: false + attribute: memberOf + value: 'CN=Administrators,CN=Builtin,DC=TestAutomationAD,DC=local' + standalone: false + - id: 2c9180865decdaa5015e06598b293108 + name: 'test [cloudRole-1503345085223]' + displayName: test + type: ROLE + description: test + owner: + id: 2c9180865c45e7e3015c46c5030707a0 + name: will.albin + displayName: Albin Will + disabled: false + accessCount: 3 + accessProfileCount: 1 + entitlementCount: 1 + roleCount: 1 + tags: + - TAG_1 + - TAG_2 + roles: + summary: A collection of Roles value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - UserContextAuth: - - 'idn:service-desk-admin:read' - - 'idn:service-desk-integration:read' - put: - tags: - - Service Desk Integration - summary: Update the time check configuration - description: Update the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - operationId: updateStatusCheckDetails - requestBody: - description: the modified time check configuration - content: - application/json: - schema: - description: Configuration of maximum number days and interval for checking Service Desk integration queue status - required: - - provisioningStatusCheckIntervalMinutes - - provisioningMaxStatusCheckDays - type: object - properties: - provisioningStatusCheckIntervalMinutes: - description: interval in minutes between status checks - type: string - example: '30' - provisioningMaxStatusCheckDays: - description: maximum number of days to check - type: string - example: '2' - required: true - responses: - '200': - description: QueuedCheckConfigDetails as updated - content: - application/json: + - id: 2c91808c6faadea6016fb4f2bc69077b + name: IT Role + _type: role + description: IT role + created: '2020-01-17T19:20:15.040Z' + modified: null + synced: '2020-02-18T05:30:20.145Z' + enabled: true + requestable: false + requestCommentsRequired: false + owner: + id: 2c9180a46faadee4016fb4e018c20639 + name: Cloud Support + type: IDENTITY + email: thomas.edison@acme-solar.com + accessProfiles: + - id: 2c91809c6faade77016fb4f0b63407ae + name: Admin Access + accessProfileCount: 1 + tags: + - TAG_1 + - TAG_2 + headers: + X-Total-Count: schema: - description: Configuration of maximum number days and interval for checking Service Desk integration queue status - required: - - provisioningStatusCheckIntervalMinutes - - provisioningMaxStatusCheckDays - type: object - properties: - provisioningStatusCheckIntervalMinutes: - description: interval in minutes between status checks - type: string - example: '30' - provisioningMaxStatusCheckDays: - description: maximum number of days to check - type: string - example: '2' + type: integer + description: The total result count (returned only if the *count* parameter is specified as *true*). + example: 30 '400': description: Client Error - Returned if the request body is invalid. content: @@ -77937,8 +64737,18 @@ paths: - locale: en-US localeOrigin: DEFAULT text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist + '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: @@ -77995,174 +64805,704 @@ paths: description: Actual text of the error message in the indicated locale. example: The request was syntactically correct but its content is semantically invalid. examples: - '404': - summary: An example of a 404 response object + '500': + summary: An example of a 500 response object value: - detailCode: 404 Not found + detailCode: 500.0 Internal Fault trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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: + text: An internal fault occurred. + /search/count: + post: + tags: + - Search + description: Performs a search with a provided query and returns the count of results in the X-Total-Count header. + operationId: searchCount + summary: Count Documents Satisfying a Query + requestBody: + content: + application/json: + schema: + type: object + properties: + indices: + description: 'The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched.' + externalDocs: + description: Learn more about search indices here. + url: 'https://documentation.sailpoint.com/saas/help/search/searchable-fields.html' + type: array + items: + description: |- + Enum representing the currently supported indices. + Additional values may be added in the future without notice. type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: + enum: + - accessprofiles + - accountactivities + - entitlements + - events + - identities + - roles + - '*' + example: identities + example: + - identities + queryType: + description: |- + The type of query to use. By default, the `SAILPOINT` query type is used, which requires the `query` object to be defined in the request body. + To use the `queryDsl` or `typeAheadQuery` objects in the request, you must set the type to `DSL` or `TYPEAHEAD` accordingly. + Additional values may be added in the future without notice. + type: string + enum: + - DSL + - SAILPOINT + - TEXT + - TYPEAHEAD + default: SAILPOINT + example: SAILPOINT + queryVersion: + allOf: + - description: The current Elasticserver version. + type: string + default: '5.2' + example: '5.2' + - type: string + description: |- + The version of the query object. + This version number will map to the version of Elasticsearch for the query strings and objects being used. + query: + type: object + description: Query parameters used to construct an Elasticsearch query object. + properties: + query: + description: 'The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.' + type: string + example: 'name:a*' + fields: + description: The fields to which the specified query will be applied. The available fields are dependent on the indice(s) being searched on. Please refer to the response schema of this API for a list of available fields. + type: array + items: + type: string + example: + - name + timeZone: + description: The time zone to be applied to any range query related to dates. + type: string + example: America/Chicago + innerHit: + description: The innerHit query object returns a flattened list of results for the specified nested type. type: object + required: + - query + - type properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: + query: + description: 'The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.' 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: + example: 'source.name:\"Active Directory\"' + type: + description: 'The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document "nested" within another document. For example, an identity can have nested documents for access, accounts, and apps.' 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 + example: access + queryDsl: + description: 'The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax.' + type: object + example: + match: + name: john.doe + textQuery: + type: object + description: Query parameters used to construct an Elasticsearch text query object. + required: + - terms + - fields + properties: + terms: + description: Words or characters that specify a particular thing to be searched for. + type: array + items: + type: string + example: + - The quick brown fox + - '3141592' + - '7' + fields: + description: The fields to be searched. + type: array + items: + type: string + example: + - displayName + - employeeNumber + - roleCount + matchAny: + description: 'Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found.' + type: boolean + default: false + example: false + contains: + description: 'Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms.' + type: boolean + default: false + example: true + typeAheadQuery: + type: object + description: 'Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing "Jo" results in top hits matching "Jo." Typing "Job" results in top hits matching "Job." ' + required: + - query + - field + properties: + query: + description: The type ahead query string used to construct a phrase prefix match query. + type: string + example: Work + field: + description: The field on which to perform the type ahead search. + type: string + example: source.name + nestedType: + description: The nested type. + type: string + example: access + maxExpansions: + description: |- + The number of suffixes the last term will be expanded into. + Influences the performance of the query and the number results returned. + Valid values: 1 to 1000. + type: integer + format: int32 + minimum: 1 + maximum: 1000 + default: 10 + example: 10 + includeNested: + description: Indicates whether nested objects from returned search results should be included. + type: boolean + default: true + example: true + queryResultFilter: + type: object + description: Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents. + properties: + includes: + description: The list of field names to include in the result documents. + type: array + items: + type: string + example: + - name + - displayName + excludes: + description: The list of field names to exclude from the result documents. + type: array + items: + type: string + example: + - stacktrace + aggregationType: + description: | + Enum representing the currently available query languages for aggregations, which are used to perform calculations or groupings on search results. + + Additional values may be added in the future without notice. + type: string + enum: + - DSL + - SAILPOINT + default: DSL + example: DSL + aggregationsVersion: + allOf: + - description: The current Elasticserver version. + type: string + default: '5.2' + example: '5.2' + - type: string + description: |- + The version of the language being used for aggregation queries. + This version number will map to the version of Elasticsearch for the aggregation query object. + aggregationsDsl: + description: 'The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax.' + type: object + example: {} + aggregations: + description: | + The aggregation’s specifications, such as the groupings and calculations to be performed. + allOf: + - type: object + properties: + nested: + type: object + description: The nested aggregation object. + required: + - name + - type + properties: + name: + description: The name of the nested aggregate to be included in the result. + type: string + example: id + type: + description: The type of the nested object. + type: string + example: access + metric: + type: object + description: The calculation done on the results of the query + required: + - name + - field + properties: + name: + description: |- + The name of the metric aggregate to be included in the result. + If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. + type: string + example: Access Name Count + type: + description: |- + Enum representing the currently supported metric aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - COUNT + - UNIQUE_COUNT + - AVG + - SUM + - MEDIAN + - MIN + - MAX + default: UNIQUE_COUNT + example: COUNT + field: + description: | + The field the calculation is performed on. + + Prefix the field name with '@' to reference a nested object. + type: string + example: '@access.name' + filter: + type: object + description: An additional filter to constrain the results of the search query. + required: + - name + - field + - value + properties: + name: + description: The name of the filter aggregate to be included in the result. + type: string + example: Entitlements + type: + description: |- + Enum representing the currently supported filter aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - TERM + default: TERM + example: TERM + field: + description: | + The search field to apply the filter to. + + Prefix the field name with '@' to reference a nested object. + type: string + example: access.type + value: + description: The value to filter on. + type: string + example: ENTITLEMENT + bucket: + type: object + description: The bucket to group the results of the aggregation query by. + required: + - name + - field + properties: + name: + description: The name of the bucket aggregate to be included in the result. + type: string + example: Identity Locations + type: + description: |- + Enum representing the currently supported bucket aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - TERMS + default: TERMS + example: TERMS + field: + description: |- + The field to bucket on. + Prefix the field name with '@' to reference a nested object. + type: string + example: attributes.city + size: + description: Maximum number of buckets to include. + type: integer + format: int32 + example: 100 + minDocCount: + description: Minimum number of documents a bucket should have. + type: integer + format: int32 + example: 2 + - 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. - security: - - UserContextAuth: - - 'idn:service-desk-admin:manage' - - 'idn:service-desk-integration:manage' - /query-password-info: - post: - operationId: queryPasswordInfo - tags: - - Password Management - summary: Query Password Info - description: | - This API is used to query password related information. + subAggregation: + description: Aggregation to be performed on the result of the parent bucket aggregation. + allOf: + - type: object + properties: + nested: + type: object + description: The nested aggregation object. + required: + - name + - type + properties: + name: + description: The name of the nested aggregate to be included in the result. + type: string + example: id + type: + description: The type of the nested object. + type: string + example: access + metric: + type: object + description: The calculation done on the results of the query + required: + - name + - field + properties: + name: + description: |- + The name of the metric aggregate to be included in the result. + If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. + type: string + example: Access Name Count + type: + description: |- + Enum representing the currently supported metric aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - COUNT + - UNIQUE_COUNT + - AVG + - SUM + - MEDIAN + - MIN + - MAX + default: UNIQUE_COUNT + example: COUNT + field: + description: | + The field the calculation is performed on. - A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) - is required to call this API. "API authority" refers to a token that only has the "client_credentials" - grant type, and therefore no user context. A [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) - or a token generated with the [authorization_code](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) - grant type will **NOT** work on this endpoint, and a `403 Forbidden` response - will be returned. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - userName: - type: string - description: The login name of the user - example: Abby.Smith - sourceName: - type: string - description: The display name of the source - example: My-AD - responses: - '200': - description: Reference to the password info. - content: - application/json: - schema: - type: object - properties: - identityId: - type: string - description: Identity ID - example: 2c918085744fec4301746f9a5bce4605 - sourceId: - type: string - description: source ID - example: 2c918083746f642c01746f990884012a - publicKeyId: + Prefix the field name with '@' to reference a nested object. + type: string + example: '@access.name' + filter: + type: object + description: An additional filter to constrain the results of the search query. + required: + - name + - field + - value + properties: + name: + description: The name of the filter aggregate to be included in the result. + type: string + example: Entitlements + type: + description: |- + Enum representing the currently supported filter aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - TERM + default: TERM + example: TERM + field: + description: | + The search field to apply the filter to. + + Prefix the field name with '@' to reference a nested object. + type: string + example: access.type + value: + description: The value to filter on. + type: string + example: ENTITLEMENT + bucket: + type: object + description: The bucket to group the results of the aggregation query by. + required: + - name + - field + properties: + name: + description: The name of the bucket aggregate to be included in the result. + type: string + example: Identity Locations + type: + description: |- + Enum representing the currently supported bucket aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - TERMS + default: TERMS + example: TERMS + field: + description: |- + The field to bucket on. + Prefix the field name with '@' to reference a nested object. + type: string + example: attributes.city + size: + description: Maximum number of buckets to include. + type: integer + format: int32 + example: 100 + minDocCount: + description: Minimum number of documents a bucket should have. + type: integer + format: int32 + example: 2 + - type: object + properties: + subAggregation: + description: Aggregation to be performed on the result of the parent bucket aggregation. + type: object + properties: + nested: + type: object + description: The nested aggregation object. + required: + - name + - type + properties: + name: + description: The name of the nested aggregate to be included in the result. + type: string + example: id + type: + description: The type of the nested object. + type: string + example: access + metric: + type: object + description: The calculation done on the results of the query + required: + - name + - field + properties: + name: + description: |- + The name of the metric aggregate to be included in the result. + If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. + type: string + example: Access Name Count + type: + description: |- + Enum representing the currently supported metric aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - COUNT + - UNIQUE_COUNT + - AVG + - SUM + - MEDIAN + - MIN + - MAX + default: UNIQUE_COUNT + example: COUNT + field: + description: | + The field the calculation is performed on. + + Prefix the field name with '@' to reference a nested object. + type: string + example: '@access.name' + filter: + type: object + description: An additional filter to constrain the results of the search query. + required: + - name + - field + - value + properties: + name: + description: The name of the filter aggregate to be included in the result. + type: string + example: Entitlements + type: + description: |- + Enum representing the currently supported filter aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - TERM + default: TERM + example: TERM + field: + description: | + The search field to apply the filter to. + + Prefix the field name with '@' to reference a nested object. + type: string + example: access.type + value: + description: The value to filter on. + type: string + example: ENTITLEMENT + bucket: + type: object + description: The bucket to group the results of the aggregation query by. + required: + - name + - field + properties: + name: + description: The name of the bucket aggregate to be included in the result. + type: string + example: Identity Locations + type: + description: |- + Enum representing the currently supported bucket aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - TERMS + default: TERMS + example: TERMS + field: + description: |- + The field to bucket on. + Prefix the field name with '@' to reference a nested object. + type: string + example: attributes.city + size: + description: Maximum number of buckets to include. + type: integer + format: int32 + example: 100 + minDocCount: + description: Minimum number of documents a bucket should have. + type: integer + format: int32 + example: 2 + sort: + description: The fields to be used to sort the search results. Use + or - to specify the sort direction. + type: array + items: type: string - description: public key ID - example: N2M1OTJiMGEtMDJlZS00ZWU3LTkyYTEtNjA5YmI5NWE3ZWVh - publicKey: + example: + - displayName + - +id + searchAfter: + description: |- + Used to begin the search window at the values specified. + This parameter consists of the last values of the sorted fields in the current record set. + This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. + It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging. + For example, when searching for identities, if you are sorting by displayName you will also want to include ID, for example ["displayName", "id"]. + If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is "John Doe", then using that displayName and ID will start a new search after this identity. + The searchAfter value will look like ["John Doe","2c91808375d8e80a0175e1f88a575221"] + type: array + items: type: string - description: User's public key with Base64 encoding - example: MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuGFkWi2J75TztpbaPKd36bJnIB3J8gZ6UcoS9oSDYsqBzPpTsfZXYaEf4Y4BKGgJIXmE/lwhwuj7mU1itdZ2qTSNFtnXA8Fn75c3UUkk+h+wdZbkuSmqlsJo3R1OnJkwkJggcAy9Jvk9jlcrNLWorpQ1w9raUvxtvfgkSdq153KxotenQ1HciSyZ0nA/Kw0UaucLnho8xdRowZs11afXGXA9IT9H6D8T6zUdtSxm0nAyH+mluma5LdTfaM50W3l/L8q56Vrqmx2pZIiwdx/0+g3Y++jV70zom0ZBkC1MmSoLMrQYG5OICNjr72f78B2PaGXfarQHqARLjKpMVt9YIQIDAQAB - accounts: - type: array - description: Account info related to queried identity and source - items: - type: object - properties: - accountId: - type: string - description: 'Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350' - example: 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com' - accountName: - type: string - description: 'Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008' - example: Abby.Smith - policies: - type: array - description: Password constraints - items: - type: string - example: - - passwordRepeatedChar is 3 - - passwordMinAlpha is 1 - - passwordMinLength is 5 - - passwordMinNumeric is 1 + example: + - John Doe + - 2c91808375d8e80a0175e1f88a575221 + filters: + description: The filters to be applied for each filtered field name. + type: object + additionalProperties: + type: object + properties: + type: + description: |- + Enum representing the currently supported filter types. + Additional values may be added in the future without notice. + type: string + enum: + - EXISTS + - RANGE + - TERMS + example: RANGE + range: + type: object + description: The range of values to be filtered. + properties: + lower: + description: The lower bound of the range. + type: object + required: + - value + properties: + value: + description: The value of the range's endpoint. + type: string + example: '1' + inclusive: + description: Indicates if the endpoint is included in the range. + type: boolean + default: false + example: false + upper: + description: The upper bound of the range. + type: object + required: + - value + properties: + value: + description: The value of the range's endpoint. + type: string + example: '1' + inclusive: + description: Indicates if the endpoint is included in the range. + type: boolean + default: false + example: false + terms: + description: The terms to be filtered. + type: array + items: + type: string + example: account_count + exclude: + description: Indicates if the filter excludes results. + type: boolean + default: false + example: false + example: {} + examples: + query-timeZone: + summary: Query with TimeZone + value: + indices: + - identities + query: + query: 'created: [2022-05-19T19:26:03.351Z TO now]' + timeZone: America/Los_Angeles + required: true + responses: + '204': + description: No content - indicates the request was successful but there is no content to be returned in the response. + headers: + X-Total-Count: + description: The total result count. + schema: + type: integer + example: 5 '400': description: Client Error - Returned if the request body is invalid. content: @@ -78374,689 +65714,2875 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - /set-password: + /search/aggregate: post: - operationId: setPassword tags: - - Password Management - summary: Set Identity's Password - description: | - This API is used to set a password for an identity. - - An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their IDN user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). - - A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity's password or the password of any of the identity's accounts. - "API authority" refers to a token that only has the "client_credentials" grant type. - - You can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). - To do so, follow these steps: - - 1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. - - 2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. - - 3. Use [Set Identity's Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password: - - ```java - import javax.crypto.Cipher; - import java.security.KeyFactory; - import java.security.PublicKey; - import java.security.spec.X509EncodedKeySpec; - import java util.Base64; - - String encrypt(String publicKey, String toEncrypt) throws Exception { - byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey); - byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes("UTF-8")); - return Base64.getEncoder().encodeToString(encryptedBytes); - } - - private byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception { - PublicKey key = KeyFactory.getInstance("RSA").generatePublic(new X509EncodedKeySpec(publicKeyBytes)); - String transformation = "RSA/ECB/PKCS1Padding"; - Cipher cipher = Cipher.getInstance(transformation); - cipher.init(1, key); - return cipher.doFinal(toEncryptBytes); - } - ``` + - Search + description: 'Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. ' + operationId: searchAggregate + summary: Perform a Search Query Aggregation + parameters: + - 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: 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: 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. - In this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. + 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. - You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. + 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 requestBody: - required: true content: application/json: schema: type: object properties: - identityId: - type: string - description: The identity ID that requested the password change - example: 8a807d4c73c545510173c545f0a002ff - encryptedPassword: - type: string - description: The RSA encrypted password - example: XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A== - publicKeyId: - type: string - description: The encryption key ID - example: YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2 - accountId: - type: string - description: 'Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350' - example: 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com' - sourceId: - type: string - description: The ID of the source for which identity is requesting the password change - example: 8a807d4c73c545510173c545d4b60246 - responses: - '202': - description: Reference to the password change. - content: - application/json: - schema: - type: object - properties: - requestId: - type: string - nullable: true - description: The password change request ID - example: 089899f13a8f4da7824996191587bab9 - state: - type: string - enum: - - IN_PROGRESS - - FINISHED - - FAILED - description: Password change state - example: IN_PROGRESS - '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. - '/password-change-status/{id}': - get: - operationId: getPasswordChangeStatus - tags: - - Password Management - summary: Get Password Change Request Status - description: This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API. - parameters: - - in: path - name: id - schema: - type: string - required: true - example: 089899f13a8f4da7824996191587bab9 - description: Password change request ID - responses: - '200': - description: Status of the password change request - content: - application/json: - schema: - type: object - properties: - requestId: - type: string - nullable: true - description: The password change request ID - example: 089899f13a8f4da7824996191587bab9 - state: + indices: + description: 'The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched.' + externalDocs: + description: Learn more about search indices here. + url: 'https://documentation.sailpoint.com/saas/help/search/searchable-fields.html' + type: array + items: + description: |- + Enum representing the currently supported indices. + Additional values may be added in the future without notice. type: string enum: - - IN_PROGRESS - - FINISHED - - FAILED - description: Password change state - example: IN_PROGRESS - errors: - type: array - items: + - accessprofiles + - accountactivities + - entitlements + - events + - identities + - roles + - '*' + example: identities + example: + - identities + queryType: + description: |- + The type of query to use. By default, the `SAILPOINT` query type is used, which requires the `query` object to be defined in the request body. + To use the `queryDsl` or `typeAheadQuery` objects in the request, you must set the type to `DSL` or `TYPEAHEAD` accordingly. + Additional values may be added in the future without notice. + type: string + enum: + - DSL + - SAILPOINT + - TEXT + - TYPEAHEAD + default: SAILPOINT + example: SAILPOINT + queryVersion: + allOf: + - description: The current Elasticserver version. type: string - description: The errors during the password change request - example: - - The password change payload is invalid - sourceIds: - type: array - items: + default: '5.2' + example: '5.2' + - type: string + description: |- + The version of the query object. + This version number will map to the version of Elasticsearch for the query strings and objects being used. + query: + type: object + description: Query parameters used to construct an Elasticsearch query object. + properties: + query: + description: 'The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.' type: string - description: List of source IDs in the password change request - example: - - 2c918083746f642c01746f990884012a - '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: + example: 'name:a*' + fields: + description: The fields to which the specified query will be applied. The available fields are dependent on the indice(s) being searched on. Please refer to the response schema of this API for a list of available fields. + type: array + items: + type: string + example: + - name + timeZone: + description: The time zone to be applied to any range query related to dates. + type: string + example: America/Chicago + innerHit: + description: The innerHit query object returns a flattened list of results for the specified nested type. type: object + required: + - query + - type properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: + query: + description: 'The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.' 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: + example: 'source.name:\"Active Directory\"' + type: + description: 'The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document "nested" within another document. For example, an identity can have nested documents for access, accounts, and apps.' 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 + example: access + queryDsl: + description: 'The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax.' + type: object + example: + match: + name: john.doe + textQuery: + type: object + description: Query parameters used to construct an Elasticsearch text query object. + required: + - terms + - fields + properties: + terms: + description: Words or characters that specify a particular thing to be searched for. + type: array + items: + type: string + example: + - The quick brown fox + - '3141592' + - '7' + fields: + description: The fields to be searched. + type: array + items: + type: string + example: + - displayName + - employeeNumber + - roleCount + matchAny: + description: 'Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found.' + type: boolean + default: false + example: false + contains: + description: 'Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms.' + type: boolean + default: false + example: true + typeAheadQuery: + type: object + description: 'Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing "Jo" results in top hits matching "Jo." Typing "Job" results in top hits matching "Job." ' + required: + - query + - field + properties: + query: + description: The type ahead query string used to construct a phrase prefix match query. + type: string + example: Work + field: + description: The field on which to perform the type ahead search. + type: string + example: source.name + nestedType: + description: The nested type. + type: string + example: access + maxExpansions: + description: |- + The number of suffixes the last term will be expanded into. + Influences the performance of the query and the number results returned. + Valid values: 1 to 1000. + type: integer + format: int32 + minimum: 1 + maximum: 1000 + default: 10 + example: 10 + includeNested: + description: Indicates whether nested objects from returned search results should be included. + type: boolean + default: true + example: true + queryResultFilter: + type: object + description: Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents. + properties: + includes: + description: The list of field names to include in the result documents. + type: array + items: + type: string + example: + - name + - displayName + excludes: + description: The list of field names to exclude from the result documents. + type: array + items: + type: string + example: + - stacktrace + aggregationType: + description: | + Enum representing the currently available query languages for aggregations, which are used to perform calculations or groupings on search results. + + Additional values may be added in the future without notice. + type: string + enum: + - DSL + - SAILPOINT + default: DSL + example: DSL + aggregationsVersion: + allOf: + - description: The current Elasticserver version. + type: string + default: '5.2' + example: '5.2' + - type: string + description: |- + The version of the language being used for aggregation queries. + This version number will map to the version of Elasticsearch for the aggregation query object. + aggregationsDsl: + description: 'The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax.' + type: object + example: {} + aggregations: + description: | + The aggregation’s specifications, such as the groupings and calculations to be performed. + allOf: + - 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 + nested: + type: object + description: The nested aggregation object. + required: + - name + - type + properties: + name: + description: The name of the nested aggregate to be included in the result. + type: string + example: id + type: + description: The type of the nested object. + type: string + example: access + metric: + type: object + description: The calculation done on the results of the query + required: + - name + - field + properties: + name: + description: |- + The name of the metric aggregate to be included in the result. + If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. + type: string + example: Access Name Count + type: + description: |- + Enum representing the currently supported metric aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - COUNT + - UNIQUE_COUNT + - AVG + - SUM + - MEDIAN + - MIN + - MAX + default: UNIQUE_COUNT + example: COUNT + field: + description: | + The field the calculation is performed on. + + Prefix the field name with '@' to reference a nested object. + type: string + example: '@access.name' + filter: + type: object + description: An additional filter to constrain the results of the search query. + required: + - name + - field + - value + properties: + name: + description: The name of the filter aggregate to be included in the result. + type: string + example: Entitlements + type: + description: |- + Enum representing the currently supported filter aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - TERM + default: TERM + example: TERM + field: + description: | + The search field to apply the filter to. + + Prefix the field name with '@' to reference a nested object. + type: string + example: access.type + value: + description: The value to filter on. + type: string + example: ENTITLEMENT + bucket: + type: object + description: The bucket to group the results of the aggregation query by. + required: + - name + - field + properties: + name: + description: The name of the bucket aggregate to be included in the result. + type: string + example: Identity Locations + type: + description: |- + Enum representing the currently supported bucket aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - TERMS + default: TERMS + example: TERMS + field: + description: |- + The field to bucket on. + Prefix the field name with '@' to reference a nested object. + type: string + example: attributes.city + size: + description: Maximum number of buckets to include. + type: integer + format: int32 + example: 100 + minDocCount: + description: Minimum number of documents a bucket should have. + type: integer + format: int32 + example: 2 + - 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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: + subAggregation: + description: Aggregation to be performed on the result of the parent bucket aggregation. + allOf: + - type: object + properties: + nested: + type: object + description: The nested aggregation object. + required: + - name + - type + properties: + name: + description: The name of the nested aggregate to be included in the result. + type: string + example: id + type: + description: The type of the nested object. + type: string + example: access + metric: + type: object + description: The calculation done on the results of the query + required: + - name + - field + properties: + name: + description: |- + The name of the metric aggregate to be included in the result. + If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. + type: string + example: Access Name Count + type: + description: |- + Enum representing the currently supported metric aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - COUNT + - UNIQUE_COUNT + - AVG + - SUM + - MEDIAN + - MIN + - MAX + default: UNIQUE_COUNT + example: COUNT + field: + description: | + The field the calculation is performed on. + + Prefix the field name with '@' to reference a nested object. + type: string + example: '@access.name' + filter: + type: object + description: An additional filter to constrain the results of the search query. + required: + - name + - field + - value + properties: + name: + description: The name of the filter aggregate to be included in the result. + type: string + example: Entitlements + type: + description: |- + Enum representing the currently supported filter aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - TERM + default: TERM + example: TERM + field: + description: | + The search field to apply the filter to. + + Prefix the field name with '@' to reference a nested object. + type: string + example: access.type + value: + description: The value to filter on. + type: string + example: ENTITLEMENT + bucket: + type: object + description: The bucket to group the results of the aggregation query by. + required: + - name + - field + properties: + name: + description: The name of the bucket aggregate to be included in the result. + type: string + example: Identity Locations + type: + description: |- + Enum representing the currently supported bucket aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - TERMS + default: TERMS + example: TERMS + field: + description: |- + The field to bucket on. + Prefix the field name with '@' to reference a nested object. + type: string + example: attributes.city + size: + description: Maximum number of buckets to include. + type: integer + format: int32 + example: 100 + minDocCount: + description: Minimum number of documents a bucket should have. + type: integer + format: int32 + example: 2 + - type: object + properties: + subAggregation: + description: Aggregation to be performed on the result of the parent bucket aggregation. + type: object + properties: + nested: + type: object + description: The nested aggregation object. + required: + - name + - type + properties: + name: + description: The name of the nested aggregate to be included in the result. + type: string + example: id + type: + description: The type of the nested object. + type: string + example: access + metric: + type: object + description: The calculation done on the results of the query + required: + - name + - field + properties: + name: + description: |- + The name of the metric aggregate to be included in the result. + If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. + type: string + example: Access Name Count + type: + description: |- + Enum representing the currently supported metric aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - COUNT + - UNIQUE_COUNT + - AVG + - SUM + - MEDIAN + - MIN + - MAX + default: UNIQUE_COUNT + example: COUNT + field: + description: | + The field the calculation is performed on. + + Prefix the field name with '@' to reference a nested object. + type: string + example: '@access.name' + filter: + type: object + description: An additional filter to constrain the results of the search query. + required: + - name + - field + - value + properties: + name: + description: The name of the filter aggregate to be included in the result. + type: string + example: Entitlements + type: + description: |- + Enum representing the currently supported filter aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - TERM + default: TERM + example: TERM + field: + description: | + The search field to apply the filter to. + + Prefix the field name with '@' to reference a nested object. + type: string + example: access.type + value: + description: The value to filter on. + type: string + example: ENTITLEMENT + bucket: + type: object + description: The bucket to group the results of the aggregation query by. + required: + - name + - field + properties: + name: + description: The name of the bucket aggregate to be included in the result. + type: string + example: Identity Locations + type: + description: |- + Enum representing the currently supported bucket aggregation types. + Additional values may be added in the future without notice. + type: string + enum: + - TERMS + default: TERMS + example: TERMS + field: + description: |- + The field to bucket on. + Prefix the field name with '@' to reference a nested object. + type: string + example: attributes.city + size: + description: Maximum number of buckets to include. + type: integer + format: int32 + example: 100 + minDocCount: + description: Minimum number of documents a bucket should have. + type: integer + format: int32 + example: 2 + sort: + description: The fields to be used to sort the search results. Use + or - to specify the sort direction. + type: array + items: type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: + example: + - displayName + - +id + searchAfter: + description: |- + Used to begin the search window at the values specified. + This parameter consists of the last values of the sorted fields in the current record set. + This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. + It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging. + For example, when searching for identities, if you are sorting by displayName you will also want to include ID, for example ["displayName", "id"]. + If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is "John Doe", then using that displayName and ID will start a new search after this identity. + The searchAfter value will look like ["John Doe","2c91808375d8e80a0175e1f88a575221"] + type: array + items: 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: + example: + - John Doe + - 2c91808375d8e80a0175e1f88a575221 + filters: + description: The filters to be applied for each filtered field name. + type: object + additionalProperties: + type: object + properties: + type: + description: |- + Enum representing the currently supported filter types. + Additional values may be added in the future without notice. + type: string + enum: + - EXISTS + - RANGE + - TERMS + example: RANGE + range: + type: object + description: The range of values to be filtered. + properties: + lower: + description: The lower bound of the range. + type: object + required: + - value + properties: + value: + description: The value of the range's endpoint. + type: string + example: '1' + inclusive: + description: Indicates if the endpoint is included in the range. + type: boolean + default: false + example: false + upper: + description: The upper bound of the range. + type: object + required: + - value + properties: + value: + description: The value of the range's endpoint. + type: string + example: '1' + inclusive: + description: Indicates if the endpoint is included in the range. + type: boolean + default: false + example: false + terms: + description: The terms to be filtered. + type: array + items: 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. + example: account_count + exclude: + description: Indicates if the filter excludes results. + type: boolean + default: false + example: false + example: {} + examples: + metricAggregation: + summary: MetricAggregation + value: + indices: + - aggregations + aggregationType: SAILPOINT + aggregations: + metric: + name: How Many Locations + type: UNIQUE_COUNT + field: attributes.city + metricAggregation-dsl: + summary: MetricAggregation using DSL + value: + indices: + - aggregations + aggregationType: DSL + aggregationsDsl: + How Many Locations: + cardinality: + field: attributes.city.exact + bucketAggregation: + summary: BucketAggregation + value: + indices: + - aggregations + aggregationType: SAILPOINT + aggregations: + bucket: + name: Identity Locations + type: TERMS + field: attributes.city + bucketAggregation-dsl: + summary: BucketAggregation using DSL + value: + indices: + - aggregations + aggregationType: DSL + aggregationsDsl: + Identity Locations: + terms: + field: attributes.city.exact + nestedAggregation-bucketAggregation: + summary: NestedAggregation with BucketAggregation + value: + indices: + - aggregations + aggregationType: SAILPOINT + aggregations: + nested: + name: Access + field: access + type: TERMS + bucket: + name: Access Source Name + type: TERMS + field: access.source.name + nestedAggregation-bucketAggregation-dsl: + summary: NestedAggregation with BucketAggregation using DSL + value: + indices: + - aggregations + aggregationType: DSL + aggregationsDsl: + access: + nested: + path: access + aggs: + Access Source Name: + terms: + field: access.source.name.exact + nestedAggregation-filterAggregation-bucketAggregation: + summary: NestedAggregation with FilterAggregation and BucketAggregation + value: + indices: + - aggregations + aggregationType: SAILPOINT + aggregations: + nested: + name: Access + field: access + type: TERMS + filter: + name: Entitlements + field: access.type + value: ENTITLEMENT + bucket: + name: Access Name + type: TERMS + field: access.name + nestedAggregation-filterAggregation-bucketAggregation-dsl: + summary: NestedAggregation with FilterAggregation and BucketAggregation using DSL + value: + indices: + - aggregations + aggregationType: DSL + aggregationsDsl: + access: + nested: + path: access + aggs: + Entitlements: + filter: + term: + access.type: ENTITLEMENT + aggs: + Access Name: + terms: + field: access.name.exact + bucketAggregation-subAggregation: + summary: BucketAggregation with SubAggregation + value: + indices: + - aggregations + aggregationType: SAILPOINT + aggregations: + bucket: + name: Identity Department + type: TERMS + field: attributes.department + subAggregation: + bucket: + name: Identity Locations + type: TERMS + field: attributes.city + bucketAggregation-subAggregation-dsl: + summary: BucketAggregation with SubAggregation using DSL + value: + indices: + - aggregations + aggregationType: DSL + aggregationsDsl: + Identity Department: + terms: + field: attributes.department.exact + aggs: + Identity Locations: + terms: + field: attributes.city.exact + required: true + responses: + '200': + description: Aggregation results. 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: + aggregations: + type: object + description: | + The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run. + + See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information. + example: + Identity Locations: + buckets: + - key: Austin + doc_count: 109 + - key: London + doc_count: 64 + - key: San Jose + doc_count: 27 + - key: Brussels + doc_count: 26 + - key: Sao Paulo + doc_count: 24 + - key: Munich + doc_count: 23 + - key: Singapore + doc_count: 22 + - key: Tokyo + doc_count: 20 + - key: Taipei + doc_count: 16 + hits: + description: | + The results of the aggregation search query. 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. - /password-dictionary: - get: - operationId: getPasswordDictionary - tags: - - Password Dictionary - summary: Get Password Dictionary - description: |- - This gets password dictionary for the organization. - A token with ORG_ADMIN authority is required to call this API. - security: - - UserContextAuth: - - 'idn:password-dictionary-management:read' - responses: - '200': - description: |- - - The password dictionary file can contain lines that are: - 1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing - 2. empty lines - 3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines - 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; - maximum length of the line is 128 Unicode codepoints - + discriminator: + propertyName: _type + mapping: + accessprofile: ../model/access/profile/AccessProfileDocument.yaml + accountactivity: ../model/account/activity/AccountActivityDocument.yaml + account: ../model/account/AccountDocument.yaml + aggregation: ../model/aggregation/AggregationDocument.yaml + entitlement: ../model/entitlement/EntitlementDocument.yaml + event: ../model/event/EventDocument.yaml + identity: ../model/identity/IdentityDocument.yaml + role: ../model/role/RoleDocument.yaml + oneOf: + - description: 'This is more of a complete representation of an access profile. ' + allOf: + - type: object + required: + - id + - name + - _type + properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + name: + type: string + example: john.doe + _type: + description: |- + Enum representing the currently supported document types. - Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). - Password dict file must contain UTF-8 characters only. + Additional values may be added in the future without notice. + type: string + enum: + - accessprofile + - accountactivity + - account + - aggregation + - entitlement + - event + - identity + - role + example: identity + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + description: + type: string + description: The description of the access item + example: The admin role + created: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + modified: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + synced: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + enabled: + type: boolean + example: true + requestable: + type: boolean + example: true + description: Indicates if the access can be requested + requestCommentsRequired: + type: boolean + description: Indicates if comments are required when requesting access + example: false + owner: + allOf: + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + - type: object + properties: + email: + type: string + example: john.doe@sailpoint.com + description: The email of the identity + - type: object + properties: + source: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + entitlements: + type: array + items: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + description: + type: string + description: A description of the entitlement + example: The admin privilege + attribute: + type: string + description: The name of the entitlement attribute + example: admin + value: + type: string + description: The value of the entitlement + example: 'true' + entitlementCount: + type: integer + example: 5 + tags: + type: array + items: + type: string + example: + - TAG_1 + - TAG_2 + - description: AccountActivity + allOf: + - type: object + required: + - id + - name + - _type + properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + name: + type: string + example: john.doe + _type: + description: |- + Enum representing the currently supported document types. - # Sample password text file + Additional values may be added in the future without notice. + type: string + enum: + - accessprofile + - accountactivity + - account + - aggregation + - entitlement + - event + - identity + - role + example: identity + - type: object + properties: + action: + type: string + description: The type of action that this activity performed + externalDocs: + description: Learn more about account activity action types + url: 'https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data' + example: Identity Refresh. + created: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + modified: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + stage: + type: string + description: The current stage of the activity + example: Completed + origin: + type: string + nullable: true + example: null + status: + type: string + description: the current status of the activity + example: Complete + requester: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + recipient: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + trackingNumber: + type: string + example: 61aad0c9e8134eca89e76a35e0cabe3f + errors: + type: array + items: + type: string + nullable: true + example: null + warnings: + type: array + items: + type: string + nullable: true + example: null + approvals: + type: array + items: + type: object + properties: + comments: + type: array + items: + type: object + properties: + comment: + type: string + description: The comment text + example: This request was autoapproved by our automated ETS subscriber. + commenter: + type: string + description: The name of the commenter + example: Automated AR Approval + date: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + created: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + modified: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + owner: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + result: + type: string + description: The result of the approval + example: Finished + type: + type: string + nullable: true + example: null + originalRequests: + type: array + items: + type: object + properties: + accountId: + type: string + description: the account id + example: 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com' + attributeRequests: + type: array + items: + type: object + properties: + name: + type: string + description: The attribute name + example: groups + op: + type: string + description: The operation to perform + example: Add + value: + type: string + description: The value of the attribute + example: '3203537556531076' + op: + type: string + description: the operation that was used + example: add + source: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + expansionItems: + type: array + items: + type: object + properties: + accountId: + type: string + description: The ID of the account + example: 2c91808981f58ea601821c3e93482e6f + cause: + type: string + example: Role + name: + type: string + description: The name of the item + example: smartsheet-role + attributeRequests: + type: array + items: + type: object + properties: + name: + type: string + description: The attribute name + example: groups + op: + type: string + description: The operation to perform + example: Add + value: + type: string + description: The value of the attribute + example: '3203537556531076' + source: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + accountRequests: + type: array + items: + type: object + properties: + accountId: + type: string + description: Unique ID of the account + example: John.Doe + attributeRequests: + type: array + items: + type: object + properties: + name: + type: string + description: The attribute name + example: groups + op: + type: string + description: The operation to perform + example: Add + value: + type: string + description: The value of the attribute + example: '3203537556531076' + op: + type: string + example: Modify + description: The operation that was performed + provisioningTarget: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + result: + type: object + properties: + errors: + type: array + items: + type: string + example: |- + [ConnectorError] [ + { + "code": "unrecognized_keys", + "keys": [ + "groups" + ], + "path": [], + "message": "Unrecognized key(s) in object: 'groups'" + } + ] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e) + status: + type: string + description: The status of the account request + example: failed + ticketId: + type: string + nullable: true + example: null + source: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + sources: + type: string + example: 'smartsheet-test, airtable-v4, IdentityNow' + - description: Account + allOf: + - type: object + required: + - id + - name + - _type + properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + name: + type: string + example: john.doe + _type: + description: |- + Enum representing the currently supported document types. - ``` + Additional values may be added in the future without notice. + type: string + enum: + - accessprofile + - accountactivity + - account + - aggregation + - entitlement + - event + - identity + - role + example: identity + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + accountId: + type: string + description: The ID of the account + example: john.doe + source: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + disabled: + type: boolean + description: Indicates if the account is disabled + example: false + locked: + type: boolean + description: Indicates if the account is locked + example: false + privileged: + type: boolean + example: false + manuallyCorrelated: + type: boolean + description: Indicates if the account has been manually correlated to an identity + example: false + passwordLastSet: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + entitlementAttributes: + type: object + nullable: true + description: a map or dictionary of key/value pairs + additionalProperties: true + example: + moderator: true + admin: true + trust_level: '4' + created: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + - type: object + properties: + modified: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + attributes: + type: object + description: a map or dictionary of key/value pairs + additionalProperties: true + example: + firstName: John + lastName: Doe + displayName: John.Doe + identity: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + access: + type: array + items: + description: EntitlementReference + allOf: + - allOf: + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + - type: object + properties: + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + description: + type: string + nullable: true + example: null + - type: object + properties: + source: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + privileged: + type: boolean + example: false + attribute: + type: string + example: memberOf + value: + type: string + example: 'CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + standalone: + type: boolean + example: false + entitlementCount: + type: integer + description: The number of entitlements assigned to the account + format: int32 + example: 2 + uncorrelated: + type: boolean + description: Indicates if the account is not correlated to an identity + example: false + tags: + type: array + items: + type: string + example: + - TAG_1 + - TAG_2 + - description: Aggregation + allOf: + - type: object + required: + - id + - name + - _type + properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + name: + type: string + example: john.doe + _type: + description: |- + Enum representing the currently supported document types. - # Password dictionary small test file + Additional values may be added in the future without notice. + type: string + enum: + - accessprofile + - accountactivity + - account + - aggregation + - entitlement + - event + - identity + - role + example: identity + - type: object + properties: + status: + type: string + example: Success + duration: + type: integer + format: int32 + example: 20 + avgDuration: + type: integer + format: int32 + example: 20 + changedAccounts: + type: integer + format: int32 + example: 1 + nextScheduled: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + startTime: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + sourceOwner: + type: string + description: John Doe + - description: Entitlement + allOf: + - type: object + required: + - id + - name + - _type + properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + name: + type: string + example: john.doe + _type: + description: |- + Enum representing the currently supported document types. - locale=en_US + Additional values may be added in the future without notice. + type: string + enum: + - accessprofile + - accountactivity + - account + - aggregation + - entitlement + - event + - identity + - role + example: identity + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + description: + type: string + description: A description of the entitlement + example: The admin privilege + attribute: + type: string + description: The name of the entitlement attribute + example: admin + value: + type: string + description: The value of the entitlement + example: 'true' + - type: object + properties: + modified: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + synced: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + displayName: + type: string + description: The display name of the entitlement + example: Admin + source: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + privileged: + type: boolean + example: false + identityCount: + type: integer + format: int32 + example: 3 + tags: + type: array + items: + type: string + example: + - TAG_1 + - TAG_2 + - description: Event + allOf: + - type: object + required: + - id + - name + - _type + properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + name: + type: string + example: john.doe + _type: + description: |- + Enum representing the currently supported document types. - # Password dictionary prohibited words + Additional values may be added in the future without notice. + type: string + enum: + - accessprofile + - accountactivity + - account + - aggregation + - entitlement + - event + - identity + - role + example: identity + - type: object + properties: + created: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + synced: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + action: + type: string + description: The action that was performed + example: update + type: + type: string + description: The type of event + example: SYSTEM_CONFIG + actor: + type: object + properties: + name: + type: string + example: John Doe + description: the actor or target name + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + target: + type: object + properties: + name: + type: string + example: John Doe + description: the actor or target name + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + stack: + type: string + example: tpe + trackingNumber: + type: string + example: 63f891e0735f4cc8bf1968144a1e7440 + ipAddress: + type: string + example: 52.52.97.85 + details: + type: string + example: 73b65dfbed1842548c207432a18c84b0 + attributes: + type: object + additionalProperties: true + example: + pod: stg03-useast1 + org: acme + sourceName: SailPoint + objects: + type: array + items: + type: string + example: AUTHENTICATION + operation: + type: string + example: REQUEST + status: + type: string + example: PASSED + technicalName: + type: string + example: AUTHENTICATION_REQUEST_PASSED + - description: Identity + allOf: + - type: object + required: + - id + - name + - _type + properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + name: + type: string + example: john.doe + _type: + description: |- + Enum representing the currently supported document types. - qwerty - abcd - aaaaa - password - qazxsws + Additional values may be added in the future without notice. + type: string + enum: + - accessprofile + - accountactivity + - account + - aggregation + - entitlement + - event + - identity + - role + example: identity + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + - type: object + properties: + firstName: + type: string + description: The first name of the identity + example: Carol + lastName: + type: string + description: The last name of the identity + example: Adams + displayName: + type: string + example: Carol.Adams + description: The display name of the identity + email: + type: string + description: The identity's primary email address + example: Carol.Adams@sailpointdemo.com + created: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + modified: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + synced: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + phone: + type: string + description: The phone number of the identity + example: +1 440-527-3672 + inactive: + type: boolean + description: Indicates if the identity is inactive + example: false + protected: + type: boolean + example: false + status: + type: string + description: The identity's status in SailPoint + example: UNREGISTERED + employeeNumber: + type: string + example: 1a2a3d4e + manager: + nullable: true + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + isManager: + type: boolean + description: Indicates if this identity is a manager of other identities + example: false + identityProfile: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + source: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + attributes: + type: object + description: a map or dictionary of key/value pairs + additionalProperties: true + example: + country: US + firstname: Carol + cloudStatus: UNREGISTERED + processingState: + type: string + nullable: true + example: null + processingDetails: + nullable: true + type: object + properties: + date: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + stage: + type: string + example: In Process + retryCount: + type: integer + example: 0 + format: int32 + stackTrace: + type: string + example: + message: + type: string + example: + accounts: + type: array + description: List of accounts associated with the identity + items: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + accountId: + type: string + description: The ID of the account + example: john.doe + source: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + disabled: + type: boolean + description: Indicates if the account is disabled + example: false + locked: + type: boolean + description: Indicates if the account is locked + example: false + privileged: + type: boolean + example: false + manuallyCorrelated: + type: boolean + description: Indicates if the account has been manually correlated to an identity + example: false + passwordLastSet: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + entitlementAttributes: + type: object + nullable: true + description: a map or dictionary of key/value pairs + additionalProperties: true + example: + moderator: true + admin: true + trust_level: '4' + created: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + accountCount: + type: integer + description: Number of accounts associated with the identity + format: int32 + example: 3 + apps: + type: array + description: The list of applications the identity has access to + items: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + source: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + account: + type: object + properties: + id: + type: string + description: The SailPoint generated unique ID + example: 2c9180837dfe6949017e21f3d8cd6d49 + accountId: + type: string + description: The account ID generated by the source + example: 'CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + appCount: + type: integer + format: int32 + description: The number of applications the identity has access to + example: 2 + access: + type: array + description: The list of access items assigned to the identity + items: + discriminator: + propertyName: type + mapping: + ACCESS_PROFILE: ../access/AccessProfileSummary.yaml + ENTITLEMENT: ../access/AccessProfileEntitlement.yaml + ROLE: ../access/AccessProfileRole.yaml + oneOf: + - description: This is a summary representation of an access profile. + allOf: + - allOf: + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + - type: object + properties: + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + description: + type: string + nullable: true + example: null + - type: object + properties: + source: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + owner: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + revocable: + type: boolean + example: true + - description: EntitlementReference + allOf: + - allOf: + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + - type: object + properties: + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + description: + type: string + nullable: true + example: null + - type: object + properties: + source: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + privileged: + type: boolean + example: false + attribute: + type: string + example: memberOf + value: + type: string + example: 'CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + standalone: + type: boolean + example: false + - description: Role + allOf: + - allOf: + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + - type: object + properties: + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + description: + type: string + nullable: true + example: null + - type: object + properties: + owner: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + disabled: + type: boolean + revocable: + type: boolean + accessCount: + type: integer + format: int32 + description: The number of access items assigned to the identity + example: 5 + accessProfileCount: + type: integer + description: The number of access profiles assigned to the identity + example: 1 + entitlementCount: + type: integer + description: The number of entitlements assigned to the identity + example: 10 + roleCount: + type: integer + description: The number of roles assigned to the identity + example: 1 + owns: + type: object + properties: + sources: + type: array + items: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + entitlements: + type: array + items: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + accessProfiles: + type: array + items: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + roles: + type: array + items: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + apps: + type: array + items: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + governanceGroups: + type: array + items: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + fallbackApprover: + type: boolean + example: false + tags: + type: array + items: + type: string + example: + - TAG_1 + - TAG_2 + - description: Role + allOf: + - type: object + required: + - id + - name + - _type + properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + name: + type: string + example: john.doe + _type: + description: |- + Enum representing the currently supported document types. - ``` - content: - text/plain: + Additional values may be added in the future without notice. + type: string + enum: + - accessprofile + - accountactivity + - account + - aggregation + - entitlement + - event + - identity + - role + example: identity + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + description: + type: string + description: The description of the access item + example: The admin role + created: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + modified: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + synced: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + enabled: + type: boolean + example: true + requestable: + type: boolean + example: true + description: Indicates if the access can be requested + requestCommentsRequired: + type: boolean + description: Indicates if comments are required when requesting access + example: false + owner: + allOf: + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + - type: object + properties: + email: + type: string + example: john.doe@sailpoint.com + description: The email of the identity + - type: object + properties: + accessProfiles: + type: array + items: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + accessProfileCount: + type: integer + tags: + type: array + items: + type: string + example: + - TAG_1 + - TAG_2 + text/csv: schema: + description: | + If the *Accept:text/csv* header is specified and the *aggregationType* parameter in the request body is *SAILPOINT*, + + the aggregation result will be returned as a CSV document. type: string + example: + - 'Identity Locations,Count' + - 'Munich,23' + - 'Brussels,26' + - 'Singapore,22' + - 'Tokyo,20' + - 'Taipei,16' + - 'London,64' + - 'Austin,109' + - 'Sao Paulo,24' + - 'San Jose,27' + headers: + X-Total-Count: + description: The total result count (returned only if the *count* parameter is specified as *true*). + schema: + type: integer + example: 5 '400': description: Client Error - Returned if the request body is invalid. content: @@ -79118,81 +68644,14 @@ paths: 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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: @@ -79249,15 +68708,15 @@ paths: description: Actual text of the error message in the indicated locale. example: The request was syntactically correct but its content is semantically invalid. examples: - '404': - summary: An example of a 404 response object + '403': + summary: An example of a 403 response object value: - detailCode: 404 Not found + detailCode: 403 Forbidden trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. + 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: @@ -79335,389 +68794,2229 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - put: - operationId: updatePasswordDictionary + '/search/{index}/{id}': + get: tags: - - Password Dictionary - summary: Update Password Dictionary - description: |- - This updates password dictionary for the organization. - A token with ORG_ADMIN authority is required to call this API. - security: - - UserContextAuth: - - 'idn:password-dictionary:manage' - requestBody: - required: true - description: |- - - The password dictionary file can contain lines that are: - 1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing - 2. empty lines - 3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines - 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; - maximum length of the line is 128 Unicode codepoints + - Search + description: 'Fetches a single document from the specified index, using the specified document ID.' + operationId: searchGet + summary: Get a Document by ID + parameters: + - in: path + name: index + description: | + The index from which to fetch the specified document. + The currently supported index names are: *accessprofiles*, *accountactivities*, *accounts*, *aggregations*, *entitlements*, *events*, *identities*, and *roles*. + schema: + type: string + required: true + example: accounts + - in: path + name: id + description: ID of the requested document. + schema: + type: string + required: true + example: 2c91808568c529c60168cca6f90c1313 + responses: + '200': + description: The requested document. + content: + application/json: + schema: + discriminator: + propertyName: _type + mapping: + accessprofile: ../model/access/profile/AccessProfileDocument.yaml + accountactivity: ../model/account/activity/AccountActivityDocument.yaml + account: ../model/account/AccountDocument.yaml + aggregation: ../model/aggregation/AggregationDocument.yaml + entitlement: ../model/entitlement/EntitlementDocument.yaml + event: ../model/event/EventDocument.yaml + identity: ../model/identity/IdentityDocument.yaml + role: ../model/role/RoleDocument.yaml + oneOf: + - description: 'This is more of a complete representation of an access profile. ' + allOf: + - type: object + required: + - id + - name + - _type + properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + name: + type: string + example: john.doe + _type: + description: |- + Enum representing the currently supported document types. - Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). - Password dict file must contain UTF-8 characters only. + Additional values may be added in the future without notice. + type: string + enum: + - accessprofile + - accountactivity + - account + - aggregation + - entitlement + - event + - identity + - role + example: identity + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + description: + type: string + description: The description of the access item + example: The admin role + created: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + modified: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + synced: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + enabled: + type: boolean + example: true + requestable: + type: boolean + example: true + description: Indicates if the access can be requested + requestCommentsRequired: + type: boolean + description: Indicates if comments are required when requesting access + example: false + owner: + allOf: + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + - type: object + properties: + email: + type: string + example: john.doe@sailpoint.com + description: The email of the identity + - type: object + properties: + source: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + entitlements: + type: array + items: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + description: + type: string + description: A description of the entitlement + example: The admin privilege + attribute: + type: string + description: The name of the entitlement attribute + example: admin + value: + type: string + description: The value of the entitlement + example: 'true' + entitlementCount: + type: integer + example: 5 + tags: + type: array + items: + type: string + example: + - TAG_1 + - TAG_2 + - description: AccountActivity + allOf: + - type: object + required: + - id + - name + - _type + properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + name: + type: string + example: john.doe + _type: + description: |- + Enum representing the currently supported document types. - # Sample password text file + Additional values may be added in the future without notice. + type: string + enum: + - accessprofile + - accountactivity + - account + - aggregation + - entitlement + - event + - identity + - role + example: identity + - type: object + properties: + action: + type: string + description: The type of action that this activity performed + externalDocs: + description: Learn more about account activity action types + url: 'https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data' + example: Identity Refresh. + created: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + modified: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + stage: + type: string + description: The current stage of the activity + example: Completed + origin: + type: string + nullable: true + example: null + status: + type: string + description: the current status of the activity + example: Complete + requester: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + recipient: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + trackingNumber: + type: string + example: 61aad0c9e8134eca89e76a35e0cabe3f + errors: + type: array + items: + type: string + nullable: true + example: null + warnings: + type: array + items: + type: string + nullable: true + example: null + approvals: + type: array + items: + type: object + properties: + comments: + type: array + items: + type: object + properties: + comment: + type: string + description: The comment text + example: This request was autoapproved by our automated ETS subscriber. + commenter: + type: string + description: The name of the commenter + example: Automated AR Approval + date: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + created: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + modified: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + owner: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + result: + type: string + description: The result of the approval + example: Finished + type: + type: string + nullable: true + example: null + originalRequests: + type: array + items: + type: object + properties: + accountId: + type: string + description: the account id + example: 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com' + attributeRequests: + type: array + items: + type: object + properties: + name: + type: string + description: The attribute name + example: groups + op: + type: string + description: The operation to perform + example: Add + value: + type: string + description: The value of the attribute + example: '3203537556531076' + op: + type: string + description: the operation that was used + example: add + source: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + expansionItems: + type: array + items: + type: object + properties: + accountId: + type: string + description: The ID of the account + example: 2c91808981f58ea601821c3e93482e6f + cause: + type: string + example: Role + name: + type: string + description: The name of the item + example: smartsheet-role + attributeRequests: + type: array + items: + type: object + properties: + name: + type: string + description: The attribute name + example: groups + op: + type: string + description: The operation to perform + example: Add + value: + type: string + description: The value of the attribute + example: '3203537556531076' + source: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + accountRequests: + type: array + items: + type: object + properties: + accountId: + type: string + description: Unique ID of the account + example: John.Doe + attributeRequests: + type: array + items: + type: object + properties: + name: + type: string + description: The attribute name + example: groups + op: + type: string + description: The operation to perform + example: Add + value: + type: string + description: The value of the attribute + example: '3203537556531076' + op: + type: string + example: Modify + description: The operation that was performed + provisioningTarget: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + result: + type: object + properties: + errors: + type: array + items: + type: string + example: |- + [ConnectorError] [ + { + "code": "unrecognized_keys", + "keys": [ + "groups" + ], + "path": [], + "message": "Unrecognized key(s) in object: 'groups'" + } + ] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e) + status: + type: string + description: The status of the account request + example: failed + ticketId: + type: string + nullable: true + example: null + source: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + sources: + type: string + example: 'smartsheet-test, airtable-v4, IdentityNow' + - description: Account + allOf: + - type: object + required: + - id + - name + - _type + properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + name: + type: string + example: john.doe + _type: + description: |- + Enum representing the currently supported document types. - ``` + Additional values may be added in the future without notice. + type: string + enum: + - accessprofile + - accountactivity + - account + - aggregation + - entitlement + - event + - identity + - role + example: identity + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + accountId: + type: string + description: The ID of the account + example: john.doe + source: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + disabled: + type: boolean + description: Indicates if the account is disabled + example: false + locked: + type: boolean + description: Indicates if the account is locked + example: false + privileged: + type: boolean + example: false + manuallyCorrelated: + type: boolean + description: Indicates if the account has been manually correlated to an identity + example: false + passwordLastSet: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + entitlementAttributes: + type: object + nullable: true + description: a map or dictionary of key/value pairs + additionalProperties: true + example: + moderator: true + admin: true + trust_level: '4' + created: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + - type: object + properties: + modified: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + attributes: + type: object + description: a map or dictionary of key/value pairs + additionalProperties: true + example: + firstName: John + lastName: Doe + displayName: John.Doe + identity: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + access: + type: array + items: + description: EntitlementReference + allOf: + - allOf: + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + - type: object + properties: + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + description: + type: string + nullable: true + example: null + - type: object + properties: + source: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + privileged: + type: boolean + example: false + attribute: + type: string + example: memberOf + value: + type: string + example: 'CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + standalone: + type: boolean + example: false + entitlementCount: + type: integer + description: The number of entitlements assigned to the account + format: int32 + example: 2 + uncorrelated: + type: boolean + description: Indicates if the account is not correlated to an identity + example: false + tags: + type: array + items: + type: string + example: + - TAG_1 + - TAG_2 + - description: Aggregation + allOf: + - type: object + required: + - id + - name + - _type + properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + name: + type: string + example: john.doe + _type: + description: |- + Enum representing the currently supported document types. - # Password dictionary small test file + Additional values may be added in the future without notice. + type: string + enum: + - accessprofile + - accountactivity + - account + - aggregation + - entitlement + - event + - identity + - role + example: identity + - type: object + properties: + status: + type: string + example: Success + duration: + type: integer + format: int32 + example: 20 + avgDuration: + type: integer + format: int32 + example: 20 + changedAccounts: + type: integer + format: int32 + example: 1 + nextScheduled: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + startTime: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + sourceOwner: + type: string + description: John Doe + - description: Entitlement + allOf: + - type: object + required: + - id + - name + - _type + properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + name: + type: string + example: john.doe + _type: + description: |- + Enum representing the currently supported document types. - locale=en_US + Additional values may be added in the future without notice. + type: string + enum: + - accessprofile + - accountactivity + - account + - aggregation + - entitlement + - event + - identity + - role + example: identity + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + description: + type: string + description: A description of the entitlement + example: The admin privilege + attribute: + type: string + description: The name of the entitlement attribute + example: admin + value: + type: string + description: The value of the entitlement + example: 'true' + - type: object + properties: + modified: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + synced: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + displayName: + type: string + description: The display name of the entitlement + example: Admin + source: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + privileged: + type: boolean + example: false + identityCount: + type: integer + format: int32 + example: 3 + tags: + type: array + items: + type: string + example: + - TAG_1 + - TAG_2 + - description: Event + allOf: + - type: object + required: + - id + - name + - _type + properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + name: + type: string + example: john.doe + _type: + description: |- + Enum representing the currently supported document types. - # Password dictionary prohibited words + Additional values may be added in the future without notice. + type: string + enum: + - accessprofile + - accountactivity + - account + - aggregation + - entitlement + - event + - identity + - role + example: identity + - type: object + properties: + created: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + synced: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + action: + type: string + description: The action that was performed + example: update + type: + type: string + description: The type of event + example: SYSTEM_CONFIG + actor: + type: object + properties: + name: + type: string + example: John Doe + description: the actor or target name + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + target: + type: object + properties: + name: + type: string + example: John Doe + description: the actor or target name + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + stack: + type: string + example: tpe + trackingNumber: + type: string + example: 63f891e0735f4cc8bf1968144a1e7440 + ipAddress: + type: string + example: 52.52.97.85 + details: + type: string + example: 73b65dfbed1842548c207432a18c84b0 + attributes: + type: object + additionalProperties: true + example: + pod: stg03-useast1 + org: acme + sourceName: SailPoint + objects: + type: array + items: + type: string + example: AUTHENTICATION + operation: + type: string + example: REQUEST + status: + type: string + example: PASSED + technicalName: + type: string + example: AUTHENTICATION_REQUEST_PASSED + - description: Identity + allOf: + - type: object + required: + - id + - name + - _type + properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + name: + type: string + example: john.doe + _type: + description: |- + Enum representing the currently supported document types. - qwerty - abcd - aaaaa - password - qazxsws + Additional values may be added in the future without notice. + type: string + enum: + - accessprofile + - accountactivity + - account + - aggregation + - entitlement + - event + - identity + - role + example: identity + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + - type: object + properties: + firstName: + type: string + description: The first name of the identity + example: Carol + lastName: + type: string + description: The last name of the identity + example: Adams + displayName: + type: string + example: Carol.Adams + description: The display name of the identity + email: + type: string + description: The identity's primary email address + example: Carol.Adams@sailpointdemo.com + created: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + modified: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + synced: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + phone: + type: string + description: The phone number of the identity + example: +1 440-527-3672 + inactive: + type: boolean + description: Indicates if the identity is inactive + example: false + protected: + type: boolean + example: false + status: + type: string + description: The identity's status in SailPoint + example: UNREGISTERED + employeeNumber: + type: string + example: 1a2a3d4e + manager: + nullable: true + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + isManager: + type: boolean + description: Indicates if this identity is a manager of other identities + example: false + identityProfile: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + source: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + attributes: + type: object + description: a map or dictionary of key/value pairs + additionalProperties: true + example: + country: US + firstname: Carol + cloudStatus: UNREGISTERED + processingState: + type: string + nullable: true + example: null + processingDetails: + nullable: true + type: object + properties: + date: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + stage: + type: string + example: In Process + retryCount: + type: integer + example: 0 + format: int32 + stackTrace: + type: string + example: + message: + type: string + example: + accounts: + type: array + description: List of accounts associated with the identity + items: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + accountId: + type: string + description: The ID of the account + example: john.doe + source: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + type: + type: string + example: Delimited File + description: the type of source returned + disabled: + type: boolean + description: Indicates if the account is disabled + example: false + locked: + type: boolean + description: Indicates if the account is locked + example: false + privileged: + type: boolean + example: false + manuallyCorrelated: + type: boolean + description: Indicates if the account has been manually correlated to an identity + example: false + passwordLastSet: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + entitlementAttributes: + type: object + nullable: true + description: a map or dictionary of key/value pairs + additionalProperties: true + example: + moderator: true + admin: true + trust_level: '4' + created: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + accountCount: + type: integer + description: Number of accounts associated with the identity + format: int32 + example: 3 + apps: + type: array + description: The list of applications the identity has access to + items: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + source: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + account: + type: object + properties: + id: + type: string + description: The SailPoint generated unique ID + example: 2c9180837dfe6949017e21f3d8cd6d49 + accountId: + type: string + description: The account ID generated by the source + example: 'CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + appCount: + type: integer + format: int32 + description: The number of applications the identity has access to + example: 2 + access: + type: array + description: The list of access items assigned to the identity + items: + discriminator: + propertyName: type + mapping: + ACCESS_PROFILE: ../access/AccessProfileSummary.yaml + ENTITLEMENT: ../access/AccessProfileEntitlement.yaml + ROLE: ../access/AccessProfileRole.yaml + oneOf: + - description: This is a summary representation of an access profile. + allOf: + - allOf: + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + - type: object + properties: + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + description: + type: string + nullable: true + example: null + - type: object + properties: + source: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + owner: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + revocable: + type: boolean + example: true + - description: EntitlementReference + allOf: + - allOf: + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + - type: object + properties: + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + description: + type: string + nullable: true + example: null + - type: object + properties: + source: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + privileged: + type: boolean + example: false + attribute: + type: string + example: memberOf + value: + type: string + example: 'CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + standalone: + type: boolean + example: false + - description: Role + allOf: + - allOf: + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + - type: object + properties: + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + description: + type: string + nullable: true + example: null + - type: object + properties: + owner: + allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + displayName: + type: string + example: John Q. Doe + disabled: + type: boolean + revocable: + type: boolean + accessCount: + type: integer + format: int32 + description: The number of access items assigned to the identity + example: 5 + accessProfileCount: + type: integer + description: The number of access profiles assigned to the identity + example: 1 + entitlementCount: + type: integer + description: The number of entitlements assigned to the identity + example: 10 + roleCount: + type: integer + description: The number of roles assigned to the identity + example: 1 + owns: + type: object + properties: + sources: + type: array + items: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + entitlements: + type: array + items: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + accessProfiles: + type: array + items: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + roles: + type: array + items: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + apps: + type: array + items: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + governanceGroups: + type: array + items: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + fallbackApprover: + type: boolean + example: false + tags: + type: array + items: + type: string + example: + - TAG_1 + - TAG_2 + - description: Role + allOf: + - type: object + required: + - id + - name + - _type + properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + name: + type: string + example: john.doe + _type: + description: |- + Enum representing the currently supported document types. - ``` - content: - multipart/form-data: - schema: - type: object - properties: - file: - type: string - format: binary - responses: - '200': - description: Successfully updated. - '201': - description: Created. - '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. + Additional values may be added in the future without notice. + type: string + enum: + - accessprofile + - accountactivity + - account + - aggregation + - entitlement + - event + - identity + - role + example: identity + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + description: + type: string + description: The description of the access item + example: The admin role + created: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + modified: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + synced: + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: A date-time in ISO-8601 format + enabled: + type: boolean + example: true + requestable: + type: boolean + example: true + description: Indicates if the access can be requested + requestCommentsRequired: + type: boolean + description: Indicates if comments are required when requesting access + example: false + owner: + allOf: + - allOf: + - type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + - type: object + properties: + 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 + - WORKGROUP + description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + example: IDENTITY + - type: object + properties: + email: + type: string + example: john.doe@sailpoint.com + description: The email of the identity + - type: object + properties: + accessProfiles: + type: array + items: + type: object + properties: + id: + type: string + example: 2c91808568c529c60168cca6f90c1313 + description: The unique ID of the referenced object. + name: + type: string + example: John Doe + description: The human readable name of the referenced object. + accessProfileCount: + type: integer + tags: + type: array + items: + type: string + example: + - TAG_1 + - TAG_2 examples: - '403': - summary: An example of a 403 response object + accessProfile: + summary: AccessProfile value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object + id: 2c9180825a6c1adc015a71c9023f0818 + name: Cloud Eng + _type: accessprofile + description: Cloud Eng + created: '2017-02-24T20:21:23.145Z' + modified: '2019-05-24T20:36:04.312Z' + synced: '2020-02-18T05:30:20.414Z' + enabled: true + requestable: true + requestCommentsRequired: false + owner: + id: ff8081815757d36a015757d42e56031e + name: SailPoint Support + type: IDENTITY + email: cloud-support@sailpoint.com + source: + id: ff8081815757d4fb0157588f3d9d008f + name: Employees + entitlements: + - id: 2c918084575812550157589064f33b89 + name: 'CN=Cloud Engineering,DC=sailpoint,DC=COM' + description: mull + attribute: memberOf + value: 'CN=Cloud Engineering,DC=sailpoint,DC=COM' + entitlementCount: 1 + tags: + - TAG_1 + - TAG_2 + entitlement: + summary: Entitlement value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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 + id: 2c9180946ed0c43d016eec1a80892fbd + name: entitlement.aa415ae7 + _type: entitlement + description: 'null' + attribute: groups + value: entitlement.aa415ae7 + modified: '2019-12-09T19:19:50.154Z' + created: '2018-12-07T01:07:48Z' + synced: '2020-02-19T04:30:32.906Z' + displayName: entitlement.aa415ae7 + source: + id: 2c91808b6e9e6fb8016eec1a2b6f7b5f + name: ODS-HR-Employees + owner: + type: IDENTITY + id: 2c9180858315595501831958427e5424 + name: Addie Lee + privileged: false + identityCount: 68 + tags: + - TAG_1 + - TAG_2 + event: + summary: Event value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /password-org-config: - get: - operationId: getPasswordOrgConfig - tags: - - Password Configuration - summary: Get Password Org Config - description: 'This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of ''idn:password-org-config:read''' - security: - - UserContextAuth: - - 'idn:password-org-config:read' - responses: - '200': - description: Reference to the password org config. - content: - application/json: - schema: - type: object - properties: - customInstructionsEnabled: - type: boolean - description: Indicator whether custom password instructions feature is enabled. The default value is false. - default: false - example: true - digitTokenEnabled: - type: boolean - description: Indicator whether "digit token" feature is enabled. The default value is false. - default: false - example: true - digitTokenDurationMinutes: - type: integer - format: int32 - description: The duration of "digit token" in minutes. The default value is 5. - minimum: 1 - maximum: 60 - default: 5 - example: 10 - digitTokenLength: - type: integer - format: int32 - description: The length of "digit token". The default value is 6. - minimum: 6 - maximum: 18 - default: 6 - example: 9 - example: - customInstructionsEnabled: true - digitTokenDurationMinutes: 9 - digitTokenEnabled: false - digitTokenLength: 6 + id: e092842f-c904-4b59-aac8-2544abeeef4b + name: Update Task Schedule Passed + _type: event + created: '2020-02-17T16:23:18.327Z' + synced: '2020-02-17T16:23:18.388Z' + action: TASK_SCHEDULE_UPDATE_PASSED + type: SYSTEM_CONFIG + actor: + name: MantisTaskScheduler + target: + name: Perform provisioning activity search delete synchronization + stack: tpe + trackingNumber: c6b98bc39ece48b080826d16c76b166c + ipAddress: 207.189.160.158 + details: 'null' + attributes: + sourceName: SailPoint + objects: + - TASK + - SCHEDULE + operation: UPDATE + status: PASSED + technicalName: TASK_SCHEDULE_UPDATE_PASSED + identity: + summary: Identity + value: + id: 2c9180865c45e7e3015c46c434a80622 + name: ad.admin + _type: identity + firstName: AD + lastName: Admin + displayName: AD Admin + email: SLPT.CLOUD.SAILPOINT.TEST+AD-ADMIN@GMAIL.COM + created: '2018-08-22T19:54:54.302Z' + modified: '2018-08-22T19:54:54.302Z' + synced: '2018-08-22T19:54:54.302Z' + phone: 512-942-7578 + inactive: false + protected: false + status: UNREGISTERED + employeeNumber: O349804 + manager: null + isManager: false + identityProfile: + id: 2c918085605c8d0601606f357cb231e6 + name: E2E AD + source: + id: 2c9180855c45b230015c46c19b9c0202 + name: EndToEnd-ADSource + attributes: + uid: ad.admin + firstname: AD + cloudAuthoritativeSource: 2c9180855c45b230015c46c19b9c0202 + cloudStatus: UNREGISTERED + iplanet-am-user-alias-list: null + displayName: AD Admin + internalCloudStatus: UNREGISTERED + workPhone: 512-942-7578 + email: SLPT.CLOUD.SAILPOINT.TEST+AD-ADMIN@GMAIL.COM + lastname: Admin + processingState: null + processingDetails: null + accounts: + - id: 2c9180865c45e7e3015c46c434a80623 + name: ad.admin + accountId: 'CN=AD Admin,OU=slpt-automation,DC=TestAutomationAD,DC=local' + source: + id: 2c9180855c45b230015c46c19b9c0202 + name: EndToEnd-ADSource + type: Active Directory - Direct + disabled: false + locked: false + privileged: false + manuallyCorrelated: false + passwordLastSet: '2018-08-22T19:54:54.302Z' + entitlementAttributes: + memberOf: + - 'CN=Group Policy Creator Owners,CN=Users,DC=TestAutomationAD,DC=local' + - 'CN=Domain Guests,CN=Users,DC=TestAutomationAD,DC=local' + - 'CN=Domain Admins,CN=Users,DC=TestAutomationAD,DC=local' + - 'CN=Enterprise Admins,CN=Users,DC=TestAutomationAD,DC=local' + - 'CN=Schema Admins,CN=Users,DC=TestAutomationAD,DC=local' + - 'CN=Guests,CN=Builtin,DC=TestAutomationAD,DC=local' + - 'CN=Administrators,CN=Builtin,DC=TestAutomationAD,DC=local' + created: '2018-08-22T19:54:54.302Z' + - id: 2c918083606d670c01606f35a30a0349 + name: ad.admin + accountId: ad.admin + source: + id: ff8081815c46b85b015c46b90c7c02a6 + name: IdentityNow + type: IdentityNowConnector + disabled: false + locked: false + privileged: false + manuallyCorrelated: false + passwordLastSet: null + entitlementAttributes: null + created: '2018-08-22T19:54:54.302Z' + accountCount: 2 + apps: + - id: '22751' + name: ADP Workforce Now + source: + id: 2c9180855c45b230015c46e2f6a8026a + name: Corporate Active Directory + account: + id: 2c9180865c45efa4015c470be0de1606 + accountId: 'CN=Bob Wilson,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com' + appCount: 1 + access: + - id: 2c918083634bc6cb01639808d40270ba + name: 'test [AccessProfile-1527264105448]' + displayName: test + type: ACCESS_PROFILE + description: test + source: + id: 2c9180855c45b230015c46c19b9c0202 + name: EndToEnd-ADSource + owner: + id: 2c9180865c45e7e3015c46c434a80622 + name: ad.admin + displayName: AD Admin + - id: 2c9180865c45e7e3015c46c457c50755 + name: Administrators + displayName: Administrators + type: ENTITLEMENT + description: null + source: + id: 2c9180855c45b230015c46c19b9c0202 + name: EndToEnd-ADSource + privileged: false + attribute: memberOf + value: 'CN=Administrators,CN=Builtin,DC=TestAutomationAD,DC=local' + standalone: false + - id: 2c9180865decdaa5015e06598b293108 + name: 'test [cloudRole-1503345085223]' + displayName: test + type: ROLE + description: test + owner: + id: 2c9180865c45e7e3015c46c5030707a0 + name: will.albin + displayName: Albin Will + disabled: false + accessCount: 3 + accessProfileCount: 1 + entitlementCount: 1 + roleCount: 1 + tags: + - TAG_1 + - TAG_2 + role: + summary: Role + value: + id: 2c91808c6faadea6016fb4f2bc69077b + name: IT Role + _type: role + description: IT role + created: '2020-01-17T19:20:15.040Z' + modified: null + synced: '2020-02-18T05:30:20.145Z' + enabled: true + requestable: false + requestCommentsRequired: false + owner: + id: 2c9180a46faadee4016fb4e018c20639 + name: Cloud Support + type: IDENTITY + email: thomas.edison@acme-solar.com + accessProfiles: + - id: 2c91809c6faade77016fb4f0b63407ae + name: Admin Access + accessProfileCount: 1 + tags: + - TAG_1 + - TAG_2 '400': description: Client Error - Returned if the request body is invalid. content: @@ -79852,18 +71151,8 @@ paths: - 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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist content: application/json: schema: @@ -79920,104 +71209,27 @@ paths: 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 + '404': + summary: An example of a 404 response object value: - detailCode: 500.0 Internal Fault + detailCode: 404 Not found trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: An internal fault occurred. - put: - operationId: putPasswordOrgConfig - tags: - - Password Configuration - summary: Update Password Org Config - description: |- - This API updates the password org config for specified fields. Other fields will keep original value. - You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions. - Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' - security: - - oauth2: - - 'idn:password-org-config:write' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - customInstructionsEnabled: - type: boolean - description: Indicator whether custom password instructions feature is enabled. The default value is false. - default: false - example: true - digitTokenEnabled: - type: boolean - description: Indicator whether "digit token" feature is enabled. The default value is false. - default: false - example: true - digitTokenDurationMinutes: - type: integer - format: int32 - description: The duration of "digit token" in minutes. The default value is 5. - minimum: 1 - maximum: 60 - default: 5 - example: 10 - digitTokenLength: - type: integer - format: int32 - description: The length of "digit token". The default value is 6. - minimum: 6 - maximum: 18 - default: 6 - example: 9 - example: - digitTokenEnabled: true - digitTokenDurationMinutes: 12 - responses: - '200': - description: Reference to the password org config. + text: The server did not find a current representation for the target resource. + '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: - customInstructionsEnabled: - type: boolean - description: Indicator whether custom password instructions feature is enabled. The default value is false. - default: false - example: true - digitTokenEnabled: - type: boolean - description: Indicator whether "digit token" feature is enabled. The default value is false. - default: false - example: true - digitTokenDurationMinutes: - type: integer - format: int32 - description: The duration of "digit token" in minutes. The default value is 5. - minimum: 1 - maximum: 60 - default: 5 - example: 10 - digitTokenLength: - type: integer - format: int32 - description: The length of "digit token". The default value is 6. - minimum: 6 - maximum: 18 - default: 6 - example: 9 - example: - customInstructionsEnabled: true - digitTokenDurationMinutes: 12 - digitTokenEnabled: true - digitTokenLength: 6 - '400': - description: Client Error - Returned if the request body is invalid. + 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: @@ -80073,18 +71285,280 @@ paths: 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.' + 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. + /segments: + post: + operationId: createSegment + security: + - UserContextAuth: + - 'idn:segment:manage' + tags: + - Segments + summary: Create Segment + description: |- + This API creates a segment. + >**Note:** Segment definitions may take time to propagate to all identities. + A token with ORG_ADMIN or API authority is required to call this API. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: The id of the Segment. + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + name: + type: string + description: Segment Business Name + example: segment-xyz + created: + type: string + format: date-time + description: The time when this Segment is created + example: '2020-01-01T00:00:00.000000Z' + modified: + type: string + format: date-time + description: The time when this Segment is modified + example: '2020-01-01T00:00:00.000000Z' + description: + type: string + description: Optional description of the Segment + example: This segment represents xyz + owner: + type: object + nullable: true + description: The owner of this object. + properties: + type: + description: 'Owner type. This field must be either left null or set to ''IDENTITY'' on input, otherwise a 400 Bad Request error will result.' + example: IDENTITY + 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 + - WORKGROUP + id: + type: string + description: Identity id + example: 2c9180a46faadee4016fb4e018c20639 + name: + type: string + description: 'Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner''s display name, otherwise a 400 Bad Request error will result.' + example: support + visibilityCriteria: + type: object + properties: + expression: + type: object + properties: + operator: + type: string + description: Operator for the expression + enum: + - AND + - EQUALS + example: EQUALS + attribute: + type: string + description: Name for the attribute + example: location + value: + type: object + properties: + type: + type: string + description: The type of attribute value + example: STRING + value: + type: string + description: The attribute value + example: Austin + children: + type: array + nullable: true + description: List of expressions + items: + type: object + properties: + type: + type: string + description: The type of attribute value + example: STRING + value: + type: string + description: The attribute value + example: Austin + example: [] + active: + type: boolean + description: Whether the Segment is currently active. Inactive segments have no effect. + default: false + example: true + responses: + '201': + description: Segment created 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.' + id: + type: string + description: The id of the Segment. + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + name: + type: string + description: Segment Business Name + example: segment-xyz + created: + type: string + format: date-time + description: The time when this Segment is created + example: '2020-01-01T00:00:00.000000Z' + modified: + type: string + format: date-time + description: The time when this Segment is modified + example: '2020-01-01T00:00:00.000000Z' + description: + type: string + description: Optional description of the Segment + example: This segment represents xyz + owner: + type: object + nullable: true + description: The owner of this object. + properties: + type: + description: 'Owner type. This field must be either left null or set to ''IDENTITY'' on input, otherwise a 400 Bad Request error will result.' + example: IDENTITY + 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 + - WORKGROUP + id: + type: string + description: Identity id + example: 2c9180a46faadee4016fb4e018c20639 + name: + type: string + description: 'Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner''s display name, otherwise a 400 Bad Request error will result.' + example: support + visibilityCriteria: + type: object + properties: + expression: + type: object + properties: + operator: + type: string + description: Operator for the expression + enum: + - AND + - EQUALS + example: EQUALS + attribute: + type: string + description: Name for the attribute + example: location + value: + type: object + properties: + type: + type: string + description: The type of attribute value + example: STRING + value: + type: string + description: The attribute value + example: Austin + children: + type: array + nullable: true + description: List of expressions + items: + type: object + properties: + type: + type: string + description: The type of attribute value + example: STRING + value: + type: string + description: The attribute value + example: Austin + example: [] + active: + type: boolean + description: Whether the Segment is currently active. Inactive segments have no effect. + default: false + example: true + '400': + description: Client Error - Returned if the request body is invalid. content: application/json: schema: @@ -80140,28 +71614,18 @@ paths: 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. + '401': + description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' content: application/json: schema: type: object properties: - message: + error: description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected 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: @@ -80213,111 +71677,32 @@ paths: - 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: createPasswordOrgConfig - tags: - - Password Configuration - summary: Create Password Org Config - description: |- - This API creates the password org config. Unspecified fields will use default value. - To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true". - Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' - security: - - UserContextAuth: - - 'idn:password-org-config:write' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - customInstructionsEnabled: - type: boolean - description: Indicator whether custom password instructions feature is enabled. The default value is false. - default: false - example: true - digitTokenEnabled: - type: boolean - description: Indicator whether "digit token" feature is enabled. The default value is false. - default: false - example: true - digitTokenDurationMinutes: - type: integer - format: int32 - description: The duration of "digit token" in minutes. The default value is 5. - minimum: 1 - maximum: 60 - default: 5 - example: 10 - digitTokenLength: - type: integer - format: int32 - description: The length of "digit token". The default value is 6. - minimum: 6 - maximum: 18 - default: 6 - example: 9 - example: - customInstructionsEnabled: true - digitTokenEnabled: true - digitTokenDurationMinutes: 12 - digitTokenLength: 9 - responses: - '200': - description: Reference to the password org config. + 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: - customInstructionsEnabled: - type: boolean - description: Indicator whether custom password instructions feature is enabled. The default value is false. - default: false - example: true - digitTokenEnabled: - type: boolean - description: Indicator whether "digit token" feature is enabled. The default value is false. - default: false - example: true - digitTokenDurationMinutes: - type: integer - format: int32 - description: The duration of "digit token" in minutes. The default value is 5. - minimum: 1 - maximum: 60 - default: 5 - example: 10 - digitTokenLength: - type: integer - format: int32 - description: The length of "digit token". The default value is 6. - minimum: 6 - maximum: 18 - default: 6 - example: 9 - example: - customInstructionsEnabled: true - digitTokenDurationMinutes: 9 - digitTokenEnabled: true - digitTokenLength: 12 - '400': - description: Client Error - Returned if the request body is invalid. + 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: @@ -80373,18 +71758,196 @@ paths: 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.' + 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. + get: + operationId: listSegments + security: + - UserContextAuth: + - 'idn:segment:read' + - 'idn:segment:manage' + tags: + - Segments + summary: List Segments + description: |- + This API returns a list of all segments. + A token with ORG_ADMIN or API authority is required to call this API. + parameters: + - 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 + responses: + '200': + description: List of all segments 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.' + type: array + items: + type: object + properties: + id: + type: string + description: The id of the Segment. + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + name: + type: string + description: Segment Business Name + example: segment-xyz + created: + type: string + format: date-time + description: The time when this Segment is created + example: '2020-01-01T00:00:00.000000Z' + modified: + type: string + format: date-time + description: The time when this Segment is modified + example: '2020-01-01T00:00:00.000000Z' + description: + type: string + description: Optional description of the Segment + example: This segment represents xyz + owner: + type: object + nullable: true + description: The owner of this object. + properties: + type: + description: 'Owner type. This field must be either left null or set to ''IDENTITY'' on input, otherwise a 400 Bad Request error will result.' + example: IDENTITY + 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 + - WORKGROUP + id: + type: string + description: Identity id + example: 2c9180a46faadee4016fb4e018c20639 + name: + type: string + description: 'Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner''s display name, otherwise a 400 Bad Request error will result.' + example: support + visibilityCriteria: + type: object + properties: + expression: + type: object + properties: + operator: + type: string + description: Operator for the expression + enum: + - AND + - EQUALS + example: EQUALS + attribute: + type: string + description: Name for the attribute + example: location + value: + type: object + properties: + type: + type: string + description: The type of attribute value + example: STRING + value: + type: string + description: The attribute value + example: Austin + children: + type: array + nullable: true + description: List of expressions + items: + type: object + properties: + type: + type: string + description: The type of attribute value + example: STRING + value: + type: string + description: The attribute value + example: Austin + example: [] + active: + type: boolean + description: Whether the Segment is currently active. Inactive segments have no effect. + default: false + example: true + '400': + description: Client Error - Returned if the request body is invalid. content: application/json: schema: @@ -80440,28 +72003,18 @@ paths: 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. + '401': + description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' content: application/json: schema: type: object properties: - message: + error: description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected 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: @@ -80518,362 +72071,116 @@ paths: 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 + '403': + summary: An example of a 403 response object value: - detailCode: 500.0 Internal Fault + detailCode: 403 Forbidden trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: An internal fault occurred. - /sod-policies: - post: - security: - - UserContextAuth: - - 'idn:sod-policy:write' - operationId: createSodPolicy - tags: - - SOD Policy - summary: Create SOD policy - description: |- - This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. - Requires role of ORG_ADMIN. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: Policy id - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - readOnly: true - name: - type: string - description: Policy Business Name - example: policy-xyz - created: - type: string - format: date-time - description: The time when this SOD policy is created. - example: '2020-01-01T00:00:00.000000Z' - readOnly: true - modified: - type: string - format: date-time - description: The time when this SOD policy is modified. - example: '2020-01-01T00:00:00.000000Z' - readOnly: true - description: - type: string - description: Optional description of the SOD policy - example: This policy ensures compliance of xyz - nullable: true - ownerRef: - 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 - - WORKGROUP - 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 - externalPolicyReference: - type: string - description: Optional External Policy Reference - example: XYZ policy - nullable: true - policyQuery: - type: string - description: Search query of the SOD policy - example: '@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)' - compensatingControls: - type: string - description: Optional compensating controls(Mitigating Controls) - example: Have a manager review the transaction decisions for their "out of compliance" employee - nullable: true - correctionAdvice: - type: string - description: Optional correction advice - example: 'Based on the role of the employee, managers should remove access that is not required for their job function.' - nullable: true - state: - type: string - description: whether the policy is enforced or not - enum: - - ENFORCED - - NOT_ENFORCED - example: ENFORCED - tags: - type: array - description: tags for this policy object - example: - - TAG1 - - TAG2 - items: + 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 - creatorId: - type: string - description: Policy's creator ID - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - readOnly: true - modifierId: - type: string - description: Policy's modifier ID - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - nullable: true - readOnly: true - violationOwnerAssignmentConfig: - nullable: true - type: object - properties: - assignmentRule: - type: string - enum: - - MANAGER - - STATIC - - null - description: |- - Details about the violations owner. - MANAGER - identity's manager - STATIC - Governance Group or Identity - example: MANAGER - nullable: true - ownerRef: - 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 - - WORKGROUP - 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 - - nullable: true - scheduled: - type: boolean - description: defines whether a policy has been scheduled or not - example: true - default: false - type: - type: string - description: whether a policy is query based or conflicting access based - default: GENERAL - enum: - - GENERAL - - CONFLICTING_ACCESS_BASED - example: GENERAL - conflictingAccessCriteria: - allOf: - - type: object + 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: - leftCriteria: - type: object - properties: - name: - type: string - description: Business name for the access construct list - example: money-in - criteriaList: - type: array - description: List of criteria. There is a min of 1 and max of 50 items in the list. - minItems: 1 - maxItems: 50 - items: - type: object - properties: - type: - type: string - enum: - - ENTITLEMENT - description: Type of the propery to which this reference applies to - example: ENTITLEMENT - id: - type: string - description: ID of the object to which this reference applies to - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies to - example: Administrator - example: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - name: Administrator - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - name: Administrator - rightCriteria: - type: object - properties: - name: - type: string - description: Business name for the access construct list - example: money-in - criteriaList: - type: array - description: List of criteria. There is a min of 1 and max of 50 items in the list. - minItems: 1 - maxItems: 50 - items: - type: object - properties: - type: - type: string - enum: - - ENTITLEMENT - description: Type of the propery to which this reference applies to - example: ENTITLEMENT - id: - type: string - description: ID of the object to which this reference applies to - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies to - example: Administrator - example: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - name: Administrator - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - name: Administrator - - nullable: true - examples: - Conflicting Access Based Policy: - value: - name: Conflicting-Policy-Name - description: This policy ensures compliance of xyz - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Owner Name - externalPolicyReference: XYZ policy - compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee - correctionAdvice: 'Based on the role of the employee, managers should remove access that is not required for their job function.' - state: ENFORCED - tags: - - string - creatorId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - modifierId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - violationOwnerAssignmentConfig: - assignmentRule: MANAGER - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Violation Owner Name - scheduled: true - type: CONFLICTING_ACCESS_BASED - conflictingAccessCriteria: - leftCriteria: - name: money-in - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - rightCriteria: - name: money-out - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a68 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a69 - General Policy: - value: - description: Description - ownerRef: - type: IDENTITY - id: 2c918087682f9a86016839c05e8f1aff - name: Owner Name - externalPolicyReference: New policy - policyQuery: policy query implementation - compensatingControls: Compensating controls - correctionAdvice: Correction advice - tags: [] - state: ENFORCED - scheduled: false - creatorId: 2c918087682f9a86016839c05e8f1aff - modifierId: null - violationOwnerAssignmentConfig: null - name: General-Policy-Name + 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. + '/segments/{id}': + get: + operationId: getSegment + security: + - UserContextAuth: + - 'idn:segment:read' + - 'idn:segment:manage' + tags: + - Segments + summary: Get Segment by ID + description: |- + This API returns the segment specified by the given ID. + A token with ORG_ADMIN or API authority is required to call this API. + parameters: + - in: path + name: id + schema: + type: string + required: true + description: The segment ID to retrieve. + example: ef38f94347e94562b5bb8424a56397d8 responses: - '201': - description: SOD policy created + '200': + description: Segment content: application/json: schema: @@ -80881,35 +72188,34 @@ paths: properties: id: type: string - description: Policy id + description: The id of the Segment. example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - readOnly: true name: type: string - description: Policy Business Name - example: policy-xyz + description: Segment Business Name + example: segment-xyz created: type: string format: date-time - description: The time when this SOD policy is created. + description: The time when this Segment is created example: '2020-01-01T00:00:00.000000Z' - readOnly: true modified: type: string format: date-time - description: The time when this SOD policy is modified. + description: The time when this Segment is modified example: '2020-01-01T00:00:00.000000Z' - readOnly: true description: type: string - description: Optional description of the SOD policy - example: This policy ensures compliance of xyz - nullable: true - ownerRef: + description: Optional description of the Segment + example: This segment represents xyz + owner: type: object + nullable: true + description: The owner of this object. properties: type: - description: DTO type + description: 'Owner type. This field must be either left null or set to ''IDENTITY'' on input, otherwise a 400 Bad Request error will result.' + example: IDENTITY type: string enum: - ACCOUNT_CORRELATION_CONFIG @@ -80936,283 +72242,67 @@ paths: - TAG - TAG_CATEGORY - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - - WORKGROUP - 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 - externalPolicyReference: - type: string - description: Optional External Policy Reference - example: XYZ policy - nullable: true - policyQuery: - type: string - description: Search query of the SOD policy - example: '@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)' - compensatingControls: - type: string - description: Optional compensating controls(Mitigating Controls) - example: Have a manager review the transaction decisions for their "out of compliance" employee - nullable: true - correctionAdvice: - type: string - description: Optional correction advice - example: 'Based on the role of the employee, managers should remove access that is not required for their job function.' - nullable: true - state: - type: string - description: whether the policy is enforced or not - enum: - - ENFORCED - - NOT_ENFORCED - example: ENFORCED - tags: - type: array - description: tags for this policy object - example: - - TAG1 - - TAG2 - items: - type: string - creatorId: - type: string - description: Policy's creator ID - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - readOnly: true - modifierId: - type: string - description: Policy's modifier ID - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - nullable: true - readOnly: true - violationOwnerAssignmentConfig: - nullable: true - type: object - properties: - assignmentRule: - type: string - enum: - - MANAGER - - STATIC - - null - description: |- - Details about the violations owner. - MANAGER - identity's manager - STATIC - Governance Group or Identity - example: MANAGER - nullable: true - ownerRef: - 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 - - WORKGROUP - 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 - - nullable: true - scheduled: - type: boolean - description: defines whether a policy has been scheduled or not - example: true - default: false - type: - type: string - description: whether a policy is query based or conflicting access based - default: GENERAL - enum: - - GENERAL - - CONFLICTING_ACCESS_BASED - example: GENERAL - conflictingAccessCriteria: - allOf: - - type: object - properties: - leftCriteria: - type: object - properties: - name: - type: string - description: Business name for the access construct list - example: money-in - criteriaList: - type: array - description: List of criteria. There is a min of 1 and max of 50 items in the list. - minItems: 1 - maxItems: 50 - items: - type: object - properties: - type: - type: string - enum: - - ENTITLEMENT - description: Type of the propery to which this reference applies to - example: ENTITLEMENT - id: - type: string - description: ID of the object to which this reference applies to - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies to - example: Administrator - example: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - name: Administrator - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - name: Administrator - rightCriteria: - type: object - properties: - name: - type: string - description: Business name for the access construct list - example: money-in - criteriaList: - type: array - description: List of criteria. There is a min of 1 and max of 50 items in the list. - minItems: 1 - maxItems: 50 - items: - type: object - properties: - type: - type: string - enum: - - ENTITLEMENT - description: Type of the propery to which this reference applies to - example: ENTITLEMENT - id: - type: string - description: ID of the object to which this reference applies to - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies to - example: Administrator - example: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - name: Administrator - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - name: Administrator - - nullable: true - examples: - Conflicting Access Based Policy: - value: - id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - name: Conflicting-Policy-Name - created: '2020-01-01T00:00:00.000000Z' - modified: '2020-01-01T00:00:00.000000Z' - description: This policy ensures compliance of xyz - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Owner Name - externalPolicyReference: XYZ policy - policyQuery: '@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)' - compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee - correctionAdvice: 'Based on the role of the employee, managers should remove access that is not required for their job function.' - state: ENFORCED - tags: - - string - creatorId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - modifierId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - violationOwnerAssignmentConfig: - assignmentRule: MANAGER - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Violation Owner Name - scheduled: true - type: CONFLICTING_ACCESS_BASED - conflictingAccessCriteria: - leftCriteria: - name: money-in - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - rightCriteria: - name: money-out - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a68 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a69 - General Policy: - value: - description: Description - ownerRef: - type: IDENTITY - id: 2c918087682f9a86016839c05e8f1aff - name: Owner Name - externalPolicyReference: New policy - policyQuery: policy query implementation - compensatingControls: Compensating controls - correctionAdvice: Correction advice - tags: [] - state: ENFORCED - scheduled: false - creatorId: 2c918087682f9a86016839c05e8f1aff - modifierId: null - violationOwnerAssignmentConfig: null - type: GENERAL - conflictingAccessCriteria: null - id: 52c11db4-733e-4c31-949a-766c95ec95f1 - name: General-Policy-Name - created: '2020-05-12T19:47:38Z' - modified: '2020-05-12T19:47:38Z' + - REPORT_RESULT + - SOD_VIOLATION + - ACCOUNT_ACTIVITY + - WORKGROUP + id: + type: string + description: Identity id + example: 2c9180a46faadee4016fb4e018c20639 + name: + type: string + description: 'Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner''s display name, otherwise a 400 Bad Request error will result.' + example: support + visibilityCriteria: + type: object + properties: + expression: + type: object + properties: + operator: + type: string + description: Operator for the expression + enum: + - AND + - EQUALS + example: EQUALS + attribute: + type: string + description: Name for the attribute + example: location + value: + type: object + properties: + type: + type: string + description: The type of attribute value + example: STRING + value: + type: string + description: The attribute value + example: Austin + children: + type: array + nullable: true + description: List of expressions + items: + type: object + properties: + type: + type: string + description: The type of attribute value + example: STRING + value: + type: string + description: The attribute value + example: Austin + example: [] + active: + type: boolean + description: Whether the Segment is currently active. Inactive segments have no effect. + default: false + example: true '400': description: Client Error - Returned if the request body is invalid. content: @@ -81347,18 +72437,8 @@ paths: - 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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist content: application/json: schema: @@ -81415,421 +72495,115 @@ paths: 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 + '404': + summary: An example of a 404 response object value: - detailCode: 500.0 Internal Fault + detailCode: 404 Not found trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: An internal fault occurred. - get: - security: - - UserContextAuth: - - 'idn:sod-policy:read' - operationId: listSodPolicies - tags: - - SOD Policy - summary: List SOD policies - description: |- - This gets list of all SOD policies. - Requires role of ORG_ADMIN - parameters: - - 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 - 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* - - **name**: *eq* - - **state**: *eq* - example: id eq "bc693f07e7b645539626c25954c58554" - required: false - responses: - '200': - description: List of all SOD policies. + text: The server did not find a current representation for the target resource. + '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: array - items: - type: object - properties: - id: - type: string - description: Policy id - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - readOnly: true - name: - type: string - description: Policy Business Name - example: policy-xyz - created: - type: string - format: date-time - description: The time when this SOD policy is created. - example: '2020-01-01T00:00:00.000000Z' - readOnly: true - modified: - type: string - format: date-time - description: The time when this SOD policy is modified. - example: '2020-01-01T00:00:00.000000Z' - readOnly: true - description: - type: string - description: Optional description of the SOD policy - example: This policy ensures compliance of xyz - nullable: true - ownerRef: + 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: - 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 - - WORKGROUP - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: + locale: type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - externalPolicyReference: - type: string - description: Optional External Policy Reference - example: XYZ policy - nullable: true - policyQuery: - type: string - description: Search query of the SOD policy - example: '@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)' - compensatingControls: - type: string - description: Optional compensating controls(Mitigating Controls) - example: Have a manager review the transaction decisions for their "out of compliance" employee - nullable: true - correctionAdvice: - type: string - description: Optional correction advice - example: 'Based on the role of the employee, managers should remove access that is not required for their job function.' - nullable: true - state: - type: string - description: whether the policy is enforced or not - enum: - - ENFORCED - - NOT_ENFORCED - example: ENFORCED - tags: - type: array - description: tags for this policy object - example: - - TAG1 - - TAG2 - items: - type: string - creatorId: - type: string - description: Policy's creator ID - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - readOnly: true - modifierId: - type: string - description: Policy's modifier ID - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - nullable: true - readOnly: true - violationOwnerAssignmentConfig: - nullable: true - type: object - properties: - assignmentRule: + description: 'The locale for the message text, a BCP 47 language tag.' + example: en-US + localeOrigin: type: string enum: - - MANAGER - - STATIC - - null - description: |- - Details about the violations owner. - MANAGER - identity's manager - STATIC - Governance Group or Identity - example: MANAGER - nullable: true - ownerRef: - 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 - - WORKGROUP - 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 - - nullable: true - scheduled: - type: boolean - description: defines whether a policy has been scheduled or not - example: true - default: false - type: - type: string - description: whether a policy is query based or conflicting access based - default: GENERAL - enum: - - GENERAL - - CONFLICTING_ACCESS_BASED - example: GENERAL - conflictingAccessCriteria: - allOf: - - type: object - properties: - leftCriteria: - type: object - properties: - name: - type: string - description: Business name for the access construct list - example: money-in - criteriaList: - type: array - description: List of criteria. There is a min of 1 and max of 50 items in the list. - minItems: 1 - maxItems: 50 - items: - type: object - properties: - type: - type: string - enum: - - ENTITLEMENT - description: Type of the propery to which this reference applies to - example: ENTITLEMENT - id: - type: string - description: ID of the object to which this reference applies to - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies to - example: Administrator - example: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - name: Administrator - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - name: Administrator - rightCriteria: - type: object - properties: - name: - type: string - description: Business name for the access construct list - example: money-in - criteriaList: - type: array - description: List of criteria. There is a min of 1 and max of 50 items in the list. - minItems: 1 - maxItems: 50 - items: - type: object - properties: - type: - type: string - enum: - - ENTITLEMENT - description: Type of the propery to which this reference applies to - example: ENTITLEMENT - id: - type: string - description: ID of the object to which this reference applies to - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies to - example: Administrator - example: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - name: Administrator - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - name: Administrator - - nullable: true - example: - - id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - name: Conflicting-Policy-Name - created: '2020-01-01T00:00:00.000000Z' - modified: '2020-01-01T00:00:00.000000Z' - description: This policy ensures compliance of xyz - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Owner Name - externalPolicyReference: XYZ policy - policyQuery: '@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)' - compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee - correctionAdvice: 'Based on the role of the employee, managers should remove access that is not required for their job function.' - state: ENFORCED - tags: - - string - creatorId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - modifierId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - violationOwnerAssignmentConfig: - assignmentRule: MANAGER - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Violation Owner Name - scheduled: true - type: CONFLICTING_ACCESS_BASED - conflictingAccessCriteria: - leftCriteria: - name: money-in - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - rightCriteria: - name: money-out - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a68 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a69 - - description: Description - ownerRef: - type: IDENTITY - id: 2c918087682f9a86016839c05e8f1aff - name: Owner Name - externalPolicyReference: New policy - policyQuery: policy query implementation - compensatingControls: Compensating controls - correctionAdvice: Correction advice - tags: [] - state: ENFORCED - scheduled: false - creatorId: 2c918087682f9a86016839c05e8f1aff - modifierId: null - violationOwnerAssignmentConfig: null - type: GENERAL - conflictingAccessCriteria: null - id: 52c11db4-733e-4c31-949a-766c95ec95f1 - name: General-Policy-Name - created: '2020-05-12T19:47:38Z' - modified: '2020-05-12T19:47:38Z' + - 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. + delete: + operationId: deleteSegment + security: + - UserContextAuth: + - 'idn:segment:manage' + tags: + - Segments + summary: Delete Segment by ID + description: |- + This API deletes the segment specified by the given ID. + >**Note:** that segment deletion may take some time to become effective. + A token with ORG_ADMIN or API authority is required to call this API. + parameters: + - in: path + name: id + schema: + type: string + required: true + description: The segment ID to delete. + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '204': + description: No content. '400': description: Client Error - Returned if the request body is invalid. content: @@ -81964,6 +72738,73 @@ paths: - locale: en-US localeOrigin: DEFAULT text: The server understood the request but refuses to authorize it. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. '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: @@ -82041,29 +72882,66 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/sod-policies/{id}': - get: + patch: + operationId: patchSegment security: - UserContextAuth: - - 'idn:sod-policy:read' - operationId: getSodPolicy + - 'idn:segment:manage' tags: - - SOD Policy - summary: Get SOD policy by ID + - Segments + summary: Update Segment description: |- - This gets specified SOD policy. - Requires role of ORG_ADMIN. + Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + >**Note:** Changes to a segment may take some time to propagate to all identities. + A token with ORG_ADMIN or API authority is required to call this API. parameters: - in: path name: id schema: type: string required: true - description: The ID of the SOD Policy to retrieve. - example: ef38f943-47e9-4562-b5bb-8424a56397d8 + description: The segment ID to modify. + example: ef38f94347e94562b5bb8424a56397d8 + requestBody: + required: true + description: | + A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + The following fields are patchable: + * name + * description + * owner + * visibilityCriteria + * active + content: + application/json-patch+json: + schema: + type: array + items: + type: object + examples: + Set Visibility Criteria: + description: Set the visibility criteria + value: + - op: replace + path: /visibilityCriteria + value: + expression: + operator: AND + children: + - operator: EQUALS + attribute: location + value: + type: STRING + value: Philadelphia + - operator: EQUALS + attribute: department + value: + type: STRING + value: HR responses: '200': - description: SOD policy ID. + description: 'Indicates the PATCH operation succeeded, and returns the segment''s new representation.' content: application/json: schema: @@ -82071,338 +72949,121 @@ paths: properties: id: type: string - description: Policy id + description: The id of the Segment. example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - readOnly: true name: type: string - description: Policy Business Name - example: policy-xyz + description: Segment Business Name + example: segment-xyz created: type: string format: date-time - description: The time when this SOD policy is created. + description: The time when this Segment is created example: '2020-01-01T00:00:00.000000Z' - readOnly: true modified: type: string format: date-time - description: The time when this SOD policy is modified. + description: The time when this Segment is modified example: '2020-01-01T00:00:00.000000Z' - readOnly: true description: type: string - description: Optional description of the SOD policy - example: This policy ensures compliance of xyz - nullable: true - ownerRef: + description: Optional description of the Segment + example: This segment represents xyz + owner: 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 - - WORKGROUP - 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 - externalPolicyReference: - type: string - description: Optional External Policy Reference - example: XYZ policy - nullable: true - policyQuery: - type: string - description: Search query of the SOD policy - example: '@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)' - compensatingControls: - type: string - description: Optional compensating controls(Mitigating Controls) - example: Have a manager review the transaction decisions for their "out of compliance" employee - nullable: true - correctionAdvice: - type: string - description: Optional correction advice - example: 'Based on the role of the employee, managers should remove access that is not required for their job function.' - nullable: true - state: - type: string - description: whether the policy is enforced or not - enum: - - ENFORCED - - NOT_ENFORCED - example: ENFORCED - tags: - type: array - description: tags for this policy object - example: - - TAG1 - - TAG2 - items: - type: string - creatorId: - type: string - description: Policy's creator ID - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - readOnly: true - modifierId: - type: string - description: Policy's modifier ID - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde nullable: true - readOnly: true - violationOwnerAssignmentConfig: - nullable: true - type: object - properties: - assignmentRule: - type: string - enum: - - MANAGER - - STATIC - - null - description: |- - Details about the violations owner. - MANAGER - identity's manager - STATIC - Governance Group or Identity - example: MANAGER - nullable: true - ownerRef: - 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 - - WORKGROUP - 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 - - nullable: true - scheduled: - type: boolean - description: defines whether a policy has been scheduled or not - example: true - default: false - type: - type: string - description: whether a policy is query based or conflicting access based - default: GENERAL - enum: - - GENERAL - - CONFLICTING_ACCESS_BASED - example: GENERAL - conflictingAccessCriteria: - allOf: - - type: object - properties: - leftCriteria: - type: object - properties: - name: - type: string - description: Business name for the access construct list - example: money-in - criteriaList: - type: array - description: List of criteria. There is a min of 1 and max of 50 items in the list. - minItems: 1 - maxItems: 50 - items: - type: object - properties: - type: - type: string - enum: - - ENTITLEMENT - description: Type of the propery to which this reference applies to - example: ENTITLEMENT - id: - type: string - description: ID of the object to which this reference applies to - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies to - example: Administrator - example: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - name: Administrator - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - name: Administrator - rightCriteria: - type: object - properties: - name: - type: string - description: Business name for the access construct list - example: money-in - criteriaList: - type: array - description: List of criteria. There is a min of 1 and max of 50 items in the list. - minItems: 1 - maxItems: 50 - items: - type: object - properties: - type: - type: string - enum: - - ENTITLEMENT - description: Type of the propery to which this reference applies to - example: ENTITLEMENT - id: - type: string - description: ID of the object to which this reference applies to - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies to - example: Administrator - example: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - name: Administrator - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - name: Administrator - - nullable: true - examples: - Conflicting Access Based Policy: - value: - id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - name: Conflicting-Policy-Name - created: '2020-01-01T00:00:00.000000Z' - modified: '2020-01-01T00:00:00.000000Z' - description: This policy ensures compliance of xyz - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Owner Name - externalPolicyReference: XYZ policy - policyQuery: '@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)' - compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee - correctionAdvice: 'Based on the role of the employee, managers should remove access that is not required for their job function.' - state: ENFORCED - tags: - - string - creatorId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - modifierId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - violationOwnerAssignmentConfig: - assignmentRule: MANAGER - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Violation Owner Name - scheduled: true - type: CONFLICTING_ACCESS_BASED - conflictingAccessCriteria: - leftCriteria: - name: money-in - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - rightCriteria: - name: money-out - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a68 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a69 - General Policy: - value: - description: Description - ownerRef: - type: IDENTITY - id: 2c918087682f9a86016839c05e8f1aff - name: Owner Name - externalPolicyReference: New policy - policyQuery: policy query implementation - compensatingControls: Compensating controls - correctionAdvice: Correction advice - tags: [] - state: ENFORCED - scheduled: false - creatorId: 2c918087682f9a86016839c05e8f1aff - modifierId: null - violationOwnerAssignmentConfig: null - type: GENERAL - conflictingAccessCriteria: null - id: 52c11db4-733e-4c31-949a-766c95ec95f1 - name: General-Policy-Name - created: '2020-05-12T19:47:38Z' - modified: '2020-05-12T19:47:38Z' + description: The owner of this object. + properties: + type: + description: 'Owner type. This field must be either left null or set to ''IDENTITY'' on input, otherwise a 400 Bad Request error will result.' + example: IDENTITY + 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 + - WORKGROUP + id: + type: string + description: Identity id + example: 2c9180a46faadee4016fb4e018c20639 + name: + type: string + description: 'Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner''s display name, otherwise a 400 Bad Request error will result.' + example: support + visibilityCriteria: + type: object + properties: + expression: + type: object + properties: + operator: + type: string + description: Operator for the expression + enum: + - AND + - EQUALS + example: EQUALS + attribute: + type: string + description: Name for the attribute + example: location + value: + type: object + properties: + type: + type: string + description: The type of attribute value + example: STRING + value: + type: string + description: The attribute value + example: Austin + children: + type: array + nullable: true + description: List of expressions + items: + type: object + properties: + type: + type: string + description: The type of attribute value + example: STRING + value: + type: string + description: The attribute value + example: Austin + example: [] + active: + type: boolean + description: Whether the Segment is currently active. Inactive segments have no effect. + default: false + example: true '400': description: Client Error - Returned if the request body is invalid. content: @@ -82681,698 +73342,428 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - put: - security: - - UserContextAuth: - - 'idn:sod-policy:write' - operationId: setSodPolicy + /service-desk-integrations: + get: tags: - - SOD Policy - summary: Update SOD policy by ID - description: |- - This updates a specified SOD policy. - Requires role of ORG_ADMIN. + - Service Desk Integration + summary: List existing Service Desk Integrations + description: Get a list of ServiceDeskIntegrationDto for existing Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + operationId: getServiceDeskIntegrations parameters: - - in: path - name: id + - 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: 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 + - name: sorters + in: query + required: false + style: form + explode: true schema: type: string - required: true - description: The ID of the SOD policy to update. - example: ef38f943-47e9-4562-b5bb-8424a56397d8 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: Policy id - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - readOnly: true - name: - type: string - description: Policy Business Name - example: policy-xyz - created: - type: string - format: date-time - description: The time when this SOD policy is created. - example: '2020-01-01T00:00:00.000000Z' - readOnly: true - modified: - type: string - format: date-time - description: The time when this SOD policy is modified. - example: '2020-01-01T00:00:00.000000Z' - readOnly: true - description: - type: string - description: Optional description of the SOD policy - example: This policy ensures compliance of xyz - nullable: true - ownerRef: - 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 - - WORKGROUP - 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 - externalPolicyReference: - type: string - description: Optional External Policy Reference - example: XYZ policy - nullable: true - policyQuery: - type: string - description: Search query of the SOD policy - example: '@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)' - compensatingControls: - type: string - description: Optional compensating controls(Mitigating Controls) - example: Have a manager review the transaction decisions for their "out of compliance" employee - nullable: true - correctionAdvice: - type: string - description: Optional correction advice - example: 'Based on the role of the employee, managers should remove access that is not required for their job function.' - nullable: true - state: - type: string - description: whether the policy is enforced or not - enum: - - ENFORCED - - NOT_ENFORCED - example: ENFORCED - tags: - type: array - description: tags for this policy object - example: - - TAG1 - - TAG2 - items: - type: string - creatorId: - type: string - description: Policy's creator ID - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - readOnly: true - modifierId: - type: string - description: Policy's modifier ID - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - nullable: true - readOnly: true - violationOwnerAssignmentConfig: - nullable: true - type: object - properties: - assignmentRule: - type: string - enum: - - MANAGER - - STATIC - - null - description: |- - Details about the violations owner. - MANAGER - identity's manager - STATIC - Governance Group or Identity - example: MANAGER - nullable: true - ownerRef: - allOf: - - type: object + 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** + example: name + - name: filters + in: query + required: false + style: form + explode: true + schema: + type: string + format: comma-separated + 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* + + **type**: *eq, in* + + **cluster**: *eq, in* + example: name eq "John Doe" + - 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 + responses: + '200': + description: List of ServiceDeskIntegrationDto + content: + application/json: + schema: + type: array + items: + allOf: + - type: object + required: + - name + properties: + id: + description: System-generated unique ID of the Object + type: string + example: id12345 + readOnly: true + name: + description: Name of the Object + type: string + example: aName + created: + description: Creation date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + modified: + description: Last modification date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + - type: object + description: Specification of a Service Desk integration + required: + - description + - type + - attributes + properties: + description: + description: Description of the Service Desk integration + type: string + example: A very nice Service Desk integration + type: + description: | + Service Desk integration types + + - ServiceNowSDIM + - ServiceNow + type: string + default: ServiceNowSDIM + example: ServiceNowSDIM + ownerRef: + 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 + - WORKGROUP + 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 + description: Reference to the identity that is the owner of this Service Desk integration properties: type: - description: DTO type - type: string + description: The type of object being referenced 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 - - WORKGROUP example: IDENTITY id: - type: string - description: ID of the object to which this reference applies + description: ID of the identity example: 2c91808568c529c60168cca6f90c1313 name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - - nullable: true - scheduled: - type: boolean - description: defines whether a policy has been scheduled or not - example: true - default: false - type: - type: string - description: whether a policy is query based or conflicting access based - default: GENERAL - enum: - - GENERAL - - CONFLICTING_ACCESS_BASED - example: GENERAL - conflictingAccessCriteria: - allOf: - - type: object - properties: - leftCriteria: - type: object + description: Human-readable display name of the identity + example: MyName + clusterRef: + 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 + - WORKGROUP + 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 + description: Reference to the source cluster for this Service Desk integration properties: + type: + description: The type of object being referenced + enum: + - CLUSTER + example: CLUSTER + id: + description: ID of the cluster + example: 2c9180866166b5b0016167c32ef31a66 name: - type: string - description: Business name for the access construct list - example: money-in - criteriaList: - type: array - description: List of criteria. There is a min of 1 and max of 50 items in the list. - minItems: 1 - maxItems: 50 - items: - type: object - properties: - type: - type: string - enum: - - ENTITLEMENT - description: Type of the propery to which this reference applies to - example: ENTITLEMENT - id: - type: string - description: ID of the object to which this reference applies to - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies to - example: Administrator - example: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - name: Administrator - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - name: Administrator - rightCriteria: + description: Human-readable display name of the cluster + example: Corporate Cluster + cluster: + description: 'ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)' + type: string + example: xyzzy999 + deprecated: true + managedSources: + description: 'Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)' + type: array + items: + type: string + deprecated: true + example: + - 2c9180835d191a86015d28455b4a2329 + - 2c5680835d191a85765d28455b4a9823 + provisioningConfig: + description: The 'provisioningConfig' property specifies the configuration used to provision integrations. type: object properties: - name: - type: string - description: Business name for the access construct list - example: money-in - criteriaList: + universalManager: + description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' + type: boolean + readOnly: true + example: true + managedResourceRefs: + description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. type: array - description: List of criteria. There is a min of 1 and max of 50 items in the list. - minItems: 1 - maxItems: 50 items: - type: object - properties: - type: - type: string - enum: - - ENTITLEMENT - description: Type of the propery to which this reference applies to - example: ENTITLEMENT - id: - type: string - description: ID of the object to which this reference applies to - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies to - example: Administrator - example: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - name: Administrator - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - name: Administrator - - nullable: true - examples: - Conflicting Access Based Policy: - value: - name: Conflicting-Policy-Name - description: Modified Description - externalPolicyReference: XYZ policy - compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee - correctionAdvice: 'Based on the role of the employee, managers should remove access that is not required for their job function.' - state: ENFORCED - tags: - - string - violationOwnerAssignmentConfig: - assignmentRule: MANAGER - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Violation Owner Name - scheduled: true - type: CONFLICTING_ACCESS_BASED - conflictingAccessCriteria: - leftCriteria: - name: money-in - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - rightCriteria: - name: money-out - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a68 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a69 - General Policy: - value: - description: Modified Description - ownerRef: - type: IDENTITY - id: 2c918087682f9a86016839c05e8f1aff - name: Owner Name - externalPolicyReference: New policy - policyQuery: policy query implementation - compensatingControls: Compensating controls - correctionAdvice: Correction advice - tags: [] - state: ENFORCED - scheduled: false - creatorId: 2c918087682f9a86016839c05e8f1aff - modifierId: null - violationOwnerAssignmentConfig: null - type: GENERAL - conflictingAccessCriteria: null - id: 52c11db4-733e-4c31-949a-766c95ec95f1 - name: General-Policy-Name - created: '2020-05-12T19:47:38Z' - modified: '2020-05-12T19:47:38Z' - responses: - '200': - description: SOD Policy by ID - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: Policy id - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - readOnly: true - name: - type: string - description: Policy Business Name - example: policy-xyz - created: - type: string - format: date-time - description: The time when this SOD policy is created. - example: '2020-01-01T00:00:00.000000Z' - readOnly: true - modified: - type: string - format: date-time - description: The time when this SOD policy is modified. - example: '2020-01-01T00:00:00.000000Z' - readOnly: true - description: - type: string - description: Optional description of the SOD policy - example: This policy ensures compliance of xyz - nullable: true - ownerRef: - 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 - - WORKGROUP - 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 - externalPolicyReference: - type: string - description: Optional External Policy Reference - example: XYZ policy - nullable: true - policyQuery: - type: string - description: Search query of the SOD policy - example: '@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)' - compensatingControls: - type: string - description: Optional compensating controls(Mitigating Controls) - example: Have a manager review the transaction decisions for their "out of compliance" employee - nullable: true - correctionAdvice: - type: string - description: Optional correction advice - example: 'Based on the role of the employee, managers should remove access that is not required for their job function.' - nullable: true - state: - type: string - description: whether the policy is enforced or not - enum: - - ENFORCED - - NOT_ENFORCED - example: ENFORCED - tags: - type: array - description: tags for this policy object - example: - - TAG1 - - TAG2 - items: - type: string - creatorId: - type: string - description: Policy's creator ID - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - readOnly: true - modifierId: - type: string - description: Policy's modifier ID - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - nullable: true - readOnly: true - violationOwnerAssignmentConfig: - nullable: true - type: object - properties: - assignmentRule: - type: string - enum: - - MANAGER - - STATIC - - null - description: |- - Details about the violations owner. - MANAGER - identity's manager - STATIC - Governance Group or Identity - example: MANAGER - nullable: true - ownerRef: - 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 - - WORKGROUP - 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 - - nullable: true - scheduled: - type: boolean - description: defines whether a policy has been scheduled or not - example: true - default: false - type: - type: string - description: whether a policy is query based or conflicting access based - default: GENERAL - enum: - - GENERAL - - CONFLICTING_ACCESS_BASED - example: GENERAL - conflictingAccessCriteria: - allOf: - - type: object - properties: - leftCriteria: - type: object - properties: - name: - type: string - description: Business name for the access construct list - example: money-in - criteriaList: - type: array - description: List of criteria. There is a min of 1 and max of 50 items in the list. - minItems: 1 - maxItems: 50 - items: - type: object - properties: - type: - type: string - enum: - - ENTITLEMENT - description: Type of the propery to which this reference applies to - example: ENTITLEMENT - id: - type: string - description: ID of the object to which this reference applies to - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies to - example: Administrator - example: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - name: Administrator - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - name: Administrator - rightCriteria: - type: object - properties: - name: - type: string - description: Business name for the access construct list - example: money-in - criteriaList: - type: array - description: List of criteria. There is a min of 1 and max of 50 items in the list. - minItems: 1 - maxItems: 50 - items: - type: object - properties: - type: - type: string - enum: - - ENTITLEMENT - description: Type of the propery to which this reference applies to - example: ENTITLEMENT - id: - type: string - description: ID of the object to which this reference applies to - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies to - example: Administrator - example: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - name: Administrator - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - name: Administrator - - nullable: true - examples: - Conflicting Access Based Policy: - value: - id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - name: Conflicting-Policy-Name - created: '2020-01-01T00:00:00.000000Z' - modified: '2020-01-01T00:00:00.000000Z' - description: Modified description - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Owner Name - externalPolicyReference: XYZ policy - policyQuery: '@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)' - compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee - correctionAdvice: 'Based on the role of the employee, managers should remove access that is not required for their job function.' - state: ENFORCED - tags: - - string - creatorId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - modifierId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - violationOwnerAssignmentConfig: - assignmentRule: MANAGER - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Violation Owner Name - scheduled: true - type: CONFLICTING_ACCESS_BASED - conflictingAccessCriteria: - leftCriteria: - name: money-in - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - rightCriteria: - name: money-out - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a68 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a69 - General Policy: - value: - description: Modified Description - ownerRef: - type: IDENTITY - id: 2c918087682f9a86016839c05e8f1aff - name: Owner Name - externalPolicyReference: New policy - policyQuery: policy query implementation - compensatingControls: Compensating controls - correctionAdvice: Correction advice - tags: [] - state: ENFORCED - scheduled: false - creatorId: 2c918087682f9a86016839c05e8f1aff - modifierId: null - violationOwnerAssignmentConfig: null - type: GENERAL - conflictingAccessCriteria: null - id: 52c11db4-733e-4c31-949a-766c95ec95f1 - name: General-Policy-Name - created: '2020-05-12T19:47:38Z' - modified: '2020-05-12T19:47:38Z' + 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 + - WORKGROUP + 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 + properties: + type: + description: The type of object being referenced + enum: + - SOURCE + example: SOURCE + id: + description: ID of the source + example: 2c91808568c529c60168cca6f90c1313 + name: + description: Human-readable display name of the source + example: My Source + example: + - type: SOURCE + id: 2c9180855d191c59015d291ceb051111 + name: My Source 1 + - type: SOURCE + id: 2c9180855d191c59015d291ceb052222 + name: My Source 2 + planInitializerScript: + description: This is a reference to a plan initializer script. + type: object + properties: + source: + description: This is a Rule that allows provisioning instruction changes. + type: string + example: | + \r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n + noProvisioningRequests: + description: Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. + type: boolean + example: true + provisioningRequestExpiration: + description: 'When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.' + type: integer + format: int32 + example: 7 + attributes: + description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation. + type: object + additionalProperties: true + example: + property: value + key: value + beforeProvisioningRule: + 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 + - WORKGROUP + 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 + description: Reference to beforeProvisioningRule for this Service Desk integration + properties: + type: + description: The type of object being referenced + enum: + - RULE + example: RULE + id: + description: ID of the rule + example: 2c91808568c529c60168cca6f90c1333 + name: + description: Human-readable display name of the rule + example: Example Rule '400': description: Client Error - Returned if the request body is invalid. content: @@ -83651,550 +74042,409 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - delete: security: - UserContextAuth: - - 'idn:sod-policy:write' - operationId: deleteSodPolicy + - 'idn:service-desk-admin:read' + - 'idn:service-desk-integration:read' + post: tags: - - SOD Policy - summary: Delete SOD policy by ID - description: |- - This deletes a specified SOD policy. - Requires role of ORG_ADMIN. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The ID of the SOD Policy to delete. - example: ef38f943-47e9-4562-b5bb-8424a56397d8 - - in: query - name: logical - schema: - type: boolean - default: true - description: Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. - example: true - required: false - responses: - '204': - description: No content. - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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 + - Service Desk Integration + summary: Create new Service Desk integration + description: Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + operationId: createServiceDeskIntegration + requestBody: + description: The specifics of a new integration to create + content: + application/json: + schema: + allOf: + - type: object + required: + - name + properties: + id: + description: System-generated unique ID of the Object + type: string + example: id12345 + readOnly: true + name: + description: Name of the Object + type: string + example: aName + created: + description: Creation date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + modified: + description: Last modification date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + - type: object + description: Specification of a Service Desk integration + required: + - description + - type + - attributes + properties: + description: + description: Description of the Service Desk integration + type: string + example: A very nice Service Desk integration + type: + description: | + Service Desk integration types + + - ServiceNowSDIM + - ServiceNow + type: string + default: ServiceNowSDIM + example: ServiceNowSDIM + ownerRef: + 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 + - WORKGROUP + 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 + description: Reference to the identity that is the owner of this Service Desk integration properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string + type: + description: The type of object being referenced 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 + - IDENTITY + example: IDENTITY + id: + description: ID of the identity + example: 2c91808568c529c60168cca6f90c1313 + name: + description: Human-readable display name of the identity + example: MyName + clusterRef: + 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 + - WORKGROUP + 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 + description: Reference to the source cluster for this Service Desk integration + properties: + type: + description: The type of object being referenced 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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: + - CLUSTER + example: CLUSTER + id: + description: ID of the cluster + example: 2c9180866166b5b0016167c32ef31a66 + name: + description: Human-readable display name of the cluster + example: Corporate Cluster + cluster: + description: 'ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)' + type: string + example: xyzzy999 + deprecated: true + managedSources: + description: 'Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)' + type: array + items: + type: string + deprecated: true + example: + - 2c9180835d191a86015d28455b4a2329 + - 2c5680835d191a85765d28455b4a9823 + provisioningConfig: + description: The 'provisioningConfig' property specifies the configuration used to provision integrations. 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: + universalManager: + description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' + type: boolean + readOnly: true + example: true + managedResourceRefs: + description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. + type: array + items: + 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 + - WORKGROUP + 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 + properties: + type: + description: The type of object being referenced + enum: + - SOURCE + example: SOURCE + id: + description: ID of the source + example: 2c91808568c529c60168cca6f90c1313 + name: + description: Human-readable display name of the source + example: My Source + example: + - type: SOURCE + id: 2c9180855d191c59015d291ceb051111 + name: My Source 1 + - type: SOURCE + id: 2c9180855d191c59015d291ceb052222 + name: My Source 2 + planInitializerScript: + description: This is a reference to a plan initializer script. + type: object + properties: + source: + description: This is a Rule that allows provisioning instruction changes. + type: string + example: | + \r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n + noProvisioningRequests: + description: Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. + type: boolean + example: true + provisioningRequestExpiration: + description: 'When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.' + type: integer + format: int32 + example: 7 + attributes: + description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation. type: object + additionalProperties: true + example: + property: value + key: value + beforeProvisioningRule: + 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 + - WORKGROUP + 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 + description: Reference to beforeProvisioningRule for this Service Desk integration properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string + type: + description: The type of object being referenced 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. - patch: - security: - - UserContextAuth: - - 'idn:sod-policy:write' - operationId: patchSodPolicy - tags: - - SOD Policy - summary: Patch SOD policy by ID - description: |- - Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - Requires role of ORG_ADMIN. - This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The ID of the SOD policy being modified. - example: 2c918083-5d19-1a86-015d-28455b4a2329 - requestBody: + - RULE + example: RULE + id: + description: ID of the rule + example: 2c91808568c529c60168cca6f90c1333 + name: + description: Human-readable display name of the rule + example: Example Rule required: true - description: | - A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - The following fields are patchable: - * name - * description - * ownerRef - * externalPolicyReference - * compensatingControls - * correctionAdvice - * state - * tags - * violationOwnerAssignmentConfig - * scheduled - * conflictingAccessCriteria - content: - application/json-patch+json: - schema: - type: array - items: - type: object - description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' - required: - - op - - path - properties: - op: - type: string - description: The operation to be performed - enum: - - add - - remove - - replace - - move - - copy - - test - example: replace - path: - type: string - description: A string JSON Pointer representing the target path to an element to be affected by the operation - example: /description - value: - anyOf: - - type: string - - type: integer - - type: object - - type: array - items: - anyOf: - - type: string - - type: integer - - type: object - description: 'The value to be used for the operation, required for "add" and "replace" operations' - example: New description - examples: - Conflicting Access Based Policy: - value: - - op: replace - path: /description - value: Modified description - - op: replace - path: /conflictingAccessCriteria/leftCriteria/name - value: money-in-modified - - op: replace - path: /conflictingAccessCriteria/rightCriteria - value: - name: money-out-modified - criteriaList: - - type: ENTITLEMENT - id: 2c918087682f9a86016839c0509c1ab2 - General Policy: - value: - - op: replace - path: /description - value: Modified description responses: '200': - description: 'Indicates the PATCH operation succeeded, and returns the SOD policy''s new representation.' + description: details of the created integration content: application/json: schema: - type: object - properties: - id: - type: string - description: Policy id - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - readOnly: true - name: - type: string - description: Policy Business Name - example: policy-xyz - created: - type: string - format: date-time - description: The time when this SOD policy is created. - example: '2020-01-01T00:00:00.000000Z' - readOnly: true - modified: - type: string - format: date-time - description: The time when this SOD policy is modified. - example: '2020-01-01T00:00:00.000000Z' - readOnly: true - description: - type: string - description: Optional description of the SOD policy - example: This policy ensures compliance of xyz - nullable: true - ownerRef: - type: object + allOf: + - type: object + required: + - name 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 - - WORKGROUP - example: IDENTITY id: + description: System-generated unique ID of the Object type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 + example: id12345 + readOnly: true name: + description: Name of the Object type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - externalPolicyReference: - type: string - description: Optional External Policy Reference - example: XYZ policy - nullable: true - policyQuery: - type: string - description: Search query of the SOD policy - example: '@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)' - compensatingControls: - type: string - description: Optional compensating controls(Mitigating Controls) - example: Have a manager review the transaction decisions for their "out of compliance" employee - nullable: true - correctionAdvice: - type: string - description: Optional correction advice - example: 'Based on the role of the employee, managers should remove access that is not required for their job function.' - nullable: true - state: - type: string - description: whether the policy is enforced or not - enum: - - ENFORCED - - NOT_ENFORCED - example: ENFORCED - tags: - type: array - description: tags for this policy object - example: - - TAG1 - - TAG2 - items: - type: string - creatorId: - type: string - description: Policy's creator ID - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - readOnly: true - modifierId: - type: string - description: Policy's modifier ID - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - nullable: true - readOnly: true - violationOwnerAssignmentConfig: - nullable: true - type: object + example: aName + created: + description: Creation date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + modified: + description: Last modification date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + - type: object + description: Specification of a Service Desk integration + required: + - description + - type + - attributes properties: - assignmentRule: + description: + description: Description of the Service Desk integration type: string - enum: - - MANAGER - - STATIC - - null - description: |- - Details about the violations owner. - MANAGER - identity's manager - STATIC - Governance Group or Identity - example: MANAGER - nullable: true + example: A very nice Service Desk integration + type: + description: | + Service Desk integration types + + - ServiceNowSDIM + - ServiceNow + type: string + default: ServiceNowSDIM + example: ServiceNowSDIM ownerRef: allOf: - type: object @@ -84240,298 +74490,252 @@ paths: type: string description: Human-readable display name of the object to which this reference applies example: William Wilson - - nullable: true - scheduled: - type: boolean - description: defines whether a policy has been scheduled or not - example: true - default: false - type: - type: string - description: whether a policy is query based or conflicting access based - default: GENERAL - enum: - - GENERAL - - CONFLICTING_ACCESS_BASED - example: GENERAL - conflictingAccessCriteria: - allOf: - - type: object + description: Reference to the identity that is the owner of this Service Desk integration properties: - leftCriteria: - type: object + type: + description: The type of object being referenced + enum: + - IDENTITY + example: IDENTITY + id: + description: ID of the identity + example: 2c91808568c529c60168cca6f90c1313 + name: + description: Human-readable display name of the identity + example: MyName + clusterRef: + 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 + - WORKGROUP + example: IDENTITY + id: + type: string + description: ID of the object to which this reference applies + example: 2c91808568c529c60168cca6f90c1313 name: type: string - description: Business name for the access construct list - example: money-in - criteriaList: - type: array - description: List of criteria. There is a min of 1 and max of 50 items in the list. - minItems: 1 - maxItems: 50 - items: - type: object + description: Human-readable display name of the object to which this reference applies + example: William Wilson + description: Reference to the source cluster for this Service Desk integration + properties: + type: + description: The type of object being referenced + enum: + - CLUSTER + example: CLUSTER + id: + description: ID of the cluster + example: 2c9180866166b5b0016167c32ef31a66 + name: + description: Human-readable display name of the cluster + example: Corporate Cluster + cluster: + description: 'ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)' + type: string + example: xyzzy999 + deprecated: true + managedSources: + description: 'Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)' + type: array + items: + type: string + deprecated: true + example: + - 2c9180835d191a86015d28455b4a2329 + - 2c5680835d191a85765d28455b4a9823 + provisioningConfig: + description: The 'provisioningConfig' property specifies the configuration used to provision integrations. + type: object + properties: + universalManager: + description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' + type: boolean + readOnly: true + example: true + managedResourceRefs: + description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. + type: array + items: + 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 - description: Type of the propery to which this reference applies to - example: 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 + - WORKGROUP + example: IDENTITY id: type: string - description: ID of the object to which this reference applies to + 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 to - example: Administrator - example: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - name: Administrator - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - name: Administrator - rightCriteria: + description: Human-readable display name of the object to which this reference applies + example: William Wilson + properties: + type: + description: The type of object being referenced + enum: + - SOURCE + example: SOURCE + id: + description: ID of the source + example: 2c91808568c529c60168cca6f90c1313 + name: + description: Human-readable display name of the source + example: My Source + example: + - type: SOURCE + id: 2c9180855d191c59015d291ceb051111 + name: My Source 1 + - type: SOURCE + id: 2c9180855d191c59015d291ceb052222 + name: My Source 2 + planInitializerScript: + description: This is a reference to a plan initializer script. type: object properties: + source: + description: This is a Rule that allows provisioning instruction changes. + type: string + example: | + \r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n + noProvisioningRequests: + description: Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. + type: boolean + example: true + provisioningRequestExpiration: + description: 'When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.' + type: integer + format: int32 + example: 7 + attributes: + description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation. + type: object + additionalProperties: true + example: + property: value + key: value + beforeProvisioningRule: + 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 + - WORKGROUP + example: IDENTITY + id: + type: string + description: ID of the object to which this reference applies + example: 2c91808568c529c60168cca6f90c1313 name: type: string - description: Business name for the access construct list - example: money-in - criteriaList: - type: array - description: List of criteria. There is a min of 1 and max of 50 items in the list. - minItems: 1 - maxItems: 50 - items: - type: object - properties: - type: - type: string - enum: - - ENTITLEMENT - description: Type of the propery to which this reference applies to - example: ENTITLEMENT - id: - type: string - description: ID of the object to which this reference applies to - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies to - example: Administrator - example: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - name: Administrator - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - name: Administrator - - nullable: true - examples: - Conflicting Access Based Policy: - value: - id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - name: Conflicting-Policy-Name - created: '2020-01-01T00:00:00.000000Z' - modified: '2020-01-01T00:00:00.000000Z' - description: Modified description - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Owner Name - externalPolicyReference: XYZ policy - policyQuery: '@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c918087682f9a86016839c0509c1ab2)' - compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee - correctionAdvice: 'Based on the role of the employee, managers should remove access that is not required for their job function.' - state: ENFORCED - tags: - - string - creatorId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - modifierId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - violationOwnerAssignmentConfig: - assignmentRule: MANAGER - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Violation Owner Name - scheduled: true - type: CONFLICTING_ACCESS_BASED - conflictingAccessCriteria: - leftCriteria: - name: money-in-modified - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - rightCriteria: - name: money-out-modified - criteriaList: - - type: ENTITLEMENT - id: 2c918087682f9a86016839c0509c1ab2 - General Policy: - value: - description: Modified description - ownerRef: - type: IDENTITY - id: 2c918087682f9a86016839c05e8f1aff - name: Owner Name - externalPolicyReference: New policy - policyQuery: policy query implementation - compensatingControls: Compensating controls - correctionAdvice: Correction advice - tags: [] - state: ENFORCED - scheduled: false - creatorId: 2c918087682f9a86016839c05e8f1aff - modifierId: null - violationOwnerAssignmentConfig: null - type: GENERAL - conflictingAccessCriteria: null - id: 52c11db4-733e-4c31-949a-766c95ec95f1 - name: General-Policy-Name - created: '2020-05-12T19:47:38Z' - modified: '2020-05-12T19:47:38Z' - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist + description: Human-readable display name of the object to which this reference applies + example: William Wilson + description: Reference to beforeProvisioningRule for this Service Desk integration + properties: + type: + description: The type of object being referenced + enum: + - RULE + example: RULE + id: + description: ID of the rule + example: 2c91808568c529c60168cca6f90c1333 + name: + description: Human-readable display name of the rule + example: Example Rule + '400': + description: Client Error - Returned if the request body is invalid. content: application/json: schema: @@ -84587,28 +74791,18 @@ paths: 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. + '401': + description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' content: application/json: schema: type: object properties: - message: + error: description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected 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: @@ -84665,103 +74859,17 @@ paths: 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 + '403': + summary: An example of a 403 response object value: - detailCode: 500.0 Internal Fault + detailCode: 403 Forbidden trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: An internal fault occurred. - '/sod-policies/{id}/evaluate': - post: - security: - - UserContextAuth: - - 'idn:sod-violation:write' - operationId: startEvaluateSodPolicy - tags: - - SOD Policy - summary: Evaluate one policy by ID - description: Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The SOD policy ID to run. - example: ef38f943-47e9-4562-b5bb-8424a56397d8 - responses: - '200': - description: Reference to the violation report run task. - content: - application/json: - schema: - 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 - - WORKGROUP - 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 - properties: - status: - type: string - description: Status of a violation report - enum: - - SUCCESS - - WARNING - - ERROR - - TERMINATED - - TEMP_ERROR - - PENDING - example: PENDING - example: - status: PENDING - type: REPORT_RESULT - id: 37b3b32a-f394-46f8-acad-b5223969fa68 - name: Multi Query Report - '400': - description: Client Error - Returned if the request body is invalid. + text: The server understood the request but refuses to authorize it. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist content: application/json: schema: @@ -84817,18 +74925,28 @@ paths: 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.' + examples: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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: - error: + message: 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.' + example: ' Rate Limit Exceeded ' + '500': + description: Internal Server Error - Returned if there is an unexpected error. content: application/json: schema: @@ -84885,27 +75003,379 @@ paths: 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 + '500': + summary: An example of a 500 response object value: - detailCode: 403 Forbidden + detailCode: 500.0 Internal Fault 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. + text: An internal fault occurred. + security: + - UserContextAuth: + - 'idn:service-desk-admin:manage' + - 'idn:service-desk-integration:manage' + '/service-desk-integrations/{id}': + get: + tags: + - Service Desk Integration + summary: Get a Service Desk integration + description: Get an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + operationId: getServiceDeskIntegration + parameters: + - name: id + in: path + description: ID of the Service Desk integration to get + required: true + style: simple + explode: false + schema: + type: string + example: anId + responses: + '200': + description: ServiceDeskIntegrationDto with the given ID 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. + allOf: + - type: object + required: + - name + properties: + id: + description: System-generated unique ID of the Object + type: string + example: id12345 + readOnly: true + name: + description: Name of the Object + type: string + example: aName + created: + description: Creation date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + modified: + description: Last modification date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + - type: object + description: Specification of a Service Desk integration + required: + - description + - type + - attributes + properties: + description: + description: Description of the Service Desk integration + type: string + example: A very nice Service Desk integration + type: + description: | + Service Desk integration types + + - ServiceNowSDIM + - ServiceNow + type: string + default: ServiceNowSDIM + example: ServiceNowSDIM + ownerRef: + 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 + - WORKGROUP + 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 + description: Reference to the identity that is the owner of this Service Desk integration + properties: + type: + description: The type of object being referenced + enum: + - IDENTITY + example: IDENTITY + id: + description: ID of the identity + example: 2c91808568c529c60168cca6f90c1313 + name: + description: Human-readable display name of the identity + example: MyName + clusterRef: + 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 + - WORKGROUP + 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 + description: Reference to the source cluster for this Service Desk integration + properties: + type: + description: The type of object being referenced + enum: + - CLUSTER + example: CLUSTER + id: + description: ID of the cluster + example: 2c9180866166b5b0016167c32ef31a66 + name: + description: Human-readable display name of the cluster + example: Corporate Cluster + cluster: + description: 'ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)' + type: string + example: xyzzy999 + deprecated: true + managedSources: + description: 'Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)' + type: array + items: + type: string + deprecated: true + example: + - 2c9180835d191a86015d28455b4a2329 + - 2c5680835d191a85765d28455b4a9823 + provisioningConfig: + description: The 'provisioningConfig' property specifies the configuration used to provision integrations. + type: object + properties: + universalManager: + description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' + type: boolean + readOnly: true + example: true + managedResourceRefs: + description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. + type: array + items: + 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 + - WORKGROUP + 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 + properties: + type: + description: The type of object being referenced + enum: + - SOURCE + example: SOURCE + id: + description: ID of the source + example: 2c91808568c529c60168cca6f90c1313 + name: + description: Human-readable display name of the source + example: My Source + example: + - type: SOURCE + id: 2c9180855d191c59015d291ceb051111 + name: My Source 1 + - type: SOURCE + id: 2c9180855d191c59015d291ceb052222 + name: My Source 2 + planInitializerScript: + description: This is a reference to a plan initializer script. + type: object + properties: + source: + description: This is a Rule that allows provisioning instruction changes. + type: string + example: | + \r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n + noProvisioningRequests: + description: Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. + type: boolean + example: true + provisioningRequestExpiration: + description: 'When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.' + type: integer + format: int32 + example: 7 + attributes: + description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation. + type: object + additionalProperties: true + example: + property: value + key: value + beforeProvisioningRule: + 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 + - WORKGROUP + 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 + description: Reference to beforeProvisioningRule for this Service Desk integration + properties: + type: + description: The type of object being referenced + enum: + - RULE + example: RULE + id: + description: ID of the rule + example: 2c91808568c529c60168cca6f90c1333 + name: + description: Human-readable display name of the rule + example: Example Rule + '400': + description: Client Error - Returned if the request body is invalid. content: application/json: schema: @@ -84961,249 +75431,18 @@ paths: 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. - '/sod-policies/{id}/schedule': - get: - security: - - UserContextAuth: - - 'idn:sod-policy:read' - operationId: getSodPolicySchedule - tags: - - SOD Policy - summary: Get SOD policy schedule - description: This endpoint gets a specified SOD policy's schedule. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The ID of the SOD policy schedule to retrieve. - example: ef38f943-47e9-4562-b5bb-8424a56397d8 - responses: - '200': - description: SOD policy schedule. + '401': + description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' content: application/json: schema: type: object properties: - name: - type: string - description: SOD Policy schedule name - example: SCH-1584312283015 - created: - type: string - format: date-time - description: The time when this SOD policy schedule is created. - example: '2020-01-01T00:00:00.000000Z' - readOnly: true - modified: - type: string - format: date-time - description: The time when this SOD policy schedule is modified. - example: '2020-01-01T00:00:00.000000Z' - readOnly: true - description: - type: string - description: SOD Policy schedule description - example: Schedule for policy xyz - schedule: - type: object - description: The schedule information. - properties: - type: - description: | - Enum representing the currently supported schedule types. - - Additional values may be added in the future without notice. - type: string - enum: - - DAILY - - WEEKLY - - MONTHLY - - CALENDAR - example: WEEKLY - days: - allOf: - - type: object - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - - description: | - The days to execute the search. - - If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. - - If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. - example: - type: LIST - values: - - MON - - WED - - FRI - nullable: true - hours: - allOf: - - type: object - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - - description: The hours selected. - example: - type: RANGE - values: - - '9' - - '18' - interval: 3 - expiration: - description: 'The schedule expiration date. Latest possible expiration date is ''2038-01-19T03:14:07+0000''' - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - timeZoneId: - description: 'The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org''s default timezone is used.' - nullable: true - type: string - example: 'GMT-06:00' - required: - - type - - hours - recipients: - type: array - items: - 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 - - WORKGROUP - 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 - emailEmptyResults: - type: boolean - description: Indicates if empty results need to be emailed - example: false - default: false - creatorId: - type: string - description: Policy's creator ID - example: 0f11f2a47c944bf3a2bd742580fe3bde - readOnly: true - modifierId: - type: string - description: Policy's modifier ID - example: 0f11f2a47c944bf3a2bd742580fe3bde - readOnly: true - '400': - description: Client Error - Returned if the request body is invalid. + 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: @@ -85259,18 +75498,18 @@ paths: 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.' + 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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist content: application/json: schema: @@ -85327,15 +75566,15 @@ paths: 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 + '404': + summary: An example of a 404 response object value: - detailCode: 403 Forbidden + detailCode: 404 Not found trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. + text: The server did not find a current representation for the target resource. '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: @@ -85413,448 +75652,708 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - put: security: - UserContextAuth: - - 'idn:sod-policy:write' - operationId: setPolicySchedule + - 'idn:service-desk-admin:read' + - 'idn:service-desk-integration:read' + put: tags: - - SOD Policy - summary: Update SOD Policy schedule - description: This updates schedule for a specified SOD policy. + - Service Desk Integration + summary: Update a Service Desk integration + description: Update an existing Service Desk integration by ID with updated value in JSON form as the request body. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + operationId: putServiceDeskIntegration parameters: - - in: path - name: id + - name: id + in: path + description: ID of the Service Desk integration to update + required: true + style: simple + explode: false schema: type: string - required: true - description: The ID of the SOD policy to update its schedule. - example: ef38f943-47e9-4562-b5bb-8424a56397d8 + example: anId requestBody: - required: true + description: The specifics of the integration to update content: application/json: schema: - type: object - properties: - name: - type: string - description: SOD Policy schedule name - example: SCH-1584312283015 - created: - type: string - format: date-time - description: The time when this SOD policy schedule is created. - example: '2020-01-01T00:00:00.000000Z' - readOnly: true - modified: - type: string - format: date-time - description: The time when this SOD policy schedule is modified. - example: '2020-01-01T00:00:00.000000Z' - readOnly: true - description: - type: string - description: SOD Policy schedule description - example: Schedule for policy xyz - schedule: - type: object - description: The schedule information. + allOf: + - type: object + required: + - name properties: + id: + description: System-generated unique ID of the Object + type: string + example: id12345 + readOnly: true + name: + description: Name of the Object + type: string + example: aName + created: + description: Creation date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + modified: + description: Last modification date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + - type: object + description: Specification of a Service Desk integration + required: + - description + - type + - attributes + properties: + description: + description: Description of the Service Desk integration + type: string + example: A very nice Service Desk integration type: description: | - Enum representing the currently supported schedule types. + Service Desk integration types - Additional values may be added in the future without notice. + - ServiceNowSDIM + - ServiceNow type: string - enum: - - DAILY - - WEEKLY - - MONTHLY - - CALENDAR - example: WEEKLY - days: + default: ServiceNowSDIM + example: ServiceNowSDIM + ownerRef: + 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 + - WORKGROUP + 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 + description: Reference to the identity that is the owner of this Service Desk integration + properties: + type: + description: The type of object being referenced + enum: + - IDENTITY + example: IDENTITY + id: + description: ID of the identity + example: 2c91808568c529c60168cca6f90c1313 + name: + description: Human-readable display name of the identity + example: MyName + clusterRef: allOf: - type: object properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. + 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 + - WORKGROUP + 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 + description: Reference to the source cluster for this Service Desk integration + properties: + type: + description: The type of object being referenced + enum: + - CLUSTER + example: CLUSTER + id: + description: ID of the cluster + example: 2c9180866166b5b0016167c32ef31a66 + name: + description: Human-readable display name of the cluster + example: Corporate Cluster + cluster: + description: 'ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)' + type: string + example: xyzzy999 + deprecated: true + managedSources: + description: 'Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)' + type: array + items: + type: string + deprecated: true + example: + - 2c9180835d191a86015d28455b4a2329 + - 2c5680835d191a85765d28455b4a9823 + provisioningConfig: + description: The 'provisioningConfig' property specifies the configuration used to provision integrations. + type: object + properties: + universalManager: + description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' + type: boolean + readOnly: true + example: true + managedResourceRefs: + description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. + type: array + items: + 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 + - WORKGROUP + 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 + properties: + type: + description: The type of object being referenced + enum: + - SOURCE + example: SOURCE + id: + description: ID of the source + example: 2c91808568c529c60168cca6f90c1313 + name: + description: Human-readable display name of the source + example: My Source + example: + - type: SOURCE + id: 2c9180855d191c59015d291ceb051111 + name: My Source 1 + - type: SOURCE + id: 2c9180855d191c59015d291ceb052222 + name: My Source 2 + planInitializerScript: + description: This is a reference to a plan initializer script. + type: object + properties: + source: + description: This is a Rule that allows provisioning instruction changes. type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - - description: | - The days to execute the search. - - If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. - - If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. - example: - type: LIST - values: - - MON - - WED - - FRI - nullable: true - hours: + example: | + \r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n + noProvisioningRequests: + description: Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. + type: boolean + example: true + provisioningRequestExpiration: + description: 'When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.' + type: integer + format: int32 + example: 7 + attributes: + description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation. + type: object + additionalProperties: true + example: + property: value + key: value + beforeProvisioningRule: allOf: - type: object properties: type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. + description: DTO type type: string enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - - description: The hours selected. - example: - type: RANGE - values: - - '9' - - '18' - interval: 3 - expiration: - description: 'The schedule expiration date. Latest possible expiration date is ''2038-01-19T03:14:07+0000''' - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - timeZoneId: - description: 'The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org''s default timezone is used.' - nullable: true - type: string - example: 'GMT-06:00' - required: - - type - - hours - recipients: - type: array - items: - 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 - - WORKGROUP - 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 - emailEmptyResults: - type: boolean - description: Indicates if empty results need to be emailed - example: false - default: false - creatorId: - type: string - description: Policy's creator ID - example: 0f11f2a47c944bf3a2bd742580fe3bde - readOnly: true - modifierId: - type: string - description: Policy's modifier ID - example: 0f11f2a47c944bf3a2bd742580fe3bde - readOnly: true + - 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 + - WORKGROUP + 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 + description: Reference to beforeProvisioningRule for this Service Desk integration + properties: + type: + description: The type of object being referenced + enum: + - RULE + example: RULE + id: + description: ID of the rule + example: 2c91808568c529c60168cca6f90c1333 + name: + description: Human-readable display name of the rule + example: Example Rule + required: true responses: '200': - description: Created or updated SOD policy schedule. + description: ServiceDeskIntegrationDto as updated content: application/json: schema: - type: object - properties: - name: - type: string - description: SOD Policy schedule name - example: SCH-1584312283015 - created: - type: string - format: date-time - description: The time when this SOD policy schedule is created. - example: '2020-01-01T00:00:00.000000Z' - readOnly: true - modified: - type: string - format: date-time - description: The time when this SOD policy schedule is modified. - example: '2020-01-01T00:00:00.000000Z' - readOnly: true - description: - type: string - description: SOD Policy schedule description - example: Schedule for policy xyz - schedule: - type: object - description: The schedule information. + allOf: + - type: object + required: + - name + properties: + id: + description: System-generated unique ID of the Object + type: string + example: id12345 + readOnly: true + name: + description: Name of the Object + type: string + example: aName + created: + description: Creation date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + modified: + description: Last modification date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + - type: object + description: Specification of a Service Desk integration + required: + - description + - type + - attributes properties: + description: + description: Description of the Service Desk integration + type: string + example: A very nice Service Desk integration type: description: | - Enum representing the currently supported schedule types. + Service Desk integration types - Additional values may be added in the future without notice. + - ServiceNowSDIM + - ServiceNow type: string - enum: - - DAILY - - WEEKLY - - MONTHLY - - CALENDAR - example: WEEKLY - days: + default: ServiceNowSDIM + example: ServiceNowSDIM + ownerRef: + 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 + - WORKGROUP + 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 + description: Reference to the identity that is the owner of this Service Desk integration + properties: + type: + description: The type of object being referenced + enum: + - IDENTITY + example: IDENTITY + id: + description: ID of the identity + example: 2c91808568c529c60168cca6f90c1313 + name: + description: Human-readable display name of the identity + example: MyName + clusterRef: allOf: - type: object properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. + 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 + - WORKGROUP + 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 + description: Reference to the source cluster for this Service Desk integration + properties: + type: + description: The type of object being referenced + enum: + - CLUSTER + example: CLUSTER + id: + description: ID of the cluster + example: 2c9180866166b5b0016167c32ef31a66 + name: + description: Human-readable display name of the cluster + example: Corporate Cluster + cluster: + description: 'ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)' + type: string + example: xyzzy999 + deprecated: true + managedSources: + description: 'Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)' + type: array + items: + type: string + deprecated: true + example: + - 2c9180835d191a86015d28455b4a2329 + - 2c5680835d191a85765d28455b4a9823 + provisioningConfig: + description: The 'provisioningConfig' property specifies the configuration used to provision integrations. + type: object + properties: + universalManager: + description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' + type: boolean + readOnly: true + example: true + managedResourceRefs: + description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. + type: array + items: + 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 + - WORKGROUP + 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 + properties: + type: + description: The type of object being referenced + enum: + - SOURCE + example: SOURCE + id: + description: ID of the source + example: 2c91808568c529c60168cca6f90c1313 + name: + description: Human-readable display name of the source + example: My Source + example: + - type: SOURCE + id: 2c9180855d191c59015d291ceb051111 + name: My Source 1 + - type: SOURCE + id: 2c9180855d191c59015d291ceb052222 + name: My Source 2 + planInitializerScript: + description: This is a reference to a plan initializer script. + type: object + properties: + source: + description: This is a Rule that allows provisioning instruction changes. type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - - description: | - The days to execute the search. - - If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. - - If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. - example: - type: LIST - values: - - MON - - WED - - FRI - nullable: true - hours: + example: | + \r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n + noProvisioningRequests: + description: Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. + type: boolean + example: true + provisioningRequestExpiration: + description: 'When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.' + type: integer + format: int32 + example: 7 + attributes: + description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation. + type: object + additionalProperties: true + example: + property: value + key: value + beforeProvisioningRule: allOf: - type: object properties: type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. + description: DTO type type: string enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - - description: The hours selected. - example: - type: RANGE - values: - - '9' - - '18' - interval: 3 - expiration: - description: 'The schedule expiration date. Latest possible expiration date is ''2038-01-19T03:14:07+0000''' - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - timeZoneId: - description: 'The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org''s default timezone is used.' - nullable: true - type: string - example: 'GMT-06:00' - required: - - type - - hours - recipients: - type: array - items: - 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 - - WORKGROUP - 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 - emailEmptyResults: - type: boolean - description: Indicates if empty results need to be emailed - example: false - default: false - creatorId: - type: string - description: Policy's creator ID - example: 0f11f2a47c944bf3a2bd742580fe3bde - readOnly: true - modifierId: - type: string - description: Policy's modifier ID - example: 0f11f2a47c944bf3a2bd742580fe3bde - readOnly: true + - 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 + - WORKGROUP + 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 + description: Reference to beforeProvisioningRule for this Service Desk integration + properties: + type: + description: The type of object being referenced + enum: + - RULE + example: RULE + id: + description: ID of the rule + example: 2c91808568c529c60168cca6f90c1333 + name: + description: Human-readable display name of the rule + example: Example Rule '400': description: Client Error - Returned if the request body is invalid. content: @@ -85989,6 +76488,73 @@ paths: - locale: en-US localeOrigin: DEFAULT text: The server understood the request but refuses to authorize it. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. '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: @@ -86066,26 +76632,29 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - delete: security: - UserContextAuth: - - 'idn:sod-policy:write' - operationId: deleteSodPolicySchedule + - 'idn:service-desk-admin:manage' + - 'idn:service-desk-integration:manage' + delete: tags: - - SOD Policy - summary: Delete SOD policy schedule - description: This deletes schedule for a specified SOD policy by ID. + - Service Desk Integration + summary: Delete a Service Desk integration + description: Delete an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + operationId: deleteServiceDeskIntegration parameters: - - in: path - name: id + - name: id + in: path + description: ID of Service Desk integration to delete + required: true + style: simple + explode: false schema: type: string - required: true - description: The ID of the SOD policy the schedule must be deleted for. - example: ef38f943-47e9-4562-b5bb-8424a56397d8 + example: anId responses: '204': - description: No content response. + description: Service Desk integration with the given ID successfully deleted '400': description: Client Error - Returned if the request body is invalid. content: @@ -86364,92 +76933,429 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/sod-policies/{id}/violation-report/run': - post: security: - UserContextAuth: - - 'idn:sod-violation:write' - operationId: startSodPolicy + - 'idn:service-desk-admin:manage' + - 'idn:service-desk-integration:manage' + patch: + operationId: patchServiceDeskIntegration tags: - - SOD Policy - summary: Runs SOD policy violation report - description: 'This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message.' + - Service Desk Integration + summary: Service Desk Integration Update PATCH + description: Update an existing ServiceDeskIntegration by ID with a PATCH request. parameters: - - in: path - name: id + - name: id + in: path + description: ID of the Service Desk integration to update + required: true + style: simple + explode: false schema: type: string - required: true - description: The SOD policy ID to run. - example: ef38f943-47e9-4562-b5bb-8424a56397d8 + example: anId + requestBody: + required: true + description: | + A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + PATCH can only be applied to the following fields: + * `beforeProvisioningRule` + * `description` + * `ownerRef` + + A 403 Forbidden Error indicates that you attempted to PATCH a field that is not allowed. + content: + application/json-patch+json: + schema: + type: object + description: 'A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' + properties: + operations: + description: Operations to be applied + type: array + items: + type: object + description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' + required: + - op + - path + properties: + op: + type: string + description: The operation to be performed + enum: + - add + - remove + - replace + - move + - copy + - test + example: replace + path: + type: string + description: A string JSON Pointer representing the target path to an element to be affected by the operation + example: /description + value: + anyOf: + - type: string + - type: integer + - type: object + - type: array + items: + anyOf: + - type: string + - type: integer + - type: object + description: 'The value to be used for the operation, required for "add" and "replace" operations' + example: New description + example: + - op: replace + path: /ownerRef + value: + id: 2c9180867d05b227017d09921a205b4d + type: IDENTITY + name: Angelo2 tester responses: '200': - description: Reference to the violation report run task. + description: ServiceDeskIntegrationDto as updated content: application/json: schema: allOf: - type: object + required: + - name 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 - - WORKGROUP - example: IDENTITY id: + description: System-generated unique ID of the Object type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 + example: id12345 + readOnly: true name: + description: Name of the Object type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson + example: aName + created: + description: Creation date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + modified: + description: Last modification date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true - type: object + description: Specification of a Service Desk integration + required: + - description + - type + - attributes properties: - status: + description: + description: Description of the Service Desk integration type: string - description: Status of a violation report - enum: - - SUCCESS - - WARNING - - ERROR - - TERMINATED - - TEMP_ERROR - - PENDING - example: PENDING - example: - status: PENDING - type: REPORT_RESULT - id: 2e8d8180-24bc-4d21-91c6-7affdb473b0d - name: policy-xyz + example: A very nice Service Desk integration + type: + description: | + Service Desk integration types + + - ServiceNowSDIM + - ServiceNow + type: string + default: ServiceNowSDIM + example: ServiceNowSDIM + ownerRef: + 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 + - WORKGROUP + 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 + description: Reference to the identity that is the owner of this Service Desk integration + properties: + type: + description: The type of object being referenced + enum: + - IDENTITY + example: IDENTITY + id: + description: ID of the identity + example: 2c91808568c529c60168cca6f90c1313 + name: + description: Human-readable display name of the identity + example: MyName + clusterRef: + 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 + - WORKGROUP + 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 + description: Reference to the source cluster for this Service Desk integration + properties: + type: + description: The type of object being referenced + enum: + - CLUSTER + example: CLUSTER + id: + description: ID of the cluster + example: 2c9180866166b5b0016167c32ef31a66 + name: + description: Human-readable display name of the cluster + example: Corporate Cluster + cluster: + description: 'ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)' + type: string + example: xyzzy999 + deprecated: true + managedSources: + description: 'Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)' + type: array + items: + type: string + deprecated: true + example: + - 2c9180835d191a86015d28455b4a2329 + - 2c5680835d191a85765d28455b4a9823 + provisioningConfig: + description: The 'provisioningConfig' property specifies the configuration used to provision integrations. + type: object + properties: + universalManager: + description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' + type: boolean + readOnly: true + example: true + managedResourceRefs: + description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. + type: array + items: + 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 + - WORKGROUP + 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 + properties: + type: + description: The type of object being referenced + enum: + - SOURCE + example: SOURCE + id: + description: ID of the source + example: 2c91808568c529c60168cca6f90c1313 + name: + description: Human-readable display name of the source + example: My Source + example: + - type: SOURCE + id: 2c9180855d191c59015d291ceb051111 + name: My Source 1 + - type: SOURCE + id: 2c9180855d191c59015d291ceb052222 + name: My Source 2 + planInitializerScript: + description: This is a reference to a plan initializer script. + type: object + properties: + source: + description: This is a Rule that allows provisioning instruction changes. + type: string + example: | + \r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n + noProvisioningRequests: + description: Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. + type: boolean + example: true + provisioningRequestExpiration: + description: 'When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.' + type: integer + format: int32 + example: 7 + attributes: + description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation. + type: object + additionalProperties: true + example: + property: value + key: value + beforeProvisioningRule: + 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 + - WORKGROUP + 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 + description: Reference to beforeProvisioningRule for this Service Desk integration + properties: + type: + description: The type of object being referenced + enum: + - RULE + example: RULE + id: + description: ID of the rule + example: 2c91808568c529c60168cca6f90c1333 + name: + description: Human-readable display name of the rule + example: Example Rule '400': description: Client Error - Returned if the request body is invalid. content: @@ -86728,92 +77634,43 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/sod-policies/{id}/violation-report': - get: security: - UserContextAuth: - - 'idn:sod-violation:read' - operationId: getSodViolationReportStatus + - 'idn:service-desk-admin:manage' + - 'idn:service-desk-integration:manage' + /service-desk-integrations/types: + get: tags: - - SOD Policy - summary: Get SOD violation report status - description: This gets the status for a violation report run task that has already been invoked. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The ID of the violation report to retrieve status for. - example: ef38f943-47e9-4562-b5bb-8424a56397d8 + - Service Desk Integration + summary: Service Desk Integration Types List. + description: This API endpoint returns the current list of supported Service Desk integration types. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + operationId: getServiceDeskIntegrationTypes responses: '200': - description: Status of the violation report run task. + description: Responds with an array of the currently supported Service Desk integration types. content: application/json: schema: - 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 - - WORKGROUP - 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 - properties: - status: - type: string - description: Status of a violation report - enum: - - SUCCESS - - WARNING - - ERROR - - TERMINATED - - TEMP_ERROR - - PENDING - example: PENDING - example: - status: SUCCESS - type: REPORT_RESULT - id: 2e8d8180-24bc-4d21-91c6-7affdb473b0d - name: policy-xyz + type: array + items: + description: This represents a Service Desk Integration template type. + required: + - type + - scriptName + type: object + properties: + name: + description: This is the name of the type. + example: aName + type: string + type: + description: This is the type value for the type. + example: aType + type: string + scriptName: + description: This is the scriptName attribute value for the type. + example: aScriptName + type: string '400': description: Client Error - Returned if the request body is invalid. content: @@ -87092,92 +77949,172 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/sod-policies/sod-violation-report-status/{reportResultId}': - get: security: - UserContextAuth: - - 'idn:sod-violation:read' - operationId: getSodViolationReportRunStatus + - 'idn:service-desk-admin:read' + - 'idn:service-desk-integration:read' + '/service-desk-integrations/templates/{scriptName}': + get: tags: - - SOD Policy - summary: Get violation report run status - description: This gets the status for a violation report run task that has already been invoked. + - Service Desk Integration + summary: Service Desk integration template by scriptName. + description: This API endpoint returns an existing Service Desk integration template by scriptName. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + operationId: getServiceDeskIntegrationTemplate parameters: - - in: path - name: reportResultId + - name: scriptName + in: path + description: The scriptName value of the Service Desk integration template to get + required: true + style: simple + explode: false schema: type: string - required: true - description: The ID of the report reference to retrieve. - example: 2e8d8180-24bc-4d21-91c6-7affdb473b0d + example: aScriptName responses: '200': - description: Status of the violation report run task. + description: Responds with the ServiceDeskIntegrationTemplateDto with the specified scriptName. content: application/json: schema: allOf: - type: object + required: + - name 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 - - WORKGROUP - example: IDENTITY id: + description: System-generated unique ID of the Object type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 + example: id12345 + readOnly: true name: + description: Name of the Object type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson + example: aName + created: + description: Creation date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true + modified: + description: Last modification date of the Object + type: string + example: '2015-05-28T14:07:17Z' + format: date-time + readOnly: true - type: object + description: 'This is the model for a Service Desk integration template, used to create and edit Service Desk Integrations.' + required: + - type + - attributes + - provisioningConfig properties: - status: + type: + description: The 'type' property specifies the type of the Service Desk integration template. type: string - description: Status of a violation report - enum: - - SUCCESS - - WARNING - - ERROR - - TERMINATED - - TEMP_ERROR - - PENDING - example: PENDING - example: - status: SUCCESS - type: REPORT_RESULT - id: 2e8d8180-24bc-4d21-91c6-7affdb473b0d - name: policy-xyz + example: Web Service SDIM + default: Web Service SDIM + attributes: + description: The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template. + type: object + additionalProperties: true + example: + property: value + key: value + provisioningConfig: + description: The 'provisioningConfig' property specifies the configuration used to provision integrations using the template. + type: object + properties: + universalManager: + description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' + type: boolean + readOnly: true + example: true + managedResourceRefs: + description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. + type: array + items: + 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 + - WORKGROUP + 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 + properties: + type: + description: The type of object being referenced + enum: + - SOURCE + example: SOURCE + id: + description: ID of the source + example: 2c91808568c529c60168cca6f90c1313 + name: + description: Human-readable display name of the source + example: My Source + example: + - type: SOURCE + id: 2c9180855d191c59015d291ceb051111 + name: My Source 1 + - type: SOURCE + id: 2c9180855d191c59015d291ceb052222 + name: My Source 2 + planInitializerScript: + description: This is a reference to a plan initializer script. + type: object + properties: + source: + description: This is a Rule that allows provisioning instruction changes. + type: string + example: | + \r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n + noProvisioningRequests: + description: Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. + type: boolean + example: true + provisioningRequestExpiration: + description: 'When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.' + type: integer + format: int32 + example: 7 '400': description: Client Error - Returned if the request body is invalid. content: @@ -87456,329 +78393,37 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - /sod-violations/predict: - post: security: - UserContextAuth: - - 'idn:sod-violation:read' - operationId: startPredictSodViolations + - 'idn:service-desk-admin:read' + - 'idn:service-desk-integration:read' + /service-desk-integrations/status-check-configuration: + get: tags: - - SOD Violations - summary: Predict SOD violations for identity. - description: |- - This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. - - A token with ORG_ADMIN or API authority is required to call this API. - requestBody: - required: true - content: - application/json: - schema: - description: An identity with a set of access to be added - required: - - identityId - - accessRefs - type: object - properties: - identityId: - description: Identity id to be checked. - type: string - example: 2c91808568c529c60168cca6f90c1313 - accessRefs: - description: The list of ENTITLEMENTs to consider for calculating possible violations in a preventive check. - type: array - items: - 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 - - WORKGROUP - 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 - description: The types of objects supported for SOD violations - properties: - type: - enum: - - ENTITLEMENT - example: ENTITLEMENT - description: The type of object that is referenced - example: - - type: ENTITLEMENT - id: 2c918087682f9a86016839c050861ab1 - name: 'CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local' - - type: ENTITLEMENT - id: 2c918087682f9a86016839c0509c1ab2 - name: 'CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local' - example: - identityId: 2c91808568c529c60168cca6f90c1313 - accessRefs: - - type: ENTITLEMENT - id: 2c918087682f9a86016839c050861ab1 - name: 'CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local' - - type: ENTITLEMENT - id: 2c918087682f9a86016839c0509c1ab2 - name: 'CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local' + - Service Desk Integration + summary: Get the time check configuration + description: Get the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + operationId: getStatusCheckDetails responses: '200': - description: Violation Contexts + description: QueuedCheckConfigDetails containing the configured values content: application/json: schema: - description: An object containing a listing of the SOD violation reasons detected by this check. + description: Configuration of maximum number days and interval for checking Service Desk integration queue status required: - - requestId + - provisioningStatusCheckIntervalMinutes + - provisioningMaxStatusCheckDays type: object properties: - violationContexts: - type: array - description: List of Violation Contexts - items: - type: object - properties: - policy: - 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 - - WORKGROUP - 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 - properties: - type: - type: string - example: SOD_POLICY - name: - type: string - example: A very cool policy name - description: The types of objects supported for SOD violations - properties: - type: - enum: - - ENTITLEMENT - example: ENTITLEMENT - description: The type of object that is referenced - conflictingAccessCriteria: - nullable: false - description: The object which contains the left and right hand side of the entitlements that got violated according to the policy. - type: object - properties: - leftCriteria: - type: object - properties: - criteriaList: - type: array - description: List of exception criteria. There is a min of 1 and max of 50 items in the list. - items: - 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 - - WORKGROUP - 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: 'CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local' - existing: - type: boolean - description: Whether the subject identity already had that access or not - default: false - example: true - description: Access reference with addition of boolean existing flag to indicate whether the access was extant - description: The types of objects supported for SOD violations - properties: - type: - enum: - - ENTITLEMENT - example: ENTITLEMENT - description: The type of object that is referenced - example: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - existing: true - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - existing: false - rightCriteria: - type: object - properties: - criteriaList: - type: array - description: List of exception criteria. There is a min of 1 and max of 50 items in the list. - items: - 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 - - WORKGROUP - 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: 'CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local' - existing: - type: boolean - description: Whether the subject identity already had that access or not - default: false - example: true - description: Access reference with addition of boolean existing flag to indicate whether the access was extant - description: The types of objects supported for SOD violations - properties: - type: - enum: - - ENTITLEMENT - example: ENTITLEMENT - description: The type of object that is referenced - example: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - existing: true - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - existing: false + provisioningStatusCheckIntervalMinutes: + description: interval in minutes between status checks + type: string + example: '30' + provisioningMaxStatusCheckDays: + description: maximum number of days to check + type: string + example: '2' '400': description: Client Error - Returned if the request body is invalid. content: @@ -88057,123 +78702,56 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - /sod-violations/check: - post: security: - UserContextAuth: - - 'idn:sod-violation:read' - operationId: startViolationCheck + - 'idn:service-desk-admin:read' + - 'idn:service-desk-integration:read' + put: tags: - - SOD Violations - summary: Check SOD violations - description: |- - This API initiates a SOD policy verification asynchronously. - - A token with ORG_ADMIN authority is required to call this API. + - Service Desk Integration + summary: Update the time check configuration + description: Update the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + operationId: updateStatusCheckDetails requestBody: - required: true + description: the modified time check configuration content: application/json: schema: - description: An identity with a set of access to be added + description: Configuration of maximum number days and interval for checking Service Desk integration queue status required: - - identityId - - accessRefs + - provisioningStatusCheckIntervalMinutes + - provisioningMaxStatusCheckDays type: object properties: - identityId: - description: Set of identity id's to be checked. + provisioningStatusCheckIntervalMinutes: + description: interval in minutes between status checks type: string - example: 2c91809050db617d0150e0bf3215385e - accessRefs: - description: The bundle of access profiles to be added to the identities specified. All references must be ENTITLEMENT type. - type: array - items: - 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 - - WORKGROUP - 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 - clientMetadata: - type: object - additionalProperties: - type: string - description: Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. - example: - clientName: client1 - clientId: 2c91808f7892918f0178b78da4a305a1 - example: - identityId: 2c91808568c529c60168cca6f90c1313 - accessRefs: - - type: ENTITLEMENT - id: 2c918087682f9a86016839c050861ab1 - name: 'CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local' - - type: ENTITLEMENT - id: 2c918087682f9a86016839c0509c1ab2 - name: 'CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local' - clientMetadata: - additionalProp1: string - additionalProp2: string - additionalProp3: string + example: '30' + provisioningMaxStatusCheckDays: + description: maximum number of days to check + type: string + example: '2' + required: true responses: - '202': - description: Request ID with a timestamp. + '200': + description: QueuedCheckConfigDetails as updated content: application/json: schema: - description: An object referencing an SOD violation check + description: Configuration of maximum number days and interval for checking Service Desk integration queue status required: - - requestId + - provisioningStatusCheckIntervalMinutes + - provisioningMaxStatusCheckDays type: object properties: - requestId: - description: The id of the original request - example: 089899f13a8f4da7824996191587bab9 + provisioningStatusCheckIntervalMinutes: + description: interval in minutes between status checks type: string - created: + example: '30' + provisioningMaxStatusCheckDays: + description: maximum number of days to check type: string - format: date-time - readOnly: true - description: The date-time when this request was created. - example: '2020-01-01T00:00:00.000000Z' + example: '2' '400': description: Client Error - Returned if the request body is invalid. content: @@ -88452,103 +79030,88 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - /sod-violation-report/run: - post: security: - UserContextAuth: - - 'idn:sod-violation:write' - operationId: startSodAllPoliciesForOrg + - 'idn:service-desk-admin:manage' + - 'idn:service-desk-integration:manage' + /query-password-info: + post: + operationId: queryPasswordInfo tags: - - SOD Policy - summary: Runs all policies for org - description: 'Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided.' + - Password Management + summary: Query Password Info + description: | + This API is used to query password related information. + + A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) + is required to call this API. "API authority" refers to a token that only has the "client_credentials" + grant type, and therefore no user context. A [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) + or a token generated with the [authorization_code](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) + grant type will **NOT** work on this endpoint, and a `403 Forbidden` response + will be returned. requestBody: - required: false + required: true content: application/json: schema: type: object properties: - filteredPolicyList: - type: array - description: Multi-policy report will be run for this list of ids - items: - type: string - example: - - b868cd40-ffa4-4337-9c07-1a51846cfa94 - - 63a07a7b-39a4-48aa-956d-50c827deba2a - example: - filteredPolicyList: - - b868cd40-ffa4-4337-9c07-1a51846cfa94 - - 63a07a7b-39a4-48aa-956d-50c827deba2a + userName: + type: string + description: The login name of the user + example: Abby.Smith + sourceName: + type: string + description: The display name of the source + example: My-AD responses: '200': - description: Reference to the violation report run task. + description: Reference to the password info. content: application/json: schema: - 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 - - WORKGROUP - 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 - properties: - status: - type: string - description: Status of a violation report - enum: - - SUCCESS - - WARNING - - ERROR - - TERMINATED - - TEMP_ERROR - - PENDING - example: PENDING - example: - status: PENDING - type: REPORT_RESULT - id: 37b3b32a-f394-46f8-acad-b5223969fa68 - name: Multi Query Report + type: object + properties: + identityId: + type: string + description: Identity ID + example: 2c918085744fec4301746f9a5bce4605 + sourceId: + type: string + description: source ID + example: 2c918083746f642c01746f990884012a + publicKeyId: + type: string + description: public key ID + example: N2M1OTJiMGEtMDJlZS00ZWU3LTkyYTEtNjA5YmI5NWE3ZWVh + publicKey: + type: string + description: User's public key with Base64 encoding + example: MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuGFkWi2J75TztpbaPKd36bJnIB3J8gZ6UcoS9oSDYsqBzPpTsfZXYaEf4Y4BKGgJIXmE/lwhwuj7mU1itdZ2qTSNFtnXA8Fn75c3UUkk+h+wdZbkuSmqlsJo3R1OnJkwkJggcAy9Jvk9jlcrNLWorpQ1w9raUvxtvfgkSdq153KxotenQ1HciSyZ0nA/Kw0UaucLnho8xdRowZs11afXGXA9IT9H6D8T6zUdtSxm0nAyH+mluma5LdTfaM50W3l/L8q56Vrqmx2pZIiwdx/0+g3Y++jV70zom0ZBkC1MmSoLMrQYG5OICNjr72f78B2PaGXfarQHqARLjKpMVt9YIQIDAQAB + accounts: + type: array + description: Account info related to queried identity and source + items: + type: object + properties: + accountId: + type: string + description: 'Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350' + example: 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com' + accountName: + type: string + description: 'Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008' + example: Abby.Smith + policies: + type: array + description: Password constraints + items: + type: string + example: + - passwordRepeatedChar is 3 + - passwordMinAlpha is 1 + - passwordMinLength is 5 + - passwordMinNumeric is 1 '400': description: Client Error - Returned if the request body is invalid. content: @@ -88760,84 +79323,102 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - /sod-violation-report: - get: - security: - - UserContextAuth: - - 'idn:sod-violation:read' - operationId: getSodAllReportRunStatus + /set-password: + post: + operationId: setPassword tags: - - SOD Policy - summary: Get multi-report run task status - description: This endpoint gets the status for a violation report for all policy run. + - Password Management + summary: Set Identity's Password + description: | + This API is used to set a password for an identity. + + An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their IDN user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). + + A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity's password or the password of any of the identity's accounts. + "API authority" refers to a token that only has the "client_credentials" grant type. + + You can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). + To do so, follow these steps: + + 1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. + + 2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. + + 3. Use [Set Identity's Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password: + + ```java + import javax.crypto.Cipher; + import java.security.KeyFactory; + import java.security.PublicKey; + import java.security.spec.X509EncodedKeySpec; + import java util.Base64; + + String encrypt(String publicKey, String toEncrypt) throws Exception { + byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey); + byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes("UTF-8")); + return Base64.getEncoder().encodeToString(encryptedBytes); + } + + private byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception { + PublicKey key = KeyFactory.getInstance("RSA").generatePublic(new X509EncodedKeySpec(publicKeyBytes)); + String transformation = "RSA/ECB/PKCS1Padding"; + Cipher cipher = Cipher.getInstance(transformation); + cipher.init(1, key); + return cipher.doFinal(toEncryptBytes); + } + ``` + + In this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. + + You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + identityId: + type: string + description: The identity ID that requested the password change + example: 8a807d4c73c545510173c545f0a002ff + encryptedPassword: + type: string + description: The RSA encrypted password + example: XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A== + publicKeyId: + type: string + description: The encryption key ID + example: YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2 + accountId: + type: string + description: 'Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350' + example: 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com' + sourceId: + type: string + description: The ID of the source for which identity is requesting the password change + example: 8a807d4c73c545510173c545d4b60246 responses: - '200': - description: Status of the violation report run task for all policy run. + '202': + description: Reference to the password change. content: application/json: schema: - 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 - - WORKGROUP - 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 - properties: - status: - type: string - description: Status of a violation report - enum: - - SUCCESS - - WARNING - - ERROR - - TERMINATED - - TEMP_ERROR - - PENDING - example: PENDING - example: - status: SUCCESS - type: REPORT_RESULT - id: 37b3b32a-f394-46f8-acad-b5223969fa68 - name: Multi Query Report + type: object + properties: + requestId: + type: string + nullable: true + description: The password change request ID + example: 089899f13a8f4da7824996191587bab9 + state: + type: string + enum: + - IN_PROGRESS + - FINISHED + - FAILED + description: Password change state + example: IN_PROGRESS '400': description: Client Error - Returned if the request body is invalid. content: @@ -89049,32 +79630,56 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/sod-violation-report/{reportResultId}/download': + '/password-change-status/{id}': get: - security: - - UserContextAuth: - - 'idn:sod-violation:read' - operationId: getDefaultViolationReport + operationId: getPasswordChangeStatus tags: - - SOD Policy - summary: Download violation report - description: This allows to download a violation report for a given report reference. + - Password Management + summary: Get Password Change Request Status + description: This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API. parameters: - in: path - name: reportResultId + name: id schema: type: string required: true - description: The ID of the report reference to download. - example: ef38f94347e94562b5bb8424a56397d8 + example: 089899f13a8f4da7824996191587bab9 + description: Password change request ID responses: '200': - description: Returns the PolicyReport.zip that contains the violation report file. + description: Status of the password change request content: - application/zip: + application/json: schema: - type: string - format: binary + type: object + properties: + requestId: + type: string + nullable: true + description: The password change request ID + example: 089899f13a8f4da7824996191587bab9 + state: + type: string + enum: + - IN_PROGRESS + - FINISHED + - FAILED + description: Password change state + example: IN_PROGRESS + errors: + type: array + items: + type: string + description: The errors during the password change request + example: + - The password change payload is invalid + sourceIds: + type: array + items: + type: string + description: List of source IDs in the password change request + example: + - 2c918083746f642c01746f990884012a '400': description: Client Error - Returned if the request body is invalid. content: @@ -89353,108 +79958,56 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/sod-violation-report/{reportResultId}/download/{fileName}': + /password-dictionary: get: + operationId: getPasswordDictionary + tags: + - Password Dictionary + summary: Get Password Dictionary + description: |- + This gets password dictionary for the organization. + A token with ORG_ADMIN authority is required to call this API. security: - UserContextAuth: - - 'idn:sod-violation:read' - operationId: getCustomViolationReport - tags: - - SOD Policy - summary: Download custom violation report - description: This allows to download a specified named violation report for a given report reference. - parameters: - - in: path - name: reportResultId - schema: - type: string - required: true - description: The ID of the report reference to download. - example: ef38f94347e94562b5bb8424a56397d8 - - in: path - name: fileName - schema: - type: string - required: true - description: Custom Name for the file. - example: custom-name + - 'idn:password-dictionary-management:read' responses: '200': - description: Returns the zip file with given custom name that contains the violation report file. - content: - application/zip: - schema: - type: string - format: binary - '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.' + description: |- + + The password dictionary file can contain lines that are: + 1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing + 2. empty lines + 3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines + 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + + Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + + # Sample password text file + + ``` + + # Password dictionary small test file + + locale=en_US + + # Password dictionary prohibited words + + qwerty + abcd + aaaaa + password + qazxsws + + ``` content: - application/json: + text/plain: 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.' + type: string + '400': + description: Client Error - Returned if the request body is invalid. content: application/json: schema: @@ -89510,18 +80063,18 @@ paths: 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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist + '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: @@ -89578,27 +80131,17 @@ paths: description: Actual text of the error message in the indicated locale. example: The request was syntactically correct but its content is semantically invalid. examples: - '404': - summary: An example of a 404 response object + '403': + summary: An example of a 403 response object value: - detailCode: 404 Not found + detailCode: 403 Forbidden trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. + text: The server understood the request but refuses to authorize it. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist content: application/json: schema: @@ -89655,460 +80198,27 @@ paths: 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 + '404': + summary: An example of a 404 response object value: - detailCode: 500.0 Internal Fault + detailCode: 404 Not found trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: An internal fault occurred. - /sources: - get: - operationId: listSources - security: - - UserContextAuth: - - 'idn:sources:read' - tags: - - Sources - summary: Lists all sources in IdentityNow. - description: |- - This end-point lists all the sources in IdentityNow. - A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or ROLE_SUBADMIN authority is required to call this API. - parameters: - - 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 - example: name eq "#Employees" - 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**: *co, eq, in, sw* - **type**: *eq, in* - **owner.id**: *eq, in* - **features**: *ca, co* - **created**: *eq* - **modified**: *eq* - **managementWorkgroup.id**: *eq* - **description**: *eq* - **authoritative**: *eq* - **healthy**: *eq* - **status**: *eq, in* - **connectionType**: *eq* - **connectorName**: *eq* - - in: query - name: sorters - schema: - type: string - format: comma-separated - example: name - 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: **type, created, modified, name, owner.name, healthy, status** - - in: query - name: for-subadmin - schema: - type: string - example: name - description: |- - Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. - Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. - responses: - '200': - description: List of Source objects + text: The server did not find a current representation for the target resource. + '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: array - items: - type: object - properties: - id: - type: string - readOnly: true - description: the id of the Source - example: 2c91808568c529c60168cca6f90c1324 - name: - type: string - description: Human-readable name of the source - example: My Source - description: - type: string - description: Human-readable description of the source - example: This is the corporate directory. - owner: - description: Reference to an owning Identity Object - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of the identity - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the identity - example: MyName - cluster: - description: Reference to the associated Cluster - type: object - required: - - name - - id - - type - properties: - type: - description: The type of object being referenced - type: string - enum: - - CLUSTER - example: CLUSTER - id: - type: string - description: ID of the cluster - example: 2c9180866166b5b0016167c32ef31a66 - name: - type: string - description: Human-readable display name of the cluster - example: Corporate Cluster - accountCorrelationConfig: - description: Reference to an Account Correlation Config object - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - example: ACCOUNT_CORRELATION_CONFIG - id: - type: string - description: ID of the account correlation config - example: 2c9180855d191c59015d28583727245a - name: - type: string - description: Human-readable display name of the account correlation config - example: 'Directory [source-62867] Account Correlation' - accountCorrelationRule: - description: 'Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can''t be used.' - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - RULE - example: RULE - id: - type: string - description: ID of the rule - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Human-readable display name of the rule - example: Example Rule - managerCorrelationMapping: - description: Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity - type: object - properties: - accountAttribute: - type: string - description: Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. - example: manager - identityAttribute: - type: string - description: Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - example: manager - managerCorrelationRule: - description: 'Reference to the ManagerCorrelationRule, only used when a simple filter isn''t sufficient.' - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - RULE - example: RULE - id: - type: string - description: ID of the rule - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Human-readable display name of the rule - example: Example Rule - beforeProvisioningRule: - description: Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - RULE - example: RULE - id: - type: string - description: ID of the rule - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Human-readable display name of the rule - example: Example Rule - schemas: - type: array - items: - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - CONNECTOR_SCHEMA - example: CONNECTOR_SCHEMA - id: - type: string - description: ID of the schema - example: 2c91808568c529c60168cca6f90c1777 - name: - type: string - description: Human-readable display name of the schema - example: MySchema - description: List of references to Schema objects - example: - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232a - name: account - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232b - name: group - passwordPolicies: - type: array - items: - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - PASSWORD_POLICY - example: PASSWORD_POLICY - id: - type: string - description: ID of the policy - example: 2c91808568c529c60168cca6f90c1777 - name: - type: string - description: Human-readable display name of the policy - example: My Password Policy - description: List of references to the associated PasswordPolicy objects. - example: - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb053980 - name: Corporate Password Policy - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb057777 - name: Vendor Password Policy - features: - type: array - description: Optional features that can be supported by a source. - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - example: AUTHENTICATE - example: - - SYNC_PROVISIONING - - MANAGER_LOOKUP - - SEARCH - - PROVISIONING - - AUTHENTICATE - - GROUP_PROVISIONING - - PASSWORD - type: - type: string - description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ' - example: OpenLDAP - Direct - connector: - type: string - description: Connector script name. - example: active-directory - connectorClass: - type: string - description: The fully qualified name of the Java class that implements the connector interface. - example: sailpoint.connector.LDAPConnector - connectorAttributes: - type: object - description: Connector specific configuration; will differ from type to type. - example: - healthCheckTimeout: 30 - authSearchAttributes: - - cn - - uid - - mail - deleteThreshold: - type: integer - format: int32 - description: Number from 0 to 100 that specifies when to skip the delete phase. - example: 10 - authoritative: - type: boolean - description: When true indicates the source is referenced by an IdentityProfile. - default: false - example: false - managementWorkgroup: - description: Reference to Management Workgroup for this Source - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - GOVERNANCE_GROUP - example: GOVERNANCE_GROUP - id: - type: string - description: ID of the management workgroup - example: 2c91808568c529c60168cca6f90c2222 - name: - type: string - description: Human-readable display name of the management workgroup - example: My Management Workgroup - healthy: - type: boolean - description: When true indicates a healthy source - default: false - example: true - status: - type: string - description: 'A status identifier, giving specific information on why a source is healthy or not' - example: SOURCE_STATE_HEALTHY - since: - type: string - description: Timestamp showing when a source health check was last performed - example: '2021-09-28T15:48:29.3801666300Z' - connectorId: - type: string - description: The id of connector - example: active-directory - connectorName: - type: string - description: The name of the connector that was chosen on source creation - example: Active Directory - connectionType: - type: string - description: The type of connection (direct or file) - example: file - connectorImplementstionId: - type: string - description: The connector implementstion id - example: delimited-file - required: - - name - - owner - - connector - '400': - description: Client Error - Returned if the request body is invalid. + 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: @@ -90164,18 +80274,74 @@ paths: 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.' + 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. + put: + operationId: updatePasswordDictionary + tags: + - Password Dictionary + summary: Update Password Dictionary + description: |- + This updates password dictionary for the organization. + A token with ORG_ADMIN authority is required to call this API. + security: + - UserContextAuth: + - 'idn:password-dictionary:manage' + requestBody: + required: true + description: |- + + The password dictionary file can contain lines that are: + 1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing + 2. empty lines + 3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines + 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + + Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + + # Sample password text file + + ``` + + # Password dictionary small test file + + locale=en_US + + # Password dictionary prohibited words + + qwerty + abcd + aaaaa + password + qazxsws + + ``` + content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + format: binary + responses: + '200': + description: Successfully updated. + '201': + description: Created. + '400': + description: Client Error - Returned if the request body is invalid. content: application/json: schema: @@ -90231,18 +80397,18 @@ paths: 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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist + '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: @@ -90299,27 +80465,17 @@ paths: description: Actual text of the error message in the indicated locale. example: The request was syntactically correct but its content is semantically invalid. examples: - '404': - summary: An example of a 404 response object + '403': + summary: An example of a 403 response object value: - detailCode: 404 Not found + detailCode: 403 Forbidden trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. + text: The server understood the request but refuses to authorize it. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist content: application/json: schema: @@ -90376,733 +80532,439 @@ paths: 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 + '404': + summary: An example of a 404 response object value: - detailCode: 500.0 Internal Fault + detailCode: 404 Not found trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: An internal fault occurred. - post: - operationId: createSource - security: - - UserContextAuth: - - 'idn:sources:manage' - tags: - - Sources - summary: Creates a source in IdentityNow. - description: |- - This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. - A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - parameters: - - in: query - name: provisionAsCsv - description: 'If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don''t set this query parameter and you attempt to set the `type` attribute directly, the request won''t correctly generate the source. ' - schema: - type: boolean - required: false - example: false - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - id: - type: string - readOnly: true - description: the id of the Source - example: 2c91808568c529c60168cca6f90c1324 - name: - type: string - description: Human-readable name of the source - example: My Source - description: - type: string - description: Human-readable description of the source - example: This is the corporate directory. - owner: - description: Reference to an owning Identity Object - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of the identity - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the identity - example: MyName - cluster: - description: Reference to the associated Cluster - type: object - required: - - name - - id - - type - properties: - type: - description: The type of object being referenced - type: string - enum: - - CLUSTER - example: CLUSTER - id: - type: string - description: ID of the cluster - example: 2c9180866166b5b0016167c32ef31a66 - name: - type: string - description: Human-readable display name of the cluster - example: Corporate Cluster - accountCorrelationConfig: - description: Reference to an Account Correlation Config object - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - example: ACCOUNT_CORRELATION_CONFIG - id: - type: string - description: ID of the account correlation config - example: 2c9180855d191c59015d28583727245a - name: - type: string - description: Human-readable display name of the account correlation config - example: 'Directory [source-62867] Account Correlation' - accountCorrelationRule: - description: 'Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can''t be used.' - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - RULE - example: RULE - id: - type: string - description: ID of the rule - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Human-readable display name of the rule - example: Example Rule - managerCorrelationMapping: - description: Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity - type: object - properties: - accountAttribute: - type: string - description: Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. - example: manager - identityAttribute: - type: string - description: Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - example: manager - managerCorrelationRule: - description: 'Reference to the ManagerCorrelationRule, only used when a simple filter isn''t sufficient.' - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - RULE - example: RULE - id: - type: string - description: ID of the rule - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Human-readable display name of the rule - example: Example Rule - beforeProvisioningRule: - description: Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - RULE - example: RULE - id: - type: string - description: ID of the rule - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Human-readable display name of the rule - example: Example Rule - schemas: - type: array - items: - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - CONNECTOR_SCHEMA - example: CONNECTOR_SCHEMA - id: - type: string - description: ID of the schema - example: 2c91808568c529c60168cca6f90c1777 - name: - type: string - description: Human-readable display name of the schema - example: MySchema - description: List of references to Schema objects - example: - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232a - name: account - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232b - name: group - passwordPolicies: - type: array - items: - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - PASSWORD_POLICY - example: PASSWORD_POLICY - id: - type: string - description: ID of the policy - example: 2c91808568c529c60168cca6f90c1777 - name: - type: string - description: Human-readable display name of the policy - example: My Password Policy - description: List of references to the associated PasswordPolicy objects. - example: - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb053980 - name: Corporate Password Policy - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb057777 - name: Vendor Password Policy - features: - type: array - description: Optional features that can be supported by a source. - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - example: AUTHENTICATE - example: - - SYNC_PROVISIONING - - MANAGER_LOOKUP - - SEARCH - - PROVISIONING - - AUTHENTICATE - - GROUP_PROVISIONING - - PASSWORD - type: - type: string - description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ' - example: OpenLDAP - Direct - connector: - type: string - description: Connector script name. - example: active-directory - connectorClass: - type: string - description: The fully qualified name of the Java class that implements the connector interface. - example: sailpoint.connector.LDAPConnector - connectorAttributes: - type: object - description: Connector specific configuration; will differ from type to type. - example: - healthCheckTimeout: 30 - authSearchAttributes: - - cn - - uid - - mail - deleteThreshold: - type: integer - format: int32 - description: Number from 0 to 100 that specifies when to skip the delete phase. - example: 10 - authoritative: - type: boolean - description: When true indicates the source is referenced by an IdentityProfile. - default: false - example: false - managementWorkgroup: - description: Reference to Management Workgroup for this Source - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - GOVERNANCE_GROUP - example: GOVERNANCE_GROUP - id: - type: string - description: ID of the management workgroup - example: 2c91808568c529c60168cca6f90c2222 - name: - type: string - description: Human-readable display name of the management workgroup - example: My Management Workgroup - healthy: - type: boolean - description: When true indicates a healthy source - default: false - example: true - status: - type: string - description: 'A status identifier, giving specific information on why a source is healthy or not' - example: SOURCE_STATE_HEALTHY - since: - type: string - description: Timestamp showing when a source health check was last performed - example: '2021-09-28T15:48:29.3801666300Z' - connectorId: - type: string - description: The id of connector - example: active-directory - connectorName: - type: string - description: The name of the connector that was chosen on source creation - example: Active Directory - connectionType: - type: string - description: The type of connection (direct or file) - example: file - connectorImplementstionId: - type: string - description: The connector implementstion id - example: delimited-file - required: - - name - - owner - - connector - responses: - '201': - description: 'Created Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design.' + text: The server did not find a current representation for the target resource. + '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: - id: - type: string - readOnly: true - description: the id of the Source - example: 2c91808568c529c60168cca6f90c1324 - name: + 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: Human-readable name of the source - example: My Source - description: + description: Fine-grained error code providing more detail of the error. + example: 400.1 Bad Request Content + trackingId: type: string - description: Human-readable description of the source - example: This is the corporate directory. - owner: - description: Reference to an owning Identity Object - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of the identity - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the identity - example: MyName - cluster: - description: Reference to the associated Cluster - type: object - required: - - name - - id - - type - properties: - type: - description: The type of object being referenced - type: string - enum: - - CLUSTER - example: CLUSTER - id: - type: string - description: ID of the cluster - example: 2c9180866166b5b0016167c32ef31a66 - name: - type: string - description: Human-readable display name of the cluster - example: Corporate Cluster - accountCorrelationConfig: - description: Reference to an Account Correlation Config object - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - example: ACCOUNT_CORRELATION_CONFIG - id: - type: string - description: ID of the account correlation config - example: 2c9180855d191c59015d28583727245a - name: - type: string - description: Human-readable display name of the account correlation config - example: 'Directory [source-62867] Account Correlation' - accountCorrelationRule: - description: 'Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can''t be used.' - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - RULE - example: RULE - id: - type: string - description: ID of the rule - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Human-readable display name of the rule - example: Example Rule - managerCorrelationMapping: - description: Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity - type: object - properties: - accountAttribute: - type: string - description: Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. - example: manager - identityAttribute: - type: string - description: Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - example: manager - managerCorrelationRule: - description: 'Reference to the ManagerCorrelationRule, only used when a simple filter isn''t sufficient.' - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - RULE - example: RULE - id: - type: string - description: ID of the rule - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Human-readable display name of the rule - example: Example Rule - beforeProvisioningRule: - description: Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - RULE - example: RULE - id: - type: string - description: ID of the rule - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Human-readable display name of the rule - example: Example Rule - schemas: + description: Unique tracking id for the error. + example: e7eab60924f64aa284175b9fa3309599 + messages: type: array + description: Generic localized reason for error items: type: object properties: - type: - description: The type of object being referenced + locale: type: string - enum: - - CONNECTOR_SCHEMA - example: CONNECTOR_SCHEMA - id: + description: 'The locale for the message text, a BCP 47 language tag.' + example: en-US + localeOrigin: type: string - description: ID of the schema - example: 2c91808568c529c60168cca6f90c1777 - name: + 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: Human-readable display name of the schema - example: MySchema - description: List of references to Schema objects - example: - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232a - name: account - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232b - name: group - passwordPolicies: + 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: - type: - description: The type of object being referenced + locale: + type: string + description: 'The locale for the message text, a BCP 47 language tag.' + example: en-US + localeOrigin: type: string enum: - - PASSWORD_POLICY - example: PASSWORD_POLICY - id: + - 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: ID of the policy - example: 2c91808568c529c60168cca6f90c1777 - name: + 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. + /password-org-config: + get: + operationId: getPasswordOrgConfig + tags: + - Password Configuration + summary: Get Password Org Config + description: 'This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of ''idn:password-org-config:read''' + security: + - UserContextAuth: + - 'idn:password-org-config:read' + responses: + '200': + description: Reference to the password org config. + content: + application/json: + schema: + type: object + properties: + customInstructionsEnabled: + type: boolean + description: Indicator whether custom password instructions feature is enabled. The default value is false. + default: false + example: true + digitTokenEnabled: + type: boolean + description: Indicator whether "digit token" feature is enabled. The default value is false. + default: false + example: true + digitTokenDurationMinutes: + type: integer + format: int32 + description: The duration of "digit token" in minutes. The default value is 5. + minimum: 1 + maximum: 60 + default: 5 + example: 10 + digitTokenLength: + type: integer + format: int32 + description: The length of "digit token". The default value is 6. + minimum: 6 + maximum: 18 + default: 6 + example: 9 + example: + customInstructionsEnabled: true + digitTokenDurationMinutes: 9 + digitTokenEnabled: false + digitTokenLength: 6 + '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: Human-readable display name of the policy - example: My Password Policy - description: List of references to the associated PasswordPolicy objects. - example: - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb053980 - name: Corporate Password Policy - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb057777 - name: Vendor Password Policy - features: + 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: Optional features that can be supported by a source. + description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - example: AUTHENTICATE - example: - - SYNC_PROVISIONING - - MANAGER_LOOKUP - - SEARCH - - PROVISIONING - - AUTHENTICATE - - GROUP_PROVISIONING - - PASSWORD - type: - type: string - description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ' - example: OpenLDAP - Direct - connector: + 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: Connector script name. - example: active-directory - connectorClass: + description: Fine-grained error code providing more detail of the error. + example: 400.1 Bad Request Content + trackingId: type: string - description: The fully qualified name of the Java class that implements the connector interface. - example: sailpoint.connector.LDAPConnector - connectorAttributes: - type: object - description: Connector specific configuration; will differ from type to type. - example: - healthCheckTimeout: 30 - authSearchAttributes: - - cn - - uid - - mail - deleteThreshold: - type: integer - format: int32 - description: Number from 0 to 100 that specifies when to skip the delete phase. - example: 10 - authoritative: + 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. + put: + operationId: putPasswordOrgConfig + tags: + - Password Configuration + summary: Update Password Org Config + description: |- + This API updates the password org config for specified fields. Other fields will keep original value. + You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions. + Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + security: + - oauth2: + - 'idn:password-org-config:write' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + customInstructionsEnabled: + type: boolean + description: Indicator whether custom password instructions feature is enabled. The default value is false. + default: false + example: true + digitTokenEnabled: + type: boolean + description: Indicator whether "digit token" feature is enabled. The default value is false. + default: false + example: true + digitTokenDurationMinutes: + type: integer + format: int32 + description: The duration of "digit token" in minutes. The default value is 5. + minimum: 1 + maximum: 60 + default: 5 + example: 10 + digitTokenLength: + type: integer + format: int32 + description: The length of "digit token". The default value is 6. + minimum: 6 + maximum: 18 + default: 6 + example: 9 + example: + digitTokenEnabled: true + digitTokenDurationMinutes: 12 + responses: + '200': + description: Reference to the password org config. + content: + application/json: + schema: + type: object + properties: + customInstructionsEnabled: type: boolean - description: When true indicates the source is referenced by an IdentityProfile. + description: Indicator whether custom password instructions feature is enabled. The default value is false. default: false - example: false - managementWorkgroup: - description: Reference to Management Workgroup for this Source - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - GOVERNANCE_GROUP - example: GOVERNANCE_GROUP - id: - type: string - description: ID of the management workgroup - example: 2c91808568c529c60168cca6f90c2222 - name: - type: string - description: Human-readable display name of the management workgroup - example: My Management Workgroup - healthy: + example: true + digitTokenEnabled: type: boolean - description: When true indicates a healthy source + description: Indicator whether "digit token" feature is enabled. The default value is false. default: false example: true - status: - type: string - description: 'A status identifier, giving specific information on why a source is healthy or not' - example: SOURCE_STATE_HEALTHY - since: - type: string - description: Timestamp showing when a source health check was last performed - example: '2021-09-28T15:48:29.3801666300Z' - connectorId: - type: string - description: The id of connector - example: active-directory - connectorName: - type: string - description: The name of the connector that was chosen on source creation - example: Active Directory - connectionType: - type: string - description: The type of connection (direct or file) - example: file - connectorImplementstionId: - type: string - description: The connector implementstion id - example: delimited-file - required: - - name - - owner - - connector + digitTokenDurationMinutes: + type: integer + format: int32 + description: The duration of "digit token" in minutes. The default value is 5. + minimum: 1 + maximum: 60 + default: 5 + example: 10 + digitTokenLength: + type: integer + format: int32 + description: The length of "digit token". The default value is 6. + minimum: 6 + maximum: 18 + default: 6 + example: 9 + example: + customInstructionsEnabled: true + digitTokenDurationMinutes: 12 + digitTokenEnabled: true + digitTokenLength: 6 '400': description: Client Error - Returned if the request body is invalid. content: @@ -91314,512 +81176,994 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/sources/{id}': - get: - operationId: getSource - security: - - UserContextAuth: - - 'idn:sources:read' + post: + operationId: createPasswordOrgConfig tags: - - Sources - summary: Get Source by ID + - Password Configuration + summary: Create Password Org Config description: |- - This end-point gets a specific source in IdentityNow. - A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The Source id - example: 2c9180835d191a86015d28455b4a2329 + This API creates the password org config. Unspecified fields will use default value. + To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true". + Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + security: + - UserContextAuth: + - 'idn:password-org-config:write' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + customInstructionsEnabled: + type: boolean + description: Indicator whether custom password instructions feature is enabled. The default value is false. + default: false + example: true + digitTokenEnabled: + type: boolean + description: Indicator whether "digit token" feature is enabled. The default value is false. + default: false + example: true + digitTokenDurationMinutes: + type: integer + format: int32 + description: The duration of "digit token" in minutes. The default value is 5. + minimum: 1 + maximum: 60 + default: 5 + example: 10 + digitTokenLength: + type: integer + format: int32 + description: The length of "digit token". The default value is 6. + minimum: 6 + maximum: 18 + default: 6 + example: 9 + example: + customInstructionsEnabled: true + digitTokenEnabled: true + digitTokenDurationMinutes: 12 + digitTokenLength: 9 responses: '200': - description: A Source object + description: Reference to the password org config. content: application/json: schema: type: object properties: - id: + customInstructionsEnabled: + type: boolean + description: Indicator whether custom password instructions feature is enabled. The default value is false. + default: false + example: true + digitTokenEnabled: + type: boolean + description: Indicator whether "digit token" feature is enabled. The default value is false. + default: false + example: true + digitTokenDurationMinutes: + type: integer + format: int32 + description: The duration of "digit token" in minutes. The default value is 5. + minimum: 1 + maximum: 60 + default: 5 + example: 10 + digitTokenLength: + type: integer + format: int32 + description: The length of "digit token". The default value is 6. + minimum: 6 + maximum: 18 + default: 6 + example: 9 + example: + customInstructionsEnabled: true + digitTokenDurationMinutes: 9 + digitTokenEnabled: true + digitTokenLength: 12 + '400': + description: Client Error - Returned if the request body is invalid. + content: + application/json: + schema: + type: object + properties: + detailCode: type: string - readOnly: true - description: the id of the Source - example: 2c91808568c529c60168cca6f90c1324 - name: + description: Fine-grained error code providing more detail of the error. + example: 400.1 Bad Request Content + trackingId: type: string - description: Human-readable name of the source - example: My Source - description: + 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: Human-readable description of the source - example: This is the corporate directory. - owner: - description: Reference to an owning Identity Object - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of the identity - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the identity - example: MyName - cluster: - description: Reference to the associated Cluster - type: object - required: - - name - - id - - type - properties: - type: - description: The type of object being referenced - type: string - enum: - - CLUSTER - example: CLUSTER - id: - type: string - description: ID of the cluster - example: 2c9180866166b5b0016167c32ef31a66 - name: - type: string - description: Human-readable display name of the cluster - example: Corporate Cluster - accountCorrelationConfig: - description: Reference to an Account Correlation Config object - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - example: ACCOUNT_CORRELATION_CONFIG - id: - type: string - description: ID of the account correlation config - example: 2c9180855d191c59015d28583727245a - name: - type: string - description: Human-readable display name of the account correlation config - example: 'Directory [source-62867] Account Correlation' - accountCorrelationRule: - description: 'Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can''t be used.' - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - RULE - example: RULE - id: - type: string - description: ID of the rule - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Human-readable display name of the rule - example: Example Rule - managerCorrelationMapping: - description: Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity - type: object - properties: - accountAttribute: - type: string - description: Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. - example: manager - identityAttribute: - type: string - description: Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - example: manager - managerCorrelationRule: - description: 'Reference to the ManagerCorrelationRule, only used when a simple filter isn''t sufficient.' - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - RULE - example: RULE - id: - type: string - description: ID of the rule - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Human-readable display name of the rule - example: Example Rule - beforeProvisioningRule: - description: Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - RULE - example: RULE - id: - type: string - description: ID of the rule - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Human-readable display name of the rule - example: Example Rule - schemas: + 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: - type: - description: The type of object being referenced + locale: type: string - enum: - - CONNECTOR_SCHEMA - example: CONNECTOR_SCHEMA - id: + description: 'The locale for the message text, a BCP 47 language tag.' + example: en-US + localeOrigin: type: string - description: ID of the schema - example: 2c91808568c529c60168cca6f90c1777 - name: + 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: Human-readable display name of the schema - example: MySchema - description: List of references to Schema objects - example: - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232a - name: account - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232b - name: group - passwordPolicies: + 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: - type: - description: The type of object being referenced + locale: + type: string + description: 'The locale for the message text, a BCP 47 language tag.' + example: en-US + localeOrigin: type: string enum: - - PASSWORD_POLICY - example: PASSWORD_POLICY - id: + - 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: ID of the policy - example: 2c91808568c529c60168cca6f90c1777 - name: + 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: Human-readable display name of the policy - example: My Password Policy - description: List of references to the associated PasswordPolicy objects. - example: - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb053980 - name: Corporate Password Policy - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb057777 - name: Vendor Password Policy - features: + 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: Optional features that can be supported by a source. + 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. + /sod-policies: + post: + security: + - UserContextAuth: + - 'idn:sod-policy:write' + operationId: createSodPolicy + tags: + - SOD Policy + summary: Create SOD policy + description: |- + This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. + Requires role of ORG_ADMIN. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: Policy id + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + readOnly: true + name: + type: string + description: Policy Business Name + example: policy-xyz + created: + type: string + format: date-time + description: The time when this SOD policy is created. + example: '2020-01-01T00:00:00.000000Z' + readOnly: true + modified: + type: string + format: date-time + description: The time when this SOD policy is modified. + example: '2020-01-01T00:00:00.000000Z' + readOnly: true + description: + type: string + description: Optional description of the SOD policy + example: This policy ensures compliance of xyz + nullable: true + ownerRef: + type: object + properties: + type: + description: DTO type type: string enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING + - 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 + - WORKGROUP + 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 + externalPolicyReference: + type: string + description: Optional External Policy Reference + example: XYZ policy + nullable: true + policyQuery: + type: string + description: Search query of the SOD policy + example: '@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)' + compensatingControls: + type: string + description: Optional compensating controls(Mitigating Controls) + example: Have a manager review the transaction decisions for their "out of compliance" employee + nullable: true + correctionAdvice: + type: string + description: Optional correction advice + example: 'Based on the role of the employee, managers should remove access that is not required for their job function.' + nullable: true + state: + type: string + description: whether the policy is enforced or not + enum: + - ENFORCED + - NOT_ENFORCED + example: ENFORCED + tags: + type: array + description: tags for this policy object + example: + - TAG1 + - TAG2 + items: + type: string + creatorId: + type: string + description: Policy's creator ID + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + readOnly: true + modifierId: + type: string + description: Policy's modifier ID + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + nullable: true + readOnly: true + violationOwnerAssignmentConfig: + nullable: true + type: object + properties: + assignmentRule: + type: string + enum: + - MANAGER + - STATIC + - null description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - example: AUTHENTICATE - example: - - SYNC_PROVISIONING - - MANAGER_LOOKUP - - SEARCH - - PROVISIONING - - AUTHENTICATE - - GROUP_PROVISIONING - - PASSWORD - type: + Details about the violations owner. + MANAGER - identity's manager + STATIC - Governance Group or Identity + example: MANAGER + nullable: true + ownerRef: + 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 + - WORKGROUP + 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 + - nullable: true + scheduled: + type: boolean + description: defines whether a policy has been scheduled or not + example: true + default: false + type: + type: string + description: whether a policy is query based or conflicting access based + default: GENERAL + enum: + - GENERAL + - CONFLICTING_ACCESS_BASED + example: GENERAL + conflictingAccessCriteria: + allOf: + - type: object + properties: + leftCriteria: + type: object + properties: + name: + type: string + description: Business name for the access construct list + example: money-in + criteriaList: + type: array + description: List of criteria. There is a min of 1 and max of 50 items in the list. + minItems: 1 + maxItems: 50 + items: + type: object + properties: + type: + type: string + enum: + - ENTITLEMENT + description: Type of the propery to which this reference applies to + example: ENTITLEMENT + id: + type: string + description: ID of the object to which this reference applies to + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the object to which this reference applies to + example: Administrator + example: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a66 + name: Administrator + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a67 + name: Administrator + rightCriteria: + type: object + properties: + name: + type: string + description: Business name for the access construct list + example: money-in + criteriaList: + type: array + description: List of criteria. There is a min of 1 and max of 50 items in the list. + minItems: 1 + maxItems: 50 + items: + type: object + properties: + type: + type: string + enum: + - ENTITLEMENT + description: Type of the propery to which this reference applies to + example: ENTITLEMENT + id: + type: string + description: ID of the object to which this reference applies to + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the object to which this reference applies to + example: Administrator + example: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a66 + name: Administrator + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a67 + name: Administrator + - nullable: true + examples: + Conflicting Access Based Policy: + value: + name: Conflicting-Policy-Name + description: This policy ensures compliance of xyz + ownerRef: + type: IDENTITY + id: 2c91808568c529c60168cca6f90c1313 + name: Owner Name + externalPolicyReference: XYZ policy + compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee + correctionAdvice: 'Based on the role of the employee, managers should remove access that is not required for their job function.' + state: ENFORCED + tags: + - string + creatorId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + modifierId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + violationOwnerAssignmentConfig: + assignmentRule: MANAGER + ownerRef: + type: IDENTITY + id: 2c91808568c529c60168cca6f90c1313 + name: Violation Owner Name + scheduled: true + type: CONFLICTING_ACCESS_BASED + conflictingAccessCriteria: + leftCriteria: + name: money-in + criteriaList: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a66 + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a67 + rightCriteria: + name: money-out + criteriaList: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a68 + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a69 + General Policy: + value: + description: Description + ownerRef: + type: IDENTITY + id: 2c918087682f9a86016839c05e8f1aff + name: Owner Name + externalPolicyReference: New policy + policyQuery: policy query implementation + compensatingControls: Compensating controls + correctionAdvice: Correction advice + tags: [] + state: ENFORCED + scheduled: false + creatorId: 2c918087682f9a86016839c05e8f1aff + modifierId: null + violationOwnerAssignmentConfig: null + name: General-Policy-Name + responses: + '201': + description: SOD policy created + content: + application/json: + schema: + type: object + properties: + id: type: string - description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ' - example: OpenLDAP - Direct - connector: + description: Policy id + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + readOnly: true + name: type: string - description: Connector script name. - example: active-directory - connectorClass: + description: Policy Business Name + example: policy-xyz + created: type: string - description: The fully qualified name of the Java class that implements the connector interface. - example: sailpoint.connector.LDAPConnector - connectorAttributes: - type: object - description: Connector specific configuration; will differ from type to type. - example: - healthCheckTimeout: 30 - authSearchAttributes: - - cn - - uid - - mail - deleteThreshold: - type: integer - format: int32 - description: Number from 0 to 100 that specifies when to skip the delete phase. - example: 10 - authoritative: - type: boolean - description: When true indicates the source is referenced by an IdentityProfile. - default: false - example: false - managementWorkgroup: - description: Reference to Management Workgroup for this Source + format: date-time + description: The time when this SOD policy is created. + example: '2020-01-01T00:00:00.000000Z' + readOnly: true + modified: + type: string + format: date-time + description: The time when this SOD policy is modified. + example: '2020-01-01T00:00:00.000000Z' + readOnly: true + description: + type: string + description: Optional description of the SOD policy + example: This policy ensures compliance of xyz + nullable: true + ownerRef: type: object properties: type: - description: The type of object being referenced + 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 - example: 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 + - WORKGROUP + example: IDENTITY id: type: string - description: ID of the management workgroup - example: 2c91808568c529c60168cca6f90c2222 + description: ID of the object to which this reference applies + example: 2c91808568c529c60168cca6f90c1313 name: type: string - description: Human-readable display name of the management workgroup - example: My Management Workgroup - healthy: - type: boolean - description: When true indicates a healthy source - default: false - example: true - status: - type: string - description: 'A status identifier, giving specific information on why a source is healthy or not' - example: SOURCE_STATE_HEALTHY - since: - type: string - description: Timestamp showing when a source health check was last performed - example: '2021-09-28T15:48:29.3801666300Z' - connectorId: - type: string - description: The id of connector - example: active-directory - connectorName: + description: Human-readable display name of the object to which this reference applies + example: William Wilson + externalPolicyReference: type: string - description: The name of the connector that was chosen on source creation - example: Active Directory - connectionType: + description: Optional External Policy Reference + example: XYZ policy + nullable: true + policyQuery: type: string - description: The type of connection (direct or file) - example: file - connectorImplementstionId: + description: Search query of the SOD policy + example: '@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)' + compensatingControls: type: string - description: The connector implementstion id - example: delimited-file - required: - - name - - owner - - connector - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: + description: Optional compensating controls(Mitigating Controls) + example: Have a manager review the transaction decisions for their "out of compliance" employee + nullable: true + correctionAdvice: type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: + description: Optional correction advice + example: 'Based on the role of the employee, managers should remove access that is not required for their job function.' + nullable: true + state: 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: + description: whether the policy is enforced or not + enum: + - ENFORCED + - NOT_ENFORCED + example: ENFORCED + tags: type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + description: tags for this policy object + example: + - TAG1 + - TAG2 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 + creatorId: type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: + description: Policy's creator ID + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + readOnly: true + modifierId: 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. + description: Policy's modifier ID + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + nullable: true + readOnly: true + violationOwnerAssignmentConfig: + nullable: true + type: object + properties: + assignmentRule: + type: string + enum: + - MANAGER + - STATIC + - null + description: |- + Details about the violations owner. + MANAGER - identity's manager + STATIC - Governance Group or Identity + example: MANAGER + nullable: true + ownerRef: + 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 + - WORKGROUP + 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 + - nullable: true + scheduled: + type: boolean + description: defines whether a policy has been scheduled or not + example: true + default: false + type: + type: string + description: whether a policy is query based or conflicting access based + default: GENERAL + enum: + - GENERAL + - CONFLICTING_ACCESS_BASED + example: GENERAL + conflictingAccessCriteria: + allOf: + - type: object + properties: + leftCriteria: + type: object + properties: + name: + type: string + description: Business name for the access construct list + example: money-in + criteriaList: + type: array + description: List of criteria. There is a min of 1 and max of 50 items in the list. + minItems: 1 + maxItems: 50 + items: + type: object + properties: + type: + type: string + enum: + - ENTITLEMENT + description: Type of the propery to which this reference applies to + example: ENTITLEMENT + id: + type: string + description: ID of the object to which this reference applies to + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the object to which this reference applies to + example: Administrator + example: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a66 + name: Administrator + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a67 + name: Administrator + rightCriteria: + type: object + properties: + name: + type: string + description: Business name for the access construct list + example: money-in + criteriaList: + type: array + description: List of criteria. There is a min of 1 and max of 50 items in the list. + minItems: 1 + maxItems: 50 + items: + type: object + properties: + type: + type: string + enum: + - ENTITLEMENT + description: Type of the propery to which this reference applies to + example: ENTITLEMENT + id: + type: string + description: ID of the object to which this reference applies to + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the object to which this reference applies to + example: Administrator + example: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a66 + name: Administrator + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a67 + name: Administrator + - nullable: true examples: - '403': - summary: An example of a 403 response object + Conflicting Access Based Policy: + value: + id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + name: Conflicting-Policy-Name + created: '2020-01-01T00:00:00.000000Z' + modified: '2020-01-01T00:00:00.000000Z' + description: This policy ensures compliance of xyz + ownerRef: + type: IDENTITY + id: 2c91808568c529c60168cca6f90c1313 + name: Owner Name + externalPolicyReference: XYZ policy + policyQuery: '@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)' + compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee + correctionAdvice: 'Based on the role of the employee, managers should remove access that is not required for their job function.' + state: ENFORCED + tags: + - string + creatorId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + modifierId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + violationOwnerAssignmentConfig: + assignmentRule: MANAGER + ownerRef: + type: IDENTITY + id: 2c91808568c529c60168cca6f90c1313 + name: Violation Owner Name + scheduled: true + type: CONFLICTING_ACCESS_BASED + conflictingAccessCriteria: + leftCriteria: + name: money-in + criteriaList: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a66 + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a67 + rightCriteria: + name: money-out + criteriaList: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a68 + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a69 + General Policy: value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist + description: Description + ownerRef: + type: IDENTITY + id: 2c918087682f9a86016839c05e8f1aff + name: Owner Name + externalPolicyReference: New policy + policyQuery: policy query implementation + compensatingControls: Compensating controls + correctionAdvice: Correction advice + tags: [] + state: ENFORCED + scheduled: false + creatorId: 2c918087682f9a86016839c05e8f1aff + modifierId: null + violationOwnerAssignmentConfig: null + type: GENERAL + conflictingAccessCriteria: null + id: 52c11db4-733e-4c31-949a-766c95ec95f1 + name: General-Policy-Name + created: '2020-05-12T19:47:38Z' + modified: '2020-05-12T19:47:38Z' + '400': + description: Client Error - Returned if the request body is invalid. content: application/json: schema: @@ -91875,824 +82219,566 @@ paths: 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. + '401': + description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' content: application/json: schema: type: object properties: - message: + error: description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected 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: - '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. - put: - operationId: putSource - security: - - UserContextAuth: - - 'idn:sources:manage' - tags: - - Sources - summary: Update Source (Full) - description: | - This API updates a source in IdentityNow, using a full object representation. In other words, the existing Source - configuration is completely replaced. - - Some fields are immutable and cannot be changed, such as: - - * id - * type - * authoritative - * connector - * connectorClass - * passwordPolicies - - Attempts to modify these fields will result in a 400 error. - - A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The Source id - example: 2c9180835d191a86015d28455b4a2329 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - id: - type: string - readOnly: true - description: the id of the Source - example: 2c91808568c529c60168cca6f90c1324 - name: - type: string - description: Human-readable name of the source - example: My Source - description: - type: string - description: Human-readable description of the source - example: This is the corporate directory. - owner: - description: Reference to an owning Identity Object - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of the identity - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the identity - example: MyName - cluster: - description: Reference to the associated Cluster - type: object - required: - - name - - id - - type - properties: - type: - description: The type of object being referenced - type: string - enum: - - CLUSTER - example: CLUSTER - id: - type: string - description: ID of the cluster - example: 2c9180866166b5b0016167c32ef31a66 - name: - type: string - description: Human-readable display name of the cluster - example: Corporate Cluster - accountCorrelationConfig: - description: Reference to an Account Correlation Config object - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - example: ACCOUNT_CORRELATION_CONFIG - id: - type: string - description: ID of the account correlation config - example: 2c9180855d191c59015d28583727245a - name: - type: string - description: Human-readable display name of the account correlation config - example: 'Directory [source-62867] Account Correlation' - accountCorrelationRule: - description: 'Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can''t be used.' - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - RULE - example: RULE - id: - type: string - description: ID of the rule - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Human-readable display name of the rule - example: Example Rule - managerCorrelationMapping: - description: Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity - type: object - properties: - accountAttribute: - type: string - description: Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. - example: manager - identityAttribute: - type: string - description: Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - example: manager - managerCorrelationRule: - description: 'Reference to the ManagerCorrelationRule, only used when a simple filter isn''t sufficient.' - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - RULE - example: RULE - id: - type: string - description: ID of the rule - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Human-readable display name of the rule - example: Example Rule - beforeProvisioningRule: - description: Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - RULE - example: RULE - id: - type: string - description: ID of the rule - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Human-readable display name of the rule - example: Example Rule - schemas: - type: array - items: - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - CONNECTOR_SCHEMA - example: CONNECTOR_SCHEMA - id: - type: string - description: ID of the schema - example: 2c91808568c529c60168cca6f90c1777 - name: - type: string - description: Human-readable display name of the schema - example: MySchema - description: List of references to Schema objects - example: - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232a - name: account - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232b - name: group - passwordPolicies: - type: array - items: - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - PASSWORD_POLICY - example: PASSWORD_POLICY - id: - type: string - description: ID of the policy - example: 2c91808568c529c60168cca6f90c1777 - name: - type: string - description: Human-readable display name of the policy - example: My Password Policy - description: List of references to the associated PasswordPolicy objects. - example: - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb053980 - name: Corporate Password Policy - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb057777 - name: Vendor Password Policy - features: - type: array - description: Optional features that can be supported by a source. - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - example: AUTHENTICATE - example: - - SYNC_PROVISIONING - - MANAGER_LOOKUP - - SEARCH - - PROVISIONING - - AUTHENTICATE - - GROUP_PROVISIONING - - PASSWORD - type: - type: string - description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ' - example: OpenLDAP - Direct - connector: - type: string - description: Connector script name. - example: active-directory - connectorClass: - type: string - description: The fully qualified name of the Java class that implements the connector interface. - example: sailpoint.connector.LDAPConnector - connectorAttributes: - type: object - description: Connector specific configuration; will differ from type to type. - example: - healthCheckTimeout: 30 - authSearchAttributes: - - cn - - uid - - mail - deleteThreshold: - type: integer - format: int32 - description: Number from 0 to 100 that specifies when to skip the delete phase. - example: 10 - authoritative: - type: boolean - description: When true indicates the source is referenced by an IdentityProfile. - default: false - example: false - managementWorkgroup: - description: Reference to Management Workgroup for this Source - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - GOVERNANCE_GROUP - example: GOVERNANCE_GROUP - id: - type: string - description: ID of the management workgroup - example: 2c91808568c529c60168cca6f90c2222 - name: - type: string - description: Human-readable display name of the management workgroup - example: My Management Workgroup - healthy: - type: boolean - description: When true indicates a healthy source - default: false - example: true - status: - type: string - description: 'A status identifier, giving specific information on why a source is healthy or not' - example: SOURCE_STATE_HEALTHY - since: - type: string - description: Timestamp showing when a source health check was last performed - example: '2021-09-28T15:48:29.3801666300Z' - connectorId: - type: string - description: The id of connector - example: active-directory - connectorName: - type: string - description: The name of the connector that was chosen on source creation - example: Active Directory - connectionType: - type: string - description: The type of connection (direct or file) - example: file - connectorImplementstionId: - type: string - description: The connector implementstion id - example: delimited-file - required: - - name - - owner - - connector - responses: - '200': - description: 'Updated Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design.' + 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: - id: - type: string - readOnly: true - description: the id of the Source - example: 2c91808568c529c60168cca6f90c1324 - name: + 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: Human-readable name of the source - example: My Source - description: + description: Fine-grained error code providing more detail of the error. + example: 400.1 Bad Request Content + trackingId: type: string - description: Human-readable description of the source - example: This is the corporate directory. - owner: - description: Reference to an owning Identity Object - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of the identity - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the identity - example: MyName - cluster: - description: Reference to the associated Cluster - type: object - required: - - name - - id - - type - properties: - type: - description: The type of object being referenced - type: string - enum: - - CLUSTER - example: CLUSTER - id: - type: string - description: ID of the cluster - example: 2c9180866166b5b0016167c32ef31a66 - name: - type: string - description: Human-readable display name of the cluster - example: Corporate Cluster - accountCorrelationConfig: - description: Reference to an Account Correlation Config object - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - example: ACCOUNT_CORRELATION_CONFIG - id: - type: string - description: ID of the account correlation config - example: 2c9180855d191c59015d28583727245a - name: - type: string - description: Human-readable display name of the account correlation config - example: 'Directory [source-62867] Account Correlation' - accountCorrelationRule: - description: 'Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can''t be used.' - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - RULE - example: RULE - id: - type: string - description: ID of the rule - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Human-readable display name of the rule - example: Example Rule - managerCorrelationMapping: - description: Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity - type: object - properties: - accountAttribute: - type: string - description: Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. - example: manager - identityAttribute: - type: string - description: Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - example: manager - managerCorrelationRule: - description: 'Reference to the ManagerCorrelationRule, only used when a simple filter isn''t sufficient.' - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - RULE - example: RULE - id: - type: string - description: ID of the rule - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Human-readable display name of the rule - example: Example Rule - beforeProvisioningRule: - description: Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - RULE - example: RULE - id: - type: string - description: ID of the rule - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Human-readable display name of the rule - example: Example Rule - schemas: + description: Unique tracking id for the error. + example: e7eab60924f64aa284175b9fa3309599 + messages: type: array + description: Generic localized reason for error items: type: object properties: - type: - description: The type of object being referenced + locale: type: string - enum: - - CONNECTOR_SCHEMA - example: CONNECTOR_SCHEMA - id: + description: 'The locale for the message text, a BCP 47 language tag.' + example: en-US + localeOrigin: type: string - description: ID of the schema - example: 2c91808568c529c60168cca6f90c1777 - name: + 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: Human-readable display name of the schema - example: MySchema - description: List of references to Schema objects - example: - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232a - name: account - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232b - name: group - passwordPolicies: + 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. + get: + security: + - UserContextAuth: + - 'idn:sod-policy:read' + operationId: listSodPolicies + tags: + - SOD Policy + summary: List SOD policies + description: |- + This gets list of all SOD policies. + Requires role of ORG_ADMIN + parameters: + - 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 + 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* + + **name**: *eq* + + **state**: *eq* + example: id eq "bc693f07e7b645539626c25954c58554" + required: false + responses: + '200': + description: List of all SOD policies. + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: string + description: Policy id + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + readOnly: true + name: + type: string + description: Policy Business Name + example: policy-xyz + created: + type: string + format: date-time + description: The time when this SOD policy is created. + example: '2020-01-01T00:00:00.000000Z' + readOnly: true + modified: + type: string + format: date-time + description: The time when this SOD policy is modified. + example: '2020-01-01T00:00:00.000000Z' + readOnly: true + description: + type: string + description: Optional description of the SOD policy + example: This policy ensures compliance of xyz + nullable: true + ownerRef: type: object properties: type: - description: The type of object being referenced + 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 - example: PASSWORD_POLICY + - ROLE + - RULE + - SOD_POLICY + - SOURCE + - TAG + - TAG_CATEGORY + - TASK_RESULT + - REPORT_RESULT + - SOD_VIOLATION + - ACCOUNT_ACTIVITY + - WORKGROUP + example: IDENTITY id: type: string - description: ID of the policy - example: 2c91808568c529c60168cca6f90c1777 + description: ID of the object to which this reference applies + example: 2c91808568c529c60168cca6f90c1313 name: type: string - description: Human-readable display name of the policy - example: My Password Policy - description: List of references to the associated PasswordPolicy objects. - example: - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb053980 - name: Corporate Password Policy - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb057777 - name: Vendor Password Policy - features: - type: array - description: Optional features that can be supported by a source. - items: + description: Human-readable display name of the object to which this reference applies + example: William Wilson + externalPolicyReference: + type: string + description: Optional External Policy Reference + example: XYZ policy + nullable: true + policyQuery: + type: string + description: Search query of the SOD policy + example: '@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)' + compensatingControls: + type: string + description: Optional compensating controls(Mitigating Controls) + example: Have a manager review the transaction decisions for their "out of compliance" employee + nullable: true + correctionAdvice: + type: string + description: Optional correction advice + example: 'Based on the role of the employee, managers should remove access that is not required for their job function.' + nullable: true + state: + type: string + description: whether the policy is enforced or not + enum: + - ENFORCED + - NOT_ENFORCED + example: ENFORCED + tags: + type: array + description: tags for this policy object + example: + - TAG1 + - TAG2 + items: + type: string + creatorId: + type: string + description: Policy's creator ID + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + readOnly: true + modifierId: + type: string + description: Policy's modifier ID + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + nullable: true + readOnly: true + violationOwnerAssignmentConfig: + nullable: true + type: object + properties: + assignmentRule: + type: string + enum: + - MANAGER + - STATIC + - null + description: |- + Details about the violations owner. + MANAGER - identity's manager + STATIC - Governance Group or Identity + example: MANAGER + nullable: true + ownerRef: + 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 + - WORKGROUP + 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 + - nullable: true + scheduled: + type: boolean + description: defines whether a policy has been scheduled or not + example: true + default: false + type: type: string + description: whether a policy is query based or conflicting access based + default: GENERAL enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - example: AUTHENTICATE - example: - - SYNC_PROVISIONING - - MANAGER_LOOKUP - - SEARCH - - PROVISIONING - - AUTHENTICATE - - GROUP_PROVISIONING - - PASSWORD - type: - type: string - description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ' - example: OpenLDAP - Direct - connector: - type: string - description: Connector script name. - example: active-directory - connectorClass: - type: string - description: The fully qualified name of the Java class that implements the connector interface. - example: sailpoint.connector.LDAPConnector - connectorAttributes: - type: object - description: Connector specific configuration; will differ from type to type. - example: - healthCheckTimeout: 30 - authSearchAttributes: - - cn - - uid - - mail - deleteThreshold: - type: integer - format: int32 - description: Number from 0 to 100 that specifies when to skip the delete phase. - example: 10 - authoritative: - type: boolean - description: When true indicates the source is referenced by an IdentityProfile. - default: false - example: false - managementWorkgroup: - description: Reference to Management Workgroup for this Source - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - GOVERNANCE_GROUP - example: GOVERNANCE_GROUP - id: - type: string - description: ID of the management workgroup - example: 2c91808568c529c60168cca6f90c2222 - name: - type: string - description: Human-readable display name of the management workgroup - example: My Management Workgroup - healthy: - type: boolean - description: When true indicates a healthy source - default: false - example: true - status: - type: string - description: 'A status identifier, giving specific information on why a source is healthy or not' - example: SOURCE_STATE_HEALTHY - since: - type: string - description: Timestamp showing when a source health check was last performed - example: '2021-09-28T15:48:29.3801666300Z' - connectorId: - type: string - description: The id of connector - example: active-directory - connectorName: - type: string - description: The name of the connector that was chosen on source creation - example: Active Directory - connectionType: - type: string - description: The type of connection (direct or file) - example: file - connectorImplementstionId: - type: string - description: The connector implementstion id - example: delimited-file - required: - - name - - owner - - connector + - GENERAL + - CONFLICTING_ACCESS_BASED + example: GENERAL + conflictingAccessCriteria: + allOf: + - type: object + properties: + leftCriteria: + type: object + properties: + name: + type: string + description: Business name for the access construct list + example: money-in + criteriaList: + type: array + description: List of criteria. There is a min of 1 and max of 50 items in the list. + minItems: 1 + maxItems: 50 + items: + type: object + properties: + type: + type: string + enum: + - ENTITLEMENT + description: Type of the propery to which this reference applies to + example: ENTITLEMENT + id: + type: string + description: ID of the object to which this reference applies to + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the object to which this reference applies to + example: Administrator + example: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a66 + name: Administrator + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a67 + name: Administrator + rightCriteria: + type: object + properties: + name: + type: string + description: Business name for the access construct list + example: money-in + criteriaList: + type: array + description: List of criteria. There is a min of 1 and max of 50 items in the list. + minItems: 1 + maxItems: 50 + items: + type: object + properties: + type: + type: string + enum: + - ENTITLEMENT + description: Type of the propery to which this reference applies to + example: ENTITLEMENT + id: + type: string + description: ID of the object to which this reference applies to + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the object to which this reference applies to + example: Administrator + example: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a66 + name: Administrator + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a67 + name: Administrator + - nullable: true + example: + - id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + name: Conflicting-Policy-Name + created: '2020-01-01T00:00:00.000000Z' + modified: '2020-01-01T00:00:00.000000Z' + description: This policy ensures compliance of xyz + ownerRef: + type: IDENTITY + id: 2c91808568c529c60168cca6f90c1313 + name: Owner Name + externalPolicyReference: XYZ policy + policyQuery: '@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)' + compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee + correctionAdvice: 'Based on the role of the employee, managers should remove access that is not required for their job function.' + state: ENFORCED + tags: + - string + creatorId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + modifierId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + violationOwnerAssignmentConfig: + assignmentRule: MANAGER + ownerRef: + type: IDENTITY + id: 2c91808568c529c60168cca6f90c1313 + name: Violation Owner Name + scheduled: true + type: CONFLICTING_ACCESS_BASED + conflictingAccessCriteria: + leftCriteria: + name: money-in + criteriaList: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a66 + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a67 + rightCriteria: + name: money-out + criteriaList: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a68 + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a69 + - description: Description + ownerRef: + type: IDENTITY + id: 2c918087682f9a86016839c05e8f1aff + name: Owner Name + externalPolicyReference: New policy + policyQuery: policy query implementation + compensatingControls: Compensating controls + correctionAdvice: Correction advice + tags: [] + state: ENFORCED + scheduled: false + creatorId: 2c918087682f9a86016839c05e8f1aff + modifierId: null + violationOwnerAssignmentConfig: null + type: GENERAL + conflictingAccessCriteria: null + id: 52c11db4-733e-4c31-949a-766c95ec95f1 + name: General-Policy-Name + created: '2020-05-12T19:47:38Z' + modified: '2020-05-12T19:47:38Z' '400': description: Client Error - Returned if the request body is invalid. content: @@ -92827,73 +82913,6 @@ paths: - locale: en-US localeOrigin: DEFAULT text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. '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: @@ -92971,129 +82990,29 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - patch: - operationId: updateSource + '/sod-policies/{id}': + get: security: - UserContextAuth: - - 'idn:sources:manage' - tags: - - Sources - summary: Update Source (Partial) - description: | - This API partially updates a source in IdentityNow, using a list of patch operations according to the - [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - Some fields are immutable and cannot be changed, such as: - - * id - * type - * authoritative - * created - * modified - * connector - * connectorClass - * passwordPolicies - - Attempts to modify these fields will result in a 400 error. - - A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or API authority is required to call this API. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The Source id - example: 2c9180835d191a86015d28455b4a2329 - requestBody: - required: true - description: 'A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in IdentityNow.' - content: - application/json-patch+json: - schema: - type: array - items: - type: object - description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' - required: - - op - - path - properties: - op: - type: string - description: The operation to be performed - enum: - - add - - remove - - replace - - move - - copy - - test - example: replace - path: - type: string - description: A string JSON Pointer representing the target path to an element to be affected by the operation - example: /description - value: - anyOf: - - type: string - - type: integer - - type: object - - type: array - items: - anyOf: - - type: string - - type: integer - - type: object - description: 'The value to be used for the operation, required for "add" and "replace" operations' - example: New description - examples: - Edit the source description: - description: This example shows how to edit a source description. - value: - - op: replace - path: /description - value: new description - Edit the source cluster: - description: This example shows how to edit a source cluster by id. - value: - - op: replace - path: /cluster/id - value: 2c918087813a902001813f3f85736b45 - Edit source features: - description: This example illustrates how you can update source supported features - value: - - op: replace - path: /features - value: - - PASSWORD - - PROVISIONING - - ENABLE - - AUTHENTICATE - Change a source description and cluster in One Call: - description: This example shows how multiple fields may be updated with a single patch call. - value: - - op: replace - path: /description - value: new description - - op: replace - path: /cluster/id - value: 2c918087813a902001813f3f85736b45 - Add a filter string to the connector: - description: 'This example shows how you can add a filter to incoming accounts during the account aggregation process. In the example below, any account that does not have an "m" or "d" in the id will be aggregated.' - value: - - op: add - path: /connectorAttributes/filterString - value: '!( id.contains( "m" ) ) || !( id.contains( "d" ) )' - Update connector attribute for specific operation type: - description: This example shows how you can update the 3rd object in the connection parameters operationType. This will change it from a standard group aggregation to a group aggregation on the "test" entitlement type - value: - - op: replace - path: /connectorAttributes/connectionParameters/2/operationType - value: Group Aggregation-test + - 'idn:sod-policy:read' + operationId: getSodPolicy + tags: + - SOD Policy + summary: Get SOD policy by ID + description: |- + This gets specified SOD policy. + Requires role of ORG_ADMIN. + parameters: + - in: path + name: id + schema: + type: string + required: true + description: The ID of the SOD Policy to retrieve. + example: ef38f943-47e9-4562-b5bb-8424a56397d8 responses: '200': - description: 'Updated Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design.' + description: SOD policy ID. content: application/json: schema: @@ -93101,346 +83020,338 @@ paths: properties: id: type: string + description: Policy id + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde readOnly: true - description: the id of the Source - example: 2c91808568c529c60168cca6f90c1324 name: type: string - description: Human-readable name of the source - example: My Source + description: Policy Business Name + example: policy-xyz + created: + type: string + format: date-time + description: The time when this SOD policy is created. + example: '2020-01-01T00:00:00.000000Z' + readOnly: true + modified: + type: string + format: date-time + description: The time when this SOD policy is modified. + example: '2020-01-01T00:00:00.000000Z' + readOnly: true description: type: string - description: Human-readable description of the source - example: This is the corporate directory. - owner: - description: Reference to an owning Identity Object + description: Optional description of the SOD policy + example: This policy ensures compliance of xyz + nullable: true + ownerRef: type: object properties: type: - description: The type of object being referenced + 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 + - WORKGROUP example: IDENTITY id: type: string - description: ID of the identity + description: ID of the object to which this reference applies example: 2c91808568c529c60168cca6f90c1313 name: type: string - description: Human-readable display name of the identity - example: MyName - cluster: - description: Reference to the associated Cluster - type: object - required: - - name - - id - - type - properties: - type: - description: The type of object being referenced - type: string - enum: - - CLUSTER - example: CLUSTER - id: - type: string - description: ID of the cluster - example: 2c9180866166b5b0016167c32ef31a66 - name: - type: string - description: Human-readable display name of the cluster - example: Corporate Cluster - accountCorrelationConfig: - description: Reference to an Account Correlation Config object - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - example: ACCOUNT_CORRELATION_CONFIG - id: - type: string - description: ID of the account correlation config - example: 2c9180855d191c59015d28583727245a - name: - type: string - description: Human-readable display name of the account correlation config - example: 'Directory [source-62867] Account Correlation' - accountCorrelationRule: - description: 'Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can''t be used.' - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - RULE - example: RULE - id: - type: string - description: ID of the rule - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Human-readable display name of the rule - example: Example Rule - managerCorrelationMapping: - description: Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity - type: object - properties: - accountAttribute: - type: string - description: Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. - example: manager - identityAttribute: - type: string - description: Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - example: manager - managerCorrelationRule: - description: 'Reference to the ManagerCorrelationRule, only used when a simple filter isn''t sufficient.' - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - RULE - example: RULE - id: - type: string - description: ID of the rule - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Human-readable display name of the rule - example: Example Rule - beforeProvisioningRule: - description: Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - RULE - example: RULE - id: - type: string - description: ID of the rule - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Human-readable display name of the rule - example: Example Rule - schemas: - type: array - items: - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - CONNECTOR_SCHEMA - example: CONNECTOR_SCHEMA - id: - type: string - description: ID of the schema - example: 2c91808568c529c60168cca6f90c1777 - name: - type: string - description: Human-readable display name of the schema - example: MySchema - description: List of references to Schema objects - example: - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232a - name: account - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232b - name: group - passwordPolicies: + description: Human-readable display name of the object to which this reference applies + example: William Wilson + externalPolicyReference: + type: string + description: Optional External Policy Reference + example: XYZ policy + nullable: true + policyQuery: + type: string + description: Search query of the SOD policy + example: '@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)' + compensatingControls: + type: string + description: Optional compensating controls(Mitigating Controls) + example: Have a manager review the transaction decisions for their "out of compliance" employee + nullable: true + correctionAdvice: + type: string + description: Optional correction advice + example: 'Based on the role of the employee, managers should remove access that is not required for their job function.' + nullable: true + state: + type: string + description: whether the policy is enforced or not + enum: + - ENFORCED + - NOT_ENFORCED + example: ENFORCED + tags: type: array - items: - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - PASSWORD_POLICY - example: PASSWORD_POLICY - id: - type: string - description: ID of the policy - example: 2c91808568c529c60168cca6f90c1777 - name: - type: string - description: Human-readable display name of the policy - example: My Password Policy - description: List of references to the associated PasswordPolicy objects. + description: tags for this policy object example: - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb053980 - name: Corporate Password Policy - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb057777 - name: Vendor Password Policy - features: - type: array - description: Optional features that can be supported by a source. + - TAG1 + - TAG2 items: type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - example: AUTHENTICATE - example: - - SYNC_PROVISIONING - - MANAGER_LOOKUP - - SEARCH - - PROVISIONING - - AUTHENTICATE - - GROUP_PROVISIONING - - PASSWORD - type: - type: string - description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ' - example: OpenLDAP - Direct - connector: + creatorId: type: string - description: Connector script name. - example: active-directory - connectorClass: + description: Policy's creator ID + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + readOnly: true + modifierId: type: string - description: The fully qualified name of the Java class that implements the connector interface. - example: sailpoint.connector.LDAPConnector - connectorAttributes: - type: object - description: Connector specific configuration; will differ from type to type. - example: - healthCheckTimeout: 30 - authSearchAttributes: - - cn - - uid - - mail - deleteThreshold: - type: integer - format: int32 - description: Number from 0 to 100 that specifies when to skip the delete phase. - example: 10 - authoritative: - type: boolean - description: When true indicates the source is referenced by an IdentityProfile. - default: false - example: false - managementWorkgroup: - description: Reference to Management Workgroup for this Source + description: Policy's modifier ID + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + nullable: true + readOnly: true + violationOwnerAssignmentConfig: + nullable: true type: object properties: - type: - description: The type of object being referenced + assignmentRule: type: string enum: - - GOVERNANCE_GROUP - example: GOVERNANCE_GROUP - id: - type: string - description: ID of the management workgroup - example: 2c91808568c529c60168cca6f90c2222 - name: - type: string - description: Human-readable display name of the management workgroup - example: My Management Workgroup - healthy: + - MANAGER + - STATIC + - null + description: |- + Details about the violations owner. + MANAGER - identity's manager + STATIC - Governance Group or Identity + example: MANAGER + nullable: true + ownerRef: + 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 + - WORKGROUP + 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 + - nullable: true + scheduled: type: boolean - description: When true indicates a healthy source - default: false + description: defines whether a policy has been scheduled or not example: true - status: - type: string - description: 'A status identifier, giving specific information on why a source is healthy or not' - example: SOURCE_STATE_HEALTHY - since: - type: string - description: Timestamp showing when a source health check was last performed - example: '2021-09-28T15:48:29.3801666300Z' - connectorId: - type: string - description: The id of connector - example: active-directory - connectorName: - type: string - description: The name of the connector that was chosen on source creation - example: Active Directory - connectionType: - type: string - description: The type of connection (direct or file) - example: file - connectorImplementstionId: + default: false + type: type: string - description: The connector implementstion id - example: delimited-file - required: - - name - - owner - - connector + description: whether a policy is query based or conflicting access based + default: GENERAL + enum: + - GENERAL + - CONFLICTING_ACCESS_BASED + example: GENERAL + conflictingAccessCriteria: + allOf: + - type: object + properties: + leftCriteria: + type: object + properties: + name: + type: string + description: Business name for the access construct list + example: money-in + criteriaList: + type: array + description: List of criteria. There is a min of 1 and max of 50 items in the list. + minItems: 1 + maxItems: 50 + items: + type: object + properties: + type: + type: string + enum: + - ENTITLEMENT + description: Type of the propery to which this reference applies to + example: ENTITLEMENT + id: + type: string + description: ID of the object to which this reference applies to + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the object to which this reference applies to + example: Administrator + example: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a66 + name: Administrator + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a67 + name: Administrator + rightCriteria: + type: object + properties: + name: + type: string + description: Business name for the access construct list + example: money-in + criteriaList: + type: array + description: List of criteria. There is a min of 1 and max of 50 items in the list. + minItems: 1 + maxItems: 50 + items: + type: object + properties: + type: + type: string + enum: + - ENTITLEMENT + description: Type of the propery to which this reference applies to + example: ENTITLEMENT + id: + type: string + description: ID of the object to which this reference applies to + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the object to which this reference applies to + example: Administrator + example: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a66 + name: Administrator + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a67 + name: Administrator + - nullable: true + examples: + Conflicting Access Based Policy: + value: + id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + name: Conflicting-Policy-Name + created: '2020-01-01T00:00:00.000000Z' + modified: '2020-01-01T00:00:00.000000Z' + description: This policy ensures compliance of xyz + ownerRef: + type: IDENTITY + id: 2c91808568c529c60168cca6f90c1313 + name: Owner Name + externalPolicyReference: XYZ policy + policyQuery: '@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)' + compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee + correctionAdvice: 'Based on the role of the employee, managers should remove access that is not required for their job function.' + state: ENFORCED + tags: + - string + creatorId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + modifierId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + violationOwnerAssignmentConfig: + assignmentRule: MANAGER + ownerRef: + type: IDENTITY + id: 2c91808568c529c60168cca6f90c1313 + name: Violation Owner Name + scheduled: true + type: CONFLICTING_ACCESS_BASED + conflictingAccessCriteria: + leftCriteria: + name: money-in + criteriaList: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a66 + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a67 + rightCriteria: + name: money-out + criteriaList: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a68 + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a69 + General Policy: + value: + description: Description + ownerRef: + type: IDENTITY + id: 2c918087682f9a86016839c05e8f1aff + name: Owner Name + externalPolicyReference: New policy + policyQuery: policy query implementation + compensatingControls: Compensating controls + correctionAdvice: Correction advice + tags: [] + state: ENFORCED + scheduled: false + creatorId: 2c918087682f9a86016839c05e8f1aff + modifierId: null + violationOwnerAssignmentConfig: null + type: GENERAL + conflictingAccessCriteria: null + id: 52c11db4-733e-4c31-949a-766c95ec95f1 + name: General-Policy-Name + created: '2020-05-12T19:47:38Z' + modified: '2020-05-12T19:47:38Z' '400': description: Client Error - Returned if the request body is invalid. content: @@ -93719,436 +83630,698 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - delete: - operationId: deleteSource + put: security: - UserContextAuth: - - 'idn:sources:manage' + - 'idn:sod-policy:write' + operationId: setSodPolicy tags: - - Sources - summary: Delete Source by ID + - SOD Policy + summary: Update SOD policy by ID description: |- - This end-point deletes a specific source in IdentityNow. - A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - All of accounts on the source will be removed first, then the source will be deleted. Actual status of task execution can be retrieved via method GET `/task-status/{id}` + This updates a specified SOD policy. + Requires role of ORG_ADMIN. parameters: - in: path name: id schema: type: string required: true - description: The Source id - example: 2c9180835d191a86015d28455b4a2329 - responses: - '202': - description: Accepted - Returned if the request was successfully accepted into the system. - content: - application/json: - schema: - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - TASK_RESULT - example: TASK_RESULT - id: - type: string - description: ID of the task result - example: 2c91808779ecf55b0179f720942f181a - name: - type: string - description: Human-readable display name of the task result (should be null/empty) - example: null - examples: - deleteSource: - summary: Response returned when deleting a source - value: - type: TASK_RESULT - id: 2c91808779ecf55b0179f720942f181a - name: null - '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: + description: The ID of the SOD policy to update. + example: ef38f943-47e9-4562-b5bb-8424a56397d8 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: Policy id + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + readOnly: true + name: + type: string + description: Policy Business Name + example: policy-xyz + created: + type: string + format: date-time + description: The time when this SOD policy is created. + example: '2020-01-01T00:00:00.000000Z' + readOnly: true + modified: + type: string + format: date-time + description: The time when this SOD policy is modified. + example: '2020-01-01T00:00:00.000000Z' + readOnly: true + description: + type: string + description: Optional description of the SOD policy + example: This policy ensures compliance of xyz + nullable: true + ownerRef: + 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 + - WORKGROUP + 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 + externalPolicyReference: + type: string + description: Optional External Policy Reference + example: XYZ policy + nullable: true + policyQuery: + type: string + description: Search query of the SOD policy + example: '@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)' + compensatingControls: + type: string + description: Optional compensating controls(Mitigating Controls) + example: Have a manager review the transaction decisions for their "out of compliance" employee + nullable: true + correctionAdvice: + type: string + description: Optional correction advice + example: 'Based on the role of the employee, managers should remove access that is not required for their job function.' + nullable: true + state: + type: string + description: whether the policy is enforced or not + enum: + - ENFORCED + - NOT_ENFORCED + example: ENFORCED + tags: + type: array + description: tags for this policy object + example: + - TAG1 + - TAG2 + items: 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 + creatorId: + type: string + description: Policy's creator ID + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + readOnly: true + modifierId: + type: string + description: Policy's modifier ID + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + nullable: true + readOnly: true + violationOwnerAssignmentConfig: + nullable: true + type: object + properties: + assignmentRule: + type: string + enum: + - MANAGER + - STATIC + - null + description: |- + Details about the violations owner. + MANAGER - identity's manager + STATIC - Governance Group or Identity + example: MANAGER + nullable: true + ownerRef: + 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 + - WORKGROUP + 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 + - nullable: true + scheduled: + type: boolean + description: defines whether a policy has been scheduled or not + example: true + default: false + type: + type: string + description: whether a policy is query based or conflicting access based + default: GENERAL + enum: + - GENERAL + - CONFLICTING_ACCESS_BASED + example: GENERAL + conflictingAccessCriteria: + allOf: + - 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.' + leftCriteria: + type: object + properties: + name: + type: string + description: Business name for the access construct list + example: money-in + criteriaList: + type: array + description: List of criteria. There is a min of 1 and max of 50 items in the list. + minItems: 1 + maxItems: 50 + items: + type: object + properties: + type: + type: string + enum: + - ENTITLEMENT + description: Type of the propery to which this reference applies to + example: ENTITLEMENT + id: + type: string + description: ID of the object to which this reference applies to + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the object to which this reference applies to + example: Administrator + example: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a66 + name: Administrator + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a67 + name: Administrator + rightCriteria: + type: object + properties: + name: + type: string + description: Business name for the access construct list + example: money-in + criteriaList: + type: array + description: List of criteria. There is a min of 1 and max of 50 items in the list. + minItems: 1 + maxItems: 50 + items: + type: object + properties: + type: + type: string + enum: + - ENTITLEMENT + description: Type of the propery to which this reference applies to + example: ENTITLEMENT + id: + type: string + description: ID of the object to which this reference applies to + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the object to which this reference applies to + example: Administrator + example: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a66 + name: Administrator + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a67 + name: Administrator + - nullable: true + examples: + Conflicting Access Based Policy: + value: + name: Conflicting-Policy-Name + description: Modified Description + externalPolicyReference: XYZ policy + compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee + correctionAdvice: 'Based on the role of the employee, managers should remove access that is not required for their job function.' + state: ENFORCED + tags: + - string + violationOwnerAssignmentConfig: + assignmentRule: MANAGER + ownerRef: + type: IDENTITY + id: 2c91808568c529c60168cca6f90c1313 + name: Violation Owner Name + scheduled: true + type: CONFLICTING_ACCESS_BASED + conflictingAccessCriteria: + leftCriteria: + name: money-in + criteriaList: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a66 + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a67 + rightCriteria: + name: money-out + criteriaList: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a68 + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a69 + General Policy: + value: + description: Modified Description + ownerRef: + type: IDENTITY + id: 2c918087682f9a86016839c05e8f1aff + name: Owner Name + externalPolicyReference: New policy + policyQuery: policy query implementation + compensatingControls: Compensating controls + correctionAdvice: Correction advice + tags: [] + state: ENFORCED + scheduled: false + creatorId: 2c918087682f9a86016839c05e8f1aff + modifierId: null + violationOwnerAssignmentConfig: null + type: GENERAL + conflictingAccessCriteria: null + id: 52c11db4-733e-4c31-949a-766c95ec95f1 + name: General-Policy-Name + created: '2020-05-12T19:47:38Z' + modified: '2020-05-12T19:47:38Z' + responses: + '200': + description: SOD Policy by ID content: application/json: schema: type: object properties: - detailCode: + id: type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: + description: Policy id + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + readOnly: true + name: 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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: + description: Policy Business Name + example: policy-xyz + created: type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: + format: date-time + description: The time when this SOD policy is created. + example: '2020-01-01T00:00:00.000000Z' + readOnly: true + modified: 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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: + format: date-time + description: The time when this SOD policy is modified. + example: '2020-01-01T00:00:00.000000Z' + readOnly: true + description: type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: + description: Optional description of the SOD policy + example: This policy ensures compliance of xyz + nullable: true + ownerRef: + 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 + - WORKGROUP + 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 + externalPolicyReference: 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: + description: Optional External Policy Reference + example: XYZ policy + nullable: true + policyQuery: + type: string + description: Search query of the SOD policy + example: '@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)' + compensatingControls: + type: string + description: Optional compensating controls(Mitigating Controls) + example: Have a manager review the transaction decisions for their "out of compliance" employee + nullable: true + correctionAdvice: + type: string + description: Optional correction advice + example: 'Based on the role of the employee, managers should remove access that is not required for their job function.' + nullable: true + state: + type: string + description: whether the policy is enforced or not + enum: + - ENFORCED + - NOT_ENFORCED + example: ENFORCED + tags: type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + description: tags for this policy object + example: + - TAG1 + - TAG2 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. - '/sources/{sourceId}/provisioning-policies': - get: - operationId: listProvisioningPolicies - tags: - - Sources - summary: Lists ProvisioningPolicies - description: |- - This end-point lists all the ProvisioningPolicies in IdentityNow. - A token with API, or ORG_ADMIN authority is required to call this API. - security: - - UserContextAuth: - - 'idn:provisioning-policy:read' - - 'idn:provisioning-policy:manage' - parameters: - - in: path - name: sourceId - required: true - schema: - type: string - description: The Source id - example: 2c9180835d191a86015d28455b4a2329 - responses: - '200': - description: List of ProvisioningPolicyDto objects - content: - application/json: - schema: - type: array - items: - type: object - required: - - name - properties: - name: - type: string - description: the provisioning policy name - example: example provisioning policy for inactive identities - description: - type: string - description: the description of the provisioning policy - example: this provisioning policy creates access based on an identity going inactive - usageType: type: string - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - example: CREATE - description: The type of ProvisioningPolicy usage. - fields: - type: array - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: userName - transform: - type: object - description: The transform to apply to the field - example: - type: rule - attributes: - name: Create Unique LDAP Attribute - default: {} - attributes: + creatorId: + type: string + description: Policy's creator ID + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + readOnly: true + modifierId: + type: string + description: Policy's modifier ID + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + nullable: true + readOnly: true + violationOwnerAssignmentConfig: + nullable: true + type: object + properties: + assignmentRule: + type: string + enum: + - MANAGER + - STATIC + - null + description: |- + Details about the violations owner. + MANAGER - identity's manager + STATIC - Governance Group or Identity + example: MANAGER + nullable: true + ownerRef: + 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 + - WORKGROUP + 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 + - nullable: true + scheduled: + type: boolean + description: defines whether a policy has been scheduled or not + example: true + default: false + type: + type: string + description: whether a policy is query based or conflicting access based + default: GENERAL + enum: + - GENERAL + - CONFLICTING_ACCESS_BASED + example: GENERAL + conflictingAccessCriteria: + allOf: + - type: object + properties: + leftCriteria: type: object - description: Attributes required for the transform - example: - template: '${firstname}.${lastname}${uniqueCounter}' - cloudMaxUniqueChecks: '50' - cloudMaxSize: '20' - cloudRequired: 'true' - isRequired: - type: boolean - readOnly: true - description: Flag indicating whether or not the attribute is required. - default: false - example: false - type: - type: string - description: The type of the attribute. - example: string - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - default: false - example: false + properties: + name: + type: string + description: Business name for the access construct list + example: money-in + criteriaList: + type: array + description: List of criteria. There is a min of 1 and max of 50 items in the list. + minItems: 1 + maxItems: 50 + items: + type: object + properties: + type: + type: string + enum: + - ENTITLEMENT + description: Type of the propery to which this reference applies to + example: ENTITLEMENT + id: + type: string + description: ID of the object to which this reference applies to + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the object to which this reference applies to + example: Administrator + example: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a66 + name: Administrator + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a67 + name: Administrator + rightCriteria: + type: object + properties: + name: + type: string + description: Business name for the access construct list + example: money-in + criteriaList: + type: array + description: List of criteria. There is a min of 1 and max of 50 items in the list. + minItems: 1 + maxItems: 50 + items: + type: object + properties: + type: + type: string + enum: + - ENTITLEMENT + description: Type of the propery to which this reference applies to + example: ENTITLEMENT + id: + type: string + description: ID of the object to which this reference applies to + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the object to which this reference applies to + example: Administrator + example: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a66 + name: Administrator + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a67 + name: Administrator + - nullable: true + examples: + Conflicting Access Based Policy: + value: + id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + name: Conflicting-Policy-Name + created: '2020-01-01T00:00:00.000000Z' + modified: '2020-01-01T00:00:00.000000Z' + description: Modified description + ownerRef: + type: IDENTITY + id: 2c91808568c529c60168cca6f90c1313 + name: Owner Name + externalPolicyReference: XYZ policy + policyQuery: '@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)' + compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee + correctionAdvice: 'Based on the role of the employee, managers should remove access that is not required for their job function.' + state: ENFORCED + tags: + - string + creatorId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + modifierId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + violationOwnerAssignmentConfig: + assignmentRule: MANAGER + ownerRef: + type: IDENTITY + id: 2c91808568c529c60168cca6f90c1313 + name: Violation Owner Name + scheduled: true + type: CONFLICTING_ACCESS_BASED + conflictingAccessCriteria: + leftCriteria: + name: money-in + criteriaList: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a66 + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a67 + rightCriteria: + name: money-out + criteriaList: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a68 + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a69 + General Policy: + value: + description: Modified Description + ownerRef: + type: IDENTITY + id: 2c918087682f9a86016839c05e8f1aff + name: Owner Name + externalPolicyReference: New policy + policyQuery: policy query implementation + compensatingControls: Compensating controls + correctionAdvice: Correction advice + tags: [] + state: ENFORCED + scheduled: false + creatorId: 2c918087682f9a86016839c05e8f1aff + modifierId: null + violationOwnerAssignmentConfig: null + type: GENERAL + conflictingAccessCriteria: null + id: 52c11db4-733e-4c31-949a-766c95ec95f1 + name: General-Policy-Name + created: '2020-05-12T19:47:38Z' + modified: '2020-05-12T19:47:38Z' '400': description: Client Error - Returned if the request body is invalid. content: @@ -94247,434 +84420,216 @@ paths: - 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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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: createProvisioningPolicy - tags: - - Sources - summary: Create Provisioning Policy - description: |- - This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. - Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. - Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. - A token with ORG_ADMIN authority is required to call this API. - security: - - UserContextAuth: - - 'idn:provisioning-policy:manage' - parameters: - - in: path - name: sourceId - required: true - schema: - type: string - description: The Source id - example: 2c9180835d191a86015d28455b4a2329 - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - name - properties: - name: - type: string - description: the provisioning policy name - example: example provisioning policy for inactive identities - description: - type: string - description: the description of the provisioning policy - example: this provisioning policy creates access based on an identity going inactive - usageType: - type: string - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - example: CREATE - description: The type of ProvisioningPolicy usage. - fields: - type: array - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: userName - transform: - type: object - description: The transform to apply to the field - example: - type: rule - attributes: - name: Create Unique LDAP Attribute - default: {} - attributes: - type: object - description: Attributes required for the transform - example: - template: '${firstname}.${lastname}${uniqueCounter}' - cloudMaxUniqueChecks: '50' - cloudMaxSize: '20' - cloudRequired: 'true' - isRequired: - type: boolean - readOnly: true - description: Flag indicating whether or not the attribute is required. - default: false - example: false - type: - type: string - description: The type of the attribute. - example: string - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - default: false - example: false - examples: - Create Account Provisioning Policy: - value: - name: Account - description: Account Provisioning Policy - usageType: CREATE - fields: - - name: displayName - transform: - type: identityAttribute - attributes: - name: displayName - attributes: {} - isRequired: false - type: string - isMultiValued: false - - name: distinguishedName - transform: - type: usernameGenerator - attributes: - sourceCheck: true - patterns: - - 'CN=$fi $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' - - 'CN=$fti $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' - - 'CN=$fn $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' - - 'CN=$fn$ln${uniqueCounter},OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' - fn: - type: identityAttribute - attributes: - name: firstname - ln: - type: identityAttribute - attributes: - name: lastname - fi: - type: substring - attributes: - input: - type: identityAttribute - attributes: - name: firstname - begin: 0 - end: 1 - fti: - type: substring - attributes: - input: - type: identityAttribute - attributes: - name: firstname - begin: 0 - end: 2 - attributes: - cloudMaxUniqueChecks: '5' - cloudMaxSize: '100' - cloudRequired: 'true' - isRequired: false - type: '' - isMultiValued: false - - name: description - transform: - type: static - attributes: - value: '' - attributes: {} - isRequired: false - type: string - isMultiValued: false - responses: - '201': - description: Created ProvisioningPolicyDto object + 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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist content: application/json: schema: type: object - required: - - name properties: - name: + detailCode: type: string - description: the provisioning policy name - example: example provisioning policy for inactive identities - description: + description: Fine-grained error code providing more detail of the error. + example: 400.1 Bad Request Content + trackingId: type: string - description: the description of the provisioning policy - example: this provisioning policy creates access based on an identity going inactive - usageType: + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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 - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - example: CREATE - description: The type of ProvisioningPolicy usage. - fields: + 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: - name: + locale: type: string - description: The name of the attribute. - example: userName - transform: - type: object - description: The transform to apply to the field - example: - type: rule - attributes: - name: Create Unique LDAP Attribute - default: {} - attributes: - type: object - description: Attributes required for the transform - example: - template: '${firstname}.${lastname}${uniqueCounter}' - cloudMaxUniqueChecks: '50' - cloudMaxSize: '20' - cloudRequired: 'true' - isRequired: - type: boolean - readOnly: true - description: Flag indicating whether or not the attribute is required. - default: false - example: false - type: + description: 'The locale for the message text, a BCP 47 language tag.' + example: en-US + localeOrigin: type: string - description: The type of the attribute. - example: string - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - default: false - example: false + 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. + delete: + security: + - UserContextAuth: + - 'idn:sod-policy:write' + operationId: deleteSodPolicy + tags: + - SOD Policy + summary: Delete SOD policy by ID + description: |- + This deletes a specified SOD policy. + Requires role of ORG_ADMIN. + parameters: + - in: path + name: id + schema: + type: string + required: true + description: The ID of the SOD Policy to delete. + example: ef38f943-47e9-4562-b5bb-8424a56397d8 + - in: query + name: logical + schema: + type: boolean + default: true + description: Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. + example: true + required: false + responses: + '204': + description: No content. '400': description: Client Error - Returned if the request body is invalid. content: @@ -94953,136 +84908,443 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/sources/{sourceId}/provisioning-policies/{usageType}': - get: - operationId: getProvisioningPolicy - tags: - - Sources - summary: Get Provisioning Policy by UsageType - description: |- - This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. - A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + patch: security: - UserContextAuth: - - 'idn:provisioning-policy:read' - - 'idn:provisioning-policy-source:read' - - 'idn:provisioning-policy:manage' - - 'idn:provisioning-policy-source-admin-operations:manage' + - 'idn:sod-policy:write' + operationId: patchSodPolicy + tags: + - SOD Policy + summary: Patch SOD policy by ID + description: |- + Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + Requires role of ORG_ADMIN. + This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. parameters: - in: path - name: sourceId - required: true + name: id schema: type: string - description: The Source ID. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: usageType required: true - schema: - type: string - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - example: CREATE - description: The type of ProvisioningPolicy usage. - description: The type of ProvisioningPolicy usage. - example: REGISTER + description: The ID of the SOD policy being modified. + example: 2c918083-5d19-1a86-015d-28455b4a2329 + requestBody: + required: true + description: | + A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + The following fields are patchable: + * name + * description + * ownerRef + * externalPolicyReference + * compensatingControls + * correctionAdvice + * state + * tags + * violationOwnerAssignmentConfig + * scheduled + * conflictingAccessCriteria + content: + application/json-patch+json: + schema: + type: array + items: + type: object + description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' + required: + - op + - path + properties: + op: + type: string + description: The operation to be performed + enum: + - add + - remove + - replace + - move + - copy + - test + example: replace + path: + type: string + description: A string JSON Pointer representing the target path to an element to be affected by the operation + example: /description + value: + anyOf: + - type: string + - type: integer + - type: object + - type: array + items: + anyOf: + - type: string + - type: integer + - type: object + description: 'The value to be used for the operation, required for "add" and "replace" operations' + example: New description + examples: + Conflicting Access Based Policy: + value: + - op: replace + path: /description + value: Modified description + - op: replace + path: /conflictingAccessCriteria/leftCriteria/name + value: money-in-modified + - op: replace + path: /conflictingAccessCriteria/rightCriteria + value: + name: money-out-modified + criteriaList: + - type: ENTITLEMENT + id: 2c918087682f9a86016839c0509c1ab2 + General Policy: + value: + - op: replace + path: /description + value: Modified description responses: '200': - description: The requested ProvisioningPolicyDto was successfully retrieved. + description: 'Indicates the PATCH operation succeeded, and returns the SOD policy''s new representation.' content: application/json: schema: type: object - required: - - name properties: + id: + type: string + description: Policy id + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + readOnly: true name: type: string - description: the provisioning policy name - example: example provisioning policy for inactive identities + description: Policy Business Name + example: policy-xyz + created: + type: string + format: date-time + description: The time when this SOD policy is created. + example: '2020-01-01T00:00:00.000000Z' + readOnly: true + modified: + type: string + format: date-time + description: The time when this SOD policy is modified. + example: '2020-01-01T00:00:00.000000Z' + readOnly: true description: type: string - description: the description of the provisioning policy - example: this provisioning policy creates access based on an identity going inactive - usageType: + description: Optional description of the SOD policy + example: This policy ensures compliance of xyz + nullable: true + ownerRef: + 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 + - WORKGROUP + 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 + externalPolicyReference: type: string - nullable: false + description: Optional External Policy Reference + example: XYZ policy + nullable: true + policyQuery: + type: string + description: Search query of the SOD policy + example: '@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)' + compensatingControls: + type: string + description: Optional compensating controls(Mitigating Controls) + example: Have a manager review the transaction decisions for their "out of compliance" employee + nullable: true + correctionAdvice: + type: string + description: Optional correction advice + example: 'Based on the role of the employee, managers should remove access that is not required for their job function.' + nullable: true + state: + type: string + description: whether the policy is enforced or not enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - example: CREATE - description: The type of ProvisioningPolicy usage. - fields: + - ENFORCED + - NOT_ENFORCED + example: ENFORCED + tags: type: array + description: tags for this policy object + example: + - TAG1 + - TAG2 items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: userName - transform: - type: object - description: The transform to apply to the field - example: - type: rule - attributes: - name: Create Unique LDAP Attribute - default: {} - attributes: - type: object - description: Attributes required for the transform - example: - template: '${firstname}.${lastname}${uniqueCounter}' - cloudMaxUniqueChecks: '50' - cloudMaxSize: '20' - cloudRequired: 'true' - isRequired: - type: boolean - readOnly: true - description: Flag indicating whether or not the attribute is required. - default: false - example: false - type: - type: string - description: The type of the attribute. - example: string - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - default: false - example: false + type: string + creatorId: + type: string + description: Policy's creator ID + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + readOnly: true + modifierId: + type: string + description: Policy's modifier ID + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + nullable: true + readOnly: true + violationOwnerAssignmentConfig: + nullable: true + type: object + properties: + assignmentRule: + type: string + enum: + - MANAGER + - STATIC + - null + description: |- + Details about the violations owner. + MANAGER - identity's manager + STATIC - Governance Group or Identity + example: MANAGER + nullable: true + ownerRef: + 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 + - WORKGROUP + 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 + - nullable: true + scheduled: + type: boolean + description: defines whether a policy has been scheduled or not + example: true + default: false + type: + type: string + description: whether a policy is query based or conflicting access based + default: GENERAL + enum: + - GENERAL + - CONFLICTING_ACCESS_BASED + example: GENERAL + conflictingAccessCriteria: + allOf: + - type: object + properties: + leftCriteria: + type: object + properties: + name: + type: string + description: Business name for the access construct list + example: money-in + criteriaList: + type: array + description: List of criteria. There is a min of 1 and max of 50 items in the list. + minItems: 1 + maxItems: 50 + items: + type: object + properties: + type: + type: string + enum: + - ENTITLEMENT + description: Type of the propery to which this reference applies to + example: ENTITLEMENT + id: + type: string + description: ID of the object to which this reference applies to + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the object to which this reference applies to + example: Administrator + example: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a66 + name: Administrator + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a67 + name: Administrator + rightCriteria: + type: object + properties: + name: + type: string + description: Business name for the access construct list + example: money-in + criteriaList: + type: array + description: List of criteria. There is a min of 1 and max of 50 items in the list. + minItems: 1 + maxItems: 50 + items: + type: object + properties: + type: + type: string + enum: + - ENTITLEMENT + description: Type of the propery to which this reference applies to + example: ENTITLEMENT + id: + type: string + description: ID of the object to which this reference applies to + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the object to which this reference applies to + example: Administrator + example: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a66 + name: Administrator + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a67 + name: Administrator + - nullable: true + examples: + Conflicting Access Based Policy: + value: + id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + name: Conflicting-Policy-Name + created: '2020-01-01T00:00:00.000000Z' + modified: '2020-01-01T00:00:00.000000Z' + description: Modified description + ownerRef: + type: IDENTITY + id: 2c91808568c529c60168cca6f90c1313 + name: Owner Name + externalPolicyReference: XYZ policy + policyQuery: '@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c918087682f9a86016839c0509c1ab2)' + compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee + correctionAdvice: 'Based on the role of the employee, managers should remove access that is not required for their job function.' + state: ENFORCED + tags: + - string + creatorId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + modifierId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + violationOwnerAssignmentConfig: + assignmentRule: MANAGER + ownerRef: + type: IDENTITY + id: 2c91808568c529c60168cca6f90c1313 + name: Violation Owner Name + scheduled: true + type: CONFLICTING_ACCESS_BASED + conflictingAccessCriteria: + leftCriteria: + name: money-in-modified + criteriaList: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a66 + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a67 + rightCriteria: + name: money-out-modified + criteriaList: + - type: ENTITLEMENT + id: 2c918087682f9a86016839c0509c1ab2 + General Policy: + value: + description: Modified description + ownerRef: + type: IDENTITY + id: 2c918087682f9a86016839c05e8f1aff + name: Owner Name + externalPolicyReference: New policy + policyQuery: policy query implementation + compensatingControls: Compensating controls + correctionAdvice: Correction advice + tags: [] + state: ENFORCED + scheduled: false + creatorId: 2c918087682f9a86016839c05e8f1aff + modifierId: null + violationOwnerAssignmentConfig: null + type: GENERAL + conflictingAccessCriteria: null + id: 52c11db4-733e-4c31-949a-766c95ec95f1 + name: General-Policy-Name + created: '2020-05-12T19:47:38Z' + modified: '2020-05-12T19:47:38Z' '400': description: Client Error - Returned if the request body is invalid. content: @@ -95361,213 +85623,92 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - put: - operationId: putProvisioningPolicy - tags: - - Sources - summary: Update Provisioning Policy by UsageType - description: |- - This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. - Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. - Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. - A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + '/sod-policies/{id}/evaluate': + post: security: - UserContextAuth: - - 'idn:provisioning-policy:manage' - - 'idn:provisioning-policy-source-admin-operations:manage' + - 'idn:sod-violation:write' + operationId: startEvaluateSodPolicy + tags: + - SOD Policy + summary: Evaluate one policy by ID + description: Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. parameters: - in: path - name: sourceId - required: true + name: id schema: type: string - description: The Source ID. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: usageType required: true - schema: - type: string - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - example: CREATE - description: The type of ProvisioningPolicy usage. - description: The type of ProvisioningPolicy usage. - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - name - properties: - name: - type: string - description: the provisioning policy name - example: example provisioning policy for inactive identities - description: - type: string - description: the description of the provisioning policy - example: this provisioning policy creates access based on an identity going inactive - usageType: - type: string - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - example: CREATE - description: The type of ProvisioningPolicy usage. - fields: - type: array - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: userName - transform: - type: object - description: The transform to apply to the field - example: - type: rule - attributes: - name: Create Unique LDAP Attribute - default: {} - attributes: - type: object - description: Attributes required for the transform - example: - template: '${firstname}.${lastname}${uniqueCounter}' - cloudMaxUniqueChecks: '50' - cloudMaxSize: '20' - cloudRequired: 'true' - isRequired: - type: boolean - readOnly: true - description: Flag indicating whether or not the attribute is required. - default: false - example: false - type: - type: string - description: The type of the attribute. - example: string - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - default: false - example: false + description: The SOD policy ID to run. + example: ef38f943-47e9-4562-b5bb-8424a56397d8 responses: '200': - description: The ProvisioningPolicyDto was successfully replaced. + description: Reference to the violation report run task. content: application/json: schema: - type: object - required: - - name - properties: - name: - type: string - description: the provisioning policy name - example: example provisioning policy for inactive identities - description: - type: string - description: the description of the provisioning policy - example: this provisioning policy creates access based on an identity going inactive - usageType: - type: string - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - example: CREATE - description: The type of ProvisioningPolicy usage. - fields: - type: array - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: userName - transform: - type: object - description: The transform to apply to the field - example: - type: rule - attributes: - name: Create Unique LDAP Attribute - default: {} - attributes: - type: object - description: Attributes required for the transform - example: - template: '${firstname}.${lastname}${uniqueCounter}' - cloudMaxUniqueChecks: '50' - cloudMaxSize: '20' - cloudRequired: 'true' - isRequired: - type: boolean - readOnly: true - description: Flag indicating whether or not the attribute is required. - default: false - example: false - type: - type: string - description: The type of the attribute. - example: string - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - default: false - example: false + 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 + - WORKGROUP + 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 + properties: + status: + type: string + description: Status of a violation report + enum: + - SUCCESS + - WARNING + - ERROR + - TERMINATED + - TEMP_ERROR + - PENDING + example: PENDING + example: + status: PENDING + type: REPORT_RESULT + id: 37b3b32a-f394-46f8-acad-b5223969fa68 + name: Multi Query Report '400': description: Client Error - Returned if the request body is invalid. content: @@ -95702,8 +85843,18 @@ paths: - locale: en-US localeOrigin: DEFAULT text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist + '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: @@ -95760,27 +85911,248 @@ paths: description: Actual text of the error message in the indicated locale. example: The request was syntactically correct but its content is semantically invalid. examples: - '404': - summary: An example of a 404 response object + '500': + summary: An example of a 500 response object value: - detailCode: 404 Not found + detailCode: 500.0 Internal Fault trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. + text: An internal fault occurred. + '/sod-policies/{id}/schedule': + get: + security: + - UserContextAuth: + - 'idn:sod-policy:read' + operationId: getSodPolicySchedule + tags: + - SOD Policy + summary: Get SOD policy schedule + description: This endpoint gets a specified SOD policy's schedule. + parameters: + - in: path + name: id + schema: + type: string + required: true + description: The ID of the SOD policy schedule to retrieve. + example: ef38f943-47e9-4562-b5bb-8424a56397d8 + responses: + '200': + description: SOD policy schedule. 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. + name: + type: string + description: SOD Policy schedule name + example: SCH-1584312283015 + created: + type: string + format: date-time + description: The time when this SOD policy schedule is created. + example: '2020-01-01T00:00:00.000000Z' + readOnly: true + modified: + type: string + format: date-time + description: The time when this SOD policy schedule is modified. + example: '2020-01-01T00:00:00.000000Z' + readOnly: true + description: + type: string + description: SOD Policy schedule description + example: Schedule for policy xyz + schedule: + type: object + description: The schedule information. + properties: + type: + description: | + Enum representing the currently supported schedule types. + + Additional values may be added in the future without notice. + type: string + enum: + - DAILY + - WEEKLY + - MONTHLY + - CALENDAR + example: WEEKLY + days: + allOf: + - type: object + properties: + type: + description: | + Enum representing the currently supported selector types. + + LIST - the *values* array contains one or more distinct values. + + RANGE - the *values* array contains two values: the start and end of the range, inclusive. + + Additional values may be added in the future without notice. + type: string + enum: + - LIST + - RANGE + example: LIST + values: + description: | + The selected values. + type: array + items: + type: string + example: + - MON + - WED + interval: + nullable: true + description: | + The selected interval for RANGE selectors. + type: integer + format: int32 + example: 3 + required: + - type + - values + - description: | + The days to execute the search. + + If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. + + If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. + example: + type: LIST + values: + - MON + - WED + - FRI + nullable: true + hours: + allOf: + - type: object + properties: + type: + description: | + Enum representing the currently supported selector types. + + LIST - the *values* array contains one or more distinct values. + + RANGE - the *values* array contains two values: the start and end of the range, inclusive. + + Additional values may be added in the future without notice. + type: string + enum: + - LIST + - RANGE + example: LIST + values: + description: | + The selected values. + type: array + items: + type: string + example: + - MON + - WED + interval: + nullable: true + description: | + The selected interval for RANGE selectors. + type: integer + format: int32 + example: 3 + required: + - type + - values + - description: The hours selected. + example: + type: RANGE + values: + - '9' + - '18' + interval: 3 + expiration: + description: 'The schedule expiration date. Latest possible expiration date is ''2038-01-19T03:14:07+0000''' + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + timeZoneId: + description: 'The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org''s default timezone is used.' + nullable: true + type: string + example: 'GMT-06:00' + required: + - type + - hours + recipients: + type: array + items: + 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 + - WORKGROUP + 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 + emailEmptyResults: + type: boolean + description: Indicates if empty results need to be emailed + example: false + default: false + creatorId: + type: string + description: Policy's creator ID + example: 0f11f2a47c944bf3a2bd742580fe3bde + readOnly: true + modifierId: + type: string + description: Policy's modifier ID + example: 0f11f2a47c944bf3a2bd742580fe3bde + readOnly: true + '400': + description: Client Error - Returned if the request body is invalid. content: application/json: schema: @@ -95836,203 +86208,95 @@ paths: 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. - patch: - operationId: updateProvisioningPolicy - tags: - - Sources - summary: Partial update of Provisioning Policy - description: |- - This API selectively updates an existing Provisioning Policy using a JSONPatch payload. - Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. - Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. - A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - security: - - UserContextAuth: - - 'idn:provisioning-policy:update' - parameters: - - in: path - name: sourceId - required: true - schema: - type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: usageType - required: true - schema: - type: string - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - example: CREATE - description: The type of ProvisioningPolicy usage. - description: The type of ProvisioningPolicy usage. - requestBody: - required: true - description: The JSONPatch payload used to update the schema. - content: - application/json-patch+json: - schema: - type: array - items: + '401': + description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' + content: + application/json: + schema: type: object - description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' - required: - - op - - path properties: - op: - type: string - description: The operation to be performed - enum: - - add - - remove - - replace - - move - - copy - - test - example: replace - path: - type: string - description: A string JSON Pointer representing the target path to an element to be affected by the operation - example: /description - value: - anyOf: - - type: string - - type: integer - - type: object - - type: array - items: - anyOf: - - type: string - - type: integer - - type: object - description: 'The value to be used for the operation, required for "add" and "replace" operations' - example: New description - examples: - add-field: - summary: Add a field to the beginning of the list - value: - - op: add - path: /fields/0 - value: - name: email - transform: - type: identityAttribute - attributes: - name: email - attributes: {} - isRequired: false - type: string - isMultiValued: false - responses: - '200': - description: The ProvisioningPolicyDto was successfully updated. + 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 - required: - - name properties: - name: - type: string - description: the provisioning policy name - example: example provisioning policy for inactive identities - description: + detailCode: type: string - description: the description of the provisioning policy - example: this provisioning policy creates access based on an identity going inactive - usageType: + description: Fine-grained error code providing more detail of the error. + example: 400.1 Bad Request Content + trackingId: type: string - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - example: CREATE - description: The type of ProvisioningPolicy usage. - fields: + description: Unique tracking id for the error. + example: e7eab60924f64aa284175b9fa3309599 + messages: type: array + description: Generic localized reason for error items: type: object properties: - name: + locale: type: string - description: The name of the attribute. - example: userName - transform: - type: object - description: The transform to apply to the field - example: - type: rule - attributes: - name: Create Unique LDAP Attribute - default: {} - attributes: - type: object - description: Attributes required for the transform - example: - template: '${firstname}.${lastname}${uniqueCounter}' - cloudMaxUniqueChecks: '50' - cloudMaxSize: '20' - cloudRequired: 'true' - isRequired: - type: boolean - readOnly: true - description: Flag indicating whether or not the attribute is required. - default: false - example: false - type: + description: 'The locale for the message text, a BCP 47 language tag.' + example: en-US + localeOrigin: type: string - description: The type of the attribute. - example: string - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - default: false - example: false - '400': - description: Client Error - Returned if the request body is invalid. + 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: @@ -96088,18 +86352,460 @@ paths: 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.' + 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. + put: + security: + - UserContextAuth: + - 'idn:sod-policy:write' + operationId: setPolicySchedule + tags: + - SOD Policy + summary: Update SOD Policy schedule + description: This updates schedule for a specified SOD policy. + parameters: + - in: path + name: id + schema: + type: string + required: true + description: The ID of the SOD policy to update its schedule. + example: ef38f943-47e9-4562-b5bb-8424a56397d8 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: SOD Policy schedule name + example: SCH-1584312283015 + created: + type: string + format: date-time + description: The time when this SOD policy schedule is created. + example: '2020-01-01T00:00:00.000000Z' + readOnly: true + modified: + type: string + format: date-time + description: The time when this SOD policy schedule is modified. + example: '2020-01-01T00:00:00.000000Z' + readOnly: true + description: + type: string + description: SOD Policy schedule description + example: Schedule for policy xyz + schedule: + type: object + description: The schedule information. + properties: + type: + description: | + Enum representing the currently supported schedule types. + + Additional values may be added in the future without notice. + type: string + enum: + - DAILY + - WEEKLY + - MONTHLY + - CALENDAR + example: WEEKLY + days: + allOf: + - type: object + properties: + type: + description: | + Enum representing the currently supported selector types. + + LIST - the *values* array contains one or more distinct values. + + RANGE - the *values* array contains two values: the start and end of the range, inclusive. + + Additional values may be added in the future without notice. + type: string + enum: + - LIST + - RANGE + example: LIST + values: + description: | + The selected values. + type: array + items: + type: string + example: + - MON + - WED + interval: + nullable: true + description: | + The selected interval for RANGE selectors. + type: integer + format: int32 + example: 3 + required: + - type + - values + - description: | + The days to execute the search. + + If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. + + If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. + example: + type: LIST + values: + - MON + - WED + - FRI + nullable: true + hours: + allOf: + - type: object + properties: + type: + description: | + Enum representing the currently supported selector types. + + LIST - the *values* array contains one or more distinct values. + + RANGE - the *values* array contains two values: the start and end of the range, inclusive. + + Additional values may be added in the future without notice. + type: string + enum: + - LIST + - RANGE + example: LIST + values: + description: | + The selected values. + type: array + items: + type: string + example: + - MON + - WED + interval: + nullable: true + description: | + The selected interval for RANGE selectors. + type: integer + format: int32 + example: 3 + required: + - type + - values + - description: The hours selected. + example: + type: RANGE + values: + - '9' + - '18' + interval: 3 + expiration: + description: 'The schedule expiration date. Latest possible expiration date is ''2038-01-19T03:14:07+0000''' + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + timeZoneId: + description: 'The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org''s default timezone is used.' + nullable: true + type: string + example: 'GMT-06:00' + required: + - type + - hours + recipients: + type: array + items: + 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 + - WORKGROUP + 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 + emailEmptyResults: + type: boolean + description: Indicates if empty results need to be emailed + example: false + default: false + creatorId: + type: string + description: Policy's creator ID + example: 0f11f2a47c944bf3a2bd742580fe3bde + readOnly: true + modifierId: + type: string + description: Policy's modifier ID + example: 0f11f2a47c944bf3a2bd742580fe3bde + readOnly: true + responses: + '200': + description: Created or updated SOD policy schedule. 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.' + name: + type: string + description: SOD Policy schedule name + example: SCH-1584312283015 + created: + type: string + format: date-time + description: The time when this SOD policy schedule is created. + example: '2020-01-01T00:00:00.000000Z' + readOnly: true + modified: + type: string + format: date-time + description: The time when this SOD policy schedule is modified. + example: '2020-01-01T00:00:00.000000Z' + readOnly: true + description: + type: string + description: SOD Policy schedule description + example: Schedule for policy xyz + schedule: + type: object + description: The schedule information. + properties: + type: + description: | + Enum representing the currently supported schedule types. + + Additional values may be added in the future without notice. + type: string + enum: + - DAILY + - WEEKLY + - MONTHLY + - CALENDAR + example: WEEKLY + days: + allOf: + - type: object + properties: + type: + description: | + Enum representing the currently supported selector types. + + LIST - the *values* array contains one or more distinct values. + + RANGE - the *values* array contains two values: the start and end of the range, inclusive. + + Additional values may be added in the future without notice. + type: string + enum: + - LIST + - RANGE + example: LIST + values: + description: | + The selected values. + type: array + items: + type: string + example: + - MON + - WED + interval: + nullable: true + description: | + The selected interval for RANGE selectors. + type: integer + format: int32 + example: 3 + required: + - type + - values + - description: | + The days to execute the search. + + If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. + + If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. + example: + type: LIST + values: + - MON + - WED + - FRI + nullable: true + hours: + allOf: + - type: object + properties: + type: + description: | + Enum representing the currently supported selector types. + + LIST - the *values* array contains one or more distinct values. + + RANGE - the *values* array contains two values: the start and end of the range, inclusive. + + Additional values may be added in the future without notice. + type: string + enum: + - LIST + - RANGE + example: LIST + values: + description: | + The selected values. + type: array + items: + type: string + example: + - MON + - WED + interval: + nullable: true + description: | + The selected interval for RANGE selectors. + type: integer + format: int32 + example: 3 + required: + - type + - values + - description: The hours selected. + example: + type: RANGE + values: + - '9' + - '18' + interval: 3 + expiration: + description: 'The schedule expiration date. Latest possible expiration date is ''2038-01-19T03:14:07+0000''' + type: string + nullable: true + format: date-time + example: '2018-06-25T20:22:28.104Z' + timeZoneId: + description: 'The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org''s default timezone is used.' + nullable: true + type: string + example: 'GMT-06:00' + required: + - type + - hours + recipients: + type: array + items: + 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 + - WORKGROUP + 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 + emailEmptyResults: + type: boolean + description: Indicates if empty results need to be emailed + example: false + default: false + creatorId: + type: string + description: Policy's creator ID + example: 0f11f2a47c944bf3a2bd742580fe3bde + readOnly: true + modifierId: + type: string + description: Policy's modifier ID + example: 0f11f2a47c944bf3a2bd742580fe3bde + readOnly: true + '400': + description: Client Error - Returned if the request body is invalid. content: application/json: schema: @@ -96155,18 +86861,18 @@ paths: 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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist + '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: @@ -96223,15 +86929,15 @@ paths: description: Actual text of the error message in the indicated locale. example: The request was syntactically correct but its content is semantically invalid. examples: - '404': - summary: An example of a 404 response object + '403': + summary: An example of a 403 response object value: - detailCode: 404 Not found + detailCode: 403 Forbidden trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. + 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: @@ -96310,53 +87016,25 @@ paths: localeOrigin: DEFAULT text: An internal fault occurred. delete: - operationId: deleteProvisioningPolicy - tags: - - Sources - summary: Delete Provisioning Policy by UsageType - description: |- - Deletes the provisioning policy with the specified usage on an application. - A token with API, or ORG_ADMIN authority is required to call this API. security: - UserContextAuth: - - 'idn:provisioning-policy:manage' + - 'idn:sod-policy:write' + operationId: deleteSodPolicySchedule + tags: + - SOD Policy + summary: Delete SOD policy schedule + description: This deletes schedule for a specified SOD policy by ID. parameters: - in: path - name: sourceId - required: true + name: id schema: type: string - description: The Source ID. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: usageType required: true - schema: - type: string - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - example: CREATE - description: The type of ProvisioningPolicy usage. - description: The type of ProvisioningPolicy usage. + description: The ID of the SOD policy the schedule must be deleted for. + example: ef38f943-47e9-4562-b5bb-8424a56397d8 responses: '204': - description: The ProvisioningPolicyDto was successfully deleted. + description: No content response. '400': description: Client Error - Returned if the request body is invalid. content: @@ -96635,189 +87313,92 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/sources/{sourceId}/provisioning-policies/bulk-update': + '/sod-policies/{id}/violation-report/run': post: - operationId: updateProvisioningPoliciesInBulk - tags: - - Sources - summary: Bulk Update Provisioning Policies - description: |- - This end-point updates a list of provisioning policies on the specified source in IdentityNow. - A token with API, or ORG_ADMIN authority is required to call this API. security: - UserContextAuth: - - 'idn:provisioning-policy:manage' + - 'idn:sod-violation:write' + operationId: startSodPolicy + tags: + - SOD Policy + summary: Runs SOD policy violation report + description: 'This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message.' parameters: - in: path - name: sourceId - required: true + name: id schema: type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - requestBody: - required: true - content: - application/json: - schema: - type: array - items: - type: object - required: - - name - properties: - name: - type: string - description: the provisioning policy name - example: example provisioning policy for inactive identities - description: - type: string - description: the description of the provisioning policy - example: this provisioning policy creates access based on an identity going inactive - usageType: - type: string - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - example: CREATE - description: The type of ProvisioningPolicy usage. - fields: - type: array - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: userName - transform: - type: object - description: The transform to apply to the field - example: - type: rule - attributes: - name: Create Unique LDAP Attribute - default: {} - attributes: - type: object - description: Attributes required for the transform - example: - template: '${firstname}.${lastname}${uniqueCounter}' - cloudMaxUniqueChecks: '50' - cloudMaxSize: '20' - cloudRequired: 'true' - isRequired: - type: boolean - readOnly: true - description: Flag indicating whether or not the attribute is required. - default: false - example: false - type: - type: string - description: The type of the attribute. - example: string - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - default: false - example: false + required: true + description: The SOD policy ID to run. + example: ef38f943-47e9-4562-b5bb-8424a56397d8 responses: '200': - description: A list of the ProvisioningPolicyDto was successfully replaced. + description: Reference to the violation report run task. content: application/json: schema: - type: array - items: - type: object - required: - - name - properties: - name: - type: string - description: the provisioning policy name - example: example provisioning policy for inactive identities - description: - type: string - description: the description of the provisioning policy - example: this provisioning policy creates access based on an identity going inactive - usageType: - type: string - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - example: CREATE - description: The type of ProvisioningPolicy usage. - fields: - type: array - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: userName - transform: - type: object - description: The transform to apply to the field - example: - type: rule - attributes: - name: Create Unique LDAP Attribute - default: {} - attributes: - type: object - description: Attributes required for the transform - example: - template: '${firstname}.${lastname}${uniqueCounter}' - cloudMaxUniqueChecks: '50' - cloudMaxSize: '20' - cloudRequired: 'true' - isRequired: - type: boolean - readOnly: true - description: Flag indicating whether or not the attribute is required. - default: false - example: false - type: - type: string - description: The type of the attribute. - example: string - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - default: false - example: false + 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 + - WORKGROUP + 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 + properties: + status: + type: string + description: Status of a violation report + enum: + - SUCCESS + - WARNING + - ERROR + - TERMINATED + - TEMP_ERROR + - PENDING + example: PENDING + example: + status: PENDING + type: REPORT_RESULT + id: 2e8d8180-24bc-4d21-91c6-7affdb473b0d + name: policy-xyz '400': description: Client Error - Returned if the request body is invalid. content: @@ -97096,218 +87677,92 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/sources/{sourceId}/schemas': + '/sod-policies/{id}/violation-report': get: - operationId: listSourceSchemas + security: + - UserContextAuth: + - 'idn:sod-violation:read' + operationId: getSodViolationReportStatus tags: - - Sources - summary: List Schemas on a Source - description: | - Lists the Schemas that exist on the specified Source in IdentityNow. + - SOD Policy + summary: Get SOD violation report status + description: This gets the status for a violation report run task that has already been invoked. parameters: - in: path - name: sourceId - required: true - schema: - type: string - description: The Source ID. - example: 2c9180835d191a86015d28455b4a2329 - - in: query - name: include-types - required: false + name: id schema: type: string - description: 'If set to ''group'', then the account schema is filtered and only group schemas are returned. Only a value of ''group'' is recognized.' - example: group + required: true + description: The ID of the violation report to retrieve status for. + example: ef38f943-47e9-4562-b5bb-8424a56397d8 responses: '200': - description: The Schemas were successfully retrieved. + description: Status of the violation report run task. content: application/json: schema: - type: array - items: - type: object - properties: - id: - type: string - description: The id of the Schema. - example: 2c9180835d191a86015d28455b4a2329 - name: - type: string - description: The name of the Schema. - example: account - nativeObjectType: - type: string - description: The name of the object type on the native system that the schema represents. - example: User - identityAttribute: - type: string - description: The name of the attribute used to calculate the unique identifier for an object in the schema. - example: sAMAccountName - displayAttribute: - type: string - description: The name of the attribute used to calculate the display value for an object in the schema. - example: distinguishedName - hierarchyAttribute: - type: string - description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. - example: memberOf - includePermissions: - type: boolean - description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. - example: false - features: - type: array - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - example: AUTHENTICATE - description: The features that the schema supports. - example: - - PROVISIONING - - NO_PERMISSIONS_PROVISIONING - - GROUPS_HAVE_MEMBERS - configuration: - type: object - description: Holds any extra configuration data that the schema may require. - example: - groupMemberAttribute: member - attributes: - type: array - description: The attribute definitions which form the schema. - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: sAMAccountName - type: - description: The type of the attribute. - example: STRING - type: string - enum: - - STRING - - LONG - - INT - - BOOLEAN - schema: - description: A reference to the schema on the source to the attribute values map to. - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - CONNECTOR_SCHEMA - example: CONNECTOR_SCHEMA - id: - type: string - description: The object ID this reference applies to. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: The human-readable display name of the object. - example: group - description: - type: string - description: A human-readable description of the attribute. - example: SAM Account Name - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - example: false - isEntitlement: - type: boolean - description: Flag indicating whether or not the attribute is an entitlement. - example: false - isGroup: - type: boolean - description: | - Flag indicating whether or not the attribute represents a group. - This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. - example: false - example: - - name: sAMAccountName - type: STRING - isMultiValued: false - isEntitlement: false - isGroup: false - - name: memberOf - type: STRING - schema: - type: CONNECTOR_SCHEMA - id: 2c9180887671ff8c01767b4671fc7d60 - name: group - description: Group membership - isMultiValued: true - isEntitlement: true - isGroup: true - created: - type: string - description: The date the Schema was created. - format: date-time - example: '2019-12-24T22:32:58.104Z' - modified: - type: string - description: The date the Schema was last modified. - format: date-time - example: '2019-12-31T20:22:28.104Z' + 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 + - WORKGROUP + 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 + properties: + status: + type: string + description: Status of a violation report + enum: + - SUCCESS + - WARNING + - ERROR + - TERMINATED + - TEMP_ERROR + - PENDING + example: PENDING + example: + status: SUCCESS + type: REPORT_RESULT + id: 2e8d8180-24bc-4d21-91c6-7affdb473b0d + name: policy-xyz '400': description: Client Error - Returned if the request body is invalid. content: @@ -97586,394 +88041,92 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - post: - operationId: createSourceSchema + '/sod-policies/sod-violation-report-status/{reportResultId}': + get: + security: + - UserContextAuth: + - 'idn:sod-violation:read' + operationId: getSodViolationReportRunStatus tags: - - Sources - summary: Create Schema on a Source - description: | - Creates a new Schema on the specified Source in IdentityNow. + - SOD Policy + summary: Get violation report run status + description: This gets the status for a violation report run task that has already been invoked. parameters: - in: path - name: sourceId - required: true + name: reportResultId schema: type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The id of the Schema. - example: 2c9180835d191a86015d28455b4a2329 - name: - type: string - description: The name of the Schema. - example: account - nativeObjectType: - type: string - description: The name of the object type on the native system that the schema represents. - example: User - identityAttribute: - type: string - description: The name of the attribute used to calculate the unique identifier for an object in the schema. - example: sAMAccountName - displayAttribute: - type: string - description: The name of the attribute used to calculate the display value for an object in the schema. - example: distinguishedName - hierarchyAttribute: - type: string - description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. - example: memberOf - includePermissions: - type: boolean - description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. - example: false - features: - type: array - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - example: AUTHENTICATE - description: The features that the schema supports. - example: - - PROVISIONING - - NO_PERMISSIONS_PROVISIONING - - GROUPS_HAVE_MEMBERS - configuration: - type: object - description: Holds any extra configuration data that the schema may require. - example: - groupMemberAttribute: member - attributes: - type: array - description: The attribute definitions which form the schema. - items: - type: object + required: true + description: The ID of the report reference to retrieve. + example: 2e8d8180-24bc-4d21-91c6-7affdb473b0d + responses: + '200': + description: Status of the violation report run task. + content: + application/json: + schema: + allOf: + - type: object properties: - name: - type: string - description: The name of the attribute. - example: sAMAccountName type: - description: The type of the attribute. - example: STRING + description: DTO type type: string enum: - - STRING - - LONG - - INT - - BOOLEAN - schema: - description: A reference to the schema on the source to the attribute values map to. - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - CONNECTOR_SCHEMA - example: CONNECTOR_SCHEMA - id: - type: string - description: The object ID this reference applies to. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: The human-readable display name of the object. - example: group - description: + - 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 + - WORKGROUP + example: IDENTITY + id: type: string - description: A human-readable description of the attribute. - example: SAM Account Name - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - example: false - isEntitlement: - type: boolean - description: Flag indicating whether or not the attribute is an entitlement. - example: false - isGroup: - type: boolean - description: | - Flag indicating whether or not the attribute represents a group. - This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. - example: false - example: - - name: sAMAccountName - type: STRING - isMultiValued: false - isEntitlement: false - isGroup: false - - name: memberOf - type: STRING - schema: - type: CONNECTOR_SCHEMA - id: 2c9180887671ff8c01767b4671fc7d60 - name: group - description: Group membership - isMultiValued: true - isEntitlement: true - isGroup: true - created: - type: string - description: The date the Schema was created. - format: date-time - example: '2019-12-24T22:32:58.104Z' - modified: - type: string - description: The date the Schema was last modified. - format: date-time - example: '2019-12-31T20:22:28.104Z' - responses: - '201': - description: The Schema was successfully created on the specified Source. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The id of the Schema. - example: 2c9180835d191a86015d28455b4a2329 - name: - type: string - description: The name of the Schema. - example: account - nativeObjectType: - type: string - description: The name of the object type on the native system that the schema represents. - example: User - identityAttribute: - type: string - description: The name of the attribute used to calculate the unique identifier for an object in the schema. - example: sAMAccountName - displayAttribute: - type: string - description: The name of the attribute used to calculate the display value for an object in the schema. - example: distinguishedName - hierarchyAttribute: - type: string - description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. - example: memberOf - includePermissions: - type: boolean - description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. - example: false - features: - type: array - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - example: AUTHENTICATE - description: The features that the schema supports. - example: - - PROVISIONING - - NO_PERMISSIONS_PROVISIONING - - GROUPS_HAVE_MEMBERS - configuration: - type: object - description: Holds any extra configuration data that the schema may require. - example: - groupMemberAttribute: member - attributes: - type: array - description: The attribute definitions which form the schema. - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: sAMAccountName - type: - description: The type of the attribute. - example: STRING - type: string - enum: - - STRING - - LONG - - INT - - BOOLEAN - schema: - description: A reference to the schema on the source to the attribute values map to. - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - CONNECTOR_SCHEMA - example: CONNECTOR_SCHEMA - id: - type: string - description: The object ID this reference applies to. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: The human-readable display name of the object. - example: group - description: - type: string - description: A human-readable description of the attribute. - example: SAM Account Name - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - example: false - isEntitlement: - type: boolean - description: Flag indicating whether or not the attribute is an entitlement. - example: false - isGroup: - type: boolean - description: | - Flag indicating whether or not the attribute represents a group. - This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. - example: false - example: - - name: sAMAccountName - type: STRING - isMultiValued: false - isEntitlement: false - isGroup: false - - name: memberOf - type: STRING - schema: - type: CONNECTOR_SCHEMA - id: 2c9180887671ff8c01767b4671fc7d60 - name: group - description: Group membership - isMultiValued: true - isEntitlement: true - isGroup: true - created: - type: string - description: The date the Schema was created. - format: date-time - example: '2019-12-24T22:32:58.104Z' - modified: - type: string - description: The date the Schema was last modified. - format: date-time - example: '2019-12-31T20:22:28.104Z' + 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 + properties: + status: + type: string + description: Status of a violation report + enum: + - SUCCESS + - WARNING + - ERROR + - TERMINATED + - TEMP_ERROR + - PENDING + example: PENDING + example: + status: SUCCESS + type: REPORT_RESULT + id: 2e8d8180-24bc-4d21-91c6-7affdb473b0d + name: policy-xyz '400': description: Client Error - Returned if the request body is invalid. content: @@ -98108,6 +88261,73 @@ paths: - locale: en-US localeOrigin: DEFAULT text: The server understood the request but refuses to authorize it. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. '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: @@ -98185,216 +88405,329 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/sources/{sourceId}/schemas/{schemaId}': - get: - operationId: getSourceSchema + /sod-violations/predict: + post: + security: + - UserContextAuth: + - 'idn:sod-violation:read' + operationId: startPredictSodViolations tags: - - Sources - summary: Get Source Schema by ID - description: | - Get the Source Schema by ID in IdentityNow. - parameters: - - in: path - name: sourceId - required: true - schema: - type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: schemaId - schema: - type: string - required: true - description: The Schema id. - example: 2c9180835d191a86015d28455b4a2329 + - SOD Violations + summary: Predict SOD violations for identity. + description: |- + This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. + + A token with ORG_ADMIN or API authority is required to call this API. + requestBody: + required: true + content: + application/json: + schema: + description: An identity with a set of access to be added + required: + - identityId + - accessRefs + type: object + properties: + identityId: + description: Identity id to be checked. + type: string + example: 2c91808568c529c60168cca6f90c1313 + accessRefs: + description: The list of ENTITLEMENTs to consider for calculating possible violations in a preventive check. + type: array + items: + 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 + - WORKGROUP + 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 + description: The types of objects supported for SOD violations + properties: + type: + enum: + - ENTITLEMENT + example: ENTITLEMENT + description: The type of object that is referenced + example: + - type: ENTITLEMENT + id: 2c918087682f9a86016839c050861ab1 + name: 'CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local' + - type: ENTITLEMENT + id: 2c918087682f9a86016839c0509c1ab2 + name: 'CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local' + example: + identityId: 2c91808568c529c60168cca6f90c1313 + accessRefs: + - type: ENTITLEMENT + id: 2c918087682f9a86016839c050861ab1 + name: 'CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local' + - type: ENTITLEMENT + id: 2c918087682f9a86016839c0509c1ab2 + name: 'CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local' responses: '200': - description: The requested Schema was successfully retrieved. + description: Violation Contexts content: application/json: schema: + description: An object containing a listing of the SOD violation reasons detected by this check. + required: + - requestId type: object properties: - id: - type: string - description: The id of the Schema. - example: 2c9180835d191a86015d28455b4a2329 - name: - type: string - description: The name of the Schema. - example: account - nativeObjectType: - type: string - description: The name of the object type on the native system that the schema represents. - example: User - identityAttribute: - type: string - description: The name of the attribute used to calculate the unique identifier for an object in the schema. - example: sAMAccountName - displayAttribute: - type: string - description: The name of the attribute used to calculate the display value for an object in the schema. - example: distinguishedName - hierarchyAttribute: - type: string - description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. - example: memberOf - includePermissions: - type: boolean - description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. - example: false - features: - type: array - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - example: AUTHENTICATE - description: The features that the schema supports. - example: - - PROVISIONING - - NO_PERMISSIONS_PROVISIONING - - GROUPS_HAVE_MEMBERS - configuration: - type: object - description: Holds any extra configuration data that the schema may require. - example: - groupMemberAttribute: member - attributes: + violationContexts: type: array - description: The attribute definitions which form the schema. + description: List of Violation Contexts items: type: object properties: - name: - type: string - description: The name of the attribute. - example: sAMAccountName - type: - description: The type of the attribute. - example: STRING - type: string - enum: - - STRING - - LONG - - INT - - BOOLEAN - schema: - description: A reference to the schema on the source to the attribute values map to. - type: object + policy: + 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 + - WORKGROUP + 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 + properties: + type: + type: string + example: SOD_POLICY + name: + type: string + example: A very cool policy name + description: The types of objects supported for SOD violations properties: type: - description: The type of object being referenced - type: string enum: - - CONNECTOR_SCHEMA - example: CONNECTOR_SCHEMA - id: - type: string - description: The object ID this reference applies to. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: The human-readable display name of the object. - example: group - description: - type: string - description: A human-readable description of the attribute. - example: SAM Account Name - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - example: false - isEntitlement: - type: boolean - description: Flag indicating whether or not the attribute is an entitlement. - example: false - isGroup: - type: boolean - description: | - Flag indicating whether or not the attribute represents a group. - This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. - example: false - example: - - name: sAMAccountName - type: STRING - isMultiValued: false - isEntitlement: false - isGroup: false - - name: memberOf - type: STRING - schema: - type: CONNECTOR_SCHEMA - id: 2c9180887671ff8c01767b4671fc7d60 - name: group - description: Group membership - isMultiValued: true - isEntitlement: true - isGroup: true - created: - type: string - description: The date the Schema was created. - format: date-time - example: '2019-12-24T22:32:58.104Z' - modified: - type: string - description: The date the Schema was last modified. - format: date-time - example: '2019-12-31T20:22:28.104Z' + - ENTITLEMENT + example: ENTITLEMENT + description: The type of object that is referenced + conflictingAccessCriteria: + nullable: false + description: The object which contains the left and right hand side of the entitlements that got violated according to the policy. + type: object + properties: + leftCriteria: + type: object + properties: + criteriaList: + type: array + description: List of exception criteria. There is a min of 1 and max of 50 items in the list. + items: + 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 + - WORKGROUP + 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: 'CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local' + existing: + type: boolean + description: Whether the subject identity already had that access or not + default: false + example: true + description: Access reference with addition of boolean existing flag to indicate whether the access was extant + description: The types of objects supported for SOD violations + properties: + type: + enum: + - ENTITLEMENT + example: ENTITLEMENT + description: The type of object that is referenced + example: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a66 + existing: true + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a67 + existing: false + rightCriteria: + type: object + properties: + criteriaList: + type: array + description: List of exception criteria. There is a min of 1 and max of 50 items in the list. + items: + 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 + - WORKGROUP + 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: 'CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local' + existing: + type: boolean + description: Whether the subject identity already had that access or not + default: false + example: true + description: Access reference with addition of boolean existing flag to indicate whether the access was extant + description: The types of objects supported for SOD violations + properties: + type: + enum: + - ENTITLEMENT + example: ENTITLEMENT + description: The type of object that is referenced + example: + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a66 + existing: true + - type: ENTITLEMENT + id: 2c9180866166b5b0016167c32ef31a67 + existing: false '400': description: Client Error - Returned if the request body is invalid. content: @@ -98673,410 +89006,123 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - put: - operationId: putSourceSchema + /sod-violations/check: + post: + security: + - UserContextAuth: + - 'idn:sod-violation:read' + operationId: startViolationCheck tags: - - Sources - summary: Update Source Schema (Full) - description: | - This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. - - * id - * name - * created - * modified - - Any attempt to modify these fields will result in an error response with a status code of 400. + - SOD Violations + summary: Check SOD violations + description: |- + This API initiates a SOD policy verification asynchronously. - > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. - parameters: - - in: path - name: sourceId - required: true - schema: - type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: schemaId - schema: - type: string - required: true - description: The Schema id. - example: 2c9180835d191a86015d28455b4a2329 + A token with ORG_ADMIN authority is required to call this API. requestBody: required: true content: application/json: schema: + description: An identity with a set of access to be added + required: + - identityId + - accessRefs type: object properties: - id: - type: string - description: The id of the Schema. - example: 2c9180835d191a86015d28455b4a2329 - name: - type: string - description: The name of the Schema. - example: account - nativeObjectType: - type: string - description: The name of the object type on the native system that the schema represents. - example: User - identityAttribute: - type: string - description: The name of the attribute used to calculate the unique identifier for an object in the schema. - example: sAMAccountName - displayAttribute: - type: string - description: The name of the attribute used to calculate the display value for an object in the schema. - example: distinguishedName - hierarchyAttribute: + identityId: + description: Set of identity id's to be checked. type: string - description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. - example: memberOf - includePermissions: - type: boolean - description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. - example: false - features: - type: array - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - example: AUTHENTICATE - description: The features that the schema supports. - example: - - PROVISIONING - - NO_PERMISSIONS_PROVISIONING - - GROUPS_HAVE_MEMBERS - configuration: - type: object - description: Holds any extra configuration data that the schema may require. - example: - groupMemberAttribute: member - attributes: + example: 2c91809050db617d0150e0bf3215385e + accessRefs: + description: The bundle of access profiles to be added to the identities specified. All references must be ENTITLEMENT type. type: array - description: The attribute definitions which form the schema. items: type: object properties: - name: - type: string - description: The name of the attribute. - example: sAMAccountName type: - description: The type of the attribute. - example: STRING + description: DTO type type: string enum: - - STRING - - LONG - - INT - - BOOLEAN - schema: - description: A reference to the schema on the source to the attribute values map to. - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - CONNECTOR_SCHEMA - example: CONNECTOR_SCHEMA - id: - type: string - description: The object ID this reference applies to. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: The human-readable display name of the object. - example: group - description: + - 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 + - WORKGROUP + example: IDENTITY + id: type: string - description: A human-readable description of the attribute. - example: SAM Account Name - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - example: false - isEntitlement: - type: boolean - description: Flag indicating whether or not the attribute is an entitlement. - example: false - isGroup: - type: boolean - description: | - Flag indicating whether or not the attribute represents a group. - This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. - example: false - example: - - name: sAMAccountName - type: STRING - isMultiValued: false - isEntitlement: false - isGroup: false - - name: memberOf - type: STRING - schema: - type: CONNECTOR_SCHEMA - id: 2c9180887671ff8c01767b4671fc7d60 - name: group - description: Group membership - isMultiValued: true - isEntitlement: true - isGroup: true - created: - type: string - description: The date the Schema was created. - format: date-time - example: '2019-12-24T22:32:58.104Z' - modified: - type: string - description: The date the Schema was last modified. - format: date-time - example: '2019-12-31T20:22:28.104Z' - responses: - '200': - description: The Schema was successfully replaced. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The id of the Schema. - example: 2c9180835d191a86015d28455b4a2329 - name: - type: string - description: The name of the Schema. - example: account - nativeObjectType: - type: string - description: The name of the object type on the native system that the schema represents. - example: User - identityAttribute: - type: string - description: The name of the attribute used to calculate the unique identifier for an object in the schema. - example: sAMAccountName - displayAttribute: - type: string - description: The name of the attribute used to calculate the display value for an object in the schema. - example: distinguishedName - hierarchyAttribute: + 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 + clientMetadata: + type: object + additionalProperties: type: string - description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. - example: memberOf - includePermissions: - type: boolean - description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. - example: false - features: - type: array - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - example: AUTHENTICATE - description: The features that the schema supports. - example: - - PROVISIONING - - NO_PERMISSIONS_PROVISIONING - - GROUPS_HAVE_MEMBERS - configuration: - type: object - description: Holds any extra configuration data that the schema may require. - example: - groupMemberAttribute: member - attributes: - type: array - description: The attribute definitions which form the schema. - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: sAMAccountName - type: - description: The type of the attribute. - example: STRING - type: string - enum: - - STRING - - LONG - - INT - - BOOLEAN - schema: - description: A reference to the schema on the source to the attribute values map to. - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - CONNECTOR_SCHEMA - example: CONNECTOR_SCHEMA - id: - type: string - description: The object ID this reference applies to. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: The human-readable display name of the object. - example: group - description: - type: string - description: A human-readable description of the attribute. - example: SAM Account Name - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - example: false - isEntitlement: - type: boolean - description: Flag indicating whether or not the attribute is an entitlement. - example: false - isGroup: - type: boolean - description: | - Flag indicating whether or not the attribute represents a group. - This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. - example: false - example: - - name: sAMAccountName - type: STRING - isMultiValued: false - isEntitlement: false - isGroup: false - - name: memberOf - type: STRING - schema: - type: CONNECTOR_SCHEMA - id: 2c9180887671ff8c01767b4671fc7d60 - name: group - description: Group membership - isMultiValued: true - isEntitlement: true - isGroup: true - created: + description: Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. + example: + clientName: client1 + clientId: 2c91808f7892918f0178b78da4a305a1 + example: + identityId: 2c91808568c529c60168cca6f90c1313 + accessRefs: + - type: ENTITLEMENT + id: 2c918087682f9a86016839c050861ab1 + name: 'CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local' + - type: ENTITLEMENT + id: 2c918087682f9a86016839c0509c1ab2 + name: 'CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local' + clientMetadata: + additionalProp1: string + additionalProp2: string + additionalProp3: string + responses: + '202': + description: Request ID with a timestamp. + content: + application/json: + schema: + description: An object referencing an SOD violation check + required: + - requestId + type: object + properties: + requestId: + description: The id of the original request + example: 089899f13a8f4da7824996191587bab9 type: string - description: The date the Schema was created. - format: date-time - example: '2019-12-24T22:32:58.104Z' - modified: + created: type: string - description: The date the Schema was last modified. format: date-time - example: '2019-12-31T20:22:28.104Z' + readOnly: true + description: The date-time when this request was created. + example: '2020-01-01T00:00:00.000000Z' '400': description: Client Error - Returned if the request body is invalid. content: @@ -99355,301 +89401,249 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - patch: - operationId: updateSourceSchema + /sod-violation-report/run: + post: + security: + - UserContextAuth: + - 'idn:sod-violation:write' + operationId: startSodAllPoliciesForOrg tags: - - Sources - summary: Update Source Schema (Partial) - description: | - Use this API to selectively update an existing Schema using a JSONPatch payload. - - The following schema fields are immutable and cannot be updated: - - - id - - name - - created - - modified - - - To switch an account attribute to a group entitlement, you need to have the following in place: - - - `isEntitlement: true` - - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: - ```json - { - "name": "groups", - "type": "STRING", - "schema": { - "type": "CONNECTOR_SCHEMA", - "id": "2c9180887671ff8c01767b4671fc7d60", - "name": "group" - }, - "description": "The groups, roles etc. that reference account group objects", - "isMulti": true, - "isEntitlement": true, - "isGroup": true - } - ``` - parameters: - - in: path - name: sourceId - required: true - schema: - type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: schemaId - schema: - type: string - required: true - description: The Schema id. - example: 2c9180835d191a86015d28455b4a2329 + - SOD Policy + summary: Runs all policies for org + description: 'Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided.' requestBody: - required: true - description: The JSONPatch payload used to update the schema. + required: false content: - application/json-patch+json: + application/json: schema: - type: array - items: - type: object - description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' - required: - - op - - path - properties: - op: - type: string - description: The operation to be performed - enum: - - add - - remove - - replace - - move - - copy - - test - example: replace - path: + type: object + properties: + filteredPolicyList: + type: array + description: Multi-policy report will be run for this list of ids + items: type: string - description: A string JSON Pointer representing the target path to an element to be affected by the operation - example: /description - value: - anyOf: - - type: string - - type: integer - - type: object - - type: array - items: - anyOf: - - type: string - - type: integer - - type: object - description: 'The value to be used for the operation, required for "add" and "replace" operations' - example: New description - examples: - add-attribute: - summary: Add an attribute to the end of the list - value: - - op: add - path: /attributes/- - value: - name: location - type: STRING - schema: null - description: Employee location - isMulti: false - isEntitlement: false - isGroup: false + example: + - b868cd40-ffa4-4337-9c07-1a51846cfa94 + - 63a07a7b-39a4-48aa-956d-50c827deba2a + example: + filteredPolicyList: + - b868cd40-ffa4-4337-9c07-1a51846cfa94 + - 63a07a7b-39a4-48aa-956d-50c827deba2a responses: '200': - description: The Schema was successfully updated. + description: Reference to the violation report run task. + content: + application/json: + schema: + 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 + - WORKGROUP + 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 + properties: + status: + type: string + description: Status of a violation report + enum: + - SUCCESS + - WARNING + - ERROR + - TERMINATED + - TEMP_ERROR + - PENDING + example: PENDING + example: + status: PENDING + type: REPORT_RESULT + id: 37b3b32a-f394-46f8-acad-b5223969fa68 + name: Multi Query Report + '400': + description: Client Error - Returned if the request body is invalid. content: application/json: schema: type: object properties: - id: - type: string - description: The id of the Schema. - example: 2c9180835d191a86015d28455b4a2329 - name: - type: string - description: The name of the Schema. - example: account - nativeObjectType: - type: string - description: The name of the object type on the native system that the schema represents. - example: User - identityAttribute: - type: string - description: The name of the attribute used to calculate the unique identifier for an object in the schema. - example: sAMAccountName - displayAttribute: + detailCode: type: string - description: The name of the attribute used to calculate the display value for an object in the schema. - example: distinguishedName - hierarchyAttribute: + description: Fine-grained error code providing more detail of the error. + example: 400.1 Bad Request Content + trackingId: type: string - description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. - example: memberOf - includePermissions: - type: boolean - description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. - example: false - features: + description: Unique tracking id for the error. + example: e7eab60924f64aa284175b9fa3309599 + messages: type: array + description: Generic localized reason for error items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - example: AUTHENTICATE - description: The features that the schema supports. - example: - - PROVISIONING - - NO_PERMISSIONS_PROVISIONING - - GROUPS_HAVE_MEMBERS - configuration: - type: object - description: Holds any extra configuration data that the schema may require. - example: - groupMemberAttribute: member - attributes: + 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: The attribute definitions which form the schema. + description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field items: type: object properties: - name: + locale: type: string - description: The name of the attribute. - example: sAMAccountName - type: - description: The type of the attribute. - example: STRING + description: 'The locale for the message text, a BCP 47 language tag.' + example: en-US + localeOrigin: type: string enum: - - STRING - - LONG - - INT - - BOOLEAN - schema: - description: A reference to the schema on the source to the attribute values map to. - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - CONNECTOR_SCHEMA - example: CONNECTOR_SCHEMA - id: - type: string - description: The object ID this reference applies to. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: The human-readable display name of the object. - example: group - description: + - 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: A human-readable description of the attribute. - example: SAM Account Name - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - example: false - isEntitlement: - type: boolean - description: Flag indicating whether or not the attribute is an entitlement. - example: false - isGroup: - type: boolean - description: | - Flag indicating whether or not the attribute represents a group. - This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. - example: false - example: - - name: sAMAccountName - type: STRING - isMultiValued: false - isEntitlement: false - isGroup: false - - name: memberOf - type: STRING - schema: - type: CONNECTOR_SCHEMA - id: 2c9180887671ff8c01767b4671fc7d60 - name: group - description: Group membership - isMultiValued: true - isEntitlement: true - isGroup: true - created: + 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: The date the Schema was created. - format: date-time - example: '2019-12-24T22:32:58.104Z' - modified: + description: Fine-grained error code providing more detail of the error. + example: 400.1 Bad Request Content + trackingId: type: string - description: The date the Schema was last modified. - format: date-time - example: '2019-12-31T20:22:28.104Z' - '400': - description: Client Error - Returned if the request body is invalid. + 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: @@ -99705,18 +89699,96 @@ paths: 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.' + 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. + /sod-violation-report: + get: + security: + - UserContextAuth: + - 'idn:sod-violation:read' + operationId: getSodAllReportRunStatus + tags: + - SOD Policy + summary: Get multi-report run task status + description: This endpoint gets the status for a violation report for all policy run. + responses: + '200': + description: Status of the violation report run task for all policy run. 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.' + 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 + - WORKGROUP + 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 + properties: + status: + type: string + description: Status of a violation report + enum: + - SUCCESS + - WARNING + - ERROR + - TERMINATED + - TEMP_ERROR + - PENDING + example: PENDING + example: + status: SUCCESS + type: REPORT_RESULT + id: 37b3b32a-f394-46f8-acad-b5223969fa68 + name: Multi Query Report + '400': + description: Client Error - Returned if the request body is invalid. content: application/json: schema: @@ -99772,18 +89844,18 @@ paths: 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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist + '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: @@ -99840,15 +89912,15 @@ paths: description: Actual text of the error message in the indicated locale. example: The request was syntactically correct but its content is semantically invalid. examples: - '404': - summary: An example of a 404 response object + '403': + summary: An example of a 403 response object value: - detailCode: 404 Not found + detailCode: 403 Forbidden trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. + 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: @@ -99926,29 +89998,32 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - delete: - operationId: deleteSourceSchema + '/sod-violation-report/{reportResultId}/download': + get: + security: + - UserContextAuth: + - 'idn:sod-violation:read' + operationId: getDefaultViolationReport tags: - - Sources - summary: Delete Source Schema by ID + - SOD Policy + summary: Download violation report + description: This allows to download a violation report for a given report reference. parameters: - in: path - name: sourceId - required: true - schema: - type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: schemaId + name: reportResultId schema: type: string required: true - description: The Schema id. - example: 2c9180835d191a86015d28455b4a2329 + description: The ID of the report reference to download. + example: ef38f94347e94562b5bb8424a56397d8 responses: - '204': - description: The Schema was successfully deleted. + '200': + description: Returns the PolicyReport.zip that contains the violation report file. + content: + application/zip: + schema: + type: string + format: binary '400': description: Client Error - Returned if the request body is invalid. content: @@ -100227,87 +90302,175 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/sources/{sourceId}/source-health': + '/sod-violation-report/{reportResultId}/download/{fileName}': get: - operationId: getSourceHealth security: - UserContextAuth: - - 'idn:sources:read' + - 'idn:sod-violation:read' + operationId: getCustomViolationReport tags: - - Sources - summary: Fetches source health by id - description: This endpoint fetches source health by source's id + - SOD Policy + summary: Download custom violation report + description: This allows to download a specified named violation report for a given report reference. parameters: - in: path - name: sourceId + name: reportResultId + schema: + type: string required: true + description: The ID of the report reference to download. + example: ef38f94347e94562b5bb8424a56397d8 + - in: path + name: fileName schema: type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 + required: true + description: Custom Name for the file. + example: custom-name responses: '200': - description: Fetched source health successfully + description: Returns the zip file with given custom name that contains the violation report file. + content: + application/zip: + schema: + type: string + format: binary + '400': + description: Client Error - Returned if the request body is invalid. content: application/json: schema: type: object - description: Dto for source health data properties: - id: - type: string - readOnly: true - description: the id of the Source - example: 2c91808568c529c60168cca6f90c1324 - type: - type: string - description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ' - example: OpenLDAP - Direct - name: - type: string - description: the name of the source - example: Source1234 - org: - type: string - description: source's org - example: denali-cjh - isAuthoritative: - type: boolean - example: false - description: Is the source authoritative - isCluster: - type: boolean - example: false - description: Is the source in a cluster - hostname: + detailCode: type: string - example: megapod-useast1-secret-hostname.sailpoint.com - description: source's hostname - pod: + description: Fine-grained error code providing more detail of the error. + example: 400.1 Bad Request Content + trackingId: type: string - description: source's pod - example: megapod-useast1 - iqServiceVersion: + 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: The version of the iqService - example: iqVersion123 - status: + description: Fine-grained error code providing more detail of the error. + example: 400.1 Bad Request Content + trackingId: type: string - enum: - - SOURCE_STATE_ERROR_CLUSTER - - SOURCE_STATE_ERROR_SOURCE - - SOURCE_STATE_ERROR_VA - - SOURCE_STATE_FAILURE_CLUSTER - - SOURCE_STATE_FAILURE_SOURCE - - SOURCE_STATE_HEALTHY - - SOURCE_STATE_UNCHECKED_CLUSTER - - SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES - - SOURCE_STATE_UNCHECKED_SOURCE - - SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS - description: connection test result - example: SOURCE_STATE_UNCHECKED_SOURCE - '400': - description: Client Error - Returned if the request body is invalid. + 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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist content: application/json: schema: @@ -100363,18 +90526,28 @@ paths: 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.' + examples: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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: - error: + message: 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.' + example: ' Rate Limit Exceeded ' + '500': + description: Internal Server Error - Returned if there is an unexpected error. content: application/json: schema: @@ -100431,17 +90604,460 @@ paths: 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 + '500': + summary: An example of a 500 response object value: - detailCode: 403 Forbidden + detailCode: 500.0 Internal Fault trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist + text: An internal fault occurred. + /sources: + get: + operationId: listSources + security: + - UserContextAuth: + - 'idn:sources:read' + tags: + - Sources + summary: Lists all sources in IdentityNow. + description: |- + This end-point lists all the sources in IdentityNow. + A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or ROLE_SUBADMIN authority is required to call this API. + parameters: + - 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 + example: name eq "#Employees" + 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**: *co, eq, in, sw* + **type**: *eq, in* + **owner.id**: *eq, in* + **features**: *ca, co* + **created**: *eq* + **modified**: *eq* + **managementWorkgroup.id**: *eq* + **description**: *eq* + **authoritative**: *eq* + **healthy**: *eq* + **status**: *eq, in* + **connectionType**: *eq* + **connectorName**: *eq* + - in: query + name: sorters + schema: + type: string + format: comma-separated + example: name + 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: **type, created, modified, name, owner.name, healthy, status** + - in: query + name: for-subadmin + schema: + type: string + example: name + description: |- + Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. + Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. + responses: + '200': + description: List of Source objects + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: string + readOnly: true + description: the id of the Source + example: 2c91808568c529c60168cca6f90c1324 + name: + type: string + description: Human-readable name of the source + example: My Source + description: + type: string + description: Human-readable description of the source + example: This is the corporate directory. + owner: + description: Reference to an owning Identity Object + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: ID of the identity + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the identity + example: MyName + cluster: + description: Reference to the associated Cluster + type: object + required: + - name + - id + - type + properties: + type: + description: The type of object being referenced + type: string + enum: + - CLUSTER + example: CLUSTER + id: + type: string + description: ID of the cluster + example: 2c9180866166b5b0016167c32ef31a66 + name: + type: string + description: Human-readable display name of the cluster + example: Corporate Cluster + accountCorrelationConfig: + description: Reference to an Account Correlation Config object + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - ACCOUNT_CORRELATION_CONFIG + example: ACCOUNT_CORRELATION_CONFIG + id: + type: string + description: ID of the account correlation config + example: 2c9180855d191c59015d28583727245a + name: + type: string + description: Human-readable display name of the account correlation config + example: 'Directory [source-62867] Account Correlation' + accountCorrelationRule: + description: 'Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can''t be used.' + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - RULE + example: RULE + id: + type: string + description: ID of the rule + example: 2c918085708c274401708c2a8a760001 + name: + type: string + description: Human-readable display name of the rule + example: Example Rule + managerCorrelationMapping: + description: Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity + type: object + properties: + accountAttribute: + type: string + description: Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. + example: manager + identityAttribute: + type: string + description: Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. + example: manager + managerCorrelationRule: + description: 'Reference to the ManagerCorrelationRule, only used when a simple filter isn''t sufficient.' + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - RULE + example: RULE + id: + type: string + description: ID of the rule + example: 2c918085708c274401708c2a8a760001 + name: + type: string + description: Human-readable display name of the rule + example: Example Rule + beforeProvisioningRule: + description: Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - RULE + example: RULE + id: + type: string + description: ID of the rule + example: 2c918085708c274401708c2a8a760001 + name: + type: string + description: Human-readable display name of the rule + example: Example Rule + schemas: + type: array + items: + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - CONNECTOR_SCHEMA + example: CONNECTOR_SCHEMA + id: + type: string + description: ID of the schema + example: 2c91808568c529c60168cca6f90c1777 + name: + type: string + description: Human-readable display name of the schema + example: MySchema + description: List of references to Schema objects + example: + - type: CONNECTOR_SCHEMA + id: 2c9180835d191a86015d28455b4b232a + name: account + - type: CONNECTOR_SCHEMA + id: 2c9180835d191a86015d28455b4b232b + name: group + passwordPolicies: + type: array + items: + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - PASSWORD_POLICY + example: PASSWORD_POLICY + id: + type: string + description: ID of the policy + example: 2c91808568c529c60168cca6f90c1777 + name: + type: string + description: Human-readable display name of the policy + example: My Password Policy + description: List of references to the associated PasswordPolicy objects. + example: + - type: PASSWORD_POLICY + id: 2c9180855d191c59015d291ceb053980 + name: Corporate Password Policy + - type: PASSWORD_POLICY + id: 2c9180855d191c59015d291ceb057777 + name: Vendor Password Policy + features: + type: array + description: Optional features that can be supported by a source. + items: + type: string + enum: + - AUTHENTICATE + - COMPOSITE + - DIRECT_PERMISSIONS + - DISCOVER_SCHEMA + - ENABLE + - MANAGER_LOOKUP + - NO_RANDOM_ACCESS + - PROXY + - SEARCH + - TEMPLATE + - UNLOCK + - UNSTRUCTURED_TARGETS + - SHAREPOINT_TARGET + - PROVISIONING + - GROUP_PROVISIONING + - SYNC_PROVISIONING + - PASSWORD + - CURRENT_PASSWORD + - ACCOUNT_ONLY_REQUEST + - ADDITIONAL_ACCOUNT_REQUEST + - NO_AGGREGATION + - GROUPS_HAVE_MEMBERS + - NO_PERMISSIONS_PROVISIONING + - NO_GROUP_PERMISSIONS_PROVISIONING + - NO_UNSTRUCTURED_TARGETS_PROVISIONING + - NO_DIRECT_PERMISSIONS_PROVISIONING + description: |- + Optional features that can be supported by an source. + * AUTHENTICATE: The source supports pass-through authentication. + * COMPOSITE: The source supports composite source creation. + * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. + * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. + * ENABLE The source supports reading if an account is enabled or disabled. + * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. + * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. + * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. + * SEARCH + * TEMPLATE + * UNLOCK: The source supports reading if an account is locked or unlocked. + * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. + * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. + * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. + * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. + * SYNC_PROVISIONING: The source can provision accounts synchronously. + * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. + * CURRENT_PASSWORD: Some source types support verification of the current password + * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. + * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. + * NO_AGGREGATION: A source that does not support aggregation. + * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. + * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. + * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. + * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + example: AUTHENTICATE + example: + - SYNC_PROVISIONING + - MANAGER_LOOKUP + - SEARCH + - PROVISIONING + - AUTHENTICATE + - GROUP_PROVISIONING + - PASSWORD + type: + type: string + description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ' + example: OpenLDAP - Direct + connector: + type: string + description: Connector script name. + example: active-directory + connectorClass: + type: string + description: The fully qualified name of the Java class that implements the connector interface. + example: sailpoint.connector.LDAPConnector + connectorAttributes: + type: object + description: Connector specific configuration; will differ from type to type. + example: + healthCheckTimeout: 30 + authSearchAttributes: + - cn + - uid + - mail + deleteThreshold: + type: integer + format: int32 + description: Number from 0 to 100 that specifies when to skip the delete phase. + example: 10 + authoritative: + type: boolean + description: When true indicates the source is referenced by an IdentityProfile. + default: false + example: false + managementWorkgroup: + description: Reference to Management Workgroup for this Source + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - GOVERNANCE_GROUP + example: GOVERNANCE_GROUP + id: + type: string + description: ID of the management workgroup + example: 2c91808568c529c60168cca6f90c2222 + name: + type: string + description: Human-readable display name of the management workgroup + example: My Management Workgroup + healthy: + type: boolean + description: When true indicates a healthy source + default: false + example: true + status: + type: string + description: 'A status identifier, giving specific information on why a source is healthy or not' + example: SOURCE_STATE_HEALTHY + since: + type: string + description: Timestamp showing when a source health check was last performed + example: '2021-09-28T15:48:29.3801666300Z' + connectorId: + type: string + description: The id of connector + example: active-directory + connectorName: + type: string + description: The name of the connector that was chosen on source creation + example: Active Directory + connectionType: + type: string + description: The type of connection (direct or file) + example: file + connectorImplementstionId: + type: string + description: The connector implementstion id + example: delimited-file + required: + - name + - owner + - connector + '400': + description: Client Error - Returned if the request body is invalid. content: application/json: schema: @@ -100497,28 +91113,18 @@ paths: 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. + '401': + description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' content: application/json: schema: type: object properties: - message: + error: description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected 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: @@ -100575,40 +91181,17 @@ paths: 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 + '403': + summary: An example of a 403 response object value: - detailCode: 500.0 Internal Fault + detailCode: 403 Forbidden trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: An internal fault occurred. - '/sources/{id}/schemas/accounts': - get: - tags: - - Sources - summary: Downloads source accounts schema template - description: |- - This API downloads the CSV schema that defines the account attributes on a source. - >**NOTE: This API is designated only for Delimited File sources.** - operationId: getAccountsSchema - parameters: - - in: path - name: id - required: true - schema: - type: string - description: The Source id - example: 8c190e6787aa4ed9a90bd9d5344523fb - responses: - '200': - description: Successfully downloaded the file - content: - text/csv: - example: 'id,name,givenName,familyName,e-mail,location,manager,groups,startDate,endDate' - '400': - description: Client Error - Returned if the request body is invalid. + text: The server understood the request but refuses to authorize it. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist content: application/json: schema: @@ -100664,18 +91247,28 @@ paths: 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.' + examples: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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: - error: + message: 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.' + example: ' Rate Limit Exceeded ' + '500': + description: Internal Server Error - Returned if there is an unexpected error. content: application/json: schema: @@ -100732,231 +91325,585 @@ paths: 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 + '500': + summary: An example of a 500 response object value: - detailCode: 403 Forbidden + detailCode: 500.0 Internal Fault trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: + text: An internal fault occurred. + post: + operationId: createSource + security: + - UserContextAuth: + - 'idn:sources:manage' + tags: + - Sources + summary: Creates a source in IdentityNow. + description: |- + This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. + A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + parameters: + - in: query + name: provisionAsCsv + description: 'If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don''t set this query parameter and you attempt to set the `type` attribute directly, the request won''t correctly generate the source. ' + schema: + type: boolean + required: false + example: false + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: string + readOnly: true + description: the id of the Source + example: 2c91808568c529c60168cca6f90c1324 + name: + type: string + description: Human-readable name of the source + example: My Source + description: + type: string + description: Human-readable description of the source + example: This is the corporate directory. + owner: + description: Reference to an owning Identity Object + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: ID of the identity + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the identity + example: MyName + cluster: + description: Reference to the associated Cluster + type: object + required: + - name + - id + - type + properties: + type: + description: The type of object being referenced + type: string + enum: + - CLUSTER + example: CLUSTER + id: + type: string + description: ID of the cluster + example: 2c9180866166b5b0016167c32ef31a66 + name: + type: string + description: Human-readable display name of the cluster + example: Corporate Cluster + accountCorrelationConfig: + description: Reference to an Account Correlation Config object + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - ACCOUNT_CORRELATION_CONFIG + example: ACCOUNT_CORRELATION_CONFIG + id: + type: string + description: ID of the account correlation config + example: 2c9180855d191c59015d28583727245a + name: + type: string + description: Human-readable display name of the account correlation config + example: 'Directory [source-62867] Account Correlation' + accountCorrelationRule: + description: 'Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can''t be used.' + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - RULE + example: RULE + id: + type: string + description: ID of the rule + example: 2c918085708c274401708c2a8a760001 + name: + type: string + description: Human-readable display name of the rule + example: Example Rule + managerCorrelationMapping: + description: Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity + type: object + properties: + accountAttribute: + type: string + description: Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. + example: manager + identityAttribute: + type: string + description: Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. + example: manager + managerCorrelationRule: + description: 'Reference to the ManagerCorrelationRule, only used when a simple filter isn''t sufficient.' + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - RULE + example: RULE + id: + type: string + description: ID of the rule + example: 2c918085708c274401708c2a8a760001 + name: + type: string + description: Human-readable display name of the rule + example: Example Rule + beforeProvisioningRule: + description: Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - RULE + example: RULE + id: + type: string + description: ID of the rule + example: 2c918085708c274401708c2a8a760001 + name: + type: string + description: Human-readable display name of the rule + example: Example Rule + schemas: + type: array + items: + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - CONNECTOR_SCHEMA + example: CONNECTOR_SCHEMA + id: + type: string + description: ID of the schema + example: 2c91808568c529c60168cca6f90c1777 + name: + type: string + description: Human-readable display name of the schema + example: MySchema + description: List of references to Schema objects + example: + - type: CONNECTOR_SCHEMA + id: 2c9180835d191a86015d28455b4b232a + name: account + - type: CONNECTOR_SCHEMA + id: 2c9180835d191a86015d28455b4b232b + name: group + passwordPolicies: + type: array + items: + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - PASSWORD_POLICY + example: PASSWORD_POLICY + id: + type: string + description: ID of the policy + example: 2c91808568c529c60168cca6f90c1777 + name: + type: string + description: Human-readable display name of the policy + example: My Password Policy + description: List of references to the associated PasswordPolicy objects. + example: + - type: PASSWORD_POLICY + id: 2c9180855d191c59015d291ceb053980 + name: Corporate Password Policy + - type: PASSWORD_POLICY + id: 2c9180855d191c59015d291ceb057777 + name: Vendor Password Policy + features: + type: array + description: Optional features that can be supported by a source. + items: 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. + enum: + - AUTHENTICATE + - COMPOSITE + - DIRECT_PERMISSIONS + - DISCOVER_SCHEMA + - ENABLE + - MANAGER_LOOKUP + - NO_RANDOM_ACCESS + - PROXY + - SEARCH + - TEMPLATE + - UNLOCK + - UNSTRUCTURED_TARGETS + - SHAREPOINT_TARGET + - PROVISIONING + - GROUP_PROVISIONING + - SYNC_PROVISIONING + - PASSWORD + - CURRENT_PASSWORD + - ACCOUNT_ONLY_REQUEST + - ADDITIONAL_ACCOUNT_REQUEST + - NO_AGGREGATION + - GROUPS_HAVE_MEMBERS + - NO_PERMISSIONS_PROVISIONING + - NO_GROUP_PERMISSIONS_PROVISIONING + - NO_UNSTRUCTURED_TARGETS_PROVISIONING + - NO_DIRECT_PERMISSIONS_PROVISIONING + description: |- + Optional features that can be supported by an source. + * AUTHENTICATE: The source supports pass-through authentication. + * COMPOSITE: The source supports composite source creation. + * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. + * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. + * ENABLE The source supports reading if an account is enabled or disabled. + * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. + * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. + * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. + * SEARCH + * TEMPLATE + * UNLOCK: The source supports reading if an account is locked or unlocked. + * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. + * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. + * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. + * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. + * SYNC_PROVISIONING: The source can provision accounts synchronously. + * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. + * CURRENT_PASSWORD: Some source types support verification of the current password + * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. + * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. + * NO_AGGREGATION: A source that does not support aggregation. + * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. + * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. + * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. + * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + example: AUTHENTICATE + example: + - SYNC_PROVISIONING + - MANAGER_LOOKUP + - SEARCH + - PROVISIONING + - AUTHENTICATE + - GROUP_PROVISIONING + - PASSWORD + type: + type: string + description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ' + example: OpenLDAP - Direct + connector: + type: string + description: Connector script name. + example: active-directory + connectorClass: + type: string + description: The fully qualified name of the Java class that implements the connector interface. + example: sailpoint.connector.LDAPConnector + connectorAttributes: + type: object + description: Connector specific configuration; will differ from type to type. + example: + healthCheckTimeout: 30 + authSearchAttributes: + - cn + - uid + - mail + deleteThreshold: + type: integer + format: int32 + description: Number from 0 to 100 that specifies when to skip the delete phase. + example: 10 + authoritative: + type: boolean + description: When true indicates the source is referenced by an IdentityProfile. + default: false + example: false + managementWorkgroup: + description: Reference to Management Workgroup for this Source + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - GOVERNANCE_GROUP + example: GOVERNANCE_GROUP + id: + type: string + description: ID of the management workgroup + example: 2c91808568c529c60168cca6f90c2222 + name: + type: string + description: Human-readable display name of the management workgroup + example: My Management Workgroup + healthy: + type: boolean + description: When true indicates a healthy source + default: false + example: true + status: + type: string + description: 'A status identifier, giving specific information on why a source is healthy or not' + example: SOURCE_STATE_HEALTHY + since: + type: string + description: Timestamp showing when a source health check was last performed + example: '2021-09-28T15:48:29.3801666300Z' + connectorId: + type: string + description: The id of connector + example: active-directory + connectorName: + type: string + description: The name of the connector that was chosen on source creation + example: Active Directory + connectionType: + type: string + description: The type of connection (direct or file) + example: file + connectorImplementstionId: + type: string + description: The connector implementstion id + example: delimited-file + required: + - name + - owner + - connector + responses: + '201': + description: 'Created Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design.' content: application/json: schema: type: object properties: - detailCode: + id: type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: + readOnly: true + description: the id of the Source + example: 2c91808568c529c60168cca6f90c1324 + name: type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: + description: Human-readable name of the source + example: My Source + description: + type: string + description: Human-readable description of the source + example: This is the corporate directory. + owner: + description: Reference to an owning Identity Object + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: ID of the identity + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the identity + example: MyName + cluster: + description: Reference to the associated Cluster + type: object + required: + - name + - id + - type + properties: + type: + description: The type of object being referenced + type: string + enum: + - CLUSTER + example: CLUSTER + id: + type: string + description: ID of the cluster + example: 2c9180866166b5b0016167c32ef31a66 + name: + type: string + description: Human-readable display name of the cluster + example: Corporate Cluster + accountCorrelationConfig: + description: Reference to an Account Correlation Config object + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - ACCOUNT_CORRELATION_CONFIG + example: ACCOUNT_CORRELATION_CONFIG + id: + type: string + description: ID of the account correlation config + example: 2c9180855d191c59015d28583727245a + name: + type: string + description: Human-readable display name of the account correlation config + example: 'Directory [source-62867] Account Correlation' + accountCorrelationRule: + description: 'Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can''t be used.' + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - RULE + example: RULE + id: + type: string + description: ID of the rule + example: 2c918085708c274401708c2a8a760001 + name: + type: string + description: Human-readable display name of the rule + example: Example Rule + managerCorrelationMapping: + description: Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity + type: object + properties: + accountAttribute: + type: string + description: Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. + example: manager + identityAttribute: + type: string + description: Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. + example: manager + managerCorrelationRule: + description: 'Reference to the ManagerCorrelationRule, only used when a simple filter isn''t sufficient.' + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - RULE + example: RULE + id: + type: string + description: ID of the rule + example: 2c918085708c274401708c2a8a760001 + name: + type: string + description: Human-readable display name of the rule + example: Example Rule + beforeProvisioningRule: + description: Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - RULE + example: RULE + id: + type: string + description: ID of the rule + example: 2c918085708c274401708c2a8a760001 + name: + type: string + description: Human-readable display name of the rule + example: Example Rule + schemas: 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: + description: The type of object being referenced 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: + - CONNECTOR_SCHEMA + example: CONNECTOR_SCHEMA + id: 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: + description: ID of the schema + example: 2c91808568c529c60168cca6f90c1777 + name: + type: string + description: Human-readable display name of the schema + example: MySchema + description: List of references to Schema objects + example: + - type: CONNECTOR_SCHEMA + id: 2c9180835d191a86015d28455b4b232a + name: account + - type: CONNECTOR_SCHEMA + id: 2c9180835d191a86015d28455b4b232b + name: group + passwordPolicies: 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: + description: The type of object being referenced 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: + - PASSWORD_POLICY + example: PASSWORD_POLICY + id: 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. - security: - - UserContextAuth: - - 'idn:source-schema:read' - post: - tags: - - Sources - summary: Uploads source accounts schema template - description: |- - This API uploads a source schema template file to configure a source's account attributes. - - To retrieve the file to modify and upload, log into Identity Now. - - Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** - - >**NOTE: This API is designated only for Delimited File sources.** - operationId: importAccountsSchema - parameters: - - in: path - name: id - required: true - schema: - type: string - description: The Source id - example: 8c190e6787aa4ed9a90bd9d5344523fb - requestBody: - required: true - content: - multipart/form-data: - schema: - type: object - properties: - file: - type: string - format: binary - responses: - '200': - description: Successfully uploaded the file - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The id of the Schema. - example: 2c9180835d191a86015d28455b4a2329 - name: - type: string - description: The name of the Schema. - example: account - nativeObjectType: - type: string - description: The name of the object type on the native system that the schema represents. - example: User - identityAttribute: - type: string - description: The name of the attribute used to calculate the unique identifier for an object in the schema. - example: sAMAccountName - displayAttribute: - type: string - description: The name of the attribute used to calculate the display value for an object in the schema. - example: distinguishedName - hierarchyAttribute: - type: string - description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. - example: memberOf - includePermissions: - type: boolean - description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. - example: false + description: ID of the policy + example: 2c91808568c529c60168cca6f90c1777 + name: + type: string + description: Human-readable display name of the policy + example: My Password Policy + description: List of references to the associated PasswordPolicy objects. + example: + - type: PASSWORD_POLICY + id: 2c9180855d191c59015d291ceb053980 + name: Corporate Password Policy + - type: PASSWORD_POLICY + id: 2c9180855d191c59015d291ceb057777 + name: Vendor Password Policy features: type: array + description: Optional features that can be supported by a source. items: type: string enum: @@ -101015,97 +91962,96 @@ paths: * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. example: AUTHENTICATE - description: The features that the schema supports. example: + - SYNC_PROVISIONING + - MANAGER_LOOKUP + - SEARCH - PROVISIONING - - NO_PERMISSIONS_PROVISIONING - - GROUPS_HAVE_MEMBERS - configuration: + - AUTHENTICATE + - GROUP_PROVISIONING + - PASSWORD + type: + type: string + description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ' + example: OpenLDAP - Direct + connector: + type: string + description: Connector script name. + example: active-directory + connectorClass: + type: string + description: The fully qualified name of the Java class that implements the connector interface. + example: sailpoint.connector.LDAPConnector + connectorAttributes: type: object - description: Holds any extra configuration data that the schema may require. - example: - groupMemberAttribute: member - attributes: - type: array - description: The attribute definitions which form the schema. - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: sAMAccountName - type: - description: The type of the attribute. - example: STRING - type: string - enum: - - STRING - - LONG - - INT - - BOOLEAN - schema: - description: A reference to the schema on the source to the attribute values map to. - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - CONNECTOR_SCHEMA - example: CONNECTOR_SCHEMA - id: - type: string - description: The object ID this reference applies to. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: The human-readable display name of the object. - example: group - description: - type: string - description: A human-readable description of the attribute. - example: SAM Account Name - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - example: false - isEntitlement: - type: boolean - description: Flag indicating whether or not the attribute is an entitlement. - example: false - isGroup: - type: boolean - description: | - Flag indicating whether or not the attribute represents a group. - This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. - example: false + description: Connector specific configuration; will differ from type to type. example: - - name: sAMAccountName - type: STRING - isMultiValued: false - isEntitlement: false - isGroup: false - - name: memberOf - type: STRING - schema: - type: CONNECTOR_SCHEMA - id: 2c9180887671ff8c01767b4671fc7d60 - name: group - description: Group membership - isMultiValued: true - isEntitlement: true - isGroup: true - created: + healthCheckTimeout: 30 + authSearchAttributes: + - cn + - uid + - mail + deleteThreshold: + type: integer + format: int32 + description: Number from 0 to 100 that specifies when to skip the delete phase. + example: 10 + authoritative: + type: boolean + description: When true indicates the source is referenced by an IdentityProfile. + default: false + example: false + managementWorkgroup: + description: Reference to Management Workgroup for this Source + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - GOVERNANCE_GROUP + example: GOVERNANCE_GROUP + id: + type: string + description: ID of the management workgroup + example: 2c91808568c529c60168cca6f90c2222 + name: + type: string + description: Human-readable display name of the management workgroup + example: My Management Workgroup + healthy: + type: boolean + description: When true indicates a healthy source + default: false + example: true + status: type: string - description: The date the Schema was created. - format: date-time - example: '2019-12-24T22:32:58.104Z' - modified: + description: 'A status identifier, giving specific information on why a source is healthy or not' + example: SOURCE_STATE_HEALTHY + since: + type: string + description: Timestamp showing when a source health check was last performed + example: '2021-09-28T15:48:29.3801666300Z' + connectorId: + type: string + description: The id of connector + example: active-directory + connectorName: + type: string + description: The name of the connector that was chosen on source creation + example: Active Directory + connectionType: + type: string + description: The type of connection (direct or file) + example: file + connectorImplementstionId: type: string - description: The date the Schema was last modified. - format: date-time - example: '2019-12-31T20:22:28.104Z' + description: The connector implementstion id + example: delimited-file + required: + - name + - owner + - connector '400': description: Client Error - Returned if the request body is invalid. content: @@ -101317,39 +92263,376 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. + '/sources/{id}': + get: + operationId: getSource security: - UserContextAuth: - - 'idn:source-schema:manage' - '/sources/{id}/schemas/entitlements': - get: + - 'idn:sources:read' tags: - Sources - summary: Downloads source entitlements schema template + summary: Get Source by ID description: |- - This API downloads the CSV schema that defines the entitlement attributes on a source. - - >**NOTE: This API is designated only for Delimited File sources.** - operationId: getEntitlementsSchema + This end-point gets a specific source in IdentityNow. + A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. parameters: - in: path name: id - required: true schema: type: string + required: true description: The Source id - example: 8c190e6787aa4ed9a90bd9d5344523fb - - in: query - name: schemaName - schema: - type: string - description: Name of entitlement schema - example: '?schemaName=group' + example: 2c9180835d191a86015d28455b4a2329 responses: '200': - description: Successfully downloaded the file + description: A Source object content: - text/csv: - example: 'id,name,displayName,created,description,modified,entitlements,groups,permissions' + application/json: + schema: + type: object + properties: + id: + type: string + readOnly: true + description: the id of the Source + example: 2c91808568c529c60168cca6f90c1324 + name: + type: string + description: Human-readable name of the source + example: My Source + description: + type: string + description: Human-readable description of the source + example: This is the corporate directory. + owner: + description: Reference to an owning Identity Object + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: ID of the identity + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the identity + example: MyName + cluster: + description: Reference to the associated Cluster + type: object + required: + - name + - id + - type + properties: + type: + description: The type of object being referenced + type: string + enum: + - CLUSTER + example: CLUSTER + id: + type: string + description: ID of the cluster + example: 2c9180866166b5b0016167c32ef31a66 + name: + type: string + description: Human-readable display name of the cluster + example: Corporate Cluster + accountCorrelationConfig: + description: Reference to an Account Correlation Config object + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - ACCOUNT_CORRELATION_CONFIG + example: ACCOUNT_CORRELATION_CONFIG + id: + type: string + description: ID of the account correlation config + example: 2c9180855d191c59015d28583727245a + name: + type: string + description: Human-readable display name of the account correlation config + example: 'Directory [source-62867] Account Correlation' + accountCorrelationRule: + description: 'Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can''t be used.' + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - RULE + example: RULE + id: + type: string + description: ID of the rule + example: 2c918085708c274401708c2a8a760001 + name: + type: string + description: Human-readable display name of the rule + example: Example Rule + managerCorrelationMapping: + description: Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity + type: object + properties: + accountAttribute: + type: string + description: Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. + example: manager + identityAttribute: + type: string + description: Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. + example: manager + managerCorrelationRule: + description: 'Reference to the ManagerCorrelationRule, only used when a simple filter isn''t sufficient.' + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - RULE + example: RULE + id: + type: string + description: ID of the rule + example: 2c918085708c274401708c2a8a760001 + name: + type: string + description: Human-readable display name of the rule + example: Example Rule + beforeProvisioningRule: + description: Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - RULE + example: RULE + id: + type: string + description: ID of the rule + example: 2c918085708c274401708c2a8a760001 + name: + type: string + description: Human-readable display name of the rule + example: Example Rule + schemas: + type: array + items: + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - CONNECTOR_SCHEMA + example: CONNECTOR_SCHEMA + id: + type: string + description: ID of the schema + example: 2c91808568c529c60168cca6f90c1777 + name: + type: string + description: Human-readable display name of the schema + example: MySchema + description: List of references to Schema objects + example: + - type: CONNECTOR_SCHEMA + id: 2c9180835d191a86015d28455b4b232a + name: account + - type: CONNECTOR_SCHEMA + id: 2c9180835d191a86015d28455b4b232b + name: group + passwordPolicies: + type: array + items: + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - PASSWORD_POLICY + example: PASSWORD_POLICY + id: + type: string + description: ID of the policy + example: 2c91808568c529c60168cca6f90c1777 + name: + type: string + description: Human-readable display name of the policy + example: My Password Policy + description: List of references to the associated PasswordPolicy objects. + example: + - type: PASSWORD_POLICY + id: 2c9180855d191c59015d291ceb053980 + name: Corporate Password Policy + - type: PASSWORD_POLICY + id: 2c9180855d191c59015d291ceb057777 + name: Vendor Password Policy + features: + type: array + description: Optional features that can be supported by a source. + items: + type: string + enum: + - AUTHENTICATE + - COMPOSITE + - DIRECT_PERMISSIONS + - DISCOVER_SCHEMA + - ENABLE + - MANAGER_LOOKUP + - NO_RANDOM_ACCESS + - PROXY + - SEARCH + - TEMPLATE + - UNLOCK + - UNSTRUCTURED_TARGETS + - SHAREPOINT_TARGET + - PROVISIONING + - GROUP_PROVISIONING + - SYNC_PROVISIONING + - PASSWORD + - CURRENT_PASSWORD + - ACCOUNT_ONLY_REQUEST + - ADDITIONAL_ACCOUNT_REQUEST + - NO_AGGREGATION + - GROUPS_HAVE_MEMBERS + - NO_PERMISSIONS_PROVISIONING + - NO_GROUP_PERMISSIONS_PROVISIONING + - NO_UNSTRUCTURED_TARGETS_PROVISIONING + - NO_DIRECT_PERMISSIONS_PROVISIONING + description: |- + Optional features that can be supported by an source. + * AUTHENTICATE: The source supports pass-through authentication. + * COMPOSITE: The source supports composite source creation. + * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. + * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. + * ENABLE The source supports reading if an account is enabled or disabled. + * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. + * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. + * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. + * SEARCH + * TEMPLATE + * UNLOCK: The source supports reading if an account is locked or unlocked. + * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. + * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. + * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. + * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. + * SYNC_PROVISIONING: The source can provision accounts synchronously. + * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. + * CURRENT_PASSWORD: Some source types support verification of the current password + * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. + * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. + * NO_AGGREGATION: A source that does not support aggregation. + * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. + * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. + * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. + * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + example: AUTHENTICATE + example: + - SYNC_PROVISIONING + - MANAGER_LOOKUP + - SEARCH + - PROVISIONING + - AUTHENTICATE + - GROUP_PROVISIONING + - PASSWORD + type: + type: string + description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ' + example: OpenLDAP - Direct + connector: + type: string + description: Connector script name. + example: active-directory + connectorClass: + type: string + description: The fully qualified name of the Java class that implements the connector interface. + example: sailpoint.connector.LDAPConnector + connectorAttributes: + type: object + description: Connector specific configuration; will differ from type to type. + example: + healthCheckTimeout: 30 + authSearchAttributes: + - cn + - uid + - mail + deleteThreshold: + type: integer + format: int32 + description: Number from 0 to 100 that specifies when to skip the delete phase. + example: 10 + authoritative: + type: boolean + description: When true indicates the source is referenced by an IdentityProfile. + default: false + example: false + managementWorkgroup: + description: Reference to Management Workgroup for this Source + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - GOVERNANCE_GROUP + example: GOVERNANCE_GROUP + id: + type: string + description: ID of the management workgroup + example: 2c91808568c529c60168cca6f90c2222 + name: + type: string + description: Human-readable display name of the management workgroup + example: My Management Workgroup + healthy: + type: boolean + description: When true indicates a healthy source + default: false + example: true + status: + type: string + description: 'A status identifier, giving specific information on why a source is healthy or not' + example: SOURCE_STATE_HEALTHY + since: + type: string + description: Timestamp showing when a source health check was last performed + example: '2021-09-28T15:48:29.3801666300Z' + connectorId: + type: string + description: The id of connector + example: active-directory + connectorName: + type: string + description: The name of the connector that was chosen on source creation + example: Active Directory + connectionType: + type: string + description: The type of connection (direct or file) + example: file + connectorImplementstionId: + type: string + description: The connector implementstion id + example: delimited-file + required: + - name + - owner + - connector '400': description: Client Error - Returned if the request body is invalid. content: @@ -101407,18 +92690,162 @@ paths: 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.' + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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: - error: + message: 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.' + example: ' Rate Limit Exceeded ' + '500': + description: Internal Server Error - Returned if there is an unexpected error. content: application/json: schema: @@ -101475,237 +92902,598 @@ paths: 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 + '500': + summary: An example of a 500 response object value: - detailCode: 403 Forbidden + detailCode: 500.0 Internal Fault trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist + text: An internal fault occurred. + put: + operationId: putSource + security: + - UserContextAuth: + - 'idn:sources:manage' + tags: + - Sources + summary: Update Source (Full) + description: | + This API updates a source in IdentityNow, using a full object representation. In other words, the existing Source + configuration is completely replaced. + + Some fields are immutable and cannot be changed, such as: + + * id + * type + * authoritative + * connector + * connectorClass + * passwordPolicies + + Attempts to modify these fields will result in a 400 error. + + A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + parameters: + - in: path + name: id + schema: + type: string + required: true + description: The Source id + example: 2c9180835d191a86015d28455b4a2329 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: string + readOnly: true + description: the id of the Source + example: 2c91808568c529c60168cca6f90c1324 + name: + type: string + description: Human-readable name of the source + example: My Source + description: + type: string + description: Human-readable description of the source + example: This is the corporate directory. + owner: + description: Reference to an owning Identity Object + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: ID of the identity + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the identity + example: MyName + cluster: + description: Reference to the associated Cluster + type: object + required: + - name + - id + - type + properties: + type: + description: The type of object being referenced + type: string + enum: + - CLUSTER + example: CLUSTER + id: + type: string + description: ID of the cluster + example: 2c9180866166b5b0016167c32ef31a66 + name: + type: string + description: Human-readable display name of the cluster + example: Corporate Cluster + accountCorrelationConfig: + description: Reference to an Account Correlation Config object + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - ACCOUNT_CORRELATION_CONFIG + example: ACCOUNT_CORRELATION_CONFIG + id: + type: string + description: ID of the account correlation config + example: 2c9180855d191c59015d28583727245a + name: + type: string + description: Human-readable display name of the account correlation config + example: 'Directory [source-62867] Account Correlation' + accountCorrelationRule: + description: 'Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can''t be used.' + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - RULE + example: RULE + id: + type: string + description: ID of the rule + example: 2c918085708c274401708c2a8a760001 + name: + type: string + description: Human-readable display name of the rule + example: Example Rule + managerCorrelationMapping: + description: Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity + type: object + properties: + accountAttribute: + type: string + description: Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. + example: manager + identityAttribute: + type: string + description: Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. + example: manager + managerCorrelationRule: + description: 'Reference to the ManagerCorrelationRule, only used when a simple filter isn''t sufficient.' + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - RULE + example: RULE + id: + type: string + description: ID of the rule + example: 2c918085708c274401708c2a8a760001 + name: + type: string + description: Human-readable display name of the rule + example: Example Rule + beforeProvisioningRule: + description: Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - RULE + example: RULE + id: + type: string + description: ID of the rule + example: 2c918085708c274401708c2a8a760001 + name: + type: string + description: Human-readable display name of the rule + example: Example Rule + schemas: + type: array + items: + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - CONNECTOR_SCHEMA + example: CONNECTOR_SCHEMA + id: + type: string + description: ID of the schema + example: 2c91808568c529c60168cca6f90c1777 + name: + type: string + description: Human-readable display name of the schema + example: MySchema + description: List of references to Schema objects + example: + - type: CONNECTOR_SCHEMA + id: 2c9180835d191a86015d28455b4b232a + name: account + - type: CONNECTOR_SCHEMA + id: 2c9180835d191a86015d28455b4b232b + name: group + passwordPolicies: + type: array + items: + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - PASSWORD_POLICY + example: PASSWORD_POLICY + id: + type: string + description: ID of the policy + example: 2c91808568c529c60168cca6f90c1777 + name: + type: string + description: Human-readable display name of the policy + example: My Password Policy + description: List of references to the associated PasswordPolicy objects. + example: + - type: PASSWORD_POLICY + id: 2c9180855d191c59015d291ceb053980 + name: Corporate Password Policy + - type: PASSWORD_POLICY + id: 2c9180855d191c59015d291ceb057777 + name: Vendor Password Policy + features: + type: array + description: Optional features that can be supported by a source. + items: + type: string + enum: + - AUTHENTICATE + - COMPOSITE + - DIRECT_PERMISSIONS + - DISCOVER_SCHEMA + - ENABLE + - MANAGER_LOOKUP + - NO_RANDOM_ACCESS + - PROXY + - SEARCH + - TEMPLATE + - UNLOCK + - UNSTRUCTURED_TARGETS + - SHAREPOINT_TARGET + - PROVISIONING + - GROUP_PROVISIONING + - SYNC_PROVISIONING + - PASSWORD + - CURRENT_PASSWORD + - ACCOUNT_ONLY_REQUEST + - ADDITIONAL_ACCOUNT_REQUEST + - NO_AGGREGATION + - GROUPS_HAVE_MEMBERS + - NO_PERMISSIONS_PROVISIONING + - NO_GROUP_PERMISSIONS_PROVISIONING + - NO_UNSTRUCTURED_TARGETS_PROVISIONING + - NO_DIRECT_PERMISSIONS_PROVISIONING + description: |- + Optional features that can be supported by an source. + * AUTHENTICATE: The source supports pass-through authentication. + * COMPOSITE: The source supports composite source creation. + * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. + * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. + * ENABLE The source supports reading if an account is enabled or disabled. + * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. + * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. + * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. + * SEARCH + * TEMPLATE + * UNLOCK: The source supports reading if an account is locked or unlocked. + * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. + * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. + * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. + * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. + * SYNC_PROVISIONING: The source can provision accounts synchronously. + * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. + * CURRENT_PASSWORD: Some source types support verification of the current password + * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. + * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. + * NO_AGGREGATION: A source that does not support aggregation. + * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. + * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. + * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. + * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + example: AUTHENTICATE + example: + - SYNC_PROVISIONING + - MANAGER_LOOKUP + - SEARCH + - PROVISIONING + - AUTHENTICATE + - GROUP_PROVISIONING + - PASSWORD + type: + type: string + description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ' + example: OpenLDAP - Direct + connector: + type: string + description: Connector script name. + example: active-directory + connectorClass: + type: string + description: The fully qualified name of the Java class that implements the connector interface. + example: sailpoint.connector.LDAPConnector + connectorAttributes: + type: object + description: Connector specific configuration; will differ from type to type. + example: + healthCheckTimeout: 30 + authSearchAttributes: + - cn + - uid + - mail + deleteThreshold: + type: integer + format: int32 + description: Number from 0 to 100 that specifies when to skip the delete phase. + example: 10 + authoritative: + type: boolean + description: When true indicates the source is referenced by an IdentityProfile. + default: false + example: false + managementWorkgroup: + description: Reference to Management Workgroup for this Source + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - GOVERNANCE_GROUP + example: GOVERNANCE_GROUP + id: + type: string + description: ID of the management workgroup + example: 2c91808568c529c60168cca6f90c2222 + name: + type: string + description: Human-readable display name of the management workgroup + example: My Management Workgroup + healthy: + type: boolean + description: When true indicates a healthy source + default: false + example: true + status: + type: string + description: 'A status identifier, giving specific information on why a source is healthy or not' + example: SOURCE_STATE_HEALTHY + since: + type: string + description: Timestamp showing when a source health check was last performed + example: '2021-09-28T15:48:29.3801666300Z' + connectorId: + type: string + description: The id of connector + example: active-directory + connectorName: + type: string + description: The name of the connector that was chosen on source creation + example: Active Directory + connectionType: + type: string + description: The type of connection (direct or file) + example: file + connectorImplementstionId: + type: string + description: The connector implementstion id + example: delimited-file + required: + - name + - owner + - connector + responses: + '200': + description: 'Updated Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design.' content: application/json: schema: type: object properties: - detailCode: + id: type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: + readOnly: true + description: the id of the Source + example: 2c91808568c529c60168cca6f90c1324 + name: type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: + description: Human-readable name of the source + example: My Source + description: + type: string + description: Human-readable description of the source + example: This is the corporate directory. + owner: + description: Reference to an owning Identity Object + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: ID of the identity + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the identity + example: MyName + cluster: + description: Reference to the associated Cluster + type: object + required: + - name + - id + - type + properties: + type: + description: The type of object being referenced + type: string + enum: + - CLUSTER + example: CLUSTER + id: + type: string + description: ID of the cluster + example: 2c9180866166b5b0016167c32ef31a66 + name: + type: string + description: Human-readable display name of the cluster + example: Corporate Cluster + accountCorrelationConfig: + description: Reference to an Account Correlation Config object + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - ACCOUNT_CORRELATION_CONFIG + example: ACCOUNT_CORRELATION_CONFIG + id: + type: string + description: ID of the account correlation config + example: 2c9180855d191c59015d28583727245a + name: + type: string + description: Human-readable display name of the account correlation config + example: 'Directory [source-62867] Account Correlation' + accountCorrelationRule: + description: 'Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can''t be used.' + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - RULE + example: RULE + id: + type: string + description: ID of the rule + example: 2c918085708c274401708c2a8a760001 + name: + type: string + description: Human-readable display name of the rule + example: Example Rule + managerCorrelationMapping: + description: Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity + type: object + properties: + accountAttribute: + type: string + description: Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. + example: manager + identityAttribute: + type: string + description: Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. + example: manager + managerCorrelationRule: + description: 'Reference to the ManagerCorrelationRule, only used when a simple filter isn''t sufficient.' + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - RULE + example: RULE + id: + type: string + description: ID of the rule + example: 2c918085708c274401708c2a8a760001 + name: + type: string + description: Human-readable display name of the rule + example: Example Rule + beforeProvisioningRule: + description: Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - RULE + example: RULE + id: + type: string + description: ID of the rule + example: 2c918085708c274401708c2a8a760001 + name: + type: string + description: Human-readable display name of the rule + example: Example Rule + schemas: 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: + description: The type of object being referenced 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: + - CONNECTOR_SCHEMA + example: CONNECTOR_SCHEMA + id: 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: + description: ID of the schema + example: 2c91808568c529c60168cca6f90c1777 + name: 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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: + description: Human-readable display name of the schema + example: MySchema + description: List of references to Schema objects + example: + - type: CONNECTOR_SCHEMA + id: 2c9180835d191a86015d28455b4b232a + name: account + - type: CONNECTOR_SCHEMA + id: 2c9180835d191a86015d28455b4b232b + name: group + passwordPolicies: 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: + description: The type of object being referenced 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: + - PASSWORD_POLICY + example: PASSWORD_POLICY + id: 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: + description: ID of the policy + example: 2c91808568c529c60168cca6f90c1777 + name: 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. - security: - - UserContextAuth: - - 'idn:source-schema:read' - post: - tags: - - Sources - summary: Uploads source entitlements schema template - description: |- - This API uploads a source schema template file to configure a source's entitlement attributes. - - To retrieve the file to modify and upload, log into Identity Now. - - Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** - - >**NOTE: This API is designated only for Delimited File sources.** - operationId: importEntitlementsSchema - parameters: - - in: path - name: id - required: true - schema: - type: string - description: The Source id - example: 8c190e6787aa4ed9a90bd9d5344523fb - - in: query - name: schemaName - schema: - type: string - description: Name of entitlement schema - example: '?schemaName=group' - requestBody: - required: true - content: - multipart/form-data: - schema: - type: object - properties: - file: - type: string - format: binary - responses: - '200': - description: Successfully uploaded the file - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The id of the Schema. - example: 2c9180835d191a86015d28455b4a2329 - name: - type: string - description: The name of the Schema. - example: account - nativeObjectType: - type: string - description: The name of the object type on the native system that the schema represents. - example: User - identityAttribute: - type: string - description: The name of the attribute used to calculate the unique identifier for an object in the schema. - example: sAMAccountName - displayAttribute: - type: string - description: The name of the attribute used to calculate the display value for an object in the schema. - example: distinguishedName - hierarchyAttribute: - type: string - description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. - example: memberOf - includePermissions: - type: boolean - description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. - example: false + description: Human-readable display name of the policy + example: My Password Policy + description: List of references to the associated PasswordPolicy objects. + example: + - type: PASSWORD_POLICY + id: 2c9180855d191c59015d291ceb053980 + name: Corporate Password Policy + - type: PASSWORD_POLICY + id: 2c9180855d191c59015d291ceb057777 + name: Vendor Password Policy features: type: array + description: Optional features that can be supported by a source. items: type: string enum: @@ -101764,97 +93552,96 @@ paths: * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. example: AUTHENTICATE - description: The features that the schema supports. example: + - SYNC_PROVISIONING + - MANAGER_LOOKUP + - SEARCH - PROVISIONING - - NO_PERMISSIONS_PROVISIONING - - GROUPS_HAVE_MEMBERS - configuration: + - AUTHENTICATE + - GROUP_PROVISIONING + - PASSWORD + type: + type: string + description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ' + example: OpenLDAP - Direct + connector: + type: string + description: Connector script name. + example: active-directory + connectorClass: + type: string + description: The fully qualified name of the Java class that implements the connector interface. + example: sailpoint.connector.LDAPConnector + connectorAttributes: type: object - description: Holds any extra configuration data that the schema may require. - example: - groupMemberAttribute: member - attributes: - type: array - description: The attribute definitions which form the schema. - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: sAMAccountName - type: - description: The type of the attribute. - example: STRING - type: string - enum: - - STRING - - LONG - - INT - - BOOLEAN - schema: - description: A reference to the schema on the source to the attribute values map to. - type: object - properties: - type: - description: The type of object being referenced - type: string - enum: - - CONNECTOR_SCHEMA - example: CONNECTOR_SCHEMA - id: - type: string - description: The object ID this reference applies to. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: The human-readable display name of the object. - example: group - description: - type: string - description: A human-readable description of the attribute. - example: SAM Account Name - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - example: false - isEntitlement: - type: boolean - description: Flag indicating whether or not the attribute is an entitlement. - example: false - isGroup: - type: boolean - description: | - Flag indicating whether or not the attribute represents a group. - This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. - example: false + description: Connector specific configuration; will differ from type to type. example: - - name: sAMAccountName - type: STRING - isMultiValued: false - isEntitlement: false - isGroup: false - - name: memberOf - type: STRING - schema: - type: CONNECTOR_SCHEMA - id: 2c9180887671ff8c01767b4671fc7d60 - name: group - description: Group membership - isMultiValued: true - isEntitlement: true - isGroup: true - created: + healthCheckTimeout: 30 + authSearchAttributes: + - cn + - uid + - mail + deleteThreshold: + type: integer + format: int32 + description: Number from 0 to 100 that specifies when to skip the delete phase. + example: 10 + authoritative: + type: boolean + description: When true indicates the source is referenced by an IdentityProfile. + default: false + example: false + managementWorkgroup: + description: Reference to Management Workgroup for this Source + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - GOVERNANCE_GROUP + example: GOVERNANCE_GROUP + id: + type: string + description: ID of the management workgroup + example: 2c91808568c529c60168cca6f90c2222 + name: + type: string + description: Human-readable display name of the management workgroup + example: My Management Workgroup + healthy: + type: boolean + description: When true indicates a healthy source + default: false + example: true + status: type: string - description: The date the Schema was created. - format: date-time - example: '2019-12-24T22:32:58.104Z' - modified: + description: 'A status identifier, giving specific information on why a source is healthy or not' + example: SOURCE_STATE_HEALTHY + since: type: string - description: The date the Schema was last modified. - format: date-time - example: '2019-12-31T20:22:28.104Z' + description: Timestamp showing when a source health check was last performed + example: '2021-09-28T15:48:29.3801666300Z' + connectorId: + type: string + description: The id of connector + example: active-directory + connectorName: + type: string + description: The name of the connector that was chosen on source creation + example: Active Directory + connectionType: + type: string + description: The type of connection (direct or file) + example: file + connectorImplementstionId: + type: string + description: The connector implementstion id + example: delimited-file + required: + - name + - owner + - connector '400': description: Client Error - Returned if the request body is invalid. content: @@ -101983,12 +93770,79 @@ paths: '403': summary: An example of a 403 response object value: - detailCode: 403 Forbidden + detailCode: 403 Forbidden + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server understood the request but refuses to authorize it. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. + text: The server did not find a current representation for the target resource. '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: @@ -102066,42 +93920,129 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. + patch: + operationId: updateSource security: - UserContextAuth: - - 'idn:source-schema:manage' - '/sources/{sourceId}/upload-connector-file': - post: - operationId: importConnectorFile - security: - - UserContextAuth: - - 'idn:sources-admin:manage' + - 'idn:sources:manage' tags: - Sources - summary: Upload connector file to source + summary: Update Source (Partial) + description: | + This API partially updates a source in IdentityNow, using a list of patch operations according to the + [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + Some fields are immutable and cannot be changed, such as: + + * id + * type + * authoritative + * created + * modified + * connector + * connectorClass + * passwordPolicies + + Attempts to modify these fields will result in a 400 error. + + A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or API authority is required to call this API. parameters: - in: path - name: sourceId - required: true + name: id schema: type: string - description: The Source id. + required: true + description: The Source id example: 2c9180835d191a86015d28455b4a2329 - description: |- - This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events. - A token with ORG_ADMIN authority is required to call this API. requestBody: required: true + description: 'A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in IdentityNow.' content: - multipart/form-data: + application/json-patch+json: schema: - type: object - properties: - file: - type: string - format: binary + type: array + items: + type: object + description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' + required: + - op + - path + properties: + op: + type: string + description: The operation to be performed + enum: + - add + - remove + - replace + - move + - copy + - test + example: replace + path: + type: string + description: A string JSON Pointer representing the target path to an element to be affected by the operation + example: /description + value: + anyOf: + - type: string + - type: integer + - type: object + - type: array + items: + anyOf: + - type: string + - type: integer + - type: object + description: 'The value to be used for the operation, required for "add" and "replace" operations' + example: New description + examples: + Edit the source description: + description: This example shows how to edit a source description. + value: + - op: replace + path: /description + value: new description + Edit the source cluster: + description: This example shows how to edit a source cluster by id. + value: + - op: replace + path: /cluster/id + value: 2c918087813a902001813f3f85736b45 + Edit source features: + description: This example illustrates how you can update source supported features + value: + - op: replace + path: /features + value: + - PASSWORD + - PROVISIONING + - ENABLE + - AUTHENTICATE + Change a source description and cluster in One Call: + description: This example shows how multiple fields may be updated with a single patch call. + value: + - op: replace + path: /description + value: new description + - op: replace + path: /cluster/id + value: 2c918087813a902001813f3f85736b45 + Add a filter string to the connector: + description: 'This example shows how you can add a filter to incoming accounts during the account aggregation process. In the example below, any account that does not have an "m" or "d" in the id will be aggregated.' + value: + - op: add + path: /connectorAttributes/filterString + value: '!( id.contains( "m" ) ) || !( id.contains( "d" ) )' + Update connector attribute for specific operation type: + description: This example shows how you can update the 3rd object in the connection parameters operationType. This will change it from a standard group aggregation to a group aggregation on the "test" entitlement type + value: + - op: replace + path: /connectorAttributes/connectionParameters/2/operationType + value: Group Aggregation-test responses: '200': - description: Uploaded the file successfully and sent all post-upload events + description: 'Updated Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design.' content: application/json: schema: @@ -102583,18 +94524,8 @@ paths: - 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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist content: application/json: schema: @@ -102651,216 +94582,27 @@ paths: 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 + '404': + summary: An example of a 404 response object value: - detailCode: 500.0 Internal Fault + detailCode: 404 Not found trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: An internal fault occurred. - /tagged-objects: - get: - operationId: listTaggedObjects - security: - - UserContextAuth: - - 'idn:tag:read' - - 'idn:tag:manage' - tags: - - Tagged Objects - summary: List Tagged Objects - description: |- - This API returns a list of all tagged objects. - - Any authenticated token may be used to call this API. - parameters: - - 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 - 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: - - **objectRef.id**: *eq, in* - - **objectRef.type**: *eq, in* - - **tagName**: *eq, in* - example: tagName eq "BU_FINANCE" - required: false - responses: - '200': - description: List of all tagged objects. - content: - application/json: - schema: - type: array - items: - type: object - properties: - objectRef: - 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 - - WORKGROUP - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - nullable: true - description: Human-readable display name of the object to which this reference applies - example: William Wilson - tags: - type: array - items: - type: string - description: Labels to be applied to an Object - example: - - BU_FINANCE - - PCI - '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.' + text: The server did not find a current representation for the target resource. + '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: - error: + message: 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.' + example: ' Rate Limit Exceeded ' + '500': + description: Internal Server Error - Returned if there is an unexpected error. content: application/json: schema: @@ -102917,27 +94659,66 @@ paths: 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 + '500': + summary: An example of a 500 response object value: - detailCode: 403 Forbidden + detailCode: 500.0 Internal Fault 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. + text: An internal fault occurred. + delete: + operationId: deleteSource + security: + - UserContextAuth: + - 'idn:sources:manage' + tags: + - Sources + summary: Delete Source by ID + description: |- + This end-point deletes a specific source in IdentityNow. + A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + All of accounts on the source will be removed first, then the source will be deleted. Actual status of task execution can be retrieved via method GET `/task-status/{id}` + parameters: + - in: path + name: id + schema: + type: string + required: true + description: The Source id + example: 2c9180835d191a86015d28455b4a2329 + responses: + '202': + description: Accepted - Returned if the request was successfully accepted into the system. 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. + type: + description: The type of object being referenced + type: string + enum: + - TASK_RESULT + example: TASK_RESULT + id: + type: string + description: ID of the task result + example: 2c91808779ecf55b0179f720942f181a + name: + type: string + description: Human-readable display name of the task result (should be null/empty) + example: null + examples: + deleteSource: + summary: Response returned when deleting a source + value: + type: TASK_RESULT + id: 2c91808779ecf55b0179f720942f181a + name: null + '400': + description: Client Error - Returned if the request body is invalid. content: application/json: schema: @@ -102988,98 +94769,23 @@ paths: - 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: setTagToObject - security: - - UserContextAuth: - - 'idn:tag:manage' - tags: - - Tagged Objects - summary: Add Tag to Object - description: |- - This adds a tag to an object. - - Any authenticated token may be used to call this API. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - objectRef: - 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 - - WORKGROUP - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - nullable: true - description: Human-readable display name of the object to which this reference applies - example: William Wilson - tags: - type: array - items: - type: string - description: Labels to be applied to an Object - example: - - BU_FINANCE - - PCI - responses: - '201': - description: Created. - '400': - description: Client Error - Returned if the request body is invalid. + 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: @@ -103135,18 +94841,18 @@ paths: 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.' + 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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist content: application/json: schema: @@ -103203,15 +94909,15 @@ paths: 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 + '404': + summary: An example of a 404 response object value: - detailCode: 403 Forbidden + detailCode: 404 Not found trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. + text: The server did not find a current representation for the target resource. '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: @@ -103289,147 +94995,109 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/tagged-objects/{type}': + '/sources/{sourceId}/provisioning-policies': get: - operationId: listTaggedObjectsByType - security: - - UserContextAuth: - - 'idn:tag:read' - - 'idn:tag:manage' + operationId: listProvisioningPolicies tags: - - Tagged Objects - summary: List Tagged Objects + - Sources + summary: Lists ProvisioningPolicies description: |- - This API returns a list of all tagged objects by type. - - Any authenticated token may be used to call this API. + This end-point lists all the ProvisioningPolicies in IdentityNow. + A token with API, or ORG_ADMIN authority is required to call this API. + security: + - UserContextAuth: + - 'idn:provisioning-policy:read' + - 'idn:provisioning-policy:manage' parameters: - in: path - name: type - schema: - type: string - enum: - - ROLE - - IDENTITY - - SOD_POLICY + name: sourceId required: true - description: The type of tagged object to retrieve. - example: ROLE - - 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 - 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: - - **objectRef.id**: *eq* - - **objectRef.type**: *eq* - example: objectRef.id eq "2c91808568c529c60168cca6f90c1313" - required: false + description: The Source id + example: 2c9180835d191a86015d28455b4a2329 responses: '200': - description: List of all tagged objects for specified type. + description: List of ProvisioningPolicyDto objects content: application/json: schema: type: array items: type: object + required: + - name properties: - objectRef: - 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 - - WORKGROUP - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - nullable: true - description: Human-readable display name of the object to which this reference applies - example: William Wilson - tags: + name: + type: string + description: the provisioning policy name + example: example provisioning policy for inactive identities + description: + type: string + description: the description of the provisioning policy + example: this provisioning policy creates access based on an identity going inactive + usageType: + type: string + nullable: false + enum: + - CREATE + - UPDATE + - DELETE + - ASSIGN + - UNASSIGN + - CREATE_GROUP + - UPDATE_GROUP + - DELETE_GROUP + - REGISTER + - CREATE_IDENTITY + - UPDATE_IDENTITY + - EDIT_GROUP + - ENABLE + - DISABLE + - UNLOCK + - CHANGE_PASSWORD + example: CREATE + description: The type of ProvisioningPolicy usage. + fields: type: array items: - type: string - description: Labels to be applied to an Object - example: - - BU_FINANCE - - PCI + type: object + properties: + name: + type: string + description: The name of the attribute. + example: userName + transform: + type: object + description: The transform to apply to the field + example: + type: rule + attributes: + name: Create Unique LDAP Attribute + default: {} + attributes: + type: object + description: Attributes required for the transform + example: + template: '${firstname}.${lastname}${uniqueCounter}' + cloudMaxUniqueChecks: '50' + cloudMaxSize: '20' + cloudRequired: 'true' + isRequired: + type: boolean + readOnly: true + description: Flag indicating whether or not the attribute is required. + default: false + example: false + type: + type: string + description: The type of the attribute. + example: string + isMultiValued: + type: boolean + description: Flag indicating whether or not the attribute is multi-valued. + default: false + example: false '400': description: Client Error - Returned if the request body is invalid. content: @@ -103564,6 +95232,73 @@ paths: - locale: en-US localeOrigin: DEFAULT text: The server understood the request but refuses to authorize it. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. '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: @@ -103641,97 +95376,254 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/tagged-objects/{type}/{id}': - get: - operationId: getTaggedObject + post: + operationId: createProvisioningPolicy + tags: + - Sources + summary: Create Provisioning Policy + description: |- + This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. + Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. + Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + A token with ORG_ADMIN authority is required to call this API. security: - UserContextAuth: - - 'idn:tag:read' - - 'idn:tag:manage' - tags: - - Tagged Objects - summary: Get Tagged Object - description: This gets a tagged object for the specified type. + - 'idn:provisioning-policy:manage' parameters: - in: path - name: type - schema: - type: string - enum: - - ROLE - - IDENTITY - - SOD_POLICY + name: sourceId required: true - description: The type of tagged object to retrieve. - example: ROLE - - in: path - name: id schema: type: string - required: true - description: The ID of the object reference to retrieve. - example: ef38f94347e94562b5bb8424a56397d8 + description: The Source id + example: 2c9180835d191a86015d28455b4a2329 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - name + properties: + name: + type: string + description: the provisioning policy name + example: example provisioning policy for inactive identities + description: + type: string + description: the description of the provisioning policy + example: this provisioning policy creates access based on an identity going inactive + usageType: + type: string + nullable: false + enum: + - CREATE + - UPDATE + - DELETE + - ASSIGN + - UNASSIGN + - CREATE_GROUP + - UPDATE_GROUP + - DELETE_GROUP + - REGISTER + - CREATE_IDENTITY + - UPDATE_IDENTITY + - EDIT_GROUP + - ENABLE + - DISABLE + - UNLOCK + - CHANGE_PASSWORD + example: CREATE + description: The type of ProvisioningPolicy usage. + fields: + type: array + items: + type: object + properties: + name: + type: string + description: The name of the attribute. + example: userName + transform: + type: object + description: The transform to apply to the field + example: + type: rule + attributes: + name: Create Unique LDAP Attribute + default: {} + attributes: + type: object + description: Attributes required for the transform + example: + template: '${firstname}.${lastname}${uniqueCounter}' + cloudMaxUniqueChecks: '50' + cloudMaxSize: '20' + cloudRequired: 'true' + isRequired: + type: boolean + readOnly: true + description: Flag indicating whether or not the attribute is required. + default: false + example: false + type: + type: string + description: The type of the attribute. + example: string + isMultiValued: + type: boolean + description: Flag indicating whether or not the attribute is multi-valued. + default: false + example: false + examples: + Create Account Provisioning Policy: + value: + name: Account + description: Account Provisioning Policy + usageType: CREATE + fields: + - name: displayName + transform: + type: identityAttribute + attributes: + name: displayName + attributes: {} + isRequired: false + type: string + isMultiValued: false + - name: distinguishedName + transform: + type: usernameGenerator + attributes: + sourceCheck: true + patterns: + - 'CN=$fi $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - 'CN=$fti $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - 'CN=$fn $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - 'CN=$fn$ln${uniqueCounter},OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + fn: + type: identityAttribute + attributes: + name: firstname + ln: + type: identityAttribute + attributes: + name: lastname + fi: + type: substring + attributes: + input: + type: identityAttribute + attributes: + name: firstname + begin: 0 + end: 1 + fti: + type: substring + attributes: + input: + type: identityAttribute + attributes: + name: firstname + begin: 0 + end: 2 + attributes: + cloudMaxUniqueChecks: '5' + cloudMaxSize: '100' + cloudRequired: 'true' + isRequired: false + type: '' + isMultiValued: false + - name: description + transform: + type: static + attributes: + value: '' + attributes: {} + isRequired: false + type: string + isMultiValued: false responses: - '200': - description: Tagged object by type and ID. + '201': + description: Created ProvisioningPolicyDto object content: application/json: schema: type: object + required: + - name properties: - objectRef: - 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 - - WORKGROUP - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - nullable: true - description: Human-readable display name of the object to which this reference applies - example: William Wilson - tags: + name: + type: string + description: the provisioning policy name + example: example provisioning policy for inactive identities + description: + type: string + description: the description of the provisioning policy + example: this provisioning policy creates access based on an identity going inactive + usageType: + type: string + nullable: false + enum: + - CREATE + - UPDATE + - DELETE + - ASSIGN + - UNASSIGN + - CREATE_GROUP + - UPDATE_GROUP + - DELETE_GROUP + - REGISTER + - CREATE_IDENTITY + - UPDATE_IDENTITY + - EDIT_GROUP + - ENABLE + - DISABLE + - UNLOCK + - CHANGE_PASSWORD + example: CREATE + description: The type of ProvisioningPolicy usage. + fields: type: array items: - type: string - description: Labels to be applied to an Object - example: - - BU_FINANCE - - PCI + type: object + properties: + name: + type: string + description: The name of the attribute. + example: userName + transform: + type: object + description: The transform to apply to the field + example: + type: rule + attributes: + name: Create Unique LDAP Attribute + default: {} + attributes: + type: object + description: Attributes required for the transform + example: + template: '${firstname}.${lastname}${uniqueCounter}' + cloudMaxUniqueChecks: '50' + cloudMaxSize: '20' + cloudRequired: 'true' + isRequired: + type: boolean + readOnly: true + description: Flag indicating whether or not the attribute is required. + default: false + example: false + type: + type: string + description: The type of the attribute. + example: string + isMultiValued: + type: boolean + description: Flag indicating whether or not the attribute is multi-valued. + default: false + example: false '400': description: Client Error - Returned if the request body is invalid. content: @@ -103866,18 +95758,8 @@ paths: - 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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist content: application/json: schema: @@ -103934,233 +95816,27 @@ paths: 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 + '404': + summary: An example of a 404 response object value: - detailCode: 500.0 Internal Fault + detailCode: 404 Not found trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: An internal fault occurred. - put: - operationId: putTaggedObject - security: - - UserContextAuth: - - 'idn:tag:manage' - tags: - - Tagged Objects - summary: Update Tagged Object - description: This updates a tagged object for the specified type. - parameters: - - in: path - name: type - schema: - type: string - enum: - - ROLE - - IDENTITY - - SOD_POLICY - required: true - description: The type of tagged object to update. - example: ROLE - - in: path - name: id - schema: - type: string - required: true - description: The ID of the object reference to update. - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - objectRef: - 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 - - WORKGROUP - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - nullable: true - description: Human-readable display name of the object to which this reference applies - example: William Wilson - tags: - type: array - items: - type: string - description: Labels to be applied to an Object - example: - - BU_FINANCE - - PCI - responses: - '200': - description: Tagged object by type and ID. - content: - application/json: - schema: - type: object - properties: - objectRef: - 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 - - WORKGROUP - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - nullable: true - description: Human-readable display name of the object to which this reference applies - example: William Wilson - tags: - type: array - items: - type: string - description: Labels to be applied to an Object - example: - - BU_FINANCE - - PCI - '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.' + text: The server did not find a current representation for the target resource. + '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: - error: + message: 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.' + example: ' Rate Limit Exceeded ' + '500': + description: Internal Server Error - Returned if there is an unexpected error. content: application/json: schema: @@ -104217,123 +95893,145 @@ paths: 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 + '500': + summary: An example of a 500 response object value: - detailCode: 403 Forbidden + detailCode: 500.0 Internal Fault 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. + text: An internal fault occurred. + '/sources/{sourceId}/provisioning-policies/{usageType}': + get: + operationId: getProvisioningPolicy + tags: + - Sources + summary: Get Provisioning Policy by UsageType + description: |- + This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. + A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + security: + - UserContextAuth: + - 'idn:provisioning-policy:read' + - 'idn:provisioning-policy-source:read' + - 'idn:provisioning-policy:manage' + - 'idn:provisioning-policy-source-admin-operations:manage' + parameters: + - in: path + name: sourceId + required: true + schema: + type: string + description: The Source ID. + example: 2c9180835d191a86015d28455b4a2329 + - in: path + name: usageType + required: true + schema: + type: string + nullable: false + enum: + - CREATE + - UPDATE + - DELETE + - ASSIGN + - UNASSIGN + - CREATE_GROUP + - UPDATE_GROUP + - DELETE_GROUP + - REGISTER + - CREATE_IDENTITY + - UPDATE_IDENTITY + - EDIT_GROUP + - ENABLE + - DISABLE + - UNLOCK + - CHANGE_PASSWORD + example: CREATE + description: The type of ProvisioningPolicy usage. + description: The type of ProvisioningPolicy usage. + example: REGISTER + responses: + '200': + description: The requested ProvisioningPolicyDto was successfully retrieved. content: application/json: schema: type: object + required: + - name properties: - detailCode: + name: type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: + description: the provisioning policy name + example: example provisioning policy for inactive identities + description: 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: + description: the description of the provisioning policy + example: this provisioning policy creates access based on an identity going inactive + usageType: + type: string + nullable: false + enum: + - CREATE + - UPDATE + - DELETE + - ASSIGN + - UNASSIGN + - CREATE_GROUP + - UPDATE_GROUP + - DELETE_GROUP + - REGISTER + - CREATE_IDENTITY + - UPDATE_IDENTITY + - EDIT_GROUP + - ENABLE + - DISABLE + - UNLOCK + - CHANGE_PASSWORD + example: CREATE + description: The type of ProvisioningPolicy usage. + fields: 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: + name: 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: + description: The name of the attribute. + example: userName + transform: + type: object + description: The transform to apply to the field + example: + type: rule + attributes: + name: Create Unique LDAP Attribute + default: {} + attributes: + type: object + description: Attributes required for the transform + example: + template: '${firstname}.${lastname}${uniqueCounter}' + cloudMaxUniqueChecks: '50' + cloudMaxSize: '20' + cloudRequired: 'true' + isRequired: + type: boolean + readOnly: true + description: Flag indicating whether or not the attribute is required. + default: false + example: false + type: 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. - delete: - operationId: deleteTaggedObject - security: - - UserContextAuth: - - 'idn:tag:manage' - tags: - - Tagged Objects - summary: Delete Tagged Object - description: This deletes a tagged object for the specified type. - parameters: - - in: path - name: type - schema: - type: string - enum: - - ROLE - - IDENTITY - - SOD_POLICY - required: true - description: The type of tagged object to delete. - example: ROLE - - in: path - name: id - schema: - type: string - required: true - description: The ID of the object reference to delete. - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '204': - description: No content. + description: The type of the attribute. + example: string + isMultiValued: + type: boolean + description: Flag indicating whether or not the attribute is multi-valued. + default: false + example: false '400': description: Client Error - Returned if the request body is invalid. content: @@ -104468,18 +96166,8 @@ paths: - 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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist content: application/json: schema: @@ -104536,245 +96224,27 @@ paths: 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 + '404': + summary: An example of a 404 response object value: - detailCode: 500.0 Internal Fault + detailCode: 404 Not found trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: An internal fault occurred. - /tagged-objects/bulk-add: - post: - operationId: setTagsToManyObjects - security: - - UserContextAuth: - - 'idn:tag:manage' - tags: - - Tagged Objects - summary: Tag Multiple Objects - description: |- - This API adds tags to multiple objects. - - A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - requestBody: - required: true - description: 'Supported object types are ROLE, IDENTITY and SOD_POLICY.' - content: - application/json: - schema: - type: object - properties: - objectRefs: - type: array - items: - 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 - - WORKGROUP - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - nullable: true - description: Human-readable display name of the object to which this reference applies - example: William Wilson - tags: - type: array - items: - type: string - description: Label to be applied to an Object - example: - - BU_FINANCE - - PCI - operation: - type: string - enum: - - APPEND - - MERGE - default: APPEND - description: |- - If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. - - If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. - example: MERGE - responses: - '200': - description: Request succeeded. - content: - application/json: - schema: - type: object - properties: - objectRefs: - type: array - items: - 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 - - WORKGROUP - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - nullable: true - description: Human-readable display name of the object to which this reference applies - example: William Wilson - tags: - type: array - items: - type: string - description: Label to be applied to an Object - example: - - BU_FINANCE - - PCI - operation: - type: string - enum: - - APPEND - - MERGE - default: APPEND - description: |- - If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. - - If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. - example: MERGE - '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.' + text: The server did not find a current representation for the target resource. + '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: - error: + message: 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.' + example: ' Rate Limit Exceeded ' + '500': + description: Internal Server Error - Returned if there is an unexpected error. content: application/json: schema: @@ -104831,27 +96301,224 @@ paths: 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 + '500': + summary: An example of a 500 response object value: - detailCode: 403 Forbidden + detailCode: 500.0 Internal Fault 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. + text: An internal fault occurred. + put: + operationId: putProvisioningPolicy + tags: + - Sources + summary: Update Provisioning Policy by UsageType + description: |- + This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. + Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. + Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + security: + - UserContextAuth: + - 'idn:provisioning-policy:manage' + - 'idn:provisioning-policy-source-admin-operations:manage' + parameters: + - in: path + name: sourceId + required: true + schema: + type: string + description: The Source ID. + example: 2c9180835d191a86015d28455b4a2329 + - in: path + name: usageType + required: true + schema: + type: string + nullable: false + enum: + - CREATE + - UPDATE + - DELETE + - ASSIGN + - UNASSIGN + - CREATE_GROUP + - UPDATE_GROUP + - DELETE_GROUP + - REGISTER + - CREATE_IDENTITY + - UPDATE_IDENTITY + - EDIT_GROUP + - ENABLE + - DISABLE + - UNLOCK + - CHANGE_PASSWORD + example: CREATE + description: The type of ProvisioningPolicy usage. + description: The type of ProvisioningPolicy usage. + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - name + properties: + name: + type: string + description: the provisioning policy name + example: example provisioning policy for inactive identities + description: + type: string + description: the description of the provisioning policy + example: this provisioning policy creates access based on an identity going inactive + usageType: + type: string + nullable: false + enum: + - CREATE + - UPDATE + - DELETE + - ASSIGN + - UNASSIGN + - CREATE_GROUP + - UPDATE_GROUP + - DELETE_GROUP + - REGISTER + - CREATE_IDENTITY + - UPDATE_IDENTITY + - EDIT_GROUP + - ENABLE + - DISABLE + - UNLOCK + - CHANGE_PASSWORD + example: CREATE + description: The type of ProvisioningPolicy usage. + fields: + type: array + items: + type: object + properties: + name: + type: string + description: The name of the attribute. + example: userName + transform: + type: object + description: The transform to apply to the field + example: + type: rule + attributes: + name: Create Unique LDAP Attribute + default: {} + attributes: + type: object + description: Attributes required for the transform + example: + template: '${firstname}.${lastname}${uniqueCounter}' + cloudMaxUniqueChecks: '50' + cloudMaxSize: '20' + cloudRequired: 'true' + isRequired: + type: boolean + readOnly: true + description: Flag indicating whether or not the attribute is required. + default: false + example: false + type: + type: string + description: The type of the attribute. + example: string + isMultiValued: + type: boolean + description: Flag indicating whether or not the attribute is multi-valued. + default: false + example: false + responses: + '200': + description: The ProvisioningPolicyDto was successfully replaced. content: application/json: schema: type: object + required: + - name properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. + name: + type: string + description: the provisioning policy name + example: example provisioning policy for inactive identities + description: + type: string + description: the description of the provisioning policy + example: this provisioning policy creates access based on an identity going inactive + usageType: + type: string + nullable: false + enum: + - CREATE + - UPDATE + - DELETE + - ASSIGN + - UNASSIGN + - CREATE_GROUP + - UPDATE_GROUP + - DELETE_GROUP + - REGISTER + - CREATE_IDENTITY + - UPDATE_IDENTITY + - EDIT_GROUP + - ENABLE + - DISABLE + - UNLOCK + - CHANGE_PASSWORD + example: CREATE + description: The type of ProvisioningPolicy usage. + fields: + type: array + items: + type: object + properties: + name: + type: string + description: The name of the attribute. + example: userName + transform: + type: object + description: The transform to apply to the field + example: + type: rule + attributes: + name: Create Unique LDAP Attribute + default: {} + attributes: + type: object + description: Attributes required for the transform + example: + template: '${firstname}.${lastname}${uniqueCounter}' + cloudMaxUniqueChecks: '50' + cloudMaxSize: '20' + cloudRequired: 'true' + isRequired: + type: boolean + readOnly: true + description: Flag indicating whether or not the attribute is required. + default: false + example: false + type: + type: string + description: The type of the attribute. + example: string + isMultiValued: + type: boolean + description: Flag indicating whether or not the attribute is multi-valued. + default: false + example: false + '400': + description: Client Error - Returned if the request body is invalid. content: application/json: schema: @@ -104907,108 +96574,18 @@ paths: 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. - /tagged-objects/bulk-remove: - post: - operationId: deleteTagsToManyObject - security: - - UserContextAuth: - - 'idn:tag:manage' - tags: - - Tagged Objects - summary: Remove Tags from Multiple Objects - description: |- - This API removes tags from multiple objects. - - A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - requestBody: - description: 'Supported object types are ROLE, IDENTITY and SOD_POLICY.' - required: true - content: - application/json: - schema: - type: object - properties: - objectRefs: - type: array - items: - 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 - - WORKGROUP - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - nullable: true - description: Human-readable display name of the object to which this reference applies - example: William Wilson - tags: - type: array - items: - type: string - description: Label to be applied to an Object - example: - - BU_FINANCE - - PCI - operation: - type: string - enum: - - APPEND - - MERGE - default: APPEND - description: |- - If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. - - If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. - example: MERGE - responses: - '204': - description: No content - indicates the request was successful but there is no content to be returned in the response. - '400': - description: Client Error - Returned if the request body is 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: @@ -105064,18 +96641,18 @@ paths: 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.' + 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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist content: application/json: schema: @@ -105132,15 +96709,15 @@ paths: 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 + '404': + summary: An example of a 404 response object value: - detailCode: 403 Forbidden + detailCode: 404 Not found trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. + text: The server did not find a current representation for the target resource. '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: @@ -105218,1490 +96795,7238 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - /transforms: - get: + patch: + operationId: updateProvisioningPolicy tags: - - Transforms - summary: List transforms + - Sources + summary: Partial update of Provisioning Policy description: |- - Gets a list of all saved transform objects. - A token with transforms-list read authority is required to call this API. - operationId: listTransforms + This API selectively updates an existing Provisioning Policy using a JSONPatch payload. + Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. + Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + security: + - UserContextAuth: + - 'idn:provisioning-policy:update' parameters: - - 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: 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: 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 - - name: name - in: query - description: Name of the transform to retrieve from the list. - required: false - style: form + - in: path + name: sourceId + required: true schema: type: string - example: ExampleTransformName123 - - name: filters - in: query - 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: - **internal**: *eq* - **name**: *eq*, *sw* - required: false - style: form - explode: true - example: name eq "Uppercase" + description: The Source id. + example: 2c9180835d191a86015d28455b4a2329 + - in: path + name: usageType + required: true schema: type: string - responses: - '200': - description: A list of transforms matching the given criteria. - content: - application/json: - schema: - type: array - items: - type: object - description: The representation of an internally- or customer-defined transform. - required: - - name - - type - - attributes - properties: - id: - type: string - readOnly: true - description: Unique ID of this transform - example: 2cd78adghjkja34jh2b1hkjhasuecd - name: - type: string - description: Unique name of this transform - example: Timestamp To Date - minLength: 1 - maxLength: 50 - type: - type: string - description: The type of transform operation - enum: - - accountAttribute - - base64Decode - - base64Encode - - concat - - conditional - - dateCompare - - dateFormat - - dateMath - - decomposeDiacriticalMarks - - e164phone - - firstValid - - rule - - identityAttribute - - indexOf - - iso3166 - - lastIndexOf - - leftPad - - lookup - - lower - - normalizeNames - - randomAlphaNumeric - - randomNumeric - - reference - - replaceAll - - replace - - rightPad - - split - - static - - substring - - trim - - upper - - usernameGenerator - - uuid - example: dateFormat - externalDocs: - description: Transform Operations - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations' - attributes: - description: Meta-data about the transform. Values in this list are specific to the type of transform to be executed. - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: base64Decode - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: base64Encode - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: concat - type: object - required: - - values - properties: - values: - type: array - items: - type: object - description: An array of items to join together - example: - - John - - ' ' - - Smith - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: conditional + nullable: false + enum: + - CREATE + - UPDATE + - DELETE + - ASSIGN + - UNASSIGN + - CREATE_GROUP + - UPDATE_GROUP + - DELETE_GROUP + - REGISTER + - CREATE_IDENTITY + - UPDATE_IDENTITY + - EDIT_GROUP + - ENABLE + - DISABLE + - UNLOCK + - CHANGE_PASSWORD + example: CREATE + description: The type of ProvisioningPolicy usage. + description: The type of ProvisioningPolicy usage. + requestBody: + required: true + description: The JSONPatch payload used to update the schema. + content: + application/json-patch+json: + schema: + type: array + items: + type: object + description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' + required: + - op + - path + properties: + op: + type: string + description: The operation to be performed + enum: + - add + - remove + - replace + - move + - copy + - test + example: replace + path: + type: string + description: A string JSON Pointer representing the target path to an element to be affected by the operation + example: /description + value: + anyOf: + - type: string + - type: integer + - type: object + - type: array + items: + anyOf: + - type: string + - type: integer + - type: object + description: 'The value to be used for the operation, required for "add" and "replace" operations' + example: New description + examples: + add-field: + summary: Add a field to the beginning of the list + value: + - op: add + path: /fields/0 + value: + name: email + transform: + type: identityAttribute + attributes: + name: email + attributes: {} + isRequired: false + type: string + isMultiValued: false + responses: + '200': + description: The ProvisioningPolicyDto was successfully updated. + content: + application/json: + schema: + type: object + required: + - name + properties: + name: + type: string + description: the provisioning policy name + example: example provisioning policy for inactive identities + description: + type: string + description: the description of the provisioning policy + example: this provisioning policy creates access based on an identity going inactive + usageType: + type: string + nullable: false + enum: + - CREATE + - UPDATE + - DELETE + - ASSIGN + - UNASSIGN + - CREATE_GROUP + - UPDATE_GROUP + - DELETE_GROUP + - REGISTER + - CREATE_IDENTITY + - UPDATE_IDENTITY + - EDIT_GROUP + - ENABLE + - DISABLE + - UNLOCK + - CHANGE_PASSWORD + example: CREATE + description: The type of ProvisioningPolicy usage. + fields: + type: array + items: + type: object + properties: + name: + type: string + description: The name of the attribute. + example: userName + transform: type: object - required: - - expression - - positiveCondition - - negativeCondition - properties: - expression: - type: string - description: |- - A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. - - The `eq` operator is the only valid comparison - example: ValueA eq ValueB - positiveCondition: - type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: - type: string - description: The output of the transform if the expression evalutes to false - example: 'false' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateCompare + description: The transform to apply to the field + example: + type: rule + attributes: + name: Create Unique LDAP Attribute + default: {} + attributes: type: object - required: - - firstDate - - secondDate - - operator - - positiveCondition - - negativeCondition - properties: - firstDate: - description: This is the first date to consider (The date that would be on the left hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - secondDate: - description: This is the second date to consider (The date that would be on the right hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - operator: + description: Attributes required for the transform + example: + template: '${firstname}.${lastname}${uniqueCounter}' + cloudMaxUniqueChecks: '50' + cloudMaxSize: '20' + cloudRequired: 'true' + isRequired: + type: boolean + readOnly: true + description: Flag indicating whether or not the attribute is required. + default: false + example: false + type: + type: string + description: The type of the attribute. + example: string + isMultiValued: + type: boolean + description: Flag indicating whether or not the attribute is multi-valued. + default: false + example: 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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + delete: + operationId: deleteProvisioningPolicy + tags: + - Sources + summary: Delete Provisioning Policy by UsageType + description: |- + Deletes the provisioning policy with the specified usage on an application. + A token with API, or ORG_ADMIN authority is required to call this API. + security: + - UserContextAuth: + - 'idn:provisioning-policy:manage' + parameters: + - in: path + name: sourceId + required: true + schema: + type: string + description: The Source ID. + example: 2c9180835d191a86015d28455b4a2329 + - in: path + name: usageType + required: true + schema: + type: string + nullable: false + enum: + - CREATE + - UPDATE + - DELETE + - ASSIGN + - UNASSIGN + - CREATE_GROUP + - UPDATE_GROUP + - DELETE_GROUP + - REGISTER + - CREATE_IDENTITY + - UPDATE_IDENTITY + - EDIT_GROUP + - ENABLE + - DISABLE + - UNLOCK + - CHANGE_PASSWORD + example: CREATE + description: The type of ProvisioningPolicy usage. + description: The type of ProvisioningPolicy usage. + responses: + '204': + description: The ProvisioningPolicyDto was successfully deleted. + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + '/sources/{sourceId}/provisioning-policies/bulk-update': + post: + operationId: updateProvisioningPoliciesInBulk + tags: + - Sources + summary: Bulk Update Provisioning Policies + description: |- + This end-point updates a list of provisioning policies on the specified source in IdentityNow. + A token with API, or ORG_ADMIN authority is required to call this API. + security: + - UserContextAuth: + - 'idn:provisioning-policy:manage' + parameters: + - in: path + name: sourceId + required: true + schema: + type: string + description: The Source id. + example: 2c9180835d191a86015d28455b4a2329 + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + type: object + required: + - name + properties: + name: + type: string + description: the provisioning policy name + example: example provisioning policy for inactive identities + description: + type: string + description: the description of the provisioning policy + example: this provisioning policy creates access based on an identity going inactive + usageType: + type: string + nullable: false + enum: + - CREATE + - UPDATE + - DELETE + - ASSIGN + - UNASSIGN + - CREATE_GROUP + - UPDATE_GROUP + - DELETE_GROUP + - REGISTER + - CREATE_IDENTITY + - UPDATE_IDENTITY + - EDIT_GROUP + - ENABLE + - DISABLE + - UNLOCK + - CHANGE_PASSWORD + example: CREATE + description: The type of ProvisioningPolicy usage. + fields: + type: array + items: + type: object + properties: + name: + type: string + description: The name of the attribute. + example: userName + transform: + type: object + description: The transform to apply to the field + example: + type: rule + attributes: + name: Create Unique LDAP Attribute + default: {} + attributes: + type: object + description: Attributes required for the transform + example: + template: '${firstname}.${lastname}${uniqueCounter}' + cloudMaxUniqueChecks: '50' + cloudMaxSize: '20' + cloudRequired: 'true' + isRequired: + type: boolean + readOnly: true + description: Flag indicating whether or not the attribute is required. + default: false + example: false + type: + type: string + description: The type of the attribute. + example: string + isMultiValued: + type: boolean + description: Flag indicating whether or not the attribute is multi-valued. + default: false + example: false + responses: + '200': + description: A list of the ProvisioningPolicyDto was successfully replaced. + content: + application/json: + schema: + type: array + items: + type: object + required: + - name + properties: + name: + type: string + description: the provisioning policy name + example: example provisioning policy for inactive identities + description: + type: string + description: the description of the provisioning policy + example: this provisioning policy creates access based on an identity going inactive + usageType: + type: string + nullable: false + enum: + - CREATE + - UPDATE + - DELETE + - ASSIGN + - UNASSIGN + - CREATE_GROUP + - UPDATE_GROUP + - DELETE_GROUP + - REGISTER + - CREATE_IDENTITY + - UPDATE_IDENTITY + - EDIT_GROUP + - ENABLE + - DISABLE + - UNLOCK + - CHANGE_PASSWORD + example: CREATE + description: The type of ProvisioningPolicy usage. + fields: + type: array + items: + type: object + properties: + name: + type: string + description: The name of the attribute. + example: userName + transform: + type: object + description: The transform to apply to the field + example: + type: rule + attributes: + name: Create Unique LDAP Attribute + default: {} + attributes: + type: object + description: Attributes required for the transform + example: + template: '${firstname}.${lastname}${uniqueCounter}' + cloudMaxUniqueChecks: '50' + cloudMaxSize: '20' + cloudRequired: 'true' + isRequired: + type: boolean + readOnly: true + description: Flag indicating whether or not the attribute is required. + default: false + example: false + type: + type: string + description: The type of the attribute. + example: string + isMultiValued: + type: boolean + description: Flag indicating whether or not the attribute is multi-valued. + default: false + example: 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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + '/sources/{sourceId}/schemas': + get: + operationId: listSourceSchemas + tags: + - Sources + summary: List Schemas on a Source + description: | + Lists the Schemas that exist on the specified Source in IdentityNow. + parameters: + - in: path + name: sourceId + required: true + schema: + type: string + description: The Source ID. + example: 2c9180835d191a86015d28455b4a2329 + - in: query + name: include-types + required: false + schema: + type: string + description: 'If set to ''group'', then the account schema is filtered and only group schemas are returned. Only a value of ''group'' is recognized.' + example: group + responses: + '200': + description: The Schemas were successfully retrieved. + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: string + description: The id of the Schema. + example: 2c9180835d191a86015d28455b4a2329 + name: + type: string + description: The name of the Schema. + example: account + nativeObjectType: + type: string + description: The name of the object type on the native system that the schema represents. + example: User + identityAttribute: + type: string + description: The name of the attribute used to calculate the unique identifier for an object in the schema. + example: sAMAccountName + displayAttribute: + type: string + description: The name of the attribute used to calculate the display value for an object in the schema. + example: distinguishedName + hierarchyAttribute: + type: string + description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. + example: memberOf + includePermissions: + type: boolean + description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. + example: false + features: + type: array + items: + type: string + enum: + - AUTHENTICATE + - COMPOSITE + - DIRECT_PERMISSIONS + - DISCOVER_SCHEMA + - ENABLE + - MANAGER_LOOKUP + - NO_RANDOM_ACCESS + - PROXY + - SEARCH + - TEMPLATE + - UNLOCK + - UNSTRUCTURED_TARGETS + - SHAREPOINT_TARGET + - PROVISIONING + - GROUP_PROVISIONING + - SYNC_PROVISIONING + - PASSWORD + - CURRENT_PASSWORD + - ACCOUNT_ONLY_REQUEST + - ADDITIONAL_ACCOUNT_REQUEST + - NO_AGGREGATION + - GROUPS_HAVE_MEMBERS + - NO_PERMISSIONS_PROVISIONING + - NO_GROUP_PERMISSIONS_PROVISIONING + - NO_UNSTRUCTURED_TARGETS_PROVISIONING + - NO_DIRECT_PERMISSIONS_PROVISIONING + description: |- + Optional features that can be supported by an source. + * AUTHENTICATE: The source supports pass-through authentication. + * COMPOSITE: The source supports composite source creation. + * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. + * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. + * ENABLE The source supports reading if an account is enabled or disabled. + * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. + * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. + * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. + * SEARCH + * TEMPLATE + * UNLOCK: The source supports reading if an account is locked or unlocked. + * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. + * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. + * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. + * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. + * SYNC_PROVISIONING: The source can provision accounts synchronously. + * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. + * CURRENT_PASSWORD: Some source types support verification of the current password + * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. + * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. + * NO_AGGREGATION: A source that does not support aggregation. + * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. + * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. + * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. + * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + example: AUTHENTICATE + description: The features that the schema supports. + example: + - PROVISIONING + - NO_PERMISSIONS_PROVISIONING + - GROUPS_HAVE_MEMBERS + configuration: + type: object + description: Holds any extra configuration data that the schema may require. + example: + groupMemberAttribute: member + attributes: + type: array + description: The attribute definitions which form the schema. + items: + type: object + properties: + name: + type: string + description: The name of the attribute. + example: sAMAccountName + type: + description: The type of the attribute. + example: STRING + type: string + enum: + - STRING + - LONG + - INT + - BOOLEAN + schema: + description: A reference to the schema on the source to the attribute values map to. + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - CONNECTOR_SCHEMA + example: CONNECTOR_SCHEMA + id: + type: string + description: The object ID this reference applies to. + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: The human-readable display name of the object. + example: group + description: + type: string + description: A human-readable description of the attribute. + example: SAM Account Name + isMultiValued: + type: boolean + description: Flag indicating whether or not the attribute is multi-valued. + example: false + isEntitlement: + type: boolean + description: Flag indicating whether or not the attribute is an entitlement. + example: false + isGroup: + type: boolean + description: | + Flag indicating whether or not the attribute represents a group. + This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. + example: false + example: + - name: sAMAccountName + type: STRING + isMultiValued: false + isEntitlement: false + isGroup: false + - name: memberOf + type: STRING + schema: + type: CONNECTOR_SCHEMA + id: 2c9180887671ff8c01767b4671fc7d60 + name: group + description: Group membership + isMultiValued: true + isEntitlement: true + isGroup: true + created: + type: string + description: The date the Schema was created. + format: date-time + example: '2019-12-24T22:32:58.104Z' + modified: + type: string + description: The date the Schema was last modified. + format: date-time + example: '2019-12-31T20:22:28.104Z' + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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: createSourceSchema + tags: + - Sources + summary: Create Schema on a Source + description: | + Creates a new Schema on the specified Source in IdentityNow. + parameters: + - in: path + name: sourceId + required: true + schema: + type: string + description: The Source id. + example: 2c9180835d191a86015d28455b4a2329 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: The id of the Schema. + example: 2c9180835d191a86015d28455b4a2329 + name: + type: string + description: The name of the Schema. + example: account + nativeObjectType: + type: string + description: The name of the object type on the native system that the schema represents. + example: User + identityAttribute: + type: string + description: The name of the attribute used to calculate the unique identifier for an object in the schema. + example: sAMAccountName + displayAttribute: + type: string + description: The name of the attribute used to calculate the display value for an object in the schema. + example: distinguishedName + hierarchyAttribute: + type: string + description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. + example: memberOf + includePermissions: + type: boolean + description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. + example: false + features: + type: array + items: + type: string + enum: + - AUTHENTICATE + - COMPOSITE + - DIRECT_PERMISSIONS + - DISCOVER_SCHEMA + - ENABLE + - MANAGER_LOOKUP + - NO_RANDOM_ACCESS + - PROXY + - SEARCH + - TEMPLATE + - UNLOCK + - UNSTRUCTURED_TARGETS + - SHAREPOINT_TARGET + - PROVISIONING + - GROUP_PROVISIONING + - SYNC_PROVISIONING + - PASSWORD + - CURRENT_PASSWORD + - ACCOUNT_ONLY_REQUEST + - ADDITIONAL_ACCOUNT_REQUEST + - NO_AGGREGATION + - GROUPS_HAVE_MEMBERS + - NO_PERMISSIONS_PROVISIONING + - NO_GROUP_PERMISSIONS_PROVISIONING + - NO_UNSTRUCTURED_TARGETS_PROVISIONING + - NO_DIRECT_PERMISSIONS_PROVISIONING + description: |- + Optional features that can be supported by an source. + * AUTHENTICATE: The source supports pass-through authentication. + * COMPOSITE: The source supports composite source creation. + * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. + * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. + * ENABLE The source supports reading if an account is enabled or disabled. + * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. + * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. + * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. + * SEARCH + * TEMPLATE + * UNLOCK: The source supports reading if an account is locked or unlocked. + * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. + * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. + * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. + * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. + * SYNC_PROVISIONING: The source can provision accounts synchronously. + * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. + * CURRENT_PASSWORD: Some source types support verification of the current password + * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. + * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. + * NO_AGGREGATION: A source that does not support aggregation. + * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. + * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. + * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. + * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + example: AUTHENTICATE + description: The features that the schema supports. + example: + - PROVISIONING + - NO_PERMISSIONS_PROVISIONING + - GROUPS_HAVE_MEMBERS + configuration: + type: object + description: Holds any extra configuration data that the schema may require. + example: + groupMemberAttribute: member + attributes: + type: array + description: The attribute definitions which form the schema. + items: + type: object + properties: + name: + type: string + description: The name of the attribute. + example: sAMAccountName + type: + description: The type of the attribute. + example: STRING + type: string + enum: + - STRING + - LONG + - INT + - BOOLEAN + schema: + description: A reference to the schema on the source to the attribute values map to. + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - CONNECTOR_SCHEMA + example: CONNECTOR_SCHEMA + id: + type: string + description: The object ID this reference applies to. + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: The human-readable display name of the object. + example: group + description: + type: string + description: A human-readable description of the attribute. + example: SAM Account Name + isMultiValued: + type: boolean + description: Flag indicating whether or not the attribute is multi-valued. + example: false + isEntitlement: + type: boolean + description: Flag indicating whether or not the attribute is an entitlement. + example: false + isGroup: + type: boolean + description: | + Flag indicating whether or not the attribute represents a group. + This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. + example: false + example: + - name: sAMAccountName + type: STRING + isMultiValued: false + isEntitlement: false + isGroup: false + - name: memberOf + type: STRING + schema: + type: CONNECTOR_SCHEMA + id: 2c9180887671ff8c01767b4671fc7d60 + name: group + description: Group membership + isMultiValued: true + isEntitlement: true + isGroup: true + created: + type: string + description: The date the Schema was created. + format: date-time + example: '2019-12-24T22:32:58.104Z' + modified: + type: string + description: The date the Schema was last modified. + format: date-time + example: '2019-12-31T20:22:28.104Z' + responses: + '201': + description: The Schema was successfully created on the specified Source. + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: The id of the Schema. + example: 2c9180835d191a86015d28455b4a2329 + name: + type: string + description: The name of the Schema. + example: account + nativeObjectType: + type: string + description: The name of the object type on the native system that the schema represents. + example: User + identityAttribute: + type: string + description: The name of the attribute used to calculate the unique identifier for an object in the schema. + example: sAMAccountName + displayAttribute: + type: string + description: The name of the attribute used to calculate the display value for an object in the schema. + example: distinguishedName + hierarchyAttribute: + type: string + description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. + example: memberOf + includePermissions: + type: boolean + description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. + example: false + features: + type: array + items: + type: string + enum: + - AUTHENTICATE + - COMPOSITE + - DIRECT_PERMISSIONS + - DISCOVER_SCHEMA + - ENABLE + - MANAGER_LOOKUP + - NO_RANDOM_ACCESS + - PROXY + - SEARCH + - TEMPLATE + - UNLOCK + - UNSTRUCTURED_TARGETS + - SHAREPOINT_TARGET + - PROVISIONING + - GROUP_PROVISIONING + - SYNC_PROVISIONING + - PASSWORD + - CURRENT_PASSWORD + - ACCOUNT_ONLY_REQUEST + - ADDITIONAL_ACCOUNT_REQUEST + - NO_AGGREGATION + - GROUPS_HAVE_MEMBERS + - NO_PERMISSIONS_PROVISIONING + - NO_GROUP_PERMISSIONS_PROVISIONING + - NO_UNSTRUCTURED_TARGETS_PROVISIONING + - NO_DIRECT_PERMISSIONS_PROVISIONING + description: |- + Optional features that can be supported by an source. + * AUTHENTICATE: The source supports pass-through authentication. + * COMPOSITE: The source supports composite source creation. + * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. + * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. + * ENABLE The source supports reading if an account is enabled or disabled. + * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. + * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. + * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. + * SEARCH + * TEMPLATE + * UNLOCK: The source supports reading if an account is locked or unlocked. + * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. + * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. + * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. + * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. + * SYNC_PROVISIONING: The source can provision accounts synchronously. + * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. + * CURRENT_PASSWORD: Some source types support verification of the current password + * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. + * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. + * NO_AGGREGATION: A source that does not support aggregation. + * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. + * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. + * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. + * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + example: AUTHENTICATE + description: The features that the schema supports. + example: + - PROVISIONING + - NO_PERMISSIONS_PROVISIONING + - GROUPS_HAVE_MEMBERS + configuration: + type: object + description: Holds any extra configuration data that the schema may require. + example: + groupMemberAttribute: member + attributes: + type: array + description: The attribute definitions which form the schema. + items: + type: object + properties: + name: + type: string + description: The name of the attribute. + example: sAMAccountName + type: + description: The type of the attribute. + example: STRING + type: string + enum: + - STRING + - LONG + - INT + - BOOLEAN + schema: + description: A reference to the schema on the source to the attribute values map to. + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - CONNECTOR_SCHEMA + example: CONNECTOR_SCHEMA + id: + type: string + description: The object ID this reference applies to. + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: The human-readable display name of the object. + example: group + description: + type: string + description: A human-readable description of the attribute. + example: SAM Account Name + isMultiValued: + type: boolean + description: Flag indicating whether or not the attribute is multi-valued. + example: false + isEntitlement: + type: boolean + description: Flag indicating whether or not the attribute is an entitlement. + example: false + isGroup: + type: boolean + description: | + Flag indicating whether or not the attribute represents a group. + This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. + example: false + example: + - name: sAMAccountName + type: STRING + isMultiValued: false + isEntitlement: false + isGroup: false + - name: memberOf + type: STRING + schema: + type: CONNECTOR_SCHEMA + id: 2c9180887671ff8c01767b4671fc7d60 + name: group + description: Group membership + isMultiValued: true + isEntitlement: true + isGroup: true + created: + type: string + description: The date the Schema was created. + format: date-time + example: '2019-12-24T22:32:58.104Z' + modified: + type: string + description: The date the Schema was last modified. + format: date-time + example: '2019-12-31T20:22:28.104Z' + '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. + '/sources/{sourceId}/schemas/{schemaId}': + get: + operationId: getSourceSchema + tags: + - Sources + summary: Get Source Schema by ID + description: | + Get the Source Schema by ID in IdentityNow. + parameters: + - in: path + name: sourceId + required: true + schema: + type: string + description: The Source id. + example: 2c9180835d191a86015d28455b4a2329 + - in: path + name: schemaId + schema: + type: string + required: true + description: The Schema id. + example: 2c9180835d191a86015d28455b4a2329 + responses: + '200': + description: The requested Schema was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: The id of the Schema. + example: 2c9180835d191a86015d28455b4a2329 + name: + type: string + description: The name of the Schema. + example: account + nativeObjectType: + type: string + description: The name of the object type on the native system that the schema represents. + example: User + identityAttribute: + type: string + description: The name of the attribute used to calculate the unique identifier for an object in the schema. + example: sAMAccountName + displayAttribute: + type: string + description: The name of the attribute used to calculate the display value for an object in the schema. + example: distinguishedName + hierarchyAttribute: + type: string + description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. + example: memberOf + includePermissions: + type: boolean + description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. + example: false + features: + type: array + items: + type: string + enum: + - AUTHENTICATE + - COMPOSITE + - DIRECT_PERMISSIONS + - DISCOVER_SCHEMA + - ENABLE + - MANAGER_LOOKUP + - NO_RANDOM_ACCESS + - PROXY + - SEARCH + - TEMPLATE + - UNLOCK + - UNSTRUCTURED_TARGETS + - SHAREPOINT_TARGET + - PROVISIONING + - GROUP_PROVISIONING + - SYNC_PROVISIONING + - PASSWORD + - CURRENT_PASSWORD + - ACCOUNT_ONLY_REQUEST + - ADDITIONAL_ACCOUNT_REQUEST + - NO_AGGREGATION + - GROUPS_HAVE_MEMBERS + - NO_PERMISSIONS_PROVISIONING + - NO_GROUP_PERMISSIONS_PROVISIONING + - NO_UNSTRUCTURED_TARGETS_PROVISIONING + - NO_DIRECT_PERMISSIONS_PROVISIONING + description: |- + Optional features that can be supported by an source. + * AUTHENTICATE: The source supports pass-through authentication. + * COMPOSITE: The source supports composite source creation. + * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. + * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. + * ENABLE The source supports reading if an account is enabled or disabled. + * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. + * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. + * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. + * SEARCH + * TEMPLATE + * UNLOCK: The source supports reading if an account is locked or unlocked. + * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. + * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. + * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. + * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. + * SYNC_PROVISIONING: The source can provision accounts synchronously. + * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. + * CURRENT_PASSWORD: Some source types support verification of the current password + * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. + * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. + * NO_AGGREGATION: A source that does not support aggregation. + * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. + * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. + * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. + * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + example: AUTHENTICATE + description: The features that the schema supports. + example: + - PROVISIONING + - NO_PERMISSIONS_PROVISIONING + - GROUPS_HAVE_MEMBERS + configuration: + type: object + description: Holds any extra configuration data that the schema may require. + example: + groupMemberAttribute: member + attributes: + type: array + description: The attribute definitions which form the schema. + items: + type: object + properties: + name: + type: string + description: The name of the attribute. + example: sAMAccountName + type: + description: The type of the attribute. + example: STRING + type: string + enum: + - STRING + - LONG + - INT + - BOOLEAN + schema: + description: A reference to the schema on the source to the attribute values map to. + type: object + properties: + type: + description: The type of object being referenced type: string - description: | - This is the comparison to perform. - | Operation | Description | - | --------- | ------- | - | LT | Strictly less than: firstDate < secondDate | - | LTE | Less than or equal to: firstDate <= secondDate | - | GT | Strictly greater than: firstDate > secondDate | - | GTE | Greater than or equal to: firstDate >= secondDate | enum: - - LT - - LTE - - GT - - GTE - example: LT - positiveCondition: - type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: + - CONNECTOR_SCHEMA + example: CONNECTOR_SCHEMA + id: type: string - description: The output of the transform if the expression evalutes to false - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateMath - type: object - required: - - expression - properties: - expression: + description: The object ID this reference applies to. + example: 2c91808568c529c60168cca6f90c1313 + name: type: string - description: | - A string value of the date and time components to operation on, along with the math operations to execute. - externalDocs: - description: Date Math Expressions - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure' - example: now+1w - roundUp: - type: boolean - description: | - A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. - - - If not provided, the transform will default to `false` - + description: The human-readable display name of the object. + example: group + description: + type: string + description: A human-readable description of the attribute. + example: SAM Account Name + isMultiValued: + type: boolean + description: Flag indicating whether or not the attribute is multi-valued. + example: false + isEntitlement: + type: boolean + description: Flag indicating whether or not the attribute is an entitlement. + example: false + isGroup: + type: boolean + description: | + Flag indicating whether or not the attribute represents a group. + This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. + example: false + example: + - name: sAMAccountName + type: STRING + isMultiValued: false + isEntitlement: false + isGroup: false + - name: memberOf + type: STRING + schema: + type: CONNECTOR_SCHEMA + id: 2c9180887671ff8c01767b4671fc7d60 + name: group + description: Group membership + isMultiValued: true + isEntitlement: true + isGroup: true + created: + type: string + description: The date the Schema was created. + format: date-time + example: '2019-12-24T22:32:58.104Z' + modified: + type: string + description: The date the Schema was last modified. + format: date-time + example: '2019-12-31T20:22:28.104Z' + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + put: + operationId: putSourceSchema + tags: + - Sources + summary: Update Source Schema (Full) + description: | + This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. - `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) + * id + * name + * created + * modified + Any attempt to modify these fields will result in an error response with a status code of 400. - `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: decomposeDiacriticalMarks - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: e164phone + > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. + parameters: + - in: path + name: sourceId + required: true + schema: + type: string + description: The Source id. + example: 2c9180835d191a86015d28455b4a2329 + - in: path + name: schemaId + schema: + type: string + required: true + description: The Schema id. + example: 2c9180835d191a86015d28455b4a2329 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: The id of the Schema. + example: 2c9180835d191a86015d28455b4a2329 + name: + type: string + description: The name of the Schema. + example: account + nativeObjectType: + type: string + description: The name of the object type on the native system that the schema represents. + example: User + identityAttribute: + type: string + description: The name of the attribute used to calculate the unique identifier for an object in the schema. + example: sAMAccountName + displayAttribute: + type: string + description: The name of the attribute used to calculate the display value for an object in the schema. + example: distinguishedName + hierarchyAttribute: + type: string + description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. + example: memberOf + includePermissions: + type: boolean + description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. + example: false + features: + type: array + items: + type: string + enum: + - AUTHENTICATE + - COMPOSITE + - DIRECT_PERMISSIONS + - DISCOVER_SCHEMA + - ENABLE + - MANAGER_LOOKUP + - NO_RANDOM_ACCESS + - PROXY + - SEARCH + - TEMPLATE + - UNLOCK + - UNSTRUCTURED_TARGETS + - SHAREPOINT_TARGET + - PROVISIONING + - GROUP_PROVISIONING + - SYNC_PROVISIONING + - PASSWORD + - CURRENT_PASSWORD + - ACCOUNT_ONLY_REQUEST + - ADDITIONAL_ACCOUNT_REQUEST + - NO_AGGREGATION + - GROUPS_HAVE_MEMBERS + - NO_PERMISSIONS_PROVISIONING + - NO_GROUP_PERMISSIONS_PROVISIONING + - NO_UNSTRUCTURED_TARGETS_PROVISIONING + - NO_DIRECT_PERMISSIONS_PROVISIONING + description: |- + Optional features that can be supported by an source. + * AUTHENTICATE: The source supports pass-through authentication. + * COMPOSITE: The source supports composite source creation. + * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. + * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. + * ENABLE The source supports reading if an account is enabled or disabled. + * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. + * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. + * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. + * SEARCH + * TEMPLATE + * UNLOCK: The source supports reading if an account is locked or unlocked. + * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. + * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. + * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. + * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. + * SYNC_PROVISIONING: The source can provision accounts synchronously. + * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. + * CURRENT_PASSWORD: Some source types support verification of the current password + * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. + * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. + * NO_AGGREGATION: A source that does not support aggregation. + * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. + * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. + * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. + * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + example: AUTHENTICATE + description: The features that the schema supports. + example: + - PROVISIONING + - NO_PERMISSIONS_PROVISIONING + - GROUPS_HAVE_MEMBERS + configuration: + type: object + description: Holds any extra configuration data that the schema may require. + example: + groupMemberAttribute: member + attributes: + type: array + description: The attribute definitions which form the schema. + items: + type: object + properties: + name: + type: string + description: The name of the attribute. + example: sAMAccountName + type: + description: The type of the attribute. + example: STRING + type: string + enum: + - STRING + - LONG + - INT + - BOOLEAN + schema: + description: A reference to the schema on the source to the attribute values map to. + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - CONNECTOR_SCHEMA + example: CONNECTOR_SCHEMA + id: + type: string + description: The object ID this reference applies to. + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: The human-readable display name of the object. + example: group + description: + type: string + description: A human-readable description of the attribute. + example: SAM Account Name + isMultiValued: + type: boolean + description: Flag indicating whether or not the attribute is multi-valued. + example: false + isEntitlement: + type: boolean + description: Flag indicating whether or not the attribute is an entitlement. + example: false + isGroup: + type: boolean + description: | + Flag indicating whether or not the attribute represents a group. + This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. + example: false + example: + - name: sAMAccountName + type: STRING + isMultiValued: false + isEntitlement: false + isGroup: false + - name: memberOf + type: STRING + schema: + type: CONNECTOR_SCHEMA + id: 2c9180887671ff8c01767b4671fc7d60 + name: group + description: Group membership + isMultiValued: true + isEntitlement: true + isGroup: true + created: + type: string + description: The date the Schema was created. + format: date-time + example: '2019-12-24T22:32:58.104Z' + modified: + type: string + description: The date the Schema was last modified. + format: date-time + example: '2019-12-31T20:22:28.104Z' + responses: + '200': + description: The Schema was successfully replaced. + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: The id of the Schema. + example: 2c9180835d191a86015d28455b4a2329 + name: + type: string + description: The name of the Schema. + example: account + nativeObjectType: + type: string + description: The name of the object type on the native system that the schema represents. + example: User + identityAttribute: + type: string + description: The name of the attribute used to calculate the unique identifier for an object in the schema. + example: sAMAccountName + displayAttribute: + type: string + description: The name of the attribute used to calculate the display value for an object in the schema. + example: distinguishedName + hierarchyAttribute: + type: string + description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. + example: memberOf + includePermissions: + type: boolean + description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. + example: false + features: + type: array + items: + type: string + enum: + - AUTHENTICATE + - COMPOSITE + - DIRECT_PERMISSIONS + - DISCOVER_SCHEMA + - ENABLE + - MANAGER_LOOKUP + - NO_RANDOM_ACCESS + - PROXY + - SEARCH + - TEMPLATE + - UNLOCK + - UNSTRUCTURED_TARGETS + - SHAREPOINT_TARGET + - PROVISIONING + - GROUP_PROVISIONING + - SYNC_PROVISIONING + - PASSWORD + - CURRENT_PASSWORD + - ACCOUNT_ONLY_REQUEST + - ADDITIONAL_ACCOUNT_REQUEST + - NO_AGGREGATION + - GROUPS_HAVE_MEMBERS + - NO_PERMISSIONS_PROVISIONING + - NO_GROUP_PERMISSIONS_PROVISIONING + - NO_UNSTRUCTURED_TARGETS_PROVISIONING + - NO_DIRECT_PERMISSIONS_PROVISIONING + description: |- + Optional features that can be supported by an source. + * AUTHENTICATE: The source supports pass-through authentication. + * COMPOSITE: The source supports composite source creation. + * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. + * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. + * ENABLE The source supports reading if an account is enabled or disabled. + * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. + * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. + * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. + * SEARCH + * TEMPLATE + * UNLOCK: The source supports reading if an account is locked or unlocked. + * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. + * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. + * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. + * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. + * SYNC_PROVISIONING: The source can provision accounts synchronously. + * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. + * CURRENT_PASSWORD: Some source types support verification of the current password + * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. + * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. + * NO_AGGREGATION: A source that does not support aggregation. + * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. + * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. + * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. + * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + example: AUTHENTICATE + description: The features that the schema supports. + example: + - PROVISIONING + - NO_PERMISSIONS_PROVISIONING + - GROUPS_HAVE_MEMBERS + configuration: + type: object + description: Holds any extra configuration data that the schema may require. + example: + groupMemberAttribute: member + attributes: + type: array + description: The attribute definitions which form the schema. + items: + type: object + properties: + name: + type: string + description: The name of the attribute. + example: sAMAccountName + type: + description: The type of the attribute. + example: STRING + type: string + enum: + - STRING + - LONG + - INT + - BOOLEAN + schema: + description: A reference to the schema on the source to the attribute values map to. type: object properties: - defaultRegion: + type: + description: The type of object being referenced type: string - description: | - This is an optional attribute that can be used to define the region of the phone number to format into. - + enum: + - CONNECTOR_SCHEMA + example: CONNECTOR_SCHEMA + id: + type: string + description: The object ID this reference applies to. + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: The human-readable display name of the object. + example: group + description: + type: string + description: A human-readable description of the attribute. + example: SAM Account Name + isMultiValued: + type: boolean + description: Flag indicating whether or not the attribute is multi-valued. + example: false + isEntitlement: + type: boolean + description: Flag indicating whether or not the attribute is an entitlement. + example: false + isGroup: + type: boolean + description: | + Flag indicating whether or not the attribute represents a group. + This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. + example: false + example: + - name: sAMAccountName + type: STRING + isMultiValued: false + isEntitlement: false + isGroup: false + - name: memberOf + type: STRING + schema: + type: CONNECTOR_SCHEMA + id: 2c9180887671ff8c01767b4671fc7d60 + name: group + description: Group membership + isMultiValued: true + isEntitlement: true + isGroup: true + created: + type: string + description: The date the Schema was created. + format: date-time + example: '2019-12-24T22:32:58.104Z' + modified: + type: string + description: The date the Schema was last modified. + format: date-time + example: '2019-12-31T20:22:28.104Z' + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + patch: + operationId: updateSourceSchema + tags: + - Sources + summary: Update Source Schema (Partial) + description: | + Use this API to selectively update an existing Schema using a JSONPatch payload. - If defaultRegion is not provided, it will take US as the default country. + The following schema fields are immutable and cannot be updated: + - id + - name + - created + - modified - The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - example: US - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: firstValid - type: object - required: - - values - properties: - values: - type: array - items: - type: object - description: An array of attributes to evaluate for existence. - example: - - attributes: - sourceName: Active Directory - attributeName: sAMAccountName - type: accountAttribute - - attributes: - sourceName: Okta - attributeName: login - type: accountAttribute - - attributes: - sourceName: HR Source - attributeName: employeeID - type: accountAttribute - ignoreErrors: - type: boolean - description: a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - - title: rule - oneOf: - - type: object - required: - - name - properties: - name: - type: string - description: This is the name of the Generic rule that needs to be invoked by the transform - example: Generic Calculation Rule - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - includeNumbers - - includeSpecialChars - - length - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `generateRandomString` - example: generateRandomString - includeNumbers: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include numbers - example: true - includeSpecialChars: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include special characters - example: true - length: - type: string - description: | - This specifies how long the randomly generated string needs to be + To switch an account attribute to a group entitlement, you need to have the following in place: - >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false + - `isEntitlement: true` + - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: + ```json + { + "name": "groups", + "type": "STRING", + "schema": { + "type": "CONNECTOR_SCHEMA", + "id": "2c9180887671ff8c01767b4671fc7d60", + "name": "group" + }, + "description": "The groups, roles etc. that reference account group objects", + "isMulti": true, + "isEntitlement": true, + "isGroup": true + } + ``` + parameters: + - in: path + name: sourceId + required: true + schema: + type: string + description: The Source id. + example: 2c9180835d191a86015d28455b4a2329 + - in: path + name: schemaId + schema: + type: string + required: true + description: The Schema id. + example: 2c9180835d191a86015d28455b4a2329 + requestBody: + required: true + description: The JSONPatch payload used to update the schema. + content: + application/json-patch+json: + schema: + type: array + items: + type: object + description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' + required: + - op + - path + properties: + op: + type: string + description: The operation to be performed + enum: + - add + - remove + - replace + - move + - copy + - test + example: replace + path: + type: string + description: A string JSON Pointer representing the target path to an element to be affected by the operation + example: /description + value: + anyOf: + - type: string + - type: integer + - type: object + - type: array + items: + anyOf: + - type: string + - type: integer - type: object - required: - - name - - operation - - uid - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `getReferenceIdentityAttribute` - example: getReferenceIdentityAttribute - uid: - type: string - description: | - This is the SailPoint User Name (uid) value of the identity whose attribute is desired - - As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. - example: 2c91808570313110017040b06f344ec9 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - title: identityAttribute + description: 'The value to be used for the operation, required for "add" and "replace" operations' + example: New description + examples: + add-attribute: + summary: Add an attribute to the end of the list + value: + - op: add + path: /attributes/- + value: + name: location + type: STRING + schema: null + description: Employee location + isMulti: false + isEntitlement: false + isGroup: false + responses: + '200': + description: The Schema was successfully updated. + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: The id of the Schema. + example: 2c9180835d191a86015d28455b4a2329 + name: + type: string + description: The name of the Schema. + example: account + nativeObjectType: + type: string + description: The name of the object type on the native system that the schema represents. + example: User + identityAttribute: + type: string + description: The name of the attribute used to calculate the unique identifier for an object in the schema. + example: sAMAccountName + displayAttribute: + type: string + description: The name of the attribute used to calculate the display value for an object in the schema. + example: distinguishedName + hierarchyAttribute: + type: string + description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. + example: memberOf + includePermissions: + type: boolean + description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. + example: false + features: + type: array + items: + type: string + enum: + - AUTHENTICATE + - COMPOSITE + - DIRECT_PERMISSIONS + - DISCOVER_SCHEMA + - ENABLE + - MANAGER_LOOKUP + - NO_RANDOM_ACCESS + - PROXY + - SEARCH + - TEMPLATE + - UNLOCK + - UNSTRUCTURED_TARGETS + - SHAREPOINT_TARGET + - PROVISIONING + - GROUP_PROVISIONING + - SYNC_PROVISIONING + - PASSWORD + - CURRENT_PASSWORD + - ACCOUNT_ONLY_REQUEST + - ADDITIONAL_ACCOUNT_REQUEST + - NO_AGGREGATION + - GROUPS_HAVE_MEMBERS + - NO_PERMISSIONS_PROVISIONING + - NO_GROUP_PERMISSIONS_PROVISIONING + - NO_UNSTRUCTURED_TARGETS_PROVISIONING + - NO_DIRECT_PERMISSIONS_PROVISIONING + description: |- + Optional features that can be supported by an source. + * AUTHENTICATE: The source supports pass-through authentication. + * COMPOSITE: The source supports composite source creation. + * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. + * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. + * ENABLE The source supports reading if an account is enabled or disabled. + * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. + * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. + * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. + * SEARCH + * TEMPLATE + * UNLOCK: The source supports reading if an account is locked or unlocked. + * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. + * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. + * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. + * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. + * SYNC_PROVISIONING: The source can provision accounts synchronously. + * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. + * CURRENT_PASSWORD: Some source types support verification of the current password + * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. + * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. + * NO_AGGREGATION: A source that does not support aggregation. + * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. + * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. + * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. + * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + example: AUTHENTICATE + description: The features that the schema supports. + example: + - PROVISIONING + - NO_PERMISSIONS_PROVISIONING + - GROUPS_HAVE_MEMBERS + configuration: + type: object + description: Holds any extra configuration data that the schema may require. + example: + groupMemberAttribute: member + attributes: + type: array + description: The attribute definitions which form the schema. + items: + type: object + properties: + name: + type: string + description: The name of the attribute. + example: sAMAccountName + type: + description: The type of the attribute. + example: STRING + type: string + enum: + - STRING + - LONG + - INT + - BOOLEAN + schema: + description: A reference to the schema on the source to the attribute values map to. type: object - required: - - name properties: - name: + type: + description: The type of object being referenced type: string - description: The system (camel-cased) name of the identity attribute to bring in - example: email - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: indexOf - type: object - required: - - substring - properties: - substring: + enum: + - CONNECTOR_SCHEMA + example: CONNECTOR_SCHEMA + id: type: string - description: 'A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.' - example: admin_ - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: iso3166 - type: object - properties: - format: + description: The object ID this reference applies to. + example: 2c91808568c529c60168cca6f90c1313 + name: type: string - description: | - An optional value to denote which ISO 3166 format to return. Valid values are: - - - `alpha2` - Two-character country code (e.g., "US"); this is the default value if no format is supplied - + description: The human-readable display name of the object. + example: group + description: + type: string + description: A human-readable description of the attribute. + example: SAM Account Name + isMultiValued: + type: boolean + description: Flag indicating whether or not the attribute is multi-valued. + example: false + isEntitlement: + type: boolean + description: Flag indicating whether or not the attribute is an entitlement. + example: false + isGroup: + type: boolean + description: | + Flag indicating whether or not the attribute represents a group. + This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. + example: false + example: + - name: sAMAccountName + type: STRING + isMultiValued: false + isEntitlement: false + isGroup: false + - name: memberOf + type: STRING + schema: + type: CONNECTOR_SCHEMA + id: 2c9180887671ff8c01767b4671fc7d60 + name: group + description: Group membership + isMultiValued: true + isEntitlement: true + isGroup: true + created: + type: string + description: The date the Schema was created. + format: date-time + example: '2019-12-24T22:32:58.104Z' + modified: + type: string + description: The date the Schema was last modified. + format: date-time + example: '2019-12-31T20:22:28.104Z' + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + delete: + operationId: deleteSourceSchema + tags: + - Sources + summary: Delete Source Schema by ID + parameters: + - in: path + name: sourceId + required: true + schema: + type: string + description: The Source id. + example: 2c9180835d191a86015d28455b4a2329 + - in: path + name: schemaId + schema: + type: string + required: true + description: The Schema id. + example: 2c9180835d191a86015d28455b4a2329 + responses: + '204': + description: The Schema was successfully deleted. + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + '/sources/{sourceId}/source-health': + get: + operationId: getSourceHealth + security: + - UserContextAuth: + - 'idn:sources:read' + tags: + - Sources + summary: Fetches source health by id + description: This endpoint fetches source health by source's id + parameters: + - in: path + name: sourceId + required: true + schema: + type: string + description: The Source id. + example: 2c9180835d191a86015d28455b4a2329 + responses: + '200': + description: Fetched source health successfully + content: + application/json: + schema: + type: object + description: Dto for source health data + properties: + id: + type: string + readOnly: true + description: the id of the Source + example: 2c91808568c529c60168cca6f90c1324 + type: + type: string + description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ' + example: OpenLDAP - Direct + name: + type: string + description: the name of the source + example: Source1234 + org: + type: string + description: source's org + example: denali-cjh + isAuthoritative: + type: boolean + example: false + description: Is the source authoritative + isCluster: + type: boolean + example: false + description: Is the source in a cluster + hostname: + type: string + example: megapod-useast1-secret-hostname.sailpoint.com + description: source's hostname + pod: + type: string + description: source's pod + example: megapod-useast1 + iqServiceVersion: + type: string + description: The version of the iqService + example: iqVersion123 + status: + type: string + enum: + - SOURCE_STATE_ERROR_CLUSTER + - SOURCE_STATE_ERROR_SOURCE + - SOURCE_STATE_ERROR_VA + - SOURCE_STATE_FAILURE_CLUSTER + - SOURCE_STATE_FAILURE_SOURCE + - SOURCE_STATE_HEALTHY + - SOURCE_STATE_UNCHECKED_CLUSTER + - SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES + - SOURCE_STATE_UNCHECKED_SOURCE + - SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS + description: connection test result + example: SOURCE_STATE_UNCHECKED_SOURCE + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + '/sources/{id}/schemas/accounts': + get: + tags: + - Sources + summary: Downloads source accounts schema template + description: |- + This API downloads the CSV schema that defines the account attributes on a source. + >**NOTE: This API is designated only for Delimited File sources.** + operationId: getAccountsSchema + parameters: + - in: path + name: id + required: true + schema: + type: string + description: The Source id + example: 8c190e6787aa4ed9a90bd9d5344523fb + responses: + '200': + description: Successfully downloaded the file + content: + text/csv: + example: 'id,name,givenName,familyName,e-mail,location,manager,groups,startDate,endDate' + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + security: + - UserContextAuth: + - 'idn:source-schema:read' + post: + tags: + - Sources + summary: Uploads source accounts schema template + description: |- + This API uploads a source schema template file to configure a source's account attributes. - `alpha3` - Three-character country code (e.g., "USA") + To retrieve the file to modify and upload, log into Identity Now. + Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** - `numeric` - The numeric country code (e.g., "840") - example: alpha2 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: leftPad + >**NOTE: This API is designated only for Delimited File sources.** + operationId: importAccountsSchema + parameters: + - in: path + name: id + required: true + schema: + type: string + description: The Source id + example: 8c190e6787aa4ed9a90bd9d5344523fb + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + format: binary + responses: + '200': + description: Successfully uploaded the file + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: The id of the Schema. + example: 2c9180835d191a86015d28455b4a2329 + name: + type: string + description: The name of the Schema. + example: account + nativeObjectType: + type: string + description: The name of the object type on the native system that the schema represents. + example: User + identityAttribute: + type: string + description: The name of the attribute used to calculate the unique identifier for an object in the schema. + example: sAMAccountName + displayAttribute: + type: string + description: The name of the attribute used to calculate the display value for an object in the schema. + example: distinguishedName + hierarchyAttribute: + type: string + description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. + example: memberOf + includePermissions: + type: boolean + description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. + example: false + features: + type: array + items: + type: string + enum: + - AUTHENTICATE + - COMPOSITE + - DIRECT_PERMISSIONS + - DISCOVER_SCHEMA + - ENABLE + - MANAGER_LOOKUP + - NO_RANDOM_ACCESS + - PROXY + - SEARCH + - TEMPLATE + - UNLOCK + - UNSTRUCTURED_TARGETS + - SHAREPOINT_TARGET + - PROVISIONING + - GROUP_PROVISIONING + - SYNC_PROVISIONING + - PASSWORD + - CURRENT_PASSWORD + - ACCOUNT_ONLY_REQUEST + - ADDITIONAL_ACCOUNT_REQUEST + - NO_AGGREGATION + - GROUPS_HAVE_MEMBERS + - NO_PERMISSIONS_PROVISIONING + - NO_GROUP_PERMISSIONS_PROVISIONING + - NO_UNSTRUCTURED_TARGETS_PROVISIONING + - NO_DIRECT_PERMISSIONS_PROVISIONING + description: |- + Optional features that can be supported by an source. + * AUTHENTICATE: The source supports pass-through authentication. + * COMPOSITE: The source supports composite source creation. + * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. + * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. + * ENABLE The source supports reading if an account is enabled or disabled. + * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. + * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. + * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. + * SEARCH + * TEMPLATE + * UNLOCK: The source supports reading if an account is locked or unlocked. + * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. + * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. + * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. + * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. + * SYNC_PROVISIONING: The source can provision accounts synchronously. + * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. + * CURRENT_PASSWORD: Some source types support verification of the current password + * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. + * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. + * NO_AGGREGATION: A source that does not support aggregation. + * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. + * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. + * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. + * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + example: AUTHENTICATE + description: The features that the schema supports. + example: + - PROVISIONING + - NO_PERMISSIONS_PROVISIONING + - GROUPS_HAVE_MEMBERS + configuration: + type: object + description: Holds any extra configuration data that the schema may require. + example: + groupMemberAttribute: member + attributes: + type: array + description: The attribute definitions which form the schema. + items: + type: object + properties: + name: + type: string + description: The name of the attribute. + example: sAMAccountName + type: + description: The type of the attribute. + example: STRING + type: string + enum: + - STRING + - LONG + - INT + - BOOLEAN + schema: + description: A reference to the schema on the source to the attribute values map to. type: object - required: - - length properties: - length: - type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: + type: + description: The type of object being referenced type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length - - - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lookup - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: | - This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched - - - >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. - example: - USA: Americas - FRA: EMEA - AUS: APAC - default: Unknown Region - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lower - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: nameNormalizer - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomAlphaNumeric - type: object - properties: - length: + enum: + - CONNECTOR_SCHEMA + example: CONNECTOR_SCHEMA + id: type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain - - - * This value must be a positive number and cannot be blank - - - * If no length is provided, the transform will default to a value of `32` - - - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomNumeric - type: object - properties: - length: + description: The object ID this reference applies to. + example: 2c91808568c529c60168cca6f90c1313 + name: type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain - - - * This value must be a positive number and cannot be blank - - - * If no length is provided, the transform will default to a value of `32` - + description: The human-readable display name of the object. + example: group + description: + type: string + description: A human-readable description of the attribute. + example: SAM Account Name + isMultiValued: + type: boolean + description: Flag indicating whether or not the attribute is multi-valued. + example: false + isEntitlement: + type: boolean + description: Flag indicating whether or not the attribute is an entitlement. + example: false + isGroup: + type: boolean + description: | + Flag indicating whether or not the attribute represents a group. + This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. + example: false + example: + - name: sAMAccountName + type: STRING + isMultiValued: false + isEntitlement: false + isGroup: false + - name: memberOf + type: STRING + schema: + type: CONNECTOR_SCHEMA + id: 2c9180887671ff8c01767b4671fc7d60 + name: group + description: Group membership + isMultiValued: true + isEntitlement: true + isGroup: true + created: + type: string + description: The date the Schema was created. + format: date-time + example: '2019-12-24T22:32:58.104Z' + modified: + type: string + description: The date the Schema was last modified. + format: date-time + example: '2019-12-31T20:22:28.104Z' + '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. + security: + - UserContextAuth: + - 'idn:source-schema:manage' + '/sources/{id}/schemas/entitlements': + get: + tags: + - Sources + summary: Downloads source entitlements schema template + description: |- + This API downloads the CSV schema that defines the entitlement attributes on a source. - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: reference - type: object - required: - - id - properties: - id: - type: string - description: This ID specifies the name of the pre-existing transform which you want to use within your current transform - example: Existing Transform - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replaceAll - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: 'An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.' - example: - '-': ' ' - '"': '''' - ñ: 'n' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replace - type: object - required: - - regex - - replacement - properties: - regex: - type: string - description: This can be a string or a regex pattern in which you want to replace. - example: '[^a-zA-Z]' - externalDocs: - description: Regex Builder - url: 'https://regex101.com/' - replacement: - type: string - description: This is the replacement string that should be substituded wherever the string or pattern is found. - example: ' ' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: rightPad - type: object - required: - - length - properties: - length: - type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: - type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length + >**NOTE: This API is designated only for Delimited File sources.** + operationId: getEntitlementsSchema + parameters: + - in: path + name: id + required: true + schema: + type: string + description: The Source id + example: 8c190e6787aa4ed9a90bd9d5344523fb + - in: query + name: schemaName + schema: + type: string + description: Name of entitlement schema + example: '?schemaName=group' + responses: + '200': + description: Successfully downloaded the file + content: + text/csv: + example: 'id,name,displayName,created,description,modified,entitlements,groups,permissions' + '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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + security: + - UserContextAuth: + - 'idn:source-schema:read' + post: + tags: + - Sources + summary: Uploads source entitlements schema template + description: |- + This API uploads a source schema template file to configure a source's entitlement attributes. + To retrieve the file to modify and upload, log into Identity Now. - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: split + Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** + + >**NOTE: This API is designated only for Delimited File sources.** + operationId: importEntitlementsSchema + parameters: + - in: path + name: id + required: true + schema: + type: string + description: The Source id + example: 8c190e6787aa4ed9a90bd9d5344523fb + - in: query + name: schemaName + schema: + type: string + description: Name of entitlement schema + example: '?schemaName=group' + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + format: binary + responses: + '200': + description: Successfully uploaded the file + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: The id of the Schema. + example: 2c9180835d191a86015d28455b4a2329 + name: + type: string + description: The name of the Schema. + example: account + nativeObjectType: + type: string + description: The name of the object type on the native system that the schema represents. + example: User + identityAttribute: + type: string + description: The name of the attribute used to calculate the unique identifier for an object in the schema. + example: sAMAccountName + displayAttribute: + type: string + description: The name of the attribute used to calculate the display value for an object in the schema. + example: distinguishedName + hierarchyAttribute: + type: string + description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. + example: memberOf + includePermissions: + type: boolean + description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. + example: false + features: + type: array + items: + type: string + enum: + - AUTHENTICATE + - COMPOSITE + - DIRECT_PERMISSIONS + - DISCOVER_SCHEMA + - ENABLE + - MANAGER_LOOKUP + - NO_RANDOM_ACCESS + - PROXY + - SEARCH + - TEMPLATE + - UNLOCK + - UNSTRUCTURED_TARGETS + - SHAREPOINT_TARGET + - PROVISIONING + - GROUP_PROVISIONING + - SYNC_PROVISIONING + - PASSWORD + - CURRENT_PASSWORD + - ACCOUNT_ONLY_REQUEST + - ADDITIONAL_ACCOUNT_REQUEST + - NO_AGGREGATION + - GROUPS_HAVE_MEMBERS + - NO_PERMISSIONS_PROVISIONING + - NO_GROUP_PERMISSIONS_PROVISIONING + - NO_UNSTRUCTURED_TARGETS_PROVISIONING + - NO_DIRECT_PERMISSIONS_PROVISIONING + description: |- + Optional features that can be supported by an source. + * AUTHENTICATE: The source supports pass-through authentication. + * COMPOSITE: The source supports composite source creation. + * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. + * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. + * ENABLE The source supports reading if an account is enabled or disabled. + * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. + * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. + * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. + * SEARCH + * TEMPLATE + * UNLOCK: The source supports reading if an account is locked or unlocked. + * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. + * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. + * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. + * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. + * SYNC_PROVISIONING: The source can provision accounts synchronously. + * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. + * CURRENT_PASSWORD: Some source types support verification of the current password + * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. + * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. + * NO_AGGREGATION: A source that does not support aggregation. + * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. + * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. + * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. + * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + example: AUTHENTICATE + description: The features that the schema supports. + example: + - PROVISIONING + - NO_PERMISSIONS_PROVISIONING + - GROUPS_HAVE_MEMBERS + configuration: + type: object + description: Holds any extra configuration data that the schema may require. + example: + groupMemberAttribute: member + attributes: + type: array + description: The attribute definitions which form the schema. + items: + type: object + properties: + name: + type: string + description: The name of the attribute. + example: sAMAccountName + type: + description: The type of the attribute. + example: STRING + type: string + enum: + - STRING + - LONG + - INT + - BOOLEAN + schema: + description: A reference to the schema on the source to the attribute values map to. type: object - required: - - delimiter - - index properties: - delimiter: + type: + description: The type of object being referenced type: string - description: 'This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data' - example: ',' - index: + enum: + - CONNECTOR_SCHEMA + example: CONNECTOR_SCHEMA + id: type: string - description: 'An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.' - example: '5' - throws: - type: boolean - description: | - A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) - - - `true` - The transform should return "IndexOutOfBoundsException" - - - `false` - The transform should return null + description: The object ID this reference applies to. + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: The human-readable display name of the object. + example: group + description: + type: string + description: A human-readable description of the attribute. + example: SAM Account Name + isMultiValued: + type: boolean + description: Flag indicating whether or not the attribute is multi-valued. + example: false + isEntitlement: + type: boolean + description: Flag indicating whether or not the attribute is an entitlement. + example: false + isGroup: + type: boolean + description: | + Flag indicating whether or not the attribute represents a group. + This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. + example: false + example: + - name: sAMAccountName + type: STRING + isMultiValued: false + isEntitlement: false + isGroup: false + - name: memberOf + type: STRING + schema: + type: CONNECTOR_SCHEMA + id: 2c9180887671ff8c01767b4671fc7d60 + name: group + description: Group membership + isMultiValued: true + isEntitlement: true + isGroup: true + created: + type: string + description: The date the Schema was created. + format: date-time + example: '2019-12-24T22:32:58.104Z' + modified: + type: string + description: The date the Schema was last modified. + format: date-time + example: '2019-12-31T20:22:28.104Z' + '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. + security: + - UserContextAuth: + - 'idn:source-schema:manage' + '/sources/{sourceId}/upload-connector-file': + post: + operationId: importConnectorFile + security: + - UserContextAuth: + - 'idn:sources-admin:manage' + tags: + - Sources + summary: Upload connector file to source + parameters: + - in: path + name: sourceId + required: true + schema: + type: string + description: The Source id. + example: 2c9180835d191a86015d28455b4a2329 + description: |- + This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events. + A token with ORG_ADMIN authority is required to call this API. + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + format: binary + responses: + '200': + description: Uploaded the file successfully and sent all post-upload events + content: + application/json: + schema: + type: object + properties: + id: + type: string + readOnly: true + description: the id of the Source + example: 2c91808568c529c60168cca6f90c1324 + name: + type: string + description: Human-readable name of the source + example: My Source + description: + type: string + description: Human-readable description of the source + example: This is the corporate directory. + owner: + description: Reference to an owning Identity Object + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: ID of the identity + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the identity + example: MyName + cluster: + description: Reference to the associated Cluster + type: object + required: + - name + - id + - type + properties: + type: + description: The type of object being referenced + type: string + enum: + - CLUSTER + example: CLUSTER + id: + type: string + description: ID of the cluster + example: 2c9180866166b5b0016167c32ef31a66 + name: + type: string + description: Human-readable display name of the cluster + example: Corporate Cluster + accountCorrelationConfig: + description: Reference to an Account Correlation Config object + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - ACCOUNT_CORRELATION_CONFIG + example: ACCOUNT_CORRELATION_CONFIG + id: + type: string + description: ID of the account correlation config + example: 2c9180855d191c59015d28583727245a + name: + type: string + description: Human-readable display name of the account correlation config + example: 'Directory [source-62867] Account Correlation' + accountCorrelationRule: + description: 'Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can''t be used.' + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - RULE + example: RULE + id: + type: string + description: ID of the rule + example: 2c918085708c274401708c2a8a760001 + name: + type: string + description: Human-readable display name of the rule + example: Example Rule + managerCorrelationMapping: + description: Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity + type: object + properties: + accountAttribute: + type: string + description: Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. + example: manager + identityAttribute: + type: string + description: Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. + example: manager + managerCorrelationRule: + description: 'Reference to the ManagerCorrelationRule, only used when a simple filter isn''t sufficient.' + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - RULE + example: RULE + id: + type: string + description: ID of the rule + example: 2c918085708c274401708c2a8a760001 + name: + type: string + description: Human-readable display name of the rule + example: Example Rule + beforeProvisioningRule: + description: Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - RULE + example: RULE + id: + type: string + description: ID of the rule + example: 2c918085708c274401708c2a8a760001 + name: + type: string + description: Human-readable display name of the rule + example: Example Rule + schemas: + type: array + items: + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - CONNECTOR_SCHEMA + example: CONNECTOR_SCHEMA + id: + type: string + description: ID of the schema + example: 2c91808568c529c60168cca6f90c1777 + name: + type: string + description: Human-readable display name of the schema + example: MySchema + description: List of references to Schema objects + example: + - type: CONNECTOR_SCHEMA + id: 2c9180835d191a86015d28455b4b232a + name: account + - type: CONNECTOR_SCHEMA + id: 2c9180835d191a86015d28455b4b232b + name: group + passwordPolicies: + type: array + items: + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - PASSWORD_POLICY + example: PASSWORD_POLICY + id: + type: string + description: ID of the policy + example: 2c91808568c529c60168cca6f90c1777 + name: + type: string + description: Human-readable display name of the policy + example: My Password Policy + description: List of references to the associated PasswordPolicy objects. + example: + - type: PASSWORD_POLICY + id: 2c9180855d191c59015d291ceb053980 + name: Corporate Password Policy + - type: PASSWORD_POLICY + id: 2c9180855d191c59015d291ceb057777 + name: Vendor Password Policy + features: + type: array + description: Optional features that can be supported by a source. + items: + type: string + enum: + - AUTHENTICATE + - COMPOSITE + - DIRECT_PERMISSIONS + - DISCOVER_SCHEMA + - ENABLE + - MANAGER_LOOKUP + - NO_RANDOM_ACCESS + - PROXY + - SEARCH + - TEMPLATE + - UNLOCK + - UNSTRUCTURED_TARGETS + - SHAREPOINT_TARGET + - PROVISIONING + - GROUP_PROVISIONING + - SYNC_PROVISIONING + - PASSWORD + - CURRENT_PASSWORD + - ACCOUNT_ONLY_REQUEST + - ADDITIONAL_ACCOUNT_REQUEST + - NO_AGGREGATION + - GROUPS_HAVE_MEMBERS + - NO_PERMISSIONS_PROVISIONING + - NO_GROUP_PERMISSIONS_PROVISIONING + - NO_UNSTRUCTURED_TARGETS_PROVISIONING + - NO_DIRECT_PERMISSIONS_PROVISIONING + description: |- + Optional features that can be supported by an source. + * AUTHENTICATE: The source supports pass-through authentication. + * COMPOSITE: The source supports composite source creation. + * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. + * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. + * ENABLE The source supports reading if an account is enabled or disabled. + * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. + * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. + * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. + * SEARCH + * TEMPLATE + * UNLOCK: The source supports reading if an account is locked or unlocked. + * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. + * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. + * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. + * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. + * SYNC_PROVISIONING: The source can provision accounts synchronously. + * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. + * CURRENT_PASSWORD: Some source types support verification of the current password + * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. + * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. + * NO_AGGREGATION: A source that does not support aggregation. + * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. + * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. + * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. + * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. + example: AUTHENTICATE + example: + - SYNC_PROVISIONING + - MANAGER_LOOKUP + - SEARCH + - PROVISIONING + - AUTHENTICATE + - GROUP_PROVISIONING + - PASSWORD + type: + type: string + description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ' + example: OpenLDAP - Direct + connector: + type: string + description: Connector script name. + example: active-directory + connectorClass: + type: string + description: The fully qualified name of the Java class that implements the connector interface. + example: sailpoint.connector.LDAPConnector + connectorAttributes: + type: object + description: Connector specific configuration; will differ from type to type. + example: + healthCheckTimeout: 30 + authSearchAttributes: + - cn + - uid + - mail + deleteThreshold: + type: integer + format: int32 + description: Number from 0 to 100 that specifies when to skip the delete phase. + example: 10 + authoritative: + type: boolean + description: When true indicates the source is referenced by an IdentityProfile. + default: false + example: false + managementWorkgroup: + description: Reference to Management Workgroup for this Source + type: object + properties: + type: + description: The type of object being referenced + type: string + enum: + - GOVERNANCE_GROUP + example: GOVERNANCE_GROUP + id: + type: string + description: ID of the management workgroup + example: 2c91808568c529c60168cca6f90c2222 + name: + type: string + description: Human-readable display name of the management workgroup + example: My Management Workgroup + healthy: + type: boolean + description: When true indicates a healthy source + default: false + example: true + status: + type: string + description: 'A status identifier, giving specific information on why a source is healthy or not' + example: SOURCE_STATE_HEALTHY + since: + type: string + description: Timestamp showing when a source health check was last performed + example: '2021-09-28T15:48:29.3801666300Z' + connectorId: + type: string + description: The id of connector + example: active-directory + connectorName: + type: string + description: The name of the connector that was chosen on source creation + example: Active Directory + connectionType: + type: string + description: The type of connection (direct or file) + example: file + connectorImplementstionId: + type: string + description: The connector implementstion id + example: delimited-file + required: + - name + - owner + - connector + '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. + /tagged-objects: + get: + operationId: listTaggedObjects + security: + - UserContextAuth: + - 'idn:tag:read' + - 'idn:tag:manage' + tags: + - Tagged Objects + summary: List Tagged Objects + description: |- + This API returns a list of all tagged objects. + Any authenticated token may be used to call this API. + parameters: + - 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. - If not provided, the transform will default to false and return a null - example: true - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: static - type: object - required: - - values - properties: - values: - type: string - description: 'This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.' - example: string$variable - externalDocs: - description: Static Transform Documentation - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/static' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - - title: substring - type: object - required: - - begin - properties: - begin: - type: integer - description: | - The index of the first character to include in the returned substring. + 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 + 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) - If `begin` is set to -1, the transform will begin at character 0 of the input data - example: 1 - format: int32 - beginOffset: - type: integer - description: | - This integer value is the number of characters to add to the begin attribute when returning a substring. + Filtering is supported for the following fields and operators: - This attribute is only used if begin is not -1. - example: 3 - format: int32 - end: - type: integer - description: | - The index of the first character to exclude from the returned substring. + **objectRef.id**: *eq, in* - If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. - example: 6 - format: int32 - endOffset: - type: integer - description: | - This integer value is the number of characters to add to the end attribute when returning a substring. + **objectRef.type**: *eq, in* - This attribute is only used if end is provided and is not -1. - example: 1 - format: int32 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: trim - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: upper - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: uuid - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - internal: - type: boolean - readOnly: true - description: Indicates whether this is an internal SailPoint-created transform or a customer-created transform - example: false - example: - - id: 2cd78adghjkja34jh2b1hkjhasuecd - name: Timestamp To Date - type: dateFormat - attributes: - inputFormat: 'MMM-dd-yyyy, HH:mm:ss.SSS' - outputFormat: yyyy/dd/MM - internal: false - - id: 2lkas8dhj4bkuakja77giih7l4ashh - name: PrefixSubstring - type: substring - attributes: - begin: 0 - end: 3 - internal: true + **tagName**: *eq, in* + example: tagName eq "BU_FINANCE" + required: false + responses: + '200': + description: List of all tagged objects. + content: + application/json: + schema: + type: array + items: + type: object + properties: + objectRef: + 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 + - WORKGROUP + example: IDENTITY + id: + type: string + description: ID of the object to which this reference applies + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + nullable: true + description: Human-readable display name of the object to which this reference applies + example: William Wilson + tags: + type: array + items: + type: string + description: Labels to be applied to an Object + example: + - BU_FINANCE + - PCI + '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: setTagToObject + security: + - UserContextAuth: + - 'idn:tag:manage' + tags: + - Tagged Objects + summary: Add Tag to Object + description: |- + This adds a tag to an object. + + Any authenticated token may be used to call this API. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + objectRef: + 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 + - WORKGROUP + example: IDENTITY + id: + type: string + description: ID of the object to which this reference applies + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + nullable: true + description: Human-readable display name of the object to which this reference applies + example: William Wilson + tags: + type: array + items: + type: string + description: Labels to be applied to an Object + example: + - BU_FINANCE + - PCI + responses: + '201': + description: Created. '400': description: Client Error - Returned if the request body is invalid. content: @@ -106836,8 +104161,18 @@ paths: - locale: en-US localeOrigin: DEFAULT text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist + '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: @@ -106894,27 +104229,225 @@ paths: description: Actual text of the error message in the indicated locale. example: The request was syntactically correct but its content is semantically invalid. examples: - '404': - summary: An example of a 404 response object + '500': + summary: An example of a 500 response object value: - detailCode: 404 Not found + detailCode: 500.0 Internal Fault trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. + text: An internal fault occurred. + '/tagged-objects/{type}': + get: + operationId: listTaggedObjectsByType + security: + - UserContextAuth: + - 'idn:tag:read' + - 'idn:tag:manage' + tags: + - Tagged Objects + summary: List Tagged Objects + description: |- + This API returns a list of all tagged objects by type. + + Any authenticated token may be used to call this API. + parameters: + - in: path + name: type + schema: + type: string + enum: + - ROLE + - IDENTITY + - SOD_POLICY + required: true + description: The type of tagged object to retrieve. + example: ROLE + - 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 + 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: + + **objectRef.id**: *eq* + + **objectRef.type**: *eq* + example: objectRef.id eq "2c91808568c529c60168cca6f90c1313" + required: false + responses: + '200': + description: List of all tagged objects for specified type. + content: + application/json: + schema: + type: array + items: + type: object + properties: + objectRef: + 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 + - WORKGROUP + example: IDENTITY + id: + type: string + description: ID of the object to which this reference applies + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + nullable: true + description: Human-readable display name of the object to which this reference applies + example: William Wilson + tags: + type: array + items: + type: string + description: Labels to be applied to an Object + example: + - BU_FINANCE + - PCI + '400': + description: Client Error - Returned if the request body is invalid. content: application/json: schema: type: object properties: - message: + 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: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected 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: @@ -106971,2826 +104504,3153 @@ paths: 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 + '403': + summary: An example of a 403 response object value: - detailCode: 500.0 Internal Fault + detailCode: 403 Forbidden trackingId: b21b1f7ce4da4d639f2c62a57171b427 messages: - locale: en-US localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - UserContextAuth: - - 'idn:transform:read' - post: - tags: - - Transforms - summary: Create transform - description: 'Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. A token with transform write authority is required to call this API.' - operationId: createTransform - requestBody: - required: true - description: The transform to be created. - content: - application/json: - schema: - type: object - description: The representation of an internally- or customer-defined transform. - required: - - name - - type - - attributes - properties: - id: - type: string - readOnly: true - description: Unique ID of this transform - example: 2cd78adghjkja34jh2b1hkjhasuecd - name: - type: string - description: Unique name of this transform - example: Timestamp To Date - minLength: 1 - maxLength: 50 - type: - type: string - description: The type of transform operation - enum: - - accountAttribute - - base64Decode - - base64Encode - - concat - - conditional - - dateCompare - - dateFormat - - dateMath - - decomposeDiacriticalMarks - - e164phone - - firstValid - - rule - - identityAttribute - - indexOf - - iso3166 - - lastIndexOf - - leftPad - - lookup - - lower - - normalizeNames - - randomAlphaNumeric - - randomNumeric - - reference - - replaceAll - - replace - - rightPad - - split - - static - - substring - - trim - - upper - - usernameGenerator - - uuid - example: dateFormat - externalDocs: - description: Transform Operations - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations' - attributes: - description: Meta-data about the transform. Values in this list are specific to the type of transform to be executed. - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: base64Decode - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: base64Encode - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: concat - type: object - required: - - values - properties: - values: - type: array - items: - type: object - description: An array of items to join together - example: - - John - - ' ' - - Smith - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: conditional + 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 - required: - - expression - - positiveCondition - - negativeCondition properties: - expression: + locale: type: string - description: |- - A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. - - The `eq` operator is the only valid comparison - example: ValueA eq ValueB - positiveCondition: + description: 'The locale for the message text, a BCP 47 language tag.' + example: en-US + localeOrigin: type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: + 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: The output of the transform if the expression evalutes to false - example: 'false' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateCompare + 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 - required: - - firstDate - - secondDate - - operator - - positiveCondition - - negativeCondition properties: - firstDate: - description: This is the first date to consider (The date that would be on the left hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - secondDate: - description: This is the second date to consider (The date that would be on the right hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - operator: + 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. + '/tagged-objects/{type}/{id}': + get: + operationId: getTaggedObject + security: + - UserContextAuth: + - 'idn:tag:read' + - 'idn:tag:manage' + tags: + - Tagged Objects + summary: Get Tagged Object + description: This gets a tagged object for the specified type. + parameters: + - in: path + name: type + schema: + type: string + enum: + - ROLE + - IDENTITY + - SOD_POLICY + required: true + description: The type of tagged object to retrieve. + example: ROLE + - in: path + name: id + schema: + type: string + required: true + description: The ID of the object reference to retrieve. + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '200': + description: Tagged object by type and ID. + content: + application/json: + schema: + type: object + properties: + objectRef: + 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 + - WORKGROUP + example: IDENTITY + id: + type: string + description: ID of the object to which this reference applies + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + nullable: true + description: Human-readable display name of the object to which this reference applies + example: William Wilson + tags: + type: array + items: + type: string + description: Labels to be applied to an Object + example: + - BU_FINANCE + - PCI + '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 - description: | - This is the comparison to perform. - | Operation | Description | - | --------- | ------- | - | LT | Strictly less than: firstDate < secondDate | - | LTE | Less than or equal to: firstDate <= secondDate | - | GT | Strictly greater than: firstDate > secondDate | - | GTE | Greater than or equal to: firstDate >= secondDate | enum: - - LT - - LTE - - GT - - GTE - example: LT - positiveCondition: + - 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: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: + 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 output of the transform if the expression evalutes to false - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat + 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: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateMath + 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. + put: + operationId: putTaggedObject + security: + - UserContextAuth: + - 'idn:tag:manage' + tags: + - Tagged Objects + summary: Update Tagged Object + description: This updates a tagged object for the specified type. + parameters: + - in: path + name: type + schema: + type: string + enum: + - ROLE + - IDENTITY + - SOD_POLICY + required: true + description: The type of tagged object to update. + example: ROLE + - in: path + name: id + schema: + type: string + required: true + description: The ID of the object reference to update. + example: ef38f94347e94562b5bb8424a56397d8 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + objectRef: + 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 + - WORKGROUP + example: IDENTITY + id: + type: string + description: ID of the object to which this reference applies + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + nullable: true + description: Human-readable display name of the object to which this reference applies + example: William Wilson + tags: + type: array + items: + type: string + description: Labels to be applied to an Object + example: + - BU_FINANCE + - PCI + responses: + '200': + description: Tagged object by type and ID. + content: + application/json: + schema: + type: object + properties: + objectRef: + 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 + - WORKGROUP + example: IDENTITY + id: + type: string + description: ID of the object to which this reference applies + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + nullable: true + description: Human-readable display name of the object to which this reference applies + example: William Wilson + tags: + type: array + items: + type: string + description: Labels to be applied to an Object + example: + - BU_FINANCE + - PCI + '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 - required: - - expression properties: - expression: + locale: type: string - description: | - A string value of the date and time components to operation on, along with the math operations to execute. - externalDocs: - description: Date Math Expressions - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure' - example: now+1w - roundUp: - type: boolean - description: | - A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. - - - If not provided, the transform will default to `false` - - - `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) - - - `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: decomposeDiacriticalMarks + 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: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: e164phone + 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: - defaultRegion: + locale: type: string - description: | - This is an optional attribute that can be used to define the region of the phone number to format into. - - - If defaultRegion is not provided, it will take US as the default country. - - - The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - example: US - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: firstValid + 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 - required: - - values properties: - values: - type: array - items: - type: object - description: An array of attributes to evaluate for existence. - example: - - attributes: - sourceName: Active Directory - attributeName: sAMAccountName - type: accountAttribute - - attributes: - sourceName: Okta - attributeName: login - type: accountAttribute - - attributes: - sourceName: HR Source - attributeName: employeeID - type: accountAttribute - ignoreErrors: - type: boolean - description: a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - - title: rule - oneOf: - - type: object - required: - - name - properties: - name: - type: string - description: This is the name of the Generic rule that needs to be invoked by the transform - example: Generic Calculation Rule - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - includeNumbers - - includeSpecialChars - - length - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `generateRandomString` - example: generateRandomString - includeNumbers: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include numbers - example: true - includeSpecialChars: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include special characters - example: true - length: - type: string - description: | - This specifies how long the randomly generated string needs to be - - - >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - uid - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `getReferenceIdentityAttribute` - example: getReferenceIdentityAttribute - uid: - type: string - description: | - This is the SailPoint User Name (uid) value of the identity whose attribute is desired - - As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. - example: 2c91808570313110017040b06f344ec9 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - title: identityAttribute + 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 - required: - - name properties: - name: + locale: type: string - description: The system (camel-cased) name of the identity attribute to bring in - example: email - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: indexOf + 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. + delete: + operationId: deleteTaggedObject + security: + - UserContextAuth: + - 'idn:tag:manage' + tags: + - Tagged Objects + summary: Delete Tagged Object + description: This deletes a tagged object for the specified type. + parameters: + - in: path + name: type + schema: + type: string + enum: + - ROLE + - IDENTITY + - SOD_POLICY + required: true + description: The type of tagged object to delete. + example: ROLE + - in: path + name: id + schema: + type: string + required: true + description: The ID of the object reference to delete. + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '204': + description: No content. + '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 - required: - - substring properties: - substring: + locale: type: string - description: 'A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.' - example: admin_ - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: iso3166 + 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: - format: + locale: type: string - description: | - An optional value to denote which ISO 3166 format to return. Valid values are: - - - `alpha2` - Two-character country code (e.g., "US"); this is the default value if no format is supplied - - - `alpha3` - Three-character country code (e.g., "USA") - - - `numeric` - The numeric country code (e.g., "840") - example: alpha2 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: leftPad + 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 - required: - - length properties: - length: + locale: type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: + description: 'The locale for the message text, a BCP 47 language tag.' + example: en-US + localeOrigin: type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length - - - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lookup + 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 - required: - - table properties: - table: - type: object - additionalProperties: true - description: | - This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched + 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. + /tagged-objects/bulk-add: + post: + operationId: setTagsToManyObjects + security: + - UserContextAuth: + - 'idn:tag:manage' + tags: + - Tagged Objects + summary: Tag Multiple Objects + description: |- + This API adds tags to multiple objects. + A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + requestBody: + required: true + description: 'Supported object types are ROLE, IDENTITY and SOD_POLICY.' + content: + application/json: + schema: + type: object + properties: + objectRefs: + type: array + items: + 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 + - WORKGROUP + example: IDENTITY + id: + type: string + description: ID of the object to which this reference applies + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + nullable: true + description: Human-readable display name of the object to which this reference applies + example: William Wilson + tags: + type: array + items: + type: string + description: Label to be applied to an Object + example: + - BU_FINANCE + - PCI + operation: + type: string + enum: + - APPEND + - MERGE + default: APPEND + description: |- + If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. - >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. - example: - USA: Americas - FRA: EMEA - AUS: APAC - default: Unknown Region - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lower + If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. + example: MERGE + responses: + '200': + description: Request succeeded. + content: + application/json: + schema: + type: object + properties: + objectRefs: + type: array + items: type: object properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: nameNormalizer + 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 + - WORKGROUP + example: IDENTITY + id: + type: string + description: ID of the object to which this reference applies + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + nullable: true + description: Human-readable display name of the object to which this reference applies + example: William Wilson + tags: + type: array + items: + type: string + description: Label to be applied to an Object + example: + - BU_FINANCE + - PCI + operation: + type: string + enum: + - APPEND + - MERGE + default: APPEND + description: |- + If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. + + If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. + example: MERGE + '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: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomAlphaNumeric + 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: - length: + locale: type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain - - - * This value must be a positive number and cannot be blank - - - * If no length is provided, the transform will default to a value of `32` - - - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomNumeric + 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: - length: + locale: type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain - - - * This value must be a positive number and cannot be blank - - - * If no length is provided, the transform will default to a value of `32` - - - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: reference - type: object - required: - - id - properties: - id: + description: 'The locale for the message text, a BCP 47 language tag.' + example: en-US + localeOrigin: type: string - description: This ID specifies the name of the pre-existing transform which you want to use within your current transform - example: Existing Transform - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replaceAll - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: 'An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.' - example: - '-': ' ' - '"': '''' - ñ: 'n' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replace + 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 - required: - - regex - - replacement properties: - regex: + locale: type: string - description: This can be a string or a regex pattern in which you want to replace. - example: '[^a-zA-Z]' - externalDocs: - description: Regex Builder - url: 'https://regex101.com/' - replacement: + description: 'The locale for the message text, a BCP 47 language tag.' + example: en-US + localeOrigin: type: string - description: This is the replacement string that should be substituded wherever the string or pattern is found. - example: ' ' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: rightPad + 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 - required: - - length properties: - length: + locale: type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: + description: 'The locale for the message text, a BCP 47 language tag.' + example: en-US + localeOrigin: type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length - - - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: split + 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 - required: - - delimiter - - index properties: - delimiter: + locale: type: string - description: 'This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data' - example: ',' - index: + description: 'The locale for the message text, a BCP 47 language tag.' + example: en-US + localeOrigin: type: string - description: 'An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.' - example: '5' - throws: - type: boolean - description: | - A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) - - - `true` - The transform should return "IndexOutOfBoundsException" - - - `false` - The transform should return null + 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. + /tagged-objects/bulk-remove: + post: + operationId: deleteTagsToManyObject + security: + - UserContextAuth: + - 'idn:tag:manage' + tags: + - Tagged Objects + summary: Remove Tags from Multiple Objects + description: |- + This API removes tags from multiple objects. + A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + requestBody: + description: 'Supported object types are ROLE, IDENTITY and SOD_POLICY.' + required: true + content: + application/json: + schema: + type: object + properties: + objectRefs: + type: array + items: + 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 + - WORKGROUP + example: IDENTITY + id: + type: string + description: ID of the object to which this reference applies + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + nullable: true + description: Human-readable display name of the object to which this reference applies + example: William Wilson + tags: + type: array + items: + type: string + description: Label to be applied to an Object + example: + - BU_FINANCE + - PCI + operation: + type: string + enum: + - APPEND + - MERGE + default: APPEND + description: |- + If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. - If not provided, the transform will default to false and return a null - example: true - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: static + If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. + example: MERGE + responses: + '204': + description: No content - indicates the request was successful but there is no content to be returned in the response. + '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 - required: - - values properties: - values: + locale: type: string - description: 'This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.' - example: string$variable - externalDocs: - description: Static Transform Documentation - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/static' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - - title: substring - type: object - required: - - begin - properties: - begin: - type: integer - description: | - The index of the first character to include in the returned substring. - - - If `begin` is set to -1, the transform will begin at character 0 of the input data - example: 1 - format: int32 - beginOffset: - type: integer - description: | - This integer value is the number of characters to add to the begin attribute when returning a substring. - - This attribute is only used if begin is not -1. - example: 3 - format: int32 - end: - type: integer - description: | - The index of the first character to exclude from the returned substring. - - If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. - example: 6 - format: int32 - endOffset: - type: integer - description: | - This integer value is the number of characters to add to the end attribute when returning a substring. - - This attribute is only used if end is provided and is not -1. - example: 1 - format: int32 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: trim + 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: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: upper + 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: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: uuid + 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: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - internal: - type: boolean - readOnly: true - description: Indicates whether this is an internal SailPoint-created transform or a customer-created transform - example: false - example: - name: Timestamp To Date - type: dateFormat - attributes: - inputFormat: 'MMM dd yyyy, HH:mm:ss.SSS' - outputFormat: yyyy/dd/MM - responses: - '201': - description: Indicates the transform was successfully created and returns its representation. + 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 - description: The representation of an internally- or customer-defined transform. - required: - - name - - type - - attributes properties: - id: - type: string - readOnly: true - description: Unique ID of this transform - example: 2cd78adghjkja34jh2b1hkjhasuecd - name: + 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: Unique name of this transform - example: Timestamp To Date - minLength: 1 - maxLength: 50 - type: + description: Fine-grained error code providing more detail of the error. + example: 400.1 Bad Request Content + trackingId: type: string - description: The type of transform operation - enum: - - accountAttribute - - base64Decode - - base64Encode - - concat - - conditional - - dateCompare - - dateFormat - - dateMath - - decomposeDiacriticalMarks - - e164phone - - firstValid - - rule - - identityAttribute - - indexOf - - iso3166 - - lastIndexOf - - leftPad - - lookup - - lower - - normalizeNames - - randomAlphaNumeric - - randomNumeric - - reference - - replaceAll - - replace - - rightPad - - split - - static - - substring - - trim - - upper - - usernameGenerator - - uuid - example: dateFormat - externalDocs: - description: Transform Operations - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations' - attributes: - description: Meta-data about the transform. Values in this list are specific to the type of transform to be executed. - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. + 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. + /transforms: + get: + tags: + - Transforms + summary: List transforms + description: |- + Gets a list of all saved transform objects. + A token with transforms-list read authority is required to call this API. + operationId: listTransforms + parameters: + - 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: 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: 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. - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: base64Decode - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: base64Encode - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: concat - type: object - required: - - values - properties: - values: - type: array - items: - type: object - description: An array of items to join together - example: - - John - - ' ' - - Smith - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: conditional - type: object - required: - - expression - - positiveCondition - - negativeCondition - properties: - expression: - type: string - description: |- - A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. + 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. - The `eq` operator is the only valid comparison - example: ValueA eq ValueB - positiveCondition: - type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: - type: string - description: The output of the transform if the expression evalutes to false - example: 'false' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateCompare - type: object - required: - - firstDate - - secondDate - - operator - - positiveCondition - - negativeCondition - properties: - firstDate: - description: This is the first date to consider (The date that would be on the left hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. + 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 + - name: name + in: query + description: Name of the transform to retrieve from the list. + required: false + style: form + schema: + type: string + example: ExampleTransformName123 + - name: filters + in: query + 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: + **internal**: *eq* + **name**: *eq*, *sw* + required: false + style: form + explode: true + example: name eq "Uppercase" + schema: + type: string + responses: + '200': + description: A list of transforms matching the given criteria. + content: + application/json: + schema: + type: array + items: + type: object + description: The representation of an internally- or customer-defined transform. + required: + - name + - type + - attributes + properties: + id: + type: string + readOnly: true + description: Unique ID of this transform + example: 2cd78adghjkja34jh2b1hkjhasuecd + name: + type: string + description: Unique name of this transform + example: Timestamp To Date + minLength: 1 + maxLength: 50 + type: + type: string + description: The type of transform operation + enum: + - accountAttribute + - base64Decode + - base64Encode + - concat + - conditional + - dateCompare + - dateFormat + - dateMath + - decomposeDiacriticalMarks + - e164phone + - firstValid + - rule + - identityAttribute + - indexOf + - iso3166 + - lastIndexOf + - leftPad + - lookup + - lower + - normalizeNames + - randomAlphaNumeric + - randomNumeric + - reference + - replaceAll + - replace + - rightPad + - split + - static + - substring + - trim + - upper + - usernameGenerator + - uuid + example: dateFormat + externalDocs: + description: Transform Operations + url: 'https://developer.sailpoint.com/idn/docs/transforms/operations' + attributes: + description: Meta-data about the transform. Values in this list are specific to the type of transform to be executed. + oneOf: + - title: accountAttribute + type: object + required: + - sourceName + - attributeName + properties: + sourceName: + type: string + description: A reference to the source to search for the account + example: Workday + attributeName: + type: string + description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' + example: DEPARTMENT + accountSortAttribute: + type: string + description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries + example: created + accountSortDescending: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' + example: false + accountReturnFirstLink: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' + example: false + accountFilter: + type: string + description: |- + This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. + Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements + example: '!(nativeIdentity.startsWith("*DELETED*"))' + accountPropertyFilter: + type: string + description: |- + This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat + All account attributes are available for filtering as this operation is performed in memory. + example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: base64Decode + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: base64Encode + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: concat + type: object + required: + - values + properties: + values: + type: array + items: type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) + description: An array of items to join together + example: + - John + - ' ' + - Smith + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: conditional + type: object + required: + - expression + - positiveCondition + - negativeCondition + properties: + expression: + type: string + description: |- + A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + The `eq` operator is the only valid comparison + example: ValueA eq ValueB + positiveCondition: + type: string + description: The output of the transform if the expression evalutes to true + example: 'true' + negativeCondition: + type: string + description: The output of the transform if the expression evalutes to false + example: 'false' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateCompare + type: object + required: + - firstDate + - secondDate + - operator + - positiveCondition + - negativeCondition + properties: + firstDate: + description: This is the first date to consider (The date that would be on the left hand side of the comparison operation). + oneOf: + - title: accountAttribute + type: object + required: + - sourceName + - attributeName + properties: + sourceName: + type: string + description: A reference to the source to search for the account + example: Workday + attributeName: + type: string + description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' + example: DEPARTMENT + accountSortAttribute: + type: string + description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries + example: created + accountSortDescending: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' + example: false + accountReturnFirstLink: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' + example: false + accountFilter: + type: string + description: |- + This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. + Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements + example: '!(nativeIdentity.startsWith("*DELETED*"))' + accountPropertyFilter: + type: string + description: |- + This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + All account attributes are available for filtering as this operation is performed in memory. + example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateFormat + type: object + properties: + inputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - secondDate: - description: This is the second date to consider (The date that would be on the right hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + outputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + secondDate: + description: This is the second date to consider (The date that would be on the right hand side of the comparison operation). + oneOf: + - title: accountAttribute + type: object + required: + - sourceName + - attributeName + properties: + sourceName: + type: string + description: A reference to the source to search for the account + example: Workday + attributeName: + type: string + description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' + example: DEPARTMENT + accountSortAttribute: + type: string + description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries + example: created + accountSortDescending: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' + example: false + accountReturnFirstLink: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' + example: false + accountFilter: + type: string + description: |- + This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. + Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements + example: '!(nativeIdentity.startsWith("*DELETED*"))' + accountPropertyFilter: + type: string + description: |- + This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + All account attributes are available for filtering as this operation is performed in memory. + example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateFormat + type: object + properties: + inputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - operator: - type: string - description: | - This is the comparison to perform. - | Operation | Description | - | --------- | ------- | - | LT | Strictly less than: firstDate < secondDate | - | LTE | Less than or equal to: firstDate <= secondDate | - | GT | Strictly greater than: firstDate > secondDate | - | GTE | Greater than or equal to: firstDate >= secondDate | - enum: - - LT - - LTE - - GT - - GTE - example: LT - positiveCondition: - type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: - type: string - description: The output of the transform if the expression evalutes to false - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + outputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + operator: + type: string + description: | + This is the comparison to perform. + | Operation | Description | + | --------- | ------- | + | LT | Strictly less than: firstDate < secondDate | + | LTE | Less than or equal to: firstDate <= secondDate | + | GT | Strictly greater than: firstDate > secondDate | + | GTE | Greater than or equal to: firstDate >= secondDate | + enum: + - LT + - LTE + - GT + - GTE + example: LT + positiveCondition: + type: string + description: The output of the transform if the expression evalutes to true + example: 'true' + negativeCondition: + type: string + description: The output of the transform if the expression evalutes to false + example: false + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateFormat + type: object + properties: + inputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateMath - type: object - required: - - expression - properties: - expression: - type: string - description: | - A string value of the date and time components to operation on, along with the math operations to execute. - externalDocs: - description: Date Math Expressions - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure' - example: now+1w - roundUp: - type: boolean - description: | - A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + outputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - If not provided, the transform will default to `false` + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) - `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateMath + type: object + required: + - expression + properties: + expression: + type: string + description: | + A string value of the date and time components to operation on, along with the math operations to execute. + externalDocs: + description: Date Math Expressions + url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure' + example: now+1w + roundUp: + type: boolean + description: | + A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. - `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: decomposeDiacriticalMarks - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: e164phone - type: object - properties: - defaultRegion: - type: string - description: | - This is an optional attribute that can be used to define the region of the phone number to format into. + If not provided, the transform will default to `false` - If defaultRegion is not provided, it will take US as the default country. + `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) - The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - example: US - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: firstValid - type: object - required: - - values - properties: - values: - type: array - items: + `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) + example: false + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: type: object - description: An array of attributes to evaluate for existence. - example: - - attributes: - sourceName: Active Directory - attributeName: sAMAccountName - type: accountAttribute - - attributes: - sourceName: Okta - attributeName: login + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: type: accountAttribute - - attributes: - sourceName: HR Source - attributeName: employeeID + attributes: + attributeName: first_name + sourceName: Source + - title: decomposeDiacriticalMarks + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: type: accountAttribute - ignoreErrors: - type: boolean - description: a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - - title: rule - oneOf: - - type: object - required: - - name - properties: - name: - type: string - description: This is the name of the Generic rule that needs to be invoked by the transform - example: Generic Calculation Rule - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - includeNumbers - - includeSpecialChars - - length - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `generateRandomString` - example: generateRandomString - includeNumbers: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include numbers - example: true - includeSpecialChars: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include special characters - example: true - length: - type: string - description: | - This specifies how long the randomly generated string needs to be - - - >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - uid - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `getReferenceIdentityAttribute` - example: getReferenceIdentityAttribute - uid: - type: string - description: | - This is the SailPoint User Name (uid) value of the identity whose attribute is desired + attributes: + attributeName: first_name + sourceName: Source + - title: e164phone + type: object + properties: + defaultRegion: + type: string + description: | + This is an optional attribute that can be used to define the region of the phone number to format into. - As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. - example: 2c91808570313110017040b06f344ec9 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - title: identityAttribute - type: object - required: - - name - properties: - name: - type: string - description: The system (camel-cased) name of the identity attribute to bring in - example: email - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: indexOf - type: object - required: - - substring - properties: - substring: - type: string - description: 'A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.' - example: admin_ - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: iso3166 - type: object - properties: - format: - type: string - description: | - An optional value to denote which ISO 3166 format to return. Valid values are: + If defaultRegion is not provided, it will take US as the default country. - `alpha2` - Two-character country code (e.g., "US"); this is the default value if no format is supplied + The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + example: US + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: firstValid + type: object + required: + - values + properties: + values: + type: array + items: + type: object + description: An array of attributes to evaluate for existence. + example: + - attributes: + sourceName: Active Directory + attributeName: sAMAccountName + type: accountAttribute + - attributes: + sourceName: Okta + attributeName: login + type: accountAttribute + - attributes: + sourceName: HR Source + attributeName: employeeID + type: accountAttribute + ignoreErrors: + type: boolean + description: a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. + example: false + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + - title: rule + oneOf: + - type: object + required: + - name + properties: + name: + type: string + description: This is the name of the Generic rule that needs to be invoked by the transform + example: Generic Calculation Rule + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + - type: object + required: + - name + - operation + - includeNumbers + - includeSpecialChars + - length + properties: + name: + type: string + description: This must always be set to "Cloud Services Deployment Utility" + example: Cloud Services Deployment Utility + operation: + type: string + description: The operation to perform `generateRandomString` + example: generateRandomString + includeNumbers: + type: boolean + description: This must be either "true" or "false" to indicate whether the generator logic should include numbers + example: true + includeSpecialChars: + type: boolean + description: This must be either "true" or "false" to indicate whether the generator logic should include special characters + example: true + length: + type: string + description: | + This specifies how long the randomly generated string needs to be - `alpha3` - Three-character country code (e.g., "USA") + >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters + example: '10' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + - type: object + required: + - name + - operation + - uid + properties: + name: + type: string + description: This must always be set to "Cloud Services Deployment Utility" + example: Cloud Services Deployment Utility + operation: + type: string + description: The operation to perform `getReferenceIdentityAttribute` + example: getReferenceIdentityAttribute + uid: + type: string + description: | + This is the SailPoint User Name (uid) value of the identity whose attribute is desired - `numeric` - The numeric country code (e.g., "840") - example: alpha2 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: leftPad - type: object - required: - - length - properties: - length: - type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: - type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length + As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. + example: 2c91808570313110017040b06f344ec9 + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + - title: identityAttribute + type: object + required: + - name + properties: + name: + type: string + description: The system (camel-cased) name of the identity attribute to bring in + example: email + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: indexOf + type: object + required: + - substring + properties: + substring: + type: string + description: 'A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.' + example: admin_ + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: iso3166 + type: object + properties: + format: + type: string + description: | + An optional value to denote which ISO 3166 format to return. Valid values are: - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lookup - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: | - This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched + `alpha2` - Two-character country code (e.g., "US"); this is the default value if no format is supplied - >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. - example: - USA: Americas - FRA: EMEA - AUS: APAC - default: Unknown Region - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lower - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: nameNormalizer - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomAlphaNumeric - type: object - properties: - length: - type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain + `alpha3` - Three-character country code (e.g., "USA") - * This value must be a positive number and cannot be blank + `numeric` - The numeric country code (e.g., "840") + example: alpha2 + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: leftPad + type: object + required: + - length + properties: + length: + type: string + description: An integer value for the desired length of the final output string + example: '4' + padding: + type: string + description: | + A string value representing the character that the incoming data should be padded with to get to the desired length - * If no length is provided, the transform will default to a value of `32` + If not provided, the transform will default to a single space (" ") character for padding + example: '0' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: lookup + type: object + required: + - table + properties: + table: + type: object + additionalProperties: true + description: | + This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomNumeric - type: object - properties: - length: - type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain + >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. + example: + USA: Americas + FRA: EMEA + AUS: APAC + default: Unknown Region + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: lower + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: nameNormalizer + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: randomAlphaNumeric + type: object + properties: + length: + type: string + description: | + This is an integer value specifying the size/number of characters the random string must contain - * This value must be a positive number and cannot be blank + * This value must be a positive number and cannot be blank - * If no length is provided, the transform will default to a value of `32` + * If no length is provided, the transform will default to a value of `32` - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: reference - type: object - required: - - id - properties: - id: - type: string - description: This ID specifies the name of the pre-existing transform which you want to use within your current transform - example: Existing Transform - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replaceAll - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: 'An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.' - example: - '-': ' ' - '"': '''' - ñ: 'n' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replace - type: object - required: - - regex - - replacement - properties: - regex: - type: string - description: This can be a string or a regex pattern in which you want to replace. - example: '[^a-zA-Z]' - externalDocs: - description: Regex Builder - url: 'https://regex101.com/' - replacement: - type: string - description: This is the replacement string that should be substituded wherever the string or pattern is found. - example: ' ' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: rightPad - type: object - required: - - length - properties: - length: - type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: - type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length + * Due to identity attribute data constraints, the maximum allowable value is `450` characters + example: '10' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: randomNumeric + type: object + properties: + length: + type: string + description: | + This is an integer value specifying the size/number of characters the random string must contain - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: split - type: object - required: - - delimiter - - index - properties: - delimiter: - type: string - description: 'This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data' - example: ',' - index: - type: string - description: 'An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.' - example: '5' - throws: - type: boolean - description: | - A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) + * This value must be a positive number and cannot be blank + + + * If no length is provided, the transform will default to a value of `32` + + + * Due to identity attribute data constraints, the maximum allowable value is `450` characters + example: '10' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: reference + type: object + required: + - id + properties: + id: + type: string + description: This ID specifies the name of the pre-existing transform which you want to use within your current transform + example: Existing Transform + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: replaceAll + type: object + required: + - table + properties: + table: + type: object + additionalProperties: true + description: 'An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.' + example: + '-': ' ' + '"': '''' + ñ: 'n' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: replace + type: object + required: + - regex + - replacement + properties: + regex: + type: string + description: This can be a string or a regex pattern in which you want to replace. + example: '[^a-zA-Z]' + externalDocs: + description: Regex Builder + url: 'https://regex101.com/' + replacement: + type: string + description: This is the replacement string that should be substituded wherever the string or pattern is found. + example: ' ' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: rightPad + type: object + required: + - length + properties: + length: + type: string + description: An integer value for the desired length of the final output string + example: '4' + padding: + type: string + description: | + A string value representing the character that the incoming data should be padded with to get to the desired length - `true` - The transform should return "IndexOutOfBoundsException" + If not provided, the transform will default to a single space (" ") character for padding + example: '0' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: split + type: object + required: + - delimiter + - index + properties: + delimiter: + type: string + description: 'This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data' + example: ',' + index: + type: string + description: 'An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.' + example: '5' + throws: + type: boolean + description: | + A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) - `false` - The transform should return null + `true` - The transform should return "IndexOutOfBoundsException" - If not provided, the transform will default to false and return a null - example: true - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: static - type: object - required: - - values - properties: - values: - type: string - description: 'This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.' - example: string$variable - externalDocs: - description: Static Transform Documentation - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/static' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - - title: substring - type: object - required: - - begin - properties: - begin: - type: integer - description: | - The index of the first character to include in the returned substring. + `false` - The transform should return null - If `begin` is set to -1, the transform will begin at character 0 of the input data - example: 1 - format: int32 - beginOffset: - type: integer - description: | - This integer value is the number of characters to add to the begin attribute when returning a substring. + If not provided, the transform will default to false and return a null + example: true + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: static + type: object + required: + - values + properties: + values: + type: string + description: 'This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.' + example: string$variable + externalDocs: + description: Static Transform Documentation + url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/static' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + - title: substring + type: object + required: + - begin + properties: + begin: + type: integer + description: | + The index of the first character to include in the returned substring. - This attribute is only used if begin is not -1. - example: 3 - format: int32 - end: - type: integer - description: | - The index of the first character to exclude from the returned substring. - If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. - example: 6 - format: int32 - endOffset: - type: integer - description: | - This integer value is the number of characters to add to the end attribute when returning a substring. + If `begin` is set to -1, the transform will begin at character 0 of the input data + example: 1 + format: int32 + beginOffset: + type: integer + description: | + This integer value is the number of characters to add to the begin attribute when returning a substring. - This attribute is only used if end is provided and is not -1. - example: 1 - format: int32 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: trim - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: upper - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: uuid - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - internal: - type: boolean - readOnly: true - description: Indicates whether this is an internal SailPoint-created transform or a customer-created transform - example: false + This attribute is only used if begin is not -1. + example: 3 + format: int32 + end: + type: integer + description: | + The index of the first character to exclude from the returned substring. + + If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. + example: 6 + format: int32 + endOffset: + type: integer + description: | + This integer value is the number of characters to add to the end attribute when returning a substring. + + This attribute is only used if end is provided and is not -1. + example: 1 + format: int32 + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: trim + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: upper + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: uuid + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + internal: + type: boolean + readOnly: true + description: Indicates whether this is an internal SailPoint-created transform or a customer-created transform + example: false + example: + - id: 2cd78adghjkja34jh2b1hkjhasuecd + name: Timestamp To Date + type: dateFormat + attributes: + inputFormat: 'MMM-dd-yyyy, HH:mm:ss.SSS' + outputFormat: yyyy/dd/MM + internal: false + - id: 2lkas8dhj4bkuakja77giih7l4ashh + name: PrefixSubstring + type: substring + attributes: + begin: 0 + end: 3 + internal: true '400': description: Client Error - Returned if the request body is invalid. content: @@ -110023,1300 +107883,1572 @@ paths: 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: + 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. + security: + - UserContextAuth: + - 'idn:transform:read' + post: + tags: + - Transforms + summary: Create transform + description: 'Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. A token with transform write authority is required to call this API.' + operationId: createTransform + requestBody: + required: true + description: The transform to be created. + content: + application/json: + schema: + type: object + description: The representation of an internally- or customer-defined transform. + required: + - name + - type + - attributes + properties: + id: + type: string + readOnly: true + description: Unique ID of this transform + example: 2cd78adghjkja34jh2b1hkjhasuecd + name: + type: string + description: Unique name of this transform + example: Timestamp To Date + minLength: 1 + maxLength: 50 + type: + type: string + description: The type of transform operation + enum: + - accountAttribute + - base64Decode + - base64Encode + - concat + - conditional + - dateCompare + - dateFormat + - dateMath + - decomposeDiacriticalMarks + - e164phone + - firstValid + - rule + - identityAttribute + - indexOf + - iso3166 + - lastIndexOf + - leftPad + - lookup + - lower + - normalizeNames + - randomAlphaNumeric + - randomNumeric + - reference + - replaceAll + - replace + - rightPad + - split + - static + - substring + - trim + - upper + - usernameGenerator + - uuid + example: dateFormat + externalDocs: + description: Transform Operations + url: 'https://developer.sailpoint.com/idn/docs/transforms/operations' + attributes: + description: Meta-data about the transform. Values in this list are specific to the type of transform to be executed. + oneOf: + - title: accountAttribute + type: object + required: + - sourceName + - attributeName + properties: + sourceName: + type: string + description: A reference to the source to search for the account + example: Workday + attributeName: + type: string + description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' + example: DEPARTMENT + accountSortAttribute: + type: string + description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries + example: created + accountSortDescending: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' + example: false + accountReturnFirstLink: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' + example: false + accountFilter: + type: string + description: |- + This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. + Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements + example: '!(nativeIdentity.startsWith("*DELETED*"))' + accountPropertyFilter: + type: string + description: |- + This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. + + All account attributes are available for filtering as this operation is performed in memory. + example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: base64Decode + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: base64Encode type: object properties: - locale: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: concat + type: object + required: + - values + properties: + values: + type: array + items: + type: object + description: An array of items to join together + example: + - John + - ' ' + - Smith + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: conditional + type: object + required: + - expression + - positiveCondition + - negativeCondition + properties: + expression: type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: + description: |- + A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. + + The `eq` operator is the only valid comparison + example: ValueA eq ValueB + positiveCondition: 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: + description: The output of the transform if the expression evalutes to true + example: 'true' + negativeCondition: 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. - security: - - UserContextAuth: - - 'idn:transform:update' - '/transforms/{id}': - get: - tags: - - Transforms - summary: Transform by ID - description: |- - This API returns the transform specified by the given ID. - A token with transform read authority is required to call this API. - operationId: getTransform - parameters: - - name: id - in: path - description: ID of the transform to retrieve - required: true - style: simple - explode: false - example: 2cd78adghjkja34jh2b1hkjhasuecd - schema: - type: string - responses: - '200': - description: Transform with the given ID - content: - application/json: - schema: - type: object - description: The representation of an internally- or customer-defined transform. - required: - - name - - type - - attributes - properties: - id: - type: string - readOnly: true - description: Unique ID of this transform - example: 2cd78adghjkja34jh2b1hkjhasuecd - name: - type: string - description: Unique name of this transform - example: Timestamp To Date - minLength: 1 - maxLength: 50 - type: - type: string - description: The type of transform operation - enum: - - accountAttribute - - base64Decode - - base64Encode - - concat - - conditional - - dateCompare - - dateFormat - - dateMath - - decomposeDiacriticalMarks - - e164phone - - firstValid - - rule - - identityAttribute - - indexOf - - iso3166 - - lastIndexOf - - leftPad - - lookup - - lower - - normalizeNames - - randomAlphaNumeric - - randomNumeric - - reference - - replaceAll - - replace - - rightPad - - split - - static - - substring - - trim - - upper - - usernameGenerator - - uuid - example: dateFormat - externalDocs: - description: Transform Operations - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations' - attributes: - description: Meta-data about the transform. Values in this list are specific to the type of transform to be executed. - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. + description: The output of the transform if the expression evalutes to false + example: 'false' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateCompare + type: object + required: + - firstDate + - secondDate + - operator + - positiveCondition + - negativeCondition + properties: + firstDate: + description: This is the first date to consider (The date that would be on the left hand side of the comparison operation). + oneOf: + - title: accountAttribute + type: object + required: + - sourceName + - attributeName + properties: + sourceName: + type: string + description: A reference to the source to search for the account + example: Workday + attributeName: + type: string + description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' + example: DEPARTMENT + accountSortAttribute: + type: string + description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries + example: created + accountSortDescending: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' + example: false + accountReturnFirstLink: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' + example: false + accountFilter: + type: string + description: |- + This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. + Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements + example: '!(nativeIdentity.startsWith("*DELETED*"))' + accountPropertyFilter: + type: string + description: |- + This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: base64Decode - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: base64Encode - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: concat - type: object - required: - - values - properties: - values: - type: array - items: + All account attributes are available for filtering as this operation is performed in memory. + example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateFormat + type: object + properties: + inputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + outputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + secondDate: + description: This is the second date to consider (The date that would be on the right hand side of the comparison operation). + oneOf: + - title: accountAttribute + type: object + required: + - sourceName + - attributeName + properties: + sourceName: + type: string + description: A reference to the source to search for the account + example: Workday + attributeName: + type: string + description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' + example: DEPARTMENT + accountSortAttribute: + type: string + description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries + example: created + accountSortDescending: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' + example: false + accountReturnFirstLink: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' + example: false + accountFilter: + type: string + description: |- + This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. + Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements + example: '!(nativeIdentity.startsWith("*DELETED*"))' + accountPropertyFilter: + type: string + description: |- + This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. + + All account attributes are available for filtering as this operation is performed in memory. + example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateFormat type: object - description: An array of items to join together - example: - - John - - ' ' - - Smith - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: conditional - type: object - required: - - expression - - positiveCondition - - negativeCondition - properties: - expression: - type: string - description: |- - A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. + properties: + inputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - The `eq` operator is the only valid comparison - example: ValueA eq ValueB - positiveCondition: - type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: - type: string - description: The output of the transform if the expression evalutes to false - example: 'false' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateCompare - type: object - required: - - firstDate - - secondDate - - operator - - positiveCondition - - negativeCondition - properties: - firstDate: - description: This is the first date to consider (The date that would be on the left hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + outputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + operator: + type: string + description: | + This is the comparison to perform. + | Operation | Description | + | --------- | ------- | + | LT | Strictly less than: firstDate < secondDate | + | LTE | Less than or equal to: firstDate <= secondDate | + | GT | Strictly greater than: firstDate > secondDate | + | GTE | Greater than or equal to: firstDate >= secondDate | + enum: + - LT + - LTE + - GT + - GTE + example: LT + positiveCondition: + type: string + description: The output of the transform if the expression evalutes to true + example: 'true' + negativeCondition: + type: string + description: The output of the transform if the expression evalutes to false + example: false + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateFormat + type: object + properties: + inputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - secondDate: - description: This is the second date to consider (The date that would be on the right hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + outputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateMath + type: object + required: + - expression + properties: + expression: + type: string + description: | + A string value of the date and time components to operation on, along with the math operations to execute. + externalDocs: + description: Date Math Expressions + url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure' + example: now+1w + roundUp: + type: boolean + description: | + A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + If not provided, the transform will default to `false` - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - operator: - type: string - description: | - This is the comparison to perform. - | Operation | Description | - | --------- | ------- | - | LT | Strictly less than: firstDate < secondDate | - | LTE | Less than or equal to: firstDate <= secondDate | - | GT | Strictly greater than: firstDate > secondDate | - | GTE | Greater than or equal to: firstDate >= secondDate | - enum: - - LT - - LTE - - GT - - GTE - example: LT - positiveCondition: - type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: - type: string - description: The output of the transform if the expression evalutes to false - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) + `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) + example: false + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: decomposeDiacriticalMarks + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: e164phone + type: object + properties: + defaultRegion: + type: string + description: | + This is an optional attribute that can be used to define the region of the phone number to format into. - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + If defaultRegion is not provided, it will take US as the default country. - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: + The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + example: US + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: firstValid + type: object + required: + - values + properties: + values: + type: array + items: type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: + description: An array of attributes to evaluate for existence. + example: + - attributes: + sourceName: Active Directory + attributeName: sAMAccountName type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateMath - type: object - required: - - expression - properties: - expression: - type: string - description: | - A string value of the date and time components to operation on, along with the math operations to execute. - externalDocs: - description: Date Math Expressions - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure' - example: now+1w - roundUp: - type: boolean - description: | - A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. + - attributes: + sourceName: Okta + attributeName: login + type: accountAttribute + - attributes: + sourceName: HR Source + attributeName: employeeID + type: accountAttribute + ignoreErrors: + type: boolean + description: a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. + example: false + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + - title: rule + oneOf: + - type: object + required: + - name + properties: + name: + type: string + description: This is the name of the Generic rule that needs to be invoked by the transform + example: Generic Calculation Rule + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + - type: object + required: + - name + - operation + - includeNumbers + - includeSpecialChars + - length + properties: + name: + type: string + description: This must always be set to "Cloud Services Deployment Utility" + example: Cloud Services Deployment Utility + operation: + type: string + description: The operation to perform `generateRandomString` + example: generateRandomString + includeNumbers: + type: boolean + description: This must be either "true" or "false" to indicate whether the generator logic should include numbers + example: true + includeSpecialChars: + type: boolean + description: This must be either "true" or "false" to indicate whether the generator logic should include special characters + example: true + length: + type: string + description: | + This specifies how long the randomly generated string needs to be + + + >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters + example: '10' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + - type: object + required: + - name + - operation + - uid + properties: + name: + type: string + description: This must always be set to "Cloud Services Deployment Utility" + example: Cloud Services Deployment Utility + operation: + type: string + description: The operation to perform `getReferenceIdentityAttribute` + example: getReferenceIdentityAttribute + uid: + type: string + description: | + This is the SailPoint User Name (uid) value of the identity whose attribute is desired + + As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. + example: 2c91808570313110017040b06f344ec9 + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + - title: identityAttribute + type: object + required: + - name + properties: + name: + type: string + description: The system (camel-cased) name of the identity attribute to bring in + example: email + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: indexOf + type: object + required: + - substring + properties: + substring: + type: string + description: 'A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.' + example: admin_ + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: iso3166 + type: object + properties: + format: + type: string + description: | + An optional value to denote which ISO 3166 format to return. Valid values are: - If not provided, the transform will default to `false` + `alpha2` - Two-character country code (e.g., "US"); this is the default value if no format is supplied - `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) + `alpha3` - Three-character country code (e.g., "USA") - `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: decomposeDiacriticalMarks - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: e164phone - type: object - properties: - defaultRegion: - type: string - description: | - This is an optional attribute that can be used to define the region of the phone number to format into. + `numeric` - The numeric country code (e.g., "840") + example: alpha2 + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: leftPad + type: object + required: + - length + properties: + length: + type: string + description: An integer value for the desired length of the final output string + example: '4' + padding: + type: string + description: | + A string value representing the character that the incoming data should be padded with to get to the desired length - If defaultRegion is not provided, it will take US as the default country. + If not provided, the transform will default to a single space (" ") character for padding + example: '0' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: lookup + type: object + required: + - table + properties: + table: + type: object + additionalProperties: true + description: | + This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched - The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - example: US - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: firstValid - type: object - required: - - values - properties: - values: - type: array - items: - type: object - description: An array of attributes to evaluate for existence. - example: - - attributes: - sourceName: Active Directory - attributeName: sAMAccountName - type: accountAttribute - - attributes: - sourceName: Okta - attributeName: login - type: accountAttribute - - attributes: - sourceName: HR Source - attributeName: employeeID - type: accountAttribute - ignoreErrors: - type: boolean - description: a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - - title: rule - oneOf: - - type: object - required: - - name - properties: - name: - type: string - description: This is the name of the Generic rule that needs to be invoked by the transform - example: Generic Calculation Rule - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - includeNumbers - - includeSpecialChars - - length - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `generateRandomString` - example: generateRandomString - includeNumbers: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include numbers - example: true - includeSpecialChars: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include special characters - example: true - length: - type: string - description: | - This specifies how long the randomly generated string needs to be + >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. + example: + USA: Americas + FRA: EMEA + AUS: APAC + default: Unknown Region + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: lower + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: nameNormalizer + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: randomAlphaNumeric + type: object + properties: + length: + type: string + description: | + This is an integer value specifying the size/number of characters the random string must contain - >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - uid - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `getReferenceIdentityAttribute` - example: getReferenceIdentityAttribute - uid: - type: string - description: | - This is the SailPoint User Name (uid) value of the identity whose attribute is desired + * This value must be a positive number and cannot be blank - As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. - example: 2c91808570313110017040b06f344ec9 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - title: identityAttribute - type: object - required: - - name - properties: - name: - type: string - description: The system (camel-cased) name of the identity attribute to bring in - example: email - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: indexOf - type: object - required: - - substring - properties: - substring: - type: string - description: 'A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.' - example: admin_ - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: iso3166 - type: object - properties: - format: - type: string - description: | - An optional value to denote which ISO 3166 format to return. Valid values are: + * If no length is provided, the transform will default to a value of `32` - `alpha2` - Two-character country code (e.g., "US"); this is the default value if no format is supplied + * Due to identity attribute data constraints, the maximum allowable value is `450` characters + example: '10' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: randomNumeric + type: object + properties: + length: + type: string + description: | + This is an integer value specifying the size/number of characters the random string must contain - `alpha3` - Three-character country code (e.g., "USA") + * This value must be a positive number and cannot be blank - `numeric` - The numeric country code (e.g., "840") - example: alpha2 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: leftPad - type: object - required: - - length - properties: - length: - type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: - type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length + * If no length is provided, the transform will default to a value of `32` - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lookup - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: | - This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched + * Due to identity attribute data constraints, the maximum allowable value is `450` characters + example: '10' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: reference + type: object + required: + - id + properties: + id: + type: string + description: This ID specifies the name of the pre-existing transform which you want to use within your current transform + example: Existing Transform + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: replaceAll + type: object + required: + - table + properties: + table: + type: object + additionalProperties: true + description: 'An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.' + example: + '-': ' ' + '"': '''' + ñ: 'n' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: replace + type: object + required: + - regex + - replacement + properties: + regex: + type: string + description: This can be a string or a regex pattern in which you want to replace. + example: '[^a-zA-Z]' + externalDocs: + description: Regex Builder + url: 'https://regex101.com/' + replacement: + type: string + description: This is the replacement string that should be substituded wherever the string or pattern is found. + example: ' ' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: rightPad + type: object + required: + - length + properties: + length: + type: string + description: An integer value for the desired length of the final output string + example: '4' + padding: + type: string + description: | + A string value representing the character that the incoming data should be padded with to get to the desired length - >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. - example: - USA: Americas - FRA: EMEA - AUS: APAC - default: Unknown Region - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lower - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: nameNormalizer - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomAlphaNumeric - type: object - properties: - length: - type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain + If not provided, the transform will default to a single space (" ") character for padding + example: '0' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: split + type: object + required: + - delimiter + - index + properties: + delimiter: + type: string + description: 'This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data' + example: ',' + index: + type: string + description: 'An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.' + example: '5' + throws: + type: boolean + description: | + A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) - * This value must be a positive number and cannot be blank + `true` - The transform should return "IndexOutOfBoundsException" - * If no length is provided, the transform will default to a value of `32` + `false` - The transform should return null - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomNumeric - type: object - properties: - length: - type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain + If not provided, the transform will default to false and return a null + example: true + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: static + type: object + required: + - values + properties: + values: + type: string + description: 'This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.' + example: string$variable + externalDocs: + description: Static Transform Documentation + url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/static' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + - title: substring + type: object + required: + - begin + properties: + begin: + type: integer + description: | + The index of the first character to include in the returned substring. - * This value must be a positive number and cannot be blank + If `begin` is set to -1, the transform will begin at character 0 of the input data + example: 1 + format: int32 + beginOffset: + type: integer + description: | + This integer value is the number of characters to add to the begin attribute when returning a substring. - * If no length is provided, the transform will default to a value of `32` + This attribute is only used if begin is not -1. + example: 3 + format: int32 + end: + type: integer + description: | + The index of the first character to exclude from the returned substring. + If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. + example: 6 + format: int32 + endOffset: + type: integer + description: | + This integer value is the number of characters to add to the end attribute when returning a substring. - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: reference + This attribute is only used if end is provided and is not -1. + example: 1 + format: int32 + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: trim + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: upper + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: uuid + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + internal: + type: boolean + readOnly: true + description: Indicates whether this is an internal SailPoint-created transform or a customer-created transform + example: false + example: + name: Timestamp To Date + type: dateFormat + attributes: + inputFormat: 'MMM dd yyyy, HH:mm:ss.SSS' + outputFormat: yyyy/dd/MM + responses: + '201': + description: Indicates the transform was successfully created and returns its representation. + content: + application/json: + schema: + type: object + description: The representation of an internally- or customer-defined transform. + required: + - name + - type + - attributes + properties: + id: + type: string + readOnly: true + description: Unique ID of this transform + example: 2cd78adghjkja34jh2b1hkjhasuecd + name: + type: string + description: Unique name of this transform + example: Timestamp To Date + minLength: 1 + maxLength: 50 + type: + type: string + description: The type of transform operation + enum: + - accountAttribute + - base64Decode + - base64Encode + - concat + - conditional + - dateCompare + - dateFormat + - dateMath + - decomposeDiacriticalMarks + - e164phone + - firstValid + - rule + - identityAttribute + - indexOf + - iso3166 + - lastIndexOf + - leftPad + - lookup + - lower + - normalizeNames + - randomAlphaNumeric + - randomNumeric + - reference + - replaceAll + - replace + - rightPad + - split + - static + - substring + - trim + - upper + - usernameGenerator + - uuid + example: dateFormat + externalDocs: + description: Transform Operations + url: 'https://developer.sailpoint.com/idn/docs/transforms/operations' + attributes: + description: Meta-data about the transform. Values in this list are specific to the type of transform to be executed. + oneOf: + - title: accountAttribute type: object required: - - id + - sourceName + - attributeName properties: - id: + sourceName: type: string - description: This ID specifies the name of the pre-existing transform which you want to use within your current transform - example: Existing Transform - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replaceAll - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: 'An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.' - example: - '-': ' ' - '"': '''' - ñ: 'n' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replace - type: object - required: - - regex - - replacement - properties: - regex: + description: A reference to the source to search for the account + example: Workday + attributeName: type: string - description: This can be a string or a regex pattern in which you want to replace. - example: '[^a-zA-Z]' - externalDocs: - description: Regex Builder - url: 'https://regex101.com/' - replacement: + description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' + example: DEPARTMENT + accountSortAttribute: type: string - description: This is the replacement string that should be substituded wherever the string or pattern is found. - example: ' ' - requiresPeriodicRefresh: + description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries + example: created + accountSortDescending: type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: rightPad - type: object - required: - - length - properties: - length: + accountReturnFirstLink: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' + example: false + accountFilter: type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: + description: |- + This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. + Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements + example: '!(nativeIdentity.startsWith("*DELETED*"))' + accountPropertyFilter: type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length - + description: |- + This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - If not provided, the transform will default to a single space (" ") character for padding - example: '0' + All account attributes are available for filtering as this operation is performed in memory. + example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' requiresPeriodicRefresh: type: boolean description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process @@ -111331,34 +109463,9 @@ paths: attributes: attributeName: first_name sourceName: Source - - title: split - type: object - required: - - delimiter - - index - properties: - delimiter: - type: string - description: 'This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data' - example: ',' - index: - type: string - description: 'An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.' - example: '5' - throws: - type: boolean - description: | - A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) - - - `true` - The transform should return "IndexOutOfBoundsException" - - - `false` - The transform should return null - - - If not provided, the transform will default to false and return a null - example: true + - title: base64Decode + type: object + properties: requiresPeriodicRefresh: type: boolean description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process @@ -111373,61 +109480,73 @@ paths: attributes: attributeName: first_name sourceName: Source - - title: static + - title: base64Encode + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: concat type: object required: - values properties: values: - type: string - description: 'This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.' - example: string$variable - externalDocs: - description: Static Transform Documentation - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/static' + type: array + items: + type: object + description: An array of items to join together + example: + - John + - ' ' + - Smith requiresPeriodicRefresh: type: boolean description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process example: false default: false - - title: substring + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: conditional type: object required: - - begin + - expression + - positiveCondition + - negativeCondition properties: - begin: - type: integer - description: | - The index of the first character to include in the returned substring. - - - If `begin` is set to -1, the transform will begin at character 0 of the input data - example: 1 - format: int32 - beginOffset: - type: integer - description: | - This integer value is the number of characters to add to the begin attribute when returning a substring. - - This attribute is only used if begin is not -1. - example: 3 - format: int32 - end: - type: integer - description: | - The index of the first character to exclude from the returned substring. - - If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. - example: 6 - format: int32 - endOffset: - type: integer - description: | - This integer value is the number of characters to add to the end attribute when returning a substring. + expression: + type: string + description: |- + A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. - This attribute is only used if end is provided and is not -1. - example: 1 - format: int32 + The `eq` operator is the only valid comparison + example: ValueA eq ValueB + positiveCondition: + type: string + description: The output of the transform if the expression evalutes to true + example: 'true' + negativeCondition: + type: string + description: The output of the transform if the expression evalutes to false + example: 'false' requiresPeriodicRefresh: type: boolean description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process @@ -111442,9 +109561,365 @@ paths: attributes: attributeName: first_name sourceName: Source - - title: trim + - title: dateCompare type: object + required: + - firstDate + - secondDate + - operator + - positiveCondition + - negativeCondition properties: + firstDate: + description: This is the first date to consider (The date that would be on the left hand side of the comparison operation). + oneOf: + - title: accountAttribute + type: object + required: + - sourceName + - attributeName + properties: + sourceName: + type: string + description: A reference to the source to search for the account + example: Workday + attributeName: + type: string + description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' + example: DEPARTMENT + accountSortAttribute: + type: string + description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries + example: created + accountSortDescending: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' + example: false + accountReturnFirstLink: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' + example: false + accountFilter: + type: string + description: |- + This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. + Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements + example: '!(nativeIdentity.startsWith("*DELETED*"))' + accountPropertyFilter: + type: string + description: |- + This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. + + All account attributes are available for filtering as this operation is performed in memory. + example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateFormat + type: object + properties: + inputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + outputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + secondDate: + description: This is the second date to consider (The date that would be on the right hand side of the comparison operation). + oneOf: + - title: accountAttribute + type: object + required: + - sourceName + - attributeName + properties: + sourceName: + type: string + description: A reference to the source to search for the account + example: Workday + attributeName: + type: string + description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' + example: DEPARTMENT + accountSortAttribute: + type: string + description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries + example: created + accountSortDescending: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' + example: false + accountReturnFirstLink: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' + example: false + accountFilter: + type: string + description: |- + This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. + Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements + example: '!(nativeIdentity.startsWith("*DELETED*"))' + accountPropertyFilter: + type: string + description: |- + This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. + + All account attributes are available for filtering as this operation is performed in memory. + example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateFormat + type: object + properties: + inputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + outputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + operator: + type: string + description: | + This is the comparison to perform. + | Operation | Description | + | --------- | ------- | + | LT | Strictly less than: firstDate < secondDate | + | LTE | Less than or equal to: firstDate <= secondDate | + | GT | Strictly greater than: firstDate > secondDate | + | GTE | Greater than or equal to: firstDate >= secondDate | + enum: + - LT + - LTE + - GT + - GTE + example: LT + positiveCondition: + type: string + description: The output of the transform if the expression evalutes to true + example: 'true' + negativeCondition: + type: string + description: The output of the transform if the expression evalutes to false + example: false requiresPeriodicRefresh: type: boolean description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process @@ -111459,9 +109934,99 @@ paths: attributes: attributeName: first_name sourceName: Source - - title: upper + - title: dateFormat type: object properties: + inputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + outputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy requiresPeriodicRefresh: type: boolean description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process @@ -111476,1828 +110041,1960 @@ paths: attributes: attributeName: first_name sourceName: Source - - title: uuid + - title: dateMath type: object + required: + - expression properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - internal: - type: boolean - readOnly: true - description: Indicates whether this is an internal SailPoint-created transform or a customer-created transform - example: 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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. - security: - - UserContextAuth: - - 'idn:transform:read' - put: - tags: - - Transforms - summary: Update a transform - description: |- - Replaces the transform specified by the given ID with the transform provided in the request body. Only the "attributes" field is mutable. Attempting to change other properties (ex. "name" and "type") will result in an error. - A token with transform write authority is required to call this API. - operationId: updateTransform - parameters: - - name: id - in: path - description: ID of the transform to update - required: true - style: simple - explode: false - schema: - type: string - example: 2cd78adghjkja34jh2b1hkjhasuecd - requestBody: - description: 'The updated transform object (must include "name", "type", and "attributes" fields).' - content: - application/json: - schema: - type: object - description: The representation of an internally- or customer-defined transform. - required: - - name - - type - - attributes - properties: - id: - type: string - readOnly: true - description: Unique ID of this transform - example: 2cd78adghjkja34jh2b1hkjhasuecd - name: - type: string - description: Unique name of this transform - example: Timestamp To Date - minLength: 1 - maxLength: 50 - type: - type: string - description: The type of transform operation - enum: - - accountAttribute - - base64Decode - - base64Encode - - concat - - conditional - - dateCompare - - dateFormat - - dateMath - - decomposeDiacriticalMarks - - e164phone - - firstValid - - rule - - identityAttribute - - indexOf - - iso3166 - - lastIndexOf - - leftPad - - lookup - - lower - - normalizeNames - - randomAlphaNumeric - - randomNumeric - - reference - - replaceAll - - replace - - rightPad - - split - - static - - substring - - trim - - upper - - usernameGenerator - - uuid - example: dateFormat - externalDocs: - description: Transform Operations - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations' - attributes: - description: Meta-data about the transform. Values in this list are specific to the type of transform to be executed. - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: base64Decode - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: base64Encode - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: concat - type: object - required: - - values - properties: - values: - type: array - items: + expression: + type: string + description: | + A string value of the date and time components to operation on, along with the math operations to execute. + externalDocs: + description: Date Math Expressions + url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure' + example: now+1w + roundUp: + type: boolean + description: | + A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. + + + If not provided, the transform will default to `false` + + + `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) + + + `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) + example: false + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: type: object - description: An array of items to join together - example: - - John - - ' ' - - Smith - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: conditional - type: object - required: - - expression - - positiveCondition - - negativeCondition - properties: - expression: - type: string - description: |- - A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: decomposeDiacriticalMarks + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: e164phone + type: object + properties: + defaultRegion: + type: string + description: | + This is an optional attribute that can be used to define the region of the phone number to format into. - The `eq` operator is the only valid comparison - example: ValueA eq ValueB - positiveCondition: - type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: - type: string - description: The output of the transform if the expression evalutes to false - example: 'false' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateCompare - type: object - required: - - firstDate - - secondDate - - operator - - positiveCondition - - negativeCondition - properties: - firstDate: - description: This is the first date to consider (The date that would be on the left hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat + If defaultRegion is not provided, it will take US as the default country. + + + The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + example: US + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: firstValid + type: object + required: + - values + properties: + values: + type: array + items: type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + description: An array of attributes to evaluate for existence. + example: + - attributes: + sourceName: Active Directory + attributeName: sAMAccountName + type: accountAttribute + - attributes: + sourceName: Okta + attributeName: login + type: accountAttribute + - attributes: + sourceName: HR Source + attributeName: employeeID + type: accountAttribute + ignoreErrors: + type: boolean + description: a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. + example: false + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + - title: rule + oneOf: + - type: object + required: + - name + properties: + name: + type: string + description: This is the name of the Generic rule that needs to be invoked by the transform + example: Generic Calculation Rule + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + - type: object + required: + - name + - operation + - includeNumbers + - includeSpecialChars + - length + properties: + name: + type: string + description: This must always be set to "Cloud Services Deployment Utility" + example: Cloud Services Deployment Utility + operation: + type: string + description: The operation to perform `generateRandomString` + example: generateRandomString + includeNumbers: + type: boolean + description: This must be either "true" or "false" to indicate whether the generator logic should include numbers + example: true + includeSpecialChars: + type: boolean + description: This must be either "true" or "false" to indicate whether the generator logic should include special characters + example: true + length: + type: string + description: | + This specifies how long the randomly generated string needs to be + + + >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters + example: '10' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + - type: object + required: + - name + - operation + - uid + properties: + name: + type: string + description: This must always be set to "Cloud Services Deployment Utility" + example: Cloud Services Deployment Utility + operation: + type: string + description: The operation to perform `getReferenceIdentityAttribute` + example: getReferenceIdentityAttribute + uid: + type: string + description: | + This is the SailPoint User Name (uid) value of the identity whose attribute is desired + + As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. + example: 2c91808570313110017040b06f344ec9 + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + - title: identityAttribute + type: object + required: + - name + properties: + name: + type: string + description: The system (camel-cased) name of the identity attribute to bring in + example: email + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: indexOf + type: object + required: + - substring + properties: + substring: + type: string + description: 'A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.' + example: admin_ + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: iso3166 + type: object + properties: + format: + type: string + description: | + An optional value to denote which ISO 3166 format to return. Valid values are: + + + `alpha2` - Two-character country code (e.g., "US"); this is the default value if no format is supplied + + + `alpha3` - Three-character country code (e.g., "USA") + + + `numeric` - The numeric country code (e.g., "840") + example: alpha2 + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: leftPad + type: object + required: + - length + properties: + length: + type: string + description: An integer value for the desired length of the final output string + example: '4' + padding: + type: string + description: | + A string value representing the character that the incoming data should be padded with to get to the desired length + + + If not provided, the transform will default to a single space (" ") character for padding + example: '0' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: lookup + type: object + required: + - table + properties: + table: + type: object + additionalProperties: true + description: | + This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched + + + >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. + example: + USA: Americas + FRA: EMEA + AUS: APAC + default: Unknown Region + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: lower + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: nameNormalizer + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: randomAlphaNumeric + type: object + properties: + length: + type: string + description: | + This is an integer value specifying the size/number of characters the random string must contain + + + * This value must be a positive number and cannot be blank + + + * If no length is provided, the transform will default to a value of `32` + + + * Due to identity attribute data constraints, the maximum allowable value is `450` characters + example: '10' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: randomNumeric + type: object + properties: + length: + type: string + description: | + This is an integer value specifying the size/number of characters the random string must contain - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) + * This value must be a positive number and cannot be blank - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + * If no length is provided, the transform will default to a value of `32` - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - secondDate: - description: This is the second date to consider (The date that would be on the right hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. + * Due to identity attribute data constraints, the maximum allowable value is `450` characters + example: '10' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: reference + type: object + required: + - id + properties: + id: + type: string + description: This ID specifies the name of the pre-existing transform which you want to use within your current transform + example: Existing Transform + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: replaceAll + type: object + required: + - table + properties: + table: + type: object + additionalProperties: true + description: 'An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.' + example: + '-': ' ' + '"': '''' + ñ: 'n' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: replace + type: object + required: + - regex + - replacement + properties: + regex: + type: string + description: This can be a string or a regex pattern in which you want to replace. + example: '[^a-zA-Z]' + externalDocs: + description: Regex Builder + url: 'https://regex101.com/' + replacement: + type: string + description: This is the replacement string that should be substituded wherever the string or pattern is found. + example: ' ' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: rightPad + type: object + required: + - length + properties: + length: + type: string + description: An integer value for the desired length of the final output string + example: '4' + padding: + type: string + description: | + A string value representing the character that the incoming data should be padded with to get to the desired length - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + If not provided, the transform will default to a single space (" ") character for padding + example: '0' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: split + type: object + required: + - delimiter + - index + properties: + delimiter: + type: string + description: 'This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data' + example: ',' + index: + type: string + description: 'An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.' + example: '5' + throws: + type: boolean + description: | + A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + `true` - The transform should return "IndexOutOfBoundsException" - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) + `false` - The transform should return null - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - operator: - type: string - description: | - This is the comparison to perform. - | Operation | Description | - | --------- | ------- | - | LT | Strictly less than: firstDate < secondDate | - | LTE | Less than or equal to: firstDate <= secondDate | - | GT | Strictly greater than: firstDate > secondDate | - | GTE | Greater than or equal to: firstDate >= secondDate | - enum: - - LT - - LTE - - GT - - GTE - example: LT - positiveCondition: - type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: - type: string - description: The output of the transform if the expression evalutes to false - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + If not provided, the transform will default to false and return a null + example: true + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: static + type: object + required: + - values + properties: + values: + type: string + description: 'This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.' + example: string$variable + externalDocs: + description: Static Transform Documentation + url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/static' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + - title: substring + type: object + required: + - begin + properties: + begin: + type: integer + description: | + The index of the first character to include in the returned substring. - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + If `begin` is set to -1, the transform will begin at character 0 of the input data + example: 1 + format: int32 + beginOffset: + type: integer + description: | + This integer value is the number of characters to add to the begin attribute when returning a substring. - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + This attribute is only used if begin is not -1. + example: 3 + format: int32 + end: + type: integer + description: | + The index of the first character to exclude from the returned substring. - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) + If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. + example: 6 + format: int32 + endOffset: + type: integer + description: | + This integer value is the number of characters to add to the end attribute when returning a substring. - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateMath + This attribute is only used if end is provided and is not -1. + example: 1 + format: int32 + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: trim + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: upper + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: uuid + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + internal: + type: boolean + readOnly: true + description: Indicates whether this is an internal SailPoint-created transform or a customer-created transform + example: 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 - required: - - expression properties: - expression: + locale: type: string - description: | - A string value of the date and time components to operation on, along with the math operations to execute. - externalDocs: - description: Date Math Expressions - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure' - example: now+1w - roundUp: - type: boolean - description: | - A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. - - - If not provided, the transform will default to `false` - - - `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) - - - `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: decomposeDiacriticalMarks + 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: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: e164phone + 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: - defaultRegion: + locale: type: string - description: | - This is an optional attribute that can be used to define the region of the phone number to format into. - - - If defaultRegion is not provided, it will take US as the default country. - - - The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - example: US - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: firstValid + 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 - required: - - values properties: - values: - type: array - items: - type: object - description: An array of attributes to evaluate for existence. - example: - - attributes: - sourceName: Active Directory - attributeName: sAMAccountName - type: accountAttribute - - attributes: - sourceName: Okta - attributeName: login - type: accountAttribute - - attributes: - sourceName: HR Source - attributeName: employeeID - type: accountAttribute - ignoreErrors: - type: boolean - description: a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - - title: rule - oneOf: - - type: object - required: - - name - properties: - name: - type: string - description: This is the name of the Generic rule that needs to be invoked by the transform - example: Generic Calculation Rule - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - includeNumbers - - includeSpecialChars - - length - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `generateRandomString` - example: generateRandomString - includeNumbers: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include numbers - example: true - includeSpecialChars: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include special characters - example: true - length: - type: string - description: | - This specifies how long the randomly generated string needs to be - - - >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - uid - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `getReferenceIdentityAttribute` - example: getReferenceIdentityAttribute - uid: - type: string - description: | - This is the SailPoint User Name (uid) value of the identity whose attribute is desired - - As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. - example: 2c91808570313110017040b06f344ec9 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - title: identityAttribute + 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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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 - required: - - name properties: - name: + locale: type: string - description: The system (camel-cased) name of the identity attribute to bring in - example: email - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: indexOf + 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 - required: - - substring properties: - substring: + locale: type: string - description: 'A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.' - example: admin_ - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: iso3166 + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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: - format: + locale: type: string - description: | - An optional value to denote which ISO 3166 format to return. Valid values are: - - - `alpha2` - Two-character country code (e.g., "US"); this is the default value if no format is supplied - - - `alpha3` - Three-character country code (e.g., "USA") - - - `numeric` - The numeric country code (e.g., "840") - example: alpha2 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: leftPad + 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 - required: - - length properties: - length: + locale: type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: + description: 'The locale for the message text, a BCP 47 language tag.' + example: en-US + localeOrigin: type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length + 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. + security: + - UserContextAuth: + - 'idn:transform:update' + '/transforms/{id}': + get: + tags: + - Transforms + summary: Transform by ID + description: |- + This API returns the transform specified by the given ID. + A token with transform read authority is required to call this API. + operationId: getTransform + parameters: + - name: id + in: path + description: ID of the transform to retrieve + required: true + style: simple + explode: false + example: 2cd78adghjkja34jh2b1hkjhasuecd + schema: + type: string + responses: + '200': + description: Transform with the given ID + content: + application/json: + schema: + type: object + description: The representation of an internally- or customer-defined transform. + required: + - name + - type + - attributes + properties: + id: + type: string + readOnly: true + description: Unique ID of this transform + example: 2cd78adghjkja34jh2b1hkjhasuecd + name: + type: string + description: Unique name of this transform + example: Timestamp To Date + minLength: 1 + maxLength: 50 + type: + type: string + description: The type of transform operation + enum: + - accountAttribute + - base64Decode + - base64Encode + - concat + - conditional + - dateCompare + - dateFormat + - dateMath + - decomposeDiacriticalMarks + - e164phone + - firstValid + - rule + - identityAttribute + - indexOf + - iso3166 + - lastIndexOf + - leftPad + - lookup + - lower + - normalizeNames + - randomAlphaNumeric + - randomNumeric + - reference + - replaceAll + - replace + - rightPad + - split + - static + - substring + - trim + - upper + - usernameGenerator + - uuid + example: dateFormat + externalDocs: + description: Transform Operations + url: 'https://developer.sailpoint.com/idn/docs/transforms/operations' + attributes: + description: Meta-data about the transform. Values in this list are specific to the type of transform to be executed. + oneOf: + - title: accountAttribute + type: object + required: + - sourceName + - attributeName + properties: + sourceName: + type: string + description: A reference to the source to search for the account + example: Workday + attributeName: + type: string + description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' + example: DEPARTMENT + accountSortAttribute: + type: string + description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries + example: created + accountSortDescending: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' + example: false + accountReturnFirstLink: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' + example: false + accountFilter: + type: string + description: |- + This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. + Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements + example: '!(nativeIdentity.startsWith("*DELETED*"))' + accountPropertyFilter: + type: string + description: |- + This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. + All account attributes are available for filtering as this operation is performed in memory. + example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: base64Decode + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: base64Encode + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: concat + type: object + required: + - values + properties: + values: + type: array + items: + type: object + description: An array of items to join together + example: + - John + - ' ' + - Smith + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: conditional + type: object + required: + - expression + - positiveCondition + - negativeCondition + properties: + expression: + type: string + description: |- + A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lookup - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: | - This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched + The `eq` operator is the only valid comparison + example: ValueA eq ValueB + positiveCondition: + type: string + description: The output of the transform if the expression evalutes to true + example: 'true' + negativeCondition: + type: string + description: The output of the transform if the expression evalutes to false + example: 'false' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateCompare + type: object + required: + - firstDate + - secondDate + - operator + - positiveCondition + - negativeCondition + properties: + firstDate: + description: This is the first date to consider (The date that would be on the left hand side of the comparison operation). + oneOf: + - title: accountAttribute + type: object + required: + - sourceName + - attributeName + properties: + sourceName: + type: string + description: A reference to the source to search for the account + example: Workday + attributeName: + type: string + description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' + example: DEPARTMENT + accountSortAttribute: + type: string + description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries + example: created + accountSortDescending: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' + example: false + accountReturnFirstLink: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' + example: false + accountFilter: + type: string + description: |- + This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. + Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements + example: '!(nativeIdentity.startsWith("*DELETED*"))' + accountPropertyFilter: + type: string + description: |- + This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. + + All account attributes are available for filtering as this operation is performed in memory. + example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateFormat + type: object + properties: + inputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) - >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. - example: - USA: Americas - FRA: EMEA - AUS: APAC - default: Unknown Region - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lower - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: nameNormalizer - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomAlphaNumeric - type: object - properties: - length: - type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + outputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) - * This value must be a positive number and cannot be blank + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + secondDate: + description: This is the second date to consider (The date that would be on the right hand side of the comparison operation). + oneOf: + - title: accountAttribute + type: object + required: + - sourceName + - attributeName + properties: + sourceName: + type: string + description: A reference to the source to search for the account + example: Workday + attributeName: + type: string + description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' + example: DEPARTMENT + accountSortAttribute: + type: string + description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries + example: created + accountSortDescending: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' + example: false + accountReturnFirstLink: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' + example: false + accountFilter: + type: string + description: |- + This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. + Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements + example: '!(nativeIdentity.startsWith("*DELETED*"))' + accountPropertyFilter: + type: string + description: |- + This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. + All account attributes are available for filtering as this operation is performed in memory. + example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateFormat + type: object + properties: + inputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - * If no length is provided, the transform will default to a value of `32` + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomNumeric - type: object - properties: - length: - type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + outputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - * This value must be a positive number and cannot be blank + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + operator: + type: string + description: | + This is the comparison to perform. + | Operation | Description | + | --------- | ------- | + | LT | Strictly less than: firstDate < secondDate | + | LTE | Less than or equal to: firstDate <= secondDate | + | GT | Strictly greater than: firstDate > secondDate | + | GTE | Greater than or equal to: firstDate >= secondDate | + enum: + - LT + - LTE + - GT + - GTE + example: LT + positiveCondition: + type: string + description: The output of the transform if the expression evalutes to true + example: 'true' + negativeCondition: + type: string + description: The output of the transform if the expression evalutes to false + example: false + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateFormat + type: object + properties: + inputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - * If no length is provided, the transform will default to a value of `32` + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: reference - type: object - required: - - id - properties: - id: - type: string - description: This ID specifies the name of the pre-existing transform which you want to use within your current transform - example: Existing Transform - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replaceAll - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: 'An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.' - example: - '-': ' ' - '"': '''' - ñ: 'n' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replace - type: object - required: - - regex - - replacement - properties: - regex: - type: string - description: This can be a string or a regex pattern in which you want to replace. - example: '[^a-zA-Z]' - externalDocs: - description: Regex Builder - url: 'https://regex101.com/' - replacement: - type: string - description: This is the replacement string that should be substituded wherever the string or pattern is found. - example: ' ' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: rightPad - type: object - required: - - length - properties: - length: - type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: - type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + outputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: split - type: object - required: - - delimiter - - index - properties: - delimiter: - type: string - description: 'This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data' - example: ',' - index: - type: string - description: 'An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.' - example: '5' - throws: - type: boolean - description: | - A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateMath + type: object + required: + - expression + properties: + expression: + type: string + description: | + A string value of the date and time components to operation on, along with the math operations to execute. + externalDocs: + description: Date Math Expressions + url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure' + example: now+1w + roundUp: + type: boolean + description: | + A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. - `true` - The transform should return "IndexOutOfBoundsException" + If not provided, the transform will default to `false` - `false` - The transform should return null + `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) - If not provided, the transform will default to false and return a null - example: true - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: static - type: object - required: - - values - properties: - values: - type: string - description: 'This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.' - example: string$variable - externalDocs: - description: Static Transform Documentation - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/static' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - - title: substring - type: object - required: - - begin - properties: - begin: - type: integer - description: | - The index of the first character to include in the returned substring. + `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) + example: false + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: decomposeDiacriticalMarks + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: e164phone + type: object + properties: + defaultRegion: + type: string + description: | + This is an optional attribute that can be used to define the region of the phone number to format into. - If `begin` is set to -1, the transform will begin at character 0 of the input data - example: 1 - format: int32 - beginOffset: - type: integer - description: | - This integer value is the number of characters to add to the begin attribute when returning a substring. - This attribute is only used if begin is not -1. - example: 3 - format: int32 - end: - type: integer - description: | - The index of the first character to exclude from the returned substring. + If defaultRegion is not provided, it will take US as the default country. - If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. - example: 6 - format: int32 - endOffset: - type: integer - description: | - This integer value is the number of characters to add to the end attribute when returning a substring. - This attribute is only used if end is provided and is not -1. - example: 1 - format: int32 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: trim - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: upper - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: uuid - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - internal: - type: boolean - readOnly: true - description: Indicates whether this is an internal SailPoint-created transform or a customer-created transform - example: false - example: - name: Timestamp To Date - type: dateFormat - attributes: - inputFormat: 'MMM-dd-yyyy, HH:mm:ss.SSS' - outputFormat: yyyy/dd/MM - responses: - '200': - description: Indicates the transform was successfully updated and returns its new representation. - content: - application/json: - schema: - type: object - description: The representation of an internally- or customer-defined transform. - required: - - name - - type - - attributes - properties: - id: - type: string - readOnly: true - description: Unique ID of this transform - example: 2cd78adghjkja34jh2b1hkjhasuecd - name: - type: string - description: Unique name of this transform - example: Timestamp To Date - minLength: 1 - maxLength: 50 - type: - type: string - description: The type of transform operation - enum: - - accountAttribute - - base64Decode - - base64Encode - - concat - - conditional - - dateCompare - - dateFormat - - dateMath - - decomposeDiacriticalMarks - - e164phone - - firstValid - - rule - - identityAttribute - - indexOf - - iso3166 - - lastIndexOf - - leftPad - - lookup - - lower - - normalizeNames - - randomAlphaNumeric - - randomNumeric - - reference - - replaceAll - - replace - - rightPad - - split - - static - - substring - - trim - - upper - - usernameGenerator - - uuid - example: dateFormat - externalDocs: - description: Transform Operations - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations' - attributes: - description: Meta-data about the transform. Values in this list are specific to the type of transform to be executed. - oneOf: - - title: accountAttribute + The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + example: US + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: firstValid type: object required: - - sourceName - - attributeName + - values properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: + values: + type: array + items: + type: object + description: An array of attributes to evaluate for existence. + example: + - attributes: + sourceName: Active Directory + attributeName: sAMAccountName + type: accountAttribute + - attributes: + sourceName: Okta + attributeName: login + type: accountAttribute + - attributes: + sourceName: HR Source + attributeName: employeeID + type: accountAttribute + ignoreErrors: + type: boolean + description: a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. + example: false + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + - title: rule + oneOf: + - type: object + required: + - name + properties: + name: + type: string + description: This is the name of the Generic rule that needs to be invoked by the transform + example: Generic Calculation Rule + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + - type: object + required: + - name + - operation + - includeNumbers + - includeSpecialChars + - length + properties: + name: + type: string + description: This must always be set to "Cloud Services Deployment Utility" + example: Cloud Services Deployment Utility + operation: + type: string + description: The operation to perform `generateRandomString` + example: generateRandomString + includeNumbers: + type: boolean + description: This must be either "true" or "false" to indicate whether the generator logic should include numbers + example: true + includeSpecialChars: + type: boolean + description: This must be either "true" or "false" to indicate whether the generator logic should include special characters + example: true + length: + type: string + description: | + This specifies how long the randomly generated string needs to be + + + >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters + example: '10' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + - type: object + required: + - name + - operation + - uid + properties: + name: + type: string + description: This must always be set to "Cloud Services Deployment Utility" + example: Cloud Services Deployment Utility + operation: + type: string + description: The operation to perform `getReferenceIdentityAttribute` + example: getReferenceIdentityAttribute + uid: + type: string + description: | + This is the SailPoint User Name (uid) value of the identity whose attribute is desired + + As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. + example: 2c91808570313110017040b06f344ec9 + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + - title: identityAttribute + type: object + required: + - name + properties: + name: type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: + description: The system (camel-cased) name of the identity attribute to bring in + example: email + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: indexOf + type: object + required: + - substring + properties: + substring: type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: + description: 'A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.' + example: admin_ + requiresPeriodicRefresh: type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: iso3166 + type: object + properties: + format: type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. + description: | + An optional value to denote which ISO 3166 format to return. Valid values are: - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' + + `alpha2` - Two-character country code (e.g., "US"); this is the default value if no format is supplied + + + `alpha3` - Three-character country code (e.g., "USA") + + + `numeric` - The numeric country code (e.g., "840") + example: alpha2 requiresPeriodicRefresh: type: boolean description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process @@ -113312,9 +112009,23 @@ paths: attributes: attributeName: first_name sourceName: Source - - title: base64Decode + - title: leftPad type: object + required: + - length properties: + length: + type: string + description: An integer value for the desired length of the final output string + example: '4' + padding: + type: string + description: | + A string value representing the character that the incoming data should be padded with to get to the desired length + + + If not provided, the transform will default to a single space (" ") character for padding + example: '0' requiresPeriodicRefresh: type: boolean description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process @@ -113329,9 +112040,24 @@ paths: attributes: attributeName: first_name sourceName: Source - - title: base64Encode + - title: lookup type: object + required: + - table properties: + table: + type: object + additionalProperties: true + description: | + This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched + + + >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. + example: + USA: Americas + FRA: EMEA + AUS: APAC + default: Unknown Region requiresPeriodicRefresh: type: boolean description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process @@ -113346,20 +112072,9 @@ paths: attributes: attributeName: first_name sourceName: Source - - title: concat + - title: lower type: object - required: - - values properties: - values: - type: array - items: - type: object - description: An array of items to join together - example: - - John - - ' ' - - Smith requiresPeriodicRefresh: type: boolean description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process @@ -113374,28 +112089,9 @@ paths: attributes: attributeName: first_name sourceName: Source - - title: conditional + - title: nameNormalizer type: object - required: - - expression - - positiveCondition - - negativeCondition properties: - expression: - type: string - description: |- - A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. - - The `eq` operator is the only valid comparison - example: ValueA eq ValueB - positiveCondition: - type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: - type: string - description: The output of the transform if the expression evalutes to false - example: 'false' requiresPeriodicRefresh: type: boolean description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process @@ -113410,365 +112106,166 @@ paths: attributes: attributeName: first_name sourceName: Source - - title: dateCompare + - title: randomAlphaNumeric type: object - required: - - firstDate - - secondDate - - operator - - positiveCondition - - negativeCondition properties: - firstDate: - description: This is the first date to consider (The date that would be on the left hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + length: + type: string + description: | + This is an integer value specifying the size/number of characters the random string must contain - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + * This value must be a positive number and cannot be blank - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) + * If no length is provided, the transform will default to a value of `32` - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - secondDate: - description: This is the second date to consider (The date that would be on the right hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: boolean - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + * Due to identity attribute data constraints, the maximum allowable value is `450` characters + example: '10' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: randomNumeric + type: object + properties: + length: + type: string + description: | + This is an integer value specifying the size/number of characters the random string must contain - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) + * This value must be a positive number and cannot be blank - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + * If no length is provided, the transform will default to a value of `32` - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - operator: - type: string - description: | - This is the comparison to perform. - | Operation | Description | - | --------- | ------- | - | LT | Strictly less than: firstDate < secondDate | - | LTE | Less than or equal to: firstDate <= secondDate | - | GT | Strictly greater than: firstDate > secondDate | - | GTE | Greater than or equal to: firstDate >= secondDate | - enum: - - LT - - LTE - - GT - - GTE - example: LT - positiveCondition: + * Due to identity attribute data constraints, the maximum allowable value is `450` characters + example: '10' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: reference + type: object + required: + - id + properties: + id: type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: + description: This ID specifies the name of the pre-existing transform which you want to use within your current transform + example: Existing Transform + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: replaceAll + type: object + required: + - table + properties: + table: + type: object + additionalProperties: true + description: 'An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.' + example: + '-': ' ' + '"': '''' + ñ: 'n' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: replace + type: object + required: + - regex + - replacement + properties: + regex: type: string - description: The output of the transform if the expression evalutes to false + description: This can be a string or a regex pattern in which you want to replace. + example: '[^a-zA-Z]' + externalDocs: + description: Regex Builder + url: 'https://regex101.com/' + replacement: + type: string + description: This is the replacement string that should be substituded wherever the string or pattern is found. + example: ' ' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: rightPad + type: object + required: + - length + properties: + length: + type: string + description: An integer value for the desired length of the final output string + example: '4' + padding: + type: string + description: | + A string value representing the character that the incoming data should be padded with to get to the desired length + + + If not provided, the transform will default to a single space (" ") character for padding + example: '0' requiresPeriodicRefresh: type: boolean description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process @@ -113783,99 +112280,34 @@ paths: attributes: attributeName: first_name sourceName: Source - - title: dateFormat + - title: split type: object + required: + - delimiter + - index properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + delimiter: + type: string + description: 'This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data' + example: ',' + index: + type: string + description: 'An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.' + example: '5' + throws: + type: boolean + description: | + A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) + `true` - The transform should return "IndexOutOfBoundsException" - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + `false` - The transform should return null - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy + If not provided, the transform will default to false and return a null + example: true requiresPeriodicRefresh: type: boolean description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process @@ -113890,1722 +112322,3232 @@ paths: attributes: attributeName: first_name sourceName: Source - - title: dateMath + - title: static type: object required: - - expression + - values properties: - expression: + values: type: string - description: | - A string value of the date and time components to operation on, along with the math operations to execute. + description: 'This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.' + example: string$variable externalDocs: - description: Date Math Expressions - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure' - example: now+1w - roundUp: + description: Static Transform Documentation + url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/static' + requiresPeriodicRefresh: type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + - title: substring + type: object + required: + - begin + properties: + begin: + type: integer description: | - A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. + The index of the first character to include in the returned substring. - If not provided, the transform will default to `false` + If `begin` is set to -1, the transform will begin at character 0 of the input data + example: 1 + format: int32 + beginOffset: + type: integer + description: | + This integer value is the number of characters to add to the begin attribute when returning a substring. + This attribute is only used if begin is not -1. + example: 3 + format: int32 + end: + type: integer + description: | + The index of the first character to exclude from the returned substring. - `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) + If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. + example: 6 + format: int32 + endOffset: + type: integer + description: | + This integer value is the number of characters to add to the end attribute when returning a substring. + This attribute is only used if end is provided and is not -1. + example: 1 + format: int32 + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: trim + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: upper + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: uuid + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + internal: + type: boolean + readOnly: true + description: Indicates whether this is an internal SailPoint-created transform or a customer-created transform + example: 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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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. + security: + - UserContextAuth: + - 'idn:transform:read' + put: + tags: + - Transforms + summary: Update a transform + description: |- + Replaces the transform specified by the given ID with the transform provided in the request body. Only the "attributes" field is mutable. Attempting to change other properties (ex. "name" and "type") will result in an error. + A token with transform write authority is required to call this API. + operationId: updateTransform + parameters: + - name: id + in: path + description: ID of the transform to update + required: true + style: simple + explode: false + schema: + type: string + example: 2cd78adghjkja34jh2b1hkjhasuecd + requestBody: + description: 'The updated transform object (must include "name", "type", and "attributes" fields).' + content: + application/json: + schema: + type: object + description: The representation of an internally- or customer-defined transform. + required: + - name + - type + - attributes + properties: + id: + type: string + readOnly: true + description: Unique ID of this transform + example: 2cd78adghjkja34jh2b1hkjhasuecd + name: + type: string + description: Unique name of this transform + example: Timestamp To Date + minLength: 1 + maxLength: 50 + type: + type: string + description: The type of transform operation + enum: + - accountAttribute + - base64Decode + - base64Encode + - concat + - conditional + - dateCompare + - dateFormat + - dateMath + - decomposeDiacriticalMarks + - e164phone + - firstValid + - rule + - identityAttribute + - indexOf + - iso3166 + - lastIndexOf + - leftPad + - lookup + - lower + - normalizeNames + - randomAlphaNumeric + - randomNumeric + - reference + - replaceAll + - replace + - rightPad + - split + - static + - substring + - trim + - upper + - usernameGenerator + - uuid + example: dateFormat + externalDocs: + description: Transform Operations + url: 'https://developer.sailpoint.com/idn/docs/transforms/operations' + attributes: + description: Meta-data about the transform. Values in this list are specific to the type of transform to be executed. + oneOf: + - title: accountAttribute + type: object + required: + - sourceName + - attributeName + properties: + sourceName: + type: string + description: A reference to the source to search for the account + example: Workday + attributeName: + type: string + description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' + example: DEPARTMENT + accountSortAttribute: + type: string + description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries + example: created + accountSortDescending: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' + example: false + accountReturnFirstLink: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' + example: false + accountFilter: + type: string + description: |- + This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. + Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements + example: '!(nativeIdentity.startsWith("*DELETED*"))' + accountPropertyFilter: + type: string + description: |- + This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: decomposeDiacriticalMarks - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: + All account attributes are available for filtering as this operation is performed in memory. + example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: base64Decode + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: base64Encode + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: concat + type: object + required: + - values + properties: + values: + type: array + items: type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: e164phone - type: object - properties: - defaultRegion: - type: string - description: | - This is an optional attribute that can be used to define the region of the phone number to format into. - - - If defaultRegion is not provided, it will take US as the default country. - + description: An array of items to join together + example: + - John + - ' ' + - Smith + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: conditional + type: object + required: + - expression + - positiveCondition + - negativeCondition + properties: + expression: + type: string + description: |- + A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. - The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - example: US - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: firstValid - type: object - required: - - values - properties: - values: - type: array - items: + The `eq` operator is the only valid comparison + example: ValueA eq ValueB + positiveCondition: + type: string + description: The output of the transform if the expression evalutes to true + example: 'true' + negativeCondition: + type: string + description: The output of the transform if the expression evalutes to false + example: 'false' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateCompare + type: object + required: + - firstDate + - secondDate + - operator + - positiveCondition + - negativeCondition + properties: + firstDate: + description: This is the first date to consider (The date that would be on the left hand side of the comparison operation). + oneOf: + - title: accountAttribute type: object - description: An array of attributes to evaluate for existence. - example: - - attributes: - sourceName: Active Directory - attributeName: sAMAccountName - type: accountAttribute - - attributes: - sourceName: Okta - attributeName: login - type: accountAttribute - - attributes: - sourceName: HR Source - attributeName: employeeID - type: accountAttribute - ignoreErrors: - type: boolean - description: a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - - title: rule - oneOf: - - type: object - required: - - name - properties: - name: - type: string - description: This is the name of the Generic rule that needs to be invoked by the transform - example: Generic Calculation Rule - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - includeNumbers - - includeSpecialChars - - length - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `generateRandomString` - example: generateRandomString - includeNumbers: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include numbers - example: true - includeSpecialChars: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include special characters - example: true - length: - type: string - description: | - This specifies how long the randomly generated string needs to be + required: + - sourceName + - attributeName + properties: + sourceName: + type: string + description: A reference to the source to search for the account + example: Workday + attributeName: + type: string + description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' + example: DEPARTMENT + accountSortAttribute: + type: string + description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries + example: created + accountSortDescending: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' + example: false + accountReturnFirstLink: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' + example: false + accountFilter: + type: string + description: |- + This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. + Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements + example: '!(nativeIdentity.startsWith("*DELETED*"))' + accountPropertyFilter: + type: string + description: |- + This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. + + All account attributes are available for filtering as this operation is performed in memory. + example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateFormat + type: object + properties: + inputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - uid - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `getReferenceIdentityAttribute` - example: getReferenceIdentityAttribute - uid: - type: string - description: | - This is the SailPoint User Name (uid) value of the identity whose attribute is desired + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) - As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. - example: 2c91808570313110017040b06f344ec9 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - title: identityAttribute - type: object - required: - - name - properties: - name: - type: string - description: The system (camel-cased) name of the identity attribute to bring in - example: email - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: indexOf - type: object - required: - - substring - properties: - substring: - type: string - description: 'A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.' - example: admin_ - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: iso3166 - type: object - properties: - format: - type: string - description: | - An optional value to denote which ISO 3166 format to return. Valid values are: + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + outputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) - `alpha2` - Two-character country code (e.g., "US"); this is the default value if no format is supplied + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + secondDate: + description: This is the second date to consider (The date that would be on the right hand side of the comparison operation). + oneOf: + - title: accountAttribute + type: object + required: + - sourceName + - attributeName + properties: + sourceName: + type: string + description: A reference to the source to search for the account + example: Workday + attributeName: + type: string + description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' + example: DEPARTMENT + accountSortAttribute: + type: string + description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries + example: created + accountSortDescending: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' + example: false + accountReturnFirstLink: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' + example: false + accountFilter: + type: string + description: |- + This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. + Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements + example: '!(nativeIdentity.startsWith("*DELETED*"))' + accountPropertyFilter: + type: string + description: |- + This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. + All account attributes are available for filtering as this operation is performed in memory. + example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateFormat + type: object + properties: + inputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - `alpha3` - Three-character country code (e.g., "USA") + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) - `numeric` - The numeric country code (e.g., "840") - example: alpha2 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: leftPad - type: object - required: - - length - properties: - length: - type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: - type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + outputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lookup - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: | - This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + operator: + type: string + description: | + This is the comparison to perform. + | Operation | Description | + | --------- | ------- | + | LT | Strictly less than: firstDate < secondDate | + | LTE | Less than or equal to: firstDate <= secondDate | + | GT | Strictly greater than: firstDate > secondDate | + | GTE | Greater than or equal to: firstDate >= secondDate | + enum: + - LT + - LTE + - GT + - GTE + example: LT + positiveCondition: + type: string + description: The output of the transform if the expression evalutes to true + example: 'true' + negativeCondition: + type: string + description: The output of the transform if the expression evalutes to false + example: false + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateFormat + type: object + properties: + inputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. - example: - USA: Americas - FRA: EMEA - AUS: APAC - default: Unknown Region - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lower - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: nameNormalizer - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomAlphaNumeric - type: object - properties: - length: - type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) - * This value must be a positive number and cannot be blank + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + outputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - * If no length is provided, the transform will default to a value of `32` + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateMath + type: object + required: + - expression + properties: + expression: + type: string + description: | + A string value of the date and time components to operation on, along with the math operations to execute. + externalDocs: + description: Date Math Expressions + url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure' + example: now+1w + roundUp: + type: boolean + description: | + A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomNumeric - type: object - properties: - length: - type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain + If not provided, the transform will default to `false` - * This value must be a positive number and cannot be blank + `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) - * If no length is provided, the transform will default to a value of `32` + `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) + example: false + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: decomposeDiacriticalMarks + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: e164phone + type: object + properties: + defaultRegion: + type: string + description: | + This is an optional attribute that can be used to define the region of the phone number to format into. - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: reference - type: object - required: - - id - properties: - id: - type: string - description: This ID specifies the name of the pre-existing transform which you want to use within your current transform - example: Existing Transform - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replaceAll - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: 'An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.' - example: - '-': ' ' - '"': '''' - ñ: 'n' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replace - type: object - required: - - regex - - replacement - properties: - regex: - type: string - description: This can be a string or a regex pattern in which you want to replace. - example: '[^a-zA-Z]' - externalDocs: - description: Regex Builder - url: 'https://regex101.com/' - replacement: - type: string - description: This is the replacement string that should be substituded wherever the string or pattern is found. - example: ' ' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: rightPad - type: object - required: - - length - properties: - length: - type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: - type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length + If defaultRegion is not provided, it will take US as the default country. - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: + + The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + example: US + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: firstValid + type: object + required: + - values + properties: + values: + type: array + items: type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: + description: An array of attributes to evaluate for existence. + example: + - attributes: + sourceName: Active Directory + attributeName: sAMAccountName type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: split - type: object - required: - - delimiter - - index - properties: - delimiter: - type: string - description: 'This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data' - example: ',' - index: - type: string - description: 'An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.' - example: '5' - throws: - type: boolean - description: | - A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) - - - `true` - The transform should return "IndexOutOfBoundsException" - + - attributes: + sourceName: Okta + attributeName: login + type: accountAttribute + - attributes: + sourceName: HR Source + attributeName: employeeID + type: accountAttribute + ignoreErrors: + type: boolean + description: a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. + example: false + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + - title: rule + oneOf: + - type: object + required: + - name + properties: + name: + type: string + description: This is the name of the Generic rule that needs to be invoked by the transform + example: Generic Calculation Rule + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + - type: object + required: + - name + - operation + - includeNumbers + - includeSpecialChars + - length + properties: + name: + type: string + description: This must always be set to "Cloud Services Deployment Utility" + example: Cloud Services Deployment Utility + operation: + type: string + description: The operation to perform `generateRandomString` + example: generateRandomString + includeNumbers: + type: boolean + description: This must be either "true" or "false" to indicate whether the generator logic should include numbers + example: true + includeSpecialChars: + type: boolean + description: This must be either "true" or "false" to indicate whether the generator logic should include special characters + example: true + length: + type: string + description: | + This specifies how long the randomly generated string needs to be - `false` - The transform should return null + >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters + example: '10' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + - type: object + required: + - name + - operation + - uid + properties: + name: + type: string + description: This must always be set to "Cloud Services Deployment Utility" + example: Cloud Services Deployment Utility + operation: + type: string + description: The operation to perform `getReferenceIdentityAttribute` + example: getReferenceIdentityAttribute + uid: + type: string + description: | + This is the SailPoint User Name (uid) value of the identity whose attribute is desired - If not provided, the transform will default to false and return a null - example: true - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: static - type: object - required: - - values - properties: - values: - type: string - description: 'This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.' - example: string$variable - externalDocs: - description: Static Transform Documentation - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/static' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - - title: substring - type: object - required: - - begin - properties: - begin: - type: integer - description: | - The index of the first character to include in the returned substring. + As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. + example: 2c91808570313110017040b06f344ec9 + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + - title: identityAttribute + type: object + required: + - name + properties: + name: + type: string + description: The system (camel-cased) name of the identity attribute to bring in + example: email + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: indexOf + type: object + required: + - substring + properties: + substring: + type: string + description: 'A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.' + example: admin_ + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: iso3166 + type: object + properties: + format: + type: string + description: | + An optional value to denote which ISO 3166 format to return. Valid values are: - If `begin` is set to -1, the transform will begin at character 0 of the input data - example: 1 - format: int32 - beginOffset: - type: integer - description: | - This integer value is the number of characters to add to the begin attribute when returning a substring. + `alpha2` - Two-character country code (e.g., "US"); this is the default value if no format is supplied - This attribute is only used if begin is not -1. - example: 3 - format: int32 - end: - type: integer - description: | - The index of the first character to exclude from the returned substring. - If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. - example: 6 - format: int32 - endOffset: - type: integer - description: | - This integer value is the number of characters to add to the end attribute when returning a substring. + `alpha3` - Three-character country code (e.g., "USA") - This attribute is only used if end is provided and is not -1. - example: 1 - format: int32 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: trim - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: upper - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: uuid - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - internal: - type: boolean - readOnly: true - description: Indicates whether this is an internal SailPoint-created transform or a customer-created transform - example: false - example: - id: 2cd78adghjkja34jh2b1hkjhasuecd - name: Timestamp To Date - type: dateFormat - attributes: - inputFormat: 'MMM-dd-yyyy, HH:mm:ss.SSS' - outputFormat: yyyy/dd/MM - internal: 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: + + `numeric` - The numeric country code (e.g., "840") + example: alpha2 + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: leftPad type: object + required: + - length properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: + length: 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: + description: An integer value for the desired length of the final output string + example: '4' + padding: 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: + description: | + A string value representing the character that the incoming data should be padded with to get to the desired length + + + If not provided, the transform will default to a single space (" ") character for padding + example: '0' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: lookup type: object + required: + - table 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: + table: + type: object + additionalProperties: true + description: | + This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched + + + >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. + example: + USA: Americas + FRA: EMEA + AUS: APAC + default: Unknown Region + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: lower 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: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: nameNormalizer 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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: randomAlphaNumeric 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: + length: 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: + description: | + This is an integer value specifying the size/number of characters the random string must contain + + + * This value must be a positive number and cannot be blank + + + * If no length is provided, the transform will default to a value of `32` + + + * Due to identity attribute data constraints, the maximum allowable value is `450` characters + example: '10' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: randomNumeric type: object properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: + length: 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: + description: | + This is an integer value specifying the size/number of characters the random string must contain + + + * This value must be a positive number and cannot be blank + + + * If no length is provided, the transform will default to a value of `32` + + + * Due to identity attribute data constraints, the maximum allowable value is `450` characters + example: '10' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: reference + type: object + required: + - id + properties: + id: 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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: + description: This ID specifies the name of the pre-existing transform which you want to use within your current transform + example: Existing Transform + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: replaceAll type: object + required: + - table 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: + table: + type: object + additionalProperties: true + description: 'An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.' + example: + '-': ' ' + '"': '''' + ñ: 'n' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: replace type: object + required: + - regex + - replacement properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: + regex: 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: + description: This can be a string or a regex pattern in which you want to replace. + example: '[^a-zA-Z]' + externalDocs: + description: Regex Builder + url: 'https://regex101.com/' + replacement: 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. - security: - - UserContextAuth: - - 'idn:transform:manage' - delete: - tags: - - Transforms - summary: Delete a transform - description: |- - Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. - A token with transform delete authority is required to call this API. - operationId: deleteTransform - parameters: - - name: id - in: path - description: ID of the transform to delete - required: true - style: simple - explode: false - schema: - type: string - example: 2cd78adghjkja34jh2b1hkjhasuecd - responses: - '204': - description: No content - indicates the request was successful but there is no content to be returned in the response. - '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: + description: This is the replacement string that should be substituded wherever the string or pattern is found. + example: ' ' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: rightPad type: object + required: + - length properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: + length: 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: + description: An integer value for the desired length of the final output string + example: '4' + padding: 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: + description: | + A string value representing the character that the incoming data should be padded with to get to the desired length + + + If not provided, the transform will default to a single space (" ") character for padding + example: '0' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: split type: object + required: + - delimiter + - index properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: + delimiter: 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: + description: 'This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data' + example: ',' + index: 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: + description: 'An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.' + example: '5' + throws: + type: boolean + description: | + A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) + + + `true` - The transform should return "IndexOutOfBoundsException" + + + `false` - The transform should return null + + + If not provided, the transform will default to false and return a null + example: true + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: static type: object + required: + - values 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: + values: 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: + description: 'This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.' + example: string$variable + externalDocs: + description: Static Transform Documentation + url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/static' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + - title: substring type: object + required: + - begin 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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: + begin: + type: integer + description: | + The index of the first character to include in the returned substring. + + + If `begin` is set to -1, the transform will begin at character 0 of the input data + example: 1 + format: int32 + beginOffset: + type: integer + description: | + This integer value is the number of characters to add to the begin attribute when returning a substring. + + This attribute is only used if begin is not -1. + example: 3 + format: int32 + end: + type: integer + description: | + The index of the first character to exclude from the returned substring. + + If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. + example: 6 + format: int32 + endOffset: + type: integer + description: | + This integer value is the number of characters to add to the end attribute when returning a substring. + + This attribute is only used if end is provided and is not -1. + example: 1 + format: int32 + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: trim 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: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: upper 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: uuid + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + internal: + type: boolean + readOnly: true + description: Indicates whether this is an internal SailPoint-created transform or a customer-created transform + example: false + example: + name: Timestamp To Date + type: dateFormat + attributes: + inputFormat: 'MMM-dd-yyyy, HH:mm:ss.SSS' + outputFormat: yyyy/dd/MM + responses: + '200': + description: Indicates the transform was successfully updated and returns its new representation. content: application/json: schema: type: object + description: The representation of an internally- or customer-defined transform. + required: + - name + - type + - attributes properties: - detailCode: + id: type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: + readOnly: true + description: Unique ID of this transform + example: 2cd78adghjkja34jh2b1hkjhasuecd + name: + type: string + description: Unique name of this transform + example: Timestamp To Date + minLength: 1 + maxLength: 50 + type: 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. - security: - - UserContextAuth: - - 'idn:transform:manage' - /work-items: - get: - operationId: listWorkItems - tags: - - Work Items - summary: List Work Items - description: 'This gets a collection of work items belonging to either the specified user(admin required), or the current user.' - parameters: - - 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. + description: The type of transform operation + enum: + - accountAttribute + - base64Decode + - base64Encode + - concat + - conditional + - dateCompare + - dateFormat + - dateMath + - decomposeDiacriticalMarks + - e164phone + - firstValid + - rule + - identityAttribute + - indexOf + - iso3166 + - lastIndexOf + - leftPad + - lookup + - lower + - normalizeNames + - randomAlphaNumeric + - randomNumeric + - reference + - replaceAll + - replace + - rightPad + - split + - static + - substring + - trim + - upper + - usernameGenerator + - uuid + example: dateFormat + externalDocs: + description: Transform Operations + url: 'https://developer.sailpoint.com/idn/docs/transforms/operations' + attributes: + description: Meta-data about the transform. Values in this list are specific to the type of transform to be executed. + oneOf: + - title: accountAttribute + type: object + required: + - sourceName + - attributeName + properties: + sourceName: + type: string + description: A reference to the source to search for the account + example: Workday + attributeName: + type: string + description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' + example: DEPARTMENT + accountSortAttribute: + type: string + description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries + example: created + accountSortDescending: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' + example: false + accountReturnFirstLink: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' + example: false + accountFilter: + type: string + description: |- + This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. + Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements + example: '!(nativeIdentity.startsWith("*DELETED*"))' + accountPropertyFilter: + type: string + description: |- + This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. + + All account attributes are available for filtering as this operation is performed in memory. + example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: base64Decode + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: base64Encode + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: concat + type: object + required: + - values + properties: + values: + type: array + items: + type: object + description: An array of items to join together + example: + - John + - ' ' + - Smith + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: conditional + type: object + required: + - expression + - positiveCondition + - negativeCondition + properties: + expression: + type: string + description: |- + A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. + + The `eq` operator is the only valid comparison + example: ValueA eq ValueB + positiveCondition: + type: string + description: The output of the transform if the expression evalutes to true + example: 'true' + negativeCondition: + type: string + description: The output of the transform if the expression evalutes to false + example: 'false' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateCompare + type: object + required: + - firstDate + - secondDate + - operator + - positiveCondition + - negativeCondition + properties: + firstDate: + description: This is the first date to consider (The date that would be on the left hand side of the comparison operation). + oneOf: + - title: accountAttribute + type: object + required: + - sourceName + - attributeName + properties: + sourceName: + type: string + description: A reference to the source to search for the account + example: Workday + attributeName: + type: string + description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' + example: DEPARTMENT + accountSortAttribute: + type: string + description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries + example: created + accountSortDescending: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' + example: false + accountReturnFirstLink: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' + example: false + accountFilter: + type: string + description: |- + This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. + Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements + example: '!(nativeIdentity.startsWith("*DELETED*"))' + accountPropertyFilter: + type: string + description: |- + This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. + + All account attributes are available for filtering as this operation is performed in memory. + example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateFormat + type: object + properties: + inputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + outputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + secondDate: + description: This is the second date to consider (The date that would be on the right hand side of the comparison operation). + oneOf: + - title: accountAttribute + type: object + required: + - sourceName + - attributeName + properties: + sourceName: + type: string + description: A reference to the source to search for the account + example: Workday + attributeName: + type: string + description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' + example: DEPARTMENT + accountSortAttribute: + type: string + description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries + example: created + accountSortDescending: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' + example: false + accountReturnFirstLink: + type: boolean + description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' + example: false + accountFilter: + type: string + description: |- + This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. + Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements + example: '!(nativeIdentity.startsWith("*DELETED*"))' + accountPropertyFilter: + type: string + description: |- + This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. + + All account attributes are available for filtering as this operation is performed in memory. + example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateFormat + type: object + properties: + inputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + outputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + operator: + type: string + description: | + This is the comparison to perform. + | Operation | Description | + | --------- | ------- | + | LT | Strictly less than: firstDate < secondDate | + | LTE | Less than or equal to: firstDate <= secondDate | + | GT | Strictly greater than: firstDate > secondDate | + | GTE | Greater than or equal to: firstDate >= secondDate | + enum: + - LT + - LTE + - GT + - GTE + example: LT + positiveCondition: + type: string + description: The output of the transform if the expression evalutes to true + example: 'true' + negativeCondition: + type: string + description: The output of the transform if the expression evalutes to false + example: false + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateFormat + type: object + properties: + inputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + outputFormat: + description: |- + A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + + *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + oneOf: + - title: Named Construct + type: string + description: | + | Construct | Date Time Pattern | Description | + | --------- | ----------------- | ----------- | + | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | + | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | + | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | + | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | + | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + enum: + - ISO8601 + - LDAP + - PEOPLE_SOFT + - EPOCH_TIME_JAVA + - EPOCH_TIME_WIN32 + example: PEOPLE_SOFT + - title: Java Simple Date Format + type: string + description: | + There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + + >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + + | Date Time Pattern | Result | + | ----------------- | ------ | + | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | + | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | + | `h:mm a` | 12:08 PM | + | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | + | `K:mm a, z` | 0:08 PM, PDT | + | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | + | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | + | `yyMMddHHmmssZ` | 010704120856-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | + | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | + | `YYYY-'W'ww-u` | 2001-W27-3 | + example: mm/dd/yyyy + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: dateMath + type: object + required: + - expression + properties: + expression: + type: string + description: | + A string value of the date and time components to operation on, along with the math operations to execute. + externalDocs: + description: Date Math Expressions + url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure' + example: now+1w + roundUp: + type: boolean + description: | + A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. + + + If not provided, the transform will default to `false` + + + `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) + + + `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) + example: false + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: decomposeDiacriticalMarks + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: e164phone + type: object + properties: + defaultRegion: + type: string + description: | + This is an optional attribute that can be used to define the region of the phone number to format into. + + + If defaultRegion is not provided, it will take US as the default country. + + + The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + example: US + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: firstValid + type: object + required: + - values + properties: + values: + type: array + items: + type: object + description: An array of attributes to evaluate for existence. + example: + - attributes: + sourceName: Active Directory + attributeName: sAMAccountName + type: accountAttribute + - attributes: + sourceName: Okta + attributeName: login + type: accountAttribute + - attributes: + sourceName: HR Source + attributeName: employeeID + type: accountAttribute + ignoreErrors: + type: boolean + description: a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. + example: false + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + - title: rule + oneOf: + - type: object + required: + - name + properties: + name: + type: string + description: This is the name of the Generic rule that needs to be invoked by the transform + example: Generic Calculation Rule + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + - type: object + required: + - name + - operation + - includeNumbers + - includeSpecialChars + - length + properties: + name: + type: string + description: This must always be set to "Cloud Services Deployment Utility" + example: Cloud Services Deployment Utility + operation: + type: string + description: The operation to perform `generateRandomString` + example: generateRandomString + includeNumbers: + type: boolean + description: This must be either "true" or "false" to indicate whether the generator logic should include numbers + example: true + includeSpecialChars: + type: boolean + description: This must be either "true" or "false" to indicate whether the generator logic should include special characters + example: true + length: + type: string + description: | + This specifies how long the randomly generated string needs to be + + + >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters + example: '10' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + - type: object + required: + - name + - operation + - uid + properties: + name: + type: string + description: This must always be set to "Cloud Services Deployment Utility" + example: Cloud Services Deployment Utility + operation: + type: string + description: The operation to perform `getReferenceIdentityAttribute` + example: getReferenceIdentityAttribute + uid: + type: string + description: | + This is the SailPoint User Name (uid) value of the identity whose attribute is desired + + As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. + example: 2c91808570313110017040b06f344ec9 + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + - title: identityAttribute + type: object + required: + - name + properties: + name: + type: string + description: The system (camel-cased) name of the identity attribute to bring in + example: email + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: indexOf + type: object + required: + - substring + properties: + substring: + type: string + description: 'A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.' + example: admin_ + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: iso3166 + type: object + properties: + format: + type: string + description: | + An optional value to denote which ISO 3166 format to return. Valid values are: + + + `alpha2` - Two-character country code (e.g., "US"); this is the default value if no format is supplied + + + `alpha3` - Three-character country code (e.g., "USA") + - 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. + `numeric` - The numeric country code (e.g., "840") + example: alpha2 + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: leftPad + type: object + required: + - length + properties: + length: + type: string + description: An integer value for the desired length of the final output string + example: '4' + padding: + type: string + description: | + A string value representing the character that the incoming data should be padded with to get to the desired length - 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: ownerId - schema: - type: string - description: ID of the work item owner. - required: false - example: 1211bcaa32112bcef6122adb21cef1ac - responses: - '200': - description: List of work items - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: ID of the work item - example: 2c9180835d2e5168015d32f890ca1581 - requesterId: - type: string - description: ID of the requester - example: 2c9180835d2e5168015d32f890ca1581 - requesterDisplayName: - type: string - description: The displayname of the requester - example: John Smith - ownerId: - type: string - description: The ID of the owner - example: 2c9180835d2e5168015d32f890ca1581 - ownerName: - type: string - description: The name of the owner - example: Jason Smith - created: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - description: Time when the work item was created - modified: - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: Time when the work item was last updated - description: - type: string - description: The description of the work item - example: Create account on source 'AD' - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - example: FINISHED - description: The state of a work item - type: - type: string - enum: - - UNKNOWN - - GENERIC - - CERTIFICATION - - REMEDIATION - - DELEGATION - - APPROVAL - - VIOLATIONREVIEW - - FORM - - POLICYVIOLATION - - CHALLENGE - - IMPACTANALYSIS - - SIGNOFF - - EVENT - - MANUALACTION - - TEST - example: GENERIC - description: The type of the work item - remediationItems: - type: object - properties: - id: - type: string - description: The ID of the certification - example: 2c9180835d2e5168015d32f890ca1581 - targetId: - type: string - description: The ID of the certification target - example: 2c9180835d2e5168015d32f890ca1581 - targetName: - type: string - description: The name of the certification target - example: john.smith - targetDisplayName: - type: string - description: The display name of the certification target - example: emailAddress - applicationName: - type: string - description: The name of the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute being certified - example: phoneNumber - attributeOperation: - type: string - description: The operation of the certification on the attribute - example: update - attributeValue: - type: string - description: The value of the attribute being certified - example: 512-555-1212 - nativeIdentity: - type: string - description: The native identity of the target - example: jason.smith2 - approvalItems: - type: object - properties: - id: - type: string - description: The approval item's ID - example: 2c9180835d2e5168015d32f890ca1581 - account: - type: string - description: The account referenced by the approval item - example: john.smith - application: - type: string - description: The name of the application/source - example: Active Directory - name: - type: string - description: The attribute's name - example: emailAddress - operation: - type: string - description: The attribute's operation - example: update - value: - type: string - description: The attribute's value - example: a@b.com - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - example: FINISHED - description: The state of a work item - name: - type: string - description: The work item name - example: Account Create - completed: - type: string - format: date-time - example: '2018-10-19T13:49:37.385Z' - description: The time at which the work item completed - numItems: - type: integer - format: int32 - description: The number of items in the work item - example: 19 - form: - type: object - properties: - id: - type: string - description: ID of the form - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: Name of the form - example: AccountSelection Form - title: - type: string - description: The form title - example: Account Selection for John.Doe - subtitle: - type: string - description: The form subtitle. - example: Please select from the following - targetUser: - type: string - description: The name of the user that should be shown this form - example: Jane.Doe - sections: - type: object - allOf: - - type: object - properties: - name: - type: string - description: Name of the FormItem - example: Field1 - - type: object - properties: - label: - type: string - description: Label of the section - example: Section 1 - formItems: - type: array - items: - type: object - description: List of FormItems. FormItems can be SectionDetails and/or FieldDetails - example: [] - errors: - type: array - items: - type: string - example: - - The work item ID that was specified was not found. - description: An array of errors that ocurred during the work item - '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. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - 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: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '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. + + If not provided, the transform will default to a single space (" ") character for padding + example: '0' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: lookup + type: object + required: + - table + properties: + table: + type: object + additionalProperties: true + description: | + This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched + + + >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. + example: + USA: Americas + FRA: EMEA + AUS: APAC + default: Unknown Region + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: lower + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: nameNormalizer + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: randomAlphaNumeric + type: object + properties: + length: + type: string + description: | + This is an integer value specifying the size/number of characters the random string must contain + + + * This value must be a positive number and cannot be blank + + + * If no length is provided, the transform will default to a value of `32` + + + * Due to identity attribute data constraints, the maximum allowable value is `450` characters + example: '10' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: randomNumeric + type: object + properties: + length: + type: string + description: | + This is an integer value specifying the size/number of characters the random string must contain + + + * This value must be a positive number and cannot be blank + + + * If no length is provided, the transform will default to a value of `32` + + + * Due to identity attribute data constraints, the maximum allowable value is `450` characters + example: '10' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: reference + type: object + required: + - id + properties: + id: + type: string + description: This ID specifies the name of the pre-existing transform which you want to use within your current transform + example: Existing Transform + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: replaceAll + type: object + required: + - table + properties: + table: + type: object + additionalProperties: true + description: 'An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.' + example: + '-': ' ' + '"': '''' + ñ: 'n' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: replace + type: object + required: + - regex + - replacement + properties: + regex: + type: string + description: This can be a string or a regex pattern in which you want to replace. + example: '[^a-zA-Z]' + externalDocs: + description: Regex Builder + url: 'https://regex101.com/' + replacement: + type: string + description: This is the replacement string that should be substituded wherever the string or pattern is found. + example: ' ' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: rightPad + type: object + required: + - length + properties: + length: + type: string + description: An integer value for the desired length of the final output string + example: '4' + padding: + type: string + description: | + A string value representing the character that the incoming data should be padded with to get to the desired length + + + If not provided, the transform will default to a single space (" ") character for padding + example: '0' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: split + type: object + required: + - delimiter + - index + properties: + delimiter: + type: string + description: 'This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data' + example: ',' + index: + type: string + description: 'An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.' + example: '5' + throws: + type: boolean + description: | + A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) + + + `true` - The transform should return "IndexOutOfBoundsException" + + + `false` - The transform should return null + + + If not provided, the transform will default to false and return a null + example: true + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: static + type: object + required: + - values + properties: + values: + type: string + description: 'This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.' + example: string$variable + externalDocs: + description: Static Transform Documentation + url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/static' + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + - title: substring + type: object + required: + - begin + properties: + begin: + type: integer + description: | + The index of the first character to include in the returned substring. + + + If `begin` is set to -1, the transform will begin at character 0 of the input data + example: 1 + format: int32 + beginOffset: + type: integer + description: | + This integer value is the number of characters to add to the begin attribute when returning a substring. + + This attribute is only used if begin is not -1. + example: 3 + format: int32 + end: + type: integer + description: | + The index of the first character to exclude from the returned substring. + + If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. + example: 6 + format: int32 + endOffset: + type: integer + description: | + This integer value is the number of characters to add to the end attribute when returning a substring. + + This attribute is only used if end is provided and is not -1. + example: 1 + format: int32 + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: trim + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: upper + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + input: + type: object + description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' + additionalProperties: true + example: + type: accountAttribute + attributes: + attributeName: first_name + sourceName: Source + - title: uuid + type: object + properties: + requiresPeriodicRefresh: + type: boolean + description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process + example: false + default: false + internal: + type: boolean + readOnly: true + description: Indicates whether this is an internal SailPoint-created transform or a customer-created transform + example: false + example: + id: 2cd78adghjkja34jh2b1hkjhasuecd + name: Timestamp To Date + type: dateFormat + attributes: + inputFormat: 'MMM-dd-yyyy, HH:mm:ss.SSS' + outputFormat: yyyy/dd/MM + internal: false + '400': + description: Client Error - Returned if the request body is invalid. content: application/json: schema: @@ -115617,330 +115559,50 @@ paths: 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. - /work-items/completed: - get: - operationId: getCompletedWorkItems - tags: - - Work Items - summary: Completed Work Items - description: 'This gets a collection of completed work items belonging to either the specified user(admin required), or the current user.' - parameters: - - in: query - name: ownerId - schema: - type: string - description: 'The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request.' - required: false - example: 1211bcaa32112bcef6122adb21cef1ac - - 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 - responses: - '200': - description: List of completed work items. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: ID of the work item - example: 2c9180835d2e5168015d32f890ca1581 - requesterId: - type: string - description: ID of the requester - example: 2c9180835d2e5168015d32f890ca1581 - requesterDisplayName: - type: string - description: The displayname of the requester - example: John Smith - ownerId: - type: string - description: The ID of the owner - example: 2c9180835d2e5168015d32f890ca1581 - ownerName: - type: string - description: The name of the owner - example: Jason Smith - created: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - description: Time when the work item was created - modified: - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: Time when the work item was last updated - description: - type: string - description: The description of the work item - example: Create account on source 'AD' - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - example: FINISHED - description: The state of a work item - type: - type: string - enum: - - UNKNOWN - - GENERIC - - CERTIFICATION - - REMEDIATION - - DELEGATION - - APPROVAL - - VIOLATIONREVIEW - - FORM - - POLICYVIOLATION - - CHALLENGE - - IMPACTANALYSIS - - SIGNOFF - - EVENT - - MANUALACTION - - TEST - example: GENERIC - description: The type of the work item - remediationItems: + description: Unique tracking id for the error. + example: e7eab60924f64aa284175b9fa3309599 + messages: + type: array + description: Generic localized reason for error + items: type: object properties: - id: - type: string - description: The ID of the certification - example: 2c9180835d2e5168015d32f890ca1581 - targetId: - type: string - description: The ID of the certification target - example: 2c9180835d2e5168015d32f890ca1581 - targetName: - type: string - description: The name of the certification target - example: john.smith - targetDisplayName: - type: string - description: The display name of the certification target - example: emailAddress - applicationName: - type: string - description: The name of the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute being certified - example: phoneNumber - attributeOperation: + locale: type: string - description: The operation of the certification on the attribute - example: update - attributeValue: + description: 'The locale for the message text, a BCP 47 language tag.' + example: en-US + localeOrigin: type: string - description: The value of the attribute being certified - example: 512-555-1212 - nativeIdentity: + 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: The native identity of the target - example: jason.smith2 - approvalItems: + 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: - id: - type: string - description: The approval item's ID - example: 2c9180835d2e5168015d32f890ca1581 - account: - type: string - description: The account referenced by the approval item - example: john.smith - application: - type: string - description: The name of the application/source - example: Active Directory - name: - type: string - description: The attribute's name - example: emailAddress - operation: - type: string - description: The attribute's operation - example: update - value: + locale: type: string - description: The attribute's value - example: a@b.com - state: + description: 'The locale for the message text, a BCP 47 language tag.' + example: en-US + localeOrigin: type: string enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - example: FINISHED - description: The state of a work item - name: - type: string - description: The work item name - example: Account Create - completed: - type: string - format: date-time - example: '2018-10-19T13:49:37.385Z' - description: The time at which the work item completed - numItems: - type: integer - format: int32 - description: The number of items in the work item - example: 19 - form: - type: object - properties: - id: - type: string - description: ID of the form - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: Name of the form - example: AccountSelection Form - title: - type: string - description: The form title - example: Account Selection for John.Doe - subtitle: - type: string - description: The form subtitle. - example: Please select from the following - targetUser: + - 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: The name of the user that should be shown this form - example: Jane.Doe - sections: - type: object - allOf: - - type: object - properties: - name: - type: string - description: Name of the FormItem - example: Field1 - - type: object - properties: - label: - type: string - description: Label of the section - example: Section 1 - formItems: - type: array - items: - type: object - description: List of FormItems. FormItems can be SectionDetails and/or FieldDetails - example: [] - errors: - type: array - items: - type: string - example: - - The work item ID that was specified was not found. - description: An array of errors that ocurred during the work item + 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: @@ -116162,33 +115824,87 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - /work-items/count: - get: - operationId: getCountWorkItems + security: + - UserContextAuth: + - 'idn:transform:manage' + delete: tags: - - Work Items - summary: Count Work Items - description: 'This gets a count of work items belonging to either the specified user(admin required), or the current user.' + - Transforms + summary: Delete a transform + description: |- + Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. + A token with transform delete authority is required to call this API. + operationId: deleteTransform parameters: - - in: query - name: ownerId + - name: id + in: path + description: ID of the transform to delete + required: true + style: simple + explode: false schema: type: string - description: ID of the work item owner. - required: false - example: ef38f94347e94562b5bb8424a56397d8 + example: 2cd78adghjkja34jh2b1hkjhasuecd responses: - '200': - description: List of work items + '204': + description: No content - indicates the request was successful but there is no content to be returned in the response. + '400': + description: Client Error - Returned if the request body is invalid. content: application/json: schema: type: object properties: - count: - type: integer - description: The count of work items - example: 29 + 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: @@ -116410,14 +116126,55 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - /work-items/completed/count: + security: + - UserContextAuth: + - 'idn:transform:manage' + /work-items: get: - operationId: getCountCompletedWorkItems + operationId: listWorkItems tags: - Work Items - summary: Count Completed Work Items - description: 'This gets a count of completed work items belonging to either the specified user(admin required), or the current user.' + summary: List Work Items + description: 'This gets a collection of work items belonging to either the specified user(admin required), or the current user.' parameters: + - 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: ownerId schema: @@ -116431,12 +116188,217 @@ paths: content: application/json: schema: - type: object - properties: - count: - type: integer - description: The count of work items - example: 29 + type: array + items: + type: object + properties: + id: + type: string + description: ID of the work item + example: 2c9180835d2e5168015d32f890ca1581 + requesterId: + type: string + description: ID of the requester + example: 2c9180835d2e5168015d32f890ca1581 + requesterDisplayName: + type: string + description: The displayname of the requester + example: John Smith + ownerId: + type: string + description: The ID of the owner + example: 2c9180835d2e5168015d32f890ca1581 + ownerName: + type: string + description: The name of the owner + example: Jason Smith + created: + type: string + format: date-time + example: '2017-07-11T18:45:37.098Z' + description: Time when the work item was created + modified: + type: string + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: Time when the work item was last updated + description: + type: string + description: The description of the work item + example: Create account on source 'AD' + state: + type: string + enum: + - FINISHED + - REJECTED + - RETURNED + - EXPIRED + - PENDING + - CANCELED + example: FINISHED + description: The state of a work item + type: + type: string + enum: + - UNKNOWN + - GENERIC + - CERTIFICATION + - REMEDIATION + - DELEGATION + - APPROVAL + - VIOLATIONREVIEW + - FORM + - POLICYVIOLATION + - CHALLENGE + - IMPACTANALYSIS + - SIGNOFF + - EVENT + - MANUALACTION + - TEST + example: GENERIC + description: The type of the work item + remediationItems: + type: object + properties: + id: + type: string + description: The ID of the certification + example: 2c9180835d2e5168015d32f890ca1581 + targetId: + type: string + description: The ID of the certification target + example: 2c9180835d2e5168015d32f890ca1581 + targetName: + type: string + description: The name of the certification target + example: john.smith + targetDisplayName: + type: string + description: The display name of the certification target + example: emailAddress + applicationName: + type: string + description: The name of the application/source + example: Active Directory + attributeName: + type: string + description: The name of the attribute being certified + example: phoneNumber + attributeOperation: + type: string + description: The operation of the certification on the attribute + example: update + attributeValue: + type: string + description: The value of the attribute being certified + example: 512-555-1212 + nativeIdentity: + type: string + description: The native identity of the target + example: jason.smith2 + approvalItems: + type: object + properties: + id: + type: string + description: The approval item's ID + example: 2c9180835d2e5168015d32f890ca1581 + account: + type: string + description: The account referenced by the approval item + example: john.smith + application: + type: string + description: The name of the application/source + example: Active Directory + name: + type: string + description: The attribute's name + example: emailAddress + operation: + type: string + description: The attribute's operation + example: update + value: + type: string + description: The attribute's value + example: a@b.com + state: + type: string + enum: + - FINISHED + - REJECTED + - RETURNED + - EXPIRED + - PENDING + - CANCELED + example: FINISHED + description: The state of a work item + name: + type: string + description: The work item name + example: Account Create + completed: + type: string + format: date-time + example: '2018-10-19T13:49:37.385Z' + description: The time at which the work item completed + numItems: + type: integer + format: int32 + description: The number of items in the work item + example: 19 + form: + type: object + properties: + id: + type: string + description: ID of the form + example: 2c9180835d2e5168015d32f890ca1581 + name: + type: string + description: Name of the form + example: AccountSelection Form + title: + type: string + description: The form title + example: Account Selection for John.Doe + subtitle: + type: string + description: The form subtitle. + example: Please select from the following + targetUser: + type: string + description: The name of the user that should be shown this form + example: Jane.Doe + sections: + type: object + allOf: + - type: object + properties: + name: + type: string + description: Name of the FormItem + example: Field1 + - type: object + properties: + label: + type: string + description: Label of the section + example: Section 1 + formItems: + type: array + items: + type: object + description: List of FormItems. FormItems can be SectionDetails and/or FieldDetails + example: [] + errors: + type: array + items: + type: string + example: + - The work item ID that was specified was not found. + description: An array of errors that ocurred during the work item '401': description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' content: @@ -116658,41 +116620,276 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - /work-items/summary: + /work-items/completed: get: - operationId: getWorkItemsSummary + operationId: getCompletedWorkItems tags: - Work Items - summary: Work Items Summary - description: 'This gets a summary of work items belonging to either the specified user(admin required), or the current user.' + summary: Completed Work Items + description: 'This gets a collection of completed work items belonging to either the specified user(admin required), or the current user.' parameters: - in: query name: ownerId schema: type: string - description: ID of the work item owner. + description: 'The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request.' required: false example: 1211bcaa32112bcef6122adb21cef1ac + - 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 responses: '200': - description: List of work items + description: List of completed work items. content: application/json: schema: - type: object - properties: - open: - type: integer - description: The count of open work items - example: 29 - completed: - type: integer - description: The count of completed work items - example: 1 - total: - type: integer - description: The count of total work items - example: 30 + type: array + items: + type: object + properties: + id: + type: string + description: ID of the work item + example: 2c9180835d2e5168015d32f890ca1581 + requesterId: + type: string + description: ID of the requester + example: 2c9180835d2e5168015d32f890ca1581 + requesterDisplayName: + type: string + description: The displayname of the requester + example: John Smith + ownerId: + type: string + description: The ID of the owner + example: 2c9180835d2e5168015d32f890ca1581 + ownerName: + type: string + description: The name of the owner + example: Jason Smith + created: + type: string + format: date-time + example: '2017-07-11T18:45:37.098Z' + description: Time when the work item was created + modified: + type: string + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: Time when the work item was last updated + description: + type: string + description: The description of the work item + example: Create account on source 'AD' + state: + type: string + enum: + - FINISHED + - REJECTED + - RETURNED + - EXPIRED + - PENDING + - CANCELED + example: FINISHED + description: The state of a work item + type: + type: string + enum: + - UNKNOWN + - GENERIC + - CERTIFICATION + - REMEDIATION + - DELEGATION + - APPROVAL + - VIOLATIONREVIEW + - FORM + - POLICYVIOLATION + - CHALLENGE + - IMPACTANALYSIS + - SIGNOFF + - EVENT + - MANUALACTION + - TEST + example: GENERIC + description: The type of the work item + remediationItems: + type: object + properties: + id: + type: string + description: The ID of the certification + example: 2c9180835d2e5168015d32f890ca1581 + targetId: + type: string + description: The ID of the certification target + example: 2c9180835d2e5168015d32f890ca1581 + targetName: + type: string + description: The name of the certification target + example: john.smith + targetDisplayName: + type: string + description: The display name of the certification target + example: emailAddress + applicationName: + type: string + description: The name of the application/source + example: Active Directory + attributeName: + type: string + description: The name of the attribute being certified + example: phoneNumber + attributeOperation: + type: string + description: The operation of the certification on the attribute + example: update + attributeValue: + type: string + description: The value of the attribute being certified + example: 512-555-1212 + nativeIdentity: + type: string + description: The native identity of the target + example: jason.smith2 + approvalItems: + type: object + properties: + id: + type: string + description: The approval item's ID + example: 2c9180835d2e5168015d32f890ca1581 + account: + type: string + description: The account referenced by the approval item + example: john.smith + application: + type: string + description: The name of the application/source + example: Active Directory + name: + type: string + description: The attribute's name + example: emailAddress + operation: + type: string + description: The attribute's operation + example: update + value: + type: string + description: The attribute's value + example: a@b.com + state: + type: string + enum: + - FINISHED + - REJECTED + - RETURNED + - EXPIRED + - PENDING + - CANCELED + example: FINISHED + description: The state of a work item + name: + type: string + description: The work item name + example: Account Create + completed: + type: string + format: date-time + example: '2018-10-19T13:49:37.385Z' + description: The time at which the work item completed + numItems: + type: integer + format: int32 + description: The number of items in the work item + example: 19 + form: + type: object + properties: + id: + type: string + description: ID of the form + example: 2c9180835d2e5168015d32f890ca1581 + name: + type: string + description: Name of the form + example: AccountSelection Form + title: + type: string + description: The form title + example: Account Selection for John.Doe + subtitle: + type: string + description: The form subtitle. + example: Please select from the following + targetUser: + type: string + description: The name of the user that should be shown this form + example: Jane.Doe + sections: + type: object + allOf: + - type: object + properties: + name: + type: string + description: Name of the FormItem + example: Field1 + - type: object + properties: + label: + type: string + description: Label of the section + example: Section 1 + formItems: + type: array + items: + type: object + description: List of FormItems. FormItems can be SectionDetails and/or FieldDetails + example: [] + errors: + type: array + items: + type: string + example: + - The work item ID that was specified was not found. + description: An array of errors that ocurred during the work item '401': description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' content: @@ -116914,236 +117111,33 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/work-items/{id}': + /work-items/count: get: - operationId: getWorkItem + operationId: getCountWorkItems tags: - Work Items - summary: Get a Work Item - description: 'This gets the details of a Work Item belonging to either the specified user(admin required), or the current user.' + summary: Count Work Items + description: 'This gets a count of work items belonging to either the specified user(admin required), or the current user.' parameters: - - in: path - name: id + - in: query + name: ownerId schema: type: string - required: true - description: ID of the work item. - example: 2c9180835d191a86015d28455b4a2329 + description: ID of the work item owner. + required: false + example: ef38f94347e94562b5bb8424a56397d8 responses: '200': - description: The work item with the given ID. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: ID of the work item - example: 2c9180835d2e5168015d32f890ca1581 - requesterId: - type: string - description: ID of the requester - example: 2c9180835d2e5168015d32f890ca1581 - requesterDisplayName: - type: string - description: The displayname of the requester - example: John Smith - ownerId: - type: string - description: The ID of the owner - example: 2c9180835d2e5168015d32f890ca1581 - ownerName: - type: string - description: The name of the owner - example: Jason Smith - created: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - description: Time when the work item was created - modified: - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: Time when the work item was last updated - description: - type: string - description: The description of the work item - example: Create account on source 'AD' - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - example: FINISHED - description: The state of a work item - type: - type: string - enum: - - UNKNOWN - - GENERIC - - CERTIFICATION - - REMEDIATION - - DELEGATION - - APPROVAL - - VIOLATIONREVIEW - - FORM - - POLICYVIOLATION - - CHALLENGE - - IMPACTANALYSIS - - SIGNOFF - - EVENT - - MANUALACTION - - TEST - example: GENERIC - description: The type of the work item - remediationItems: - type: object - properties: - id: - type: string - description: The ID of the certification - example: 2c9180835d2e5168015d32f890ca1581 - targetId: - type: string - description: The ID of the certification target - example: 2c9180835d2e5168015d32f890ca1581 - targetName: - type: string - description: The name of the certification target - example: john.smith - targetDisplayName: - type: string - description: The display name of the certification target - example: emailAddress - applicationName: - type: string - description: The name of the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute being certified - example: phoneNumber - attributeOperation: - type: string - description: The operation of the certification on the attribute - example: update - attributeValue: - type: string - description: The value of the attribute being certified - example: 512-555-1212 - nativeIdentity: - type: string - description: The native identity of the target - example: jason.smith2 - approvalItems: - type: object - properties: - id: - type: string - description: The approval item's ID - example: 2c9180835d2e5168015d32f890ca1581 - account: - type: string - description: The account referenced by the approval item - example: john.smith - application: - type: string - description: The name of the application/source - example: Active Directory - name: - type: string - description: The attribute's name - example: emailAddress - operation: - type: string - description: The attribute's operation - example: update - value: - type: string - description: The attribute's value - example: a@b.com - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - example: FINISHED - description: The state of a work item - name: - type: string - description: The work item name - example: Account Create - completed: - type: string - format: date-time - example: '2018-10-19T13:49:37.385Z' - description: The time at which the work item completed - numItems: - type: integer - format: int32 - description: The number of items in the work item - example: 19 - form: - type: object - properties: - id: - type: string - description: ID of the form - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: Name of the form - example: AccountSelection Form - title: - type: string - description: The form title - example: Account Selection for John.Doe - subtitle: - type: string - description: The form subtitle. - example: Please select from the following - targetUser: - type: string - description: The name of the user that should be shown this form - example: Jane.Doe - sections: - type: object - allOf: - - type: object - properties: - name: - type: string - description: Name of the FormItem - example: Field1 - - type: object - properties: - label: - type: string - description: Label of the section - example: Section 1 - formItems: - type: array - items: - type: object - description: List of FormItems. FormItems can be SectionDetails and/or FieldDetails - example: [] - errors: - type: array - items: - type: string - example: - - The work item ID that was specified was not found. - description: An array of errors that ocurred during the work item + description: List of work items + content: + application/json: + schema: + type: object + properties: + count: + type: integer + description: The count of work items + example: 29 '401': description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' content: @@ -117365,237 +117359,189 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - post: - operationId: completeWorkItem + /work-items/completed/count: + get: + operationId: getCountCompletedWorkItems tags: - Work Items - summary: Complete a Work Item - description: 'This API completes a work item. Either an admin, or the owning/current user must make this request.' + summary: Count Completed Work Items + description: 'This gets a count of completed work items belonging to either the specified user(admin required), or the current user.' parameters: - - in: path - name: id + - in: query + name: ownerId schema: type: string - required: true - description: The ID of the work item - example: ef38f94347e94562b5bb8424a56397d8 + description: ID of the work item owner. + required: false + example: 1211bcaa32112bcef6122adb21cef1ac responses: '200': - description: A WorkItems object + description: List of work items content: application/json: schema: type: object properties: - id: - type: string - description: ID of the work item - example: 2c9180835d2e5168015d32f890ca1581 - requesterId: - type: string - description: ID of the requester - example: 2c9180835d2e5168015d32f890ca1581 - requesterDisplayName: - type: string - description: The displayname of the requester - example: John Smith - ownerId: - type: string - description: The ID of the owner - example: 2c9180835d2e5168015d32f890ca1581 - ownerName: - type: string - description: The name of the owner - example: Jason Smith - created: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - description: Time when the work item was created - modified: - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: Time when the work item was last updated - description: - type: string - description: The description of the work item - example: Create account on source 'AD' - state: + count: + type: integer + description: The count of work items + example: 29 + '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 - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - example: FINISHED - description: The state of a work item - type: + description: Fine-grained error code providing more detail of the error. + example: 400.1 Bad Request Content + trackingId: type: string - enum: - - UNKNOWN - - GENERIC - - CERTIFICATION - - REMEDIATION - - DELEGATION - - APPROVAL - - VIOLATIONREVIEW - - FORM - - POLICYVIOLATION - - CHALLENGE - - IMPACTANALYSIS - - SIGNOFF - - EVENT - - MANUALACTION - - TEST - example: GENERIC - description: The type of the work item - remediationItems: - type: object - properties: - id: - type: string - description: The ID of the certification - example: 2c9180835d2e5168015d32f890ca1581 - targetId: - type: string - description: The ID of the certification target - example: 2c9180835d2e5168015d32f890ca1581 - targetName: - type: string - description: The name of the certification target - example: john.smith - targetDisplayName: - type: string - description: The display name of the certification target - example: emailAddress - applicationName: - type: string - description: The name of the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute being certified - example: phoneNumber - attributeOperation: - type: string - description: The operation of the certification on the attribute - example: update - attributeValue: - type: string - description: The value of the attribute being certified - example: 512-555-1212 - nativeIdentity: - type: string - description: The native identity of the target - example: jason.smith2 - approvalItems: - type: object - properties: - id: - type: string - description: The approval item's ID - example: 2c9180835d2e5168015d32f890ca1581 - account: - type: string - description: The account referenced by the approval item - example: john.smith - application: - type: string - description: The name of the application/source - example: Active Directory - name: - type: string - description: The attribute's name - example: emailAddress - operation: - type: string - description: The attribute's operation - example: update - value: - type: string - description: The attribute's value - example: a@b.com - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - example: FINISHED - description: The state of a work item - name: + 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. + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + content: + application/json: + schema: + type: object + properties: + detailCode: type: string - description: The work item name - example: Account Create - completed: + description: Fine-grained error code providing more detail of the error. + example: 400.1 Bad Request Content + trackingId: type: string - format: date-time - example: '2018-10-19T13:49:37.385Z' - description: The time at which the work item completed - numItems: - type: integer - format: int32 - description: The number of items in the work item - example: 19 - form: - type: object - properties: - id: - type: string - description: ID of the form - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: Name of the form - example: AccountSelection Form - title: - type: string - description: The form title - example: Account Selection for John.Doe - subtitle: - type: string - description: The form subtitle. - example: Please select from the following - targetUser: - type: string - description: The name of the user that should be shown this form - example: Jane.Doe - sections: - type: object - allOf: - - type: object - properties: - name: - type: string - description: Name of the FormItem - example: Field1 - - type: object - properties: - label: - type: string - description: Label of the section - example: Section 1 - formItems: - type: array - items: - type: object - description: List of FormItems. FormItems can be SectionDetails and/or FieldDetails - example: [] - errors: + description: Unique tracking id for the error. + example: e7eab60924f64aa284175b9fa3309599 + messages: type: array + description: Generic localized reason for error items: - type: string - example: - - The work item ID that was specified was not found. - description: An array of errors that ocurred during the work item - '400': - description: Client Error - Returned if the request body is invalid. + 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: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '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: @@ -117651,6 +117597,51 @@ paths: 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. + /work-items/summary: + get: + operationId: getWorkItemsSummary + tags: + - Work Items + summary: Work Items Summary + description: 'This gets a summary of work items belonging to either the specified user(admin required), or the current user.' + parameters: + - in: query + name: ownerId + schema: + type: string + description: ID of the work item owner. + required: false + example: 1211bcaa32112bcef6122adb21cef1ac + responses: + '200': + description: List of work items + content: + application/json: + schema: + type: object + properties: + open: + type: integer + description: The count of open work items + example: 29 + completed: + type: integer + description: The count of completed work items + example: 1 + total: + type: integer + description: The count of total work items + example: 30 '401': description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' content: @@ -117872,31 +117863,24 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/work-items/{id}/approve/{approvalItemId}': - post: - operationId: approveApprovalItem + '/work-items/{id}': + get: + operationId: getWorkItem tags: - Work Items - summary: Approve an Approval Item - description: 'This API approves an Approval Item. Either an admin, or the owning/current user must make this request.' + summary: Get a Work Item + description: 'This gets the details of a Work Item belonging to either the specified user(admin required), or the current user.' parameters: - in: path name: id schema: type: string required: true - description: The ID of the work item - example: ef38f94347e94562b5bb8424a56397d8 - - in: path - name: approvalItemId - schema: - type: string - required: true - description: The ID of the approval item. - example: 1211bcaa32112bcef6122adb21cef1ac + description: ID of the work item. + example: 2c9180835d191a86015d28455b4a2329 responses: '200': - description: A work items details object. + description: The work item with the given ID. content: application/json: schema: @@ -118109,63 +118093,6 @@ paths: example: - The work item ID that was specified was not found. description: An array of errors that ocurred during the work item - '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: @@ -118387,13 +118314,12 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/work-items/{id}/reject/{approvalItemId}': post: - operationId: rejectApprovalItem + operationId: completeWorkItem tags: - Work Items - summary: Reject an Approval Item - description: 'This API rejects an Approval Item. Either an admin, or the owning/current user must make this request.' + summary: Complete a Work Item + description: 'This API completes a work item. Either an admin, or the owning/current user must make this request.' parameters: - in: path name: id @@ -118402,16 +118328,9 @@ paths: required: true description: The ID of the work item example: ef38f94347e94562b5bb8424a56397d8 - - in: path - name: approvalItemId - schema: - type: string - required: true - description: The ID of the approval item. - example: 1211bcaa32112bcef6122adb21cef1ac responses: '200': - description: A work items details object. + description: A WorkItems object content: application/json: schema: @@ -118902,13 +118821,13 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/work-items/bulk-approve/{id}': + '/work-items/{id}/approve/{approvalItemId}': post: - operationId: approveApprovalItemsInBulk + operationId: approveApprovalItem tags: - Work Items - summary: Bulk approve Approval Items - description: 'This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request.' + summary: Approve an Approval Item + description: 'This API approves an Approval Item. Either an admin, or the owning/current user must make this request.' parameters: - in: path name: id @@ -118917,6 +118836,13 @@ paths: required: true description: The ID of the work item example: ef38f94347e94562b5bb8424a56397d8 + - in: path + name: approvalItemId + schema: + type: string + required: true + description: The ID of the approval item. + example: 1211bcaa32112bcef6122adb21cef1ac responses: '200': description: A work items details object. @@ -119410,13 +119336,13 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/work-items/bulk-reject/{id}': + '/work-items/{id}/reject/{approvalItemId}': post: - operationId: rejectApprovalItemsInBulk + operationId: rejectApprovalItem tags: - Work Items - summary: Bulk reject Approval Items - description: 'This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request.' + summary: Reject an Approval Item + description: 'This API rejects an Approval Item. Either an admin, or the owning/current user must make this request.' parameters: - in: path name: id @@ -119425,6 +119351,13 @@ paths: required: true description: The ID of the work item example: ef38f94347e94562b5bb8424a56397d8 + - in: path + name: approvalItemId + schema: + type: string + required: true + description: The ID of the approval item. + example: 1211bcaa32112bcef6122adb21cef1ac responses: '200': description: A work items details object. @@ -119918,13 +119851,13 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/work-items/{id}/submit-account-selection': + '/work-items/bulk-approve/{id}': post: - operationId: submitAccountSelection + operationId: approveApprovalItemsInBulk tags: - Work Items - summary: Submit Account Selections - description: 'This API submits account selections. Either an admin, or the owning/current user must make this request.' + summary: Bulk approve Approval Items + description: 'This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request.' parameters: - in: path name: id @@ -119933,16 +119866,6 @@ paths: required: true description: The ID of the work item example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - content: - application/json: - schema: - type: object - additionalProperties: true - example: - fieldName: fieldValue - description: 'Account Selection Data map, keyed on fieldName' responses: '200': description: A work items details object. @@ -120378,177 +120301,294 @@ paths: properties: detailCode: type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: + 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. + '/work-items/bulk-reject/{id}': + post: + operationId: rejectApprovalItemsInBulk + tags: + - Work Items + summary: Bulk reject Approval Items + description: 'This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request.' + parameters: + - in: path + name: id + schema: + type: string + required: true + description: The ID of the work item + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '200': + description: A work items details object. + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: ID of the work item + example: 2c9180835d2e5168015d32f890ca1581 + requesterId: + type: string + description: ID of the requester + example: 2c9180835d2e5168015d32f890ca1581 + requesterDisplayName: + type: string + description: The displayname of the requester + example: John Smith + ownerId: + type: string + description: The ID of the owner + example: 2c9180835d2e5168015d32f890ca1581 + ownerName: + type: string + description: The name of the owner + example: Jason Smith + created: + type: string + format: date-time + example: '2017-07-11T18:45:37.098Z' + description: Time when the work item was created + modified: + type: string + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: Time when the work item was last updated + description: + type: string + description: The description of the work item + example: Create account on source 'AD' + state: + type: string + enum: + - FINISHED + - REJECTED + - RETURNED + - EXPIRED + - PENDING + - CANCELED + example: FINISHED + description: The state of a work item + type: + type: string + enum: + - UNKNOWN + - GENERIC + - CERTIFICATION + - REMEDIATION + - DELEGATION + - APPROVAL + - VIOLATIONREVIEW + - FORM + - POLICYVIOLATION + - CHALLENGE + - IMPACTANALYSIS + - SIGNOFF + - EVENT + - MANUALACTION + - TEST + example: GENERIC + description: The type of the work item + remediationItems: + type: object + properties: + id: + type: string + description: The ID of the certification + example: 2c9180835d2e5168015d32f890ca1581 + targetId: + type: string + description: The ID of the certification target + example: 2c9180835d2e5168015d32f890ca1581 + targetName: + type: string + description: The name of the certification target + example: john.smith + targetDisplayName: + type: string + description: The display name of the certification target + example: emailAddress + applicationName: + type: string + description: The name of the application/source + example: Active Directory + attributeName: + type: string + description: The name of the attribute being certified + example: phoneNumber + attributeOperation: + type: string + description: The operation of the certification on the attribute + example: update + attributeValue: + type: string + description: The value of the attribute being certified + example: 512-555-1212 + nativeIdentity: + type: string + description: The native identity of the target + example: jason.smith2 + approvalItems: + type: object + properties: + id: + type: string + description: The approval item's ID + example: 2c9180835d2e5168015d32f890ca1581 + account: + type: string + description: The account referenced by the approval item + example: john.smith + application: + type: string + description: The name of the application/source + example: Active Directory + name: + type: string + description: The attribute's name + example: emailAddress + operation: + type: string + description: The attribute's operation + example: update + value: + type: string + description: The attribute's value + example: a@b.com + state: + type: string + enum: + - FINISHED + - REJECTED + - RETURNED + - EXPIRED + - PENDING + - CANCELED + example: FINISHED + description: The state of a work item + name: + type: string + description: The work item name + example: Account Create + completed: 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: + format: date-time + example: '2018-10-19T13:49:37.385Z' + description: The time at which the work item completed + numItems: + type: integer + format: int32 + description: The number of items in the work item + example: 19 + form: + type: object + properties: + id: + type: string + description: ID of the form + example: 2c9180835d2e5168015d32f890ca1581 + name: + type: string + description: Name of the form + example: AccountSelection Form + title: + type: string + description: The form title + example: Account Selection for John.Doe + subtitle: + type: string + description: The form subtitle. + example: Please select from the following + targetUser: + type: string + description: The name of the user that should be shown this form + example: Jane.Doe + sections: + type: object + allOf: + - type: object + properties: + name: + type: string + description: Name of the FormItem + example: Field1 + - type: object + properties: + label: + type: string + description: Label of the section + example: Section 1 + formItems: + type: array + items: + type: object + description: List of FormItems. FormItems can be SectionDetails and/or FieldDetails + example: [] + errors: 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. - '/campaigns/{id}/reports': - get: - operationId: getCampaignReports - tags: - - Certification Campaigns - summary: Get Campaign Reports - description: |- - Fetches all reports for a certification campaign by campaign ID. - Requires roles of CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN - security: - - UserContextAuth: - - 'idn:campaign-report:read' - parameters: - - in: path - name: campaignId - schema: - type: string - example: 2c91808571bcfcf80171c23e4b4221fc - required: true - description: The ID of the campaign for which reports are being fetched. - responses: - '200': - description: Array of campaign report objects. - content: - application/json: - schema: - type: array - items: - type: object - title: Campaign Report - required: - - reportType - allOf: - - 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 - - WORKGROUP - 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 - properties: - status: - type: string - description: Status of a violation report - enum: - - SUCCESS - - WARNING - - ERROR - - TERMINATED - - TEMP_ERROR - - PENDING - example: PENDING - - type: object - properties: - reportType: - type: string - description: type of a Report - enum: - - CAMPAIGN_COMPOSITION_REPORT - - CAMPAIGN_REMEDIATION_STATUS_REPORT - - CAMPAIGN_STATUS_REPORT - - CERTIFICATION_SIGNOFF_REPORT - example: CAMPAIGN_COMPOSITION_REPORT - lastRunAt: - type: string - readOnly: true - format: date-time - description: The most recent date and time this report was run - example: - type: REPORT_RESULT - id: 2c91808568c529c60168cca6f90c1313 - name: Campaign Composition Report - status: SUCCESS - reportType: CAMPAIGN_COMPOSITION_REPORT - lastRunAt: '2019-12-19T13:49:37.385Z' + type: string + example: + - The work item ID that was specified was not found. + description: An array of errors that ocurred during the work item '400': description: Client Error - Returned if the request body is invalid. content: @@ -120827,46 +120867,246 @@ paths: - locale: en-US localeOrigin: DEFAULT text: An internal fault occurred. - '/campaigns/{id}/run-report/{type}': + '/work-items/{id}/submit-account-selection': post: - operationId: startCampaignReport + operationId: submitAccountSelection tags: - - Certification Campaigns - summary: Run Campaign Report - description: |- - Runs a report for a certification campaign. - Requires the following roles: CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN. - security: - - oauth2: - - 'idn:campaign-report:run' + - Work Items + summary: Submit Account Selections + description: 'This API submits account selections. Either an admin, or the owning/current user must make this request.' parameters: - in: path name: id schema: type: string - example: 2c91808571bcfcf80171c23e4b4221fc - required: true - description: The ID of the campaign for which report is being run. - - in: path - name: type - schema: - type: string - description: type of a Report - enum: - - CAMPAIGN_COMPOSITION_REPORT - - CAMPAIGN_REMEDIATION_STATUS_REPORT - - CAMPAIGN_STATUS_REPORT - - CERTIFICATION_SIGNOFF_REPORT - example: CAMPAIGN_COMPOSITION_REPORT required: true - description: The type of the report to run. + description: The ID of the work item + example: ef38f94347e94562b5bb8424a56397d8 + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: true + example: + fieldName: fieldValue + description: 'Account Selection Data map, keyed on fieldName' responses: - '202': - description: Accepted - Returned if the request was successfully accepted into the system. + '200': + description: A work items details object. content: application/json: schema: type: object + properties: + id: + type: string + description: ID of the work item + example: 2c9180835d2e5168015d32f890ca1581 + requesterId: + type: string + description: ID of the requester + example: 2c9180835d2e5168015d32f890ca1581 + requesterDisplayName: + type: string + description: The displayname of the requester + example: John Smith + ownerId: + type: string + description: The ID of the owner + example: 2c9180835d2e5168015d32f890ca1581 + ownerName: + type: string + description: The name of the owner + example: Jason Smith + created: + type: string + format: date-time + example: '2017-07-11T18:45:37.098Z' + description: Time when the work item was created + modified: + type: string + format: date-time + example: '2018-06-25T20:22:28.104Z' + description: Time when the work item was last updated + description: + type: string + description: The description of the work item + example: Create account on source 'AD' + state: + type: string + enum: + - FINISHED + - REJECTED + - RETURNED + - EXPIRED + - PENDING + - CANCELED + example: FINISHED + description: The state of a work item + type: + type: string + enum: + - UNKNOWN + - GENERIC + - CERTIFICATION + - REMEDIATION + - DELEGATION + - APPROVAL + - VIOLATIONREVIEW + - FORM + - POLICYVIOLATION + - CHALLENGE + - IMPACTANALYSIS + - SIGNOFF + - EVENT + - MANUALACTION + - TEST + example: GENERIC + description: The type of the work item + remediationItems: + type: object + properties: + id: + type: string + description: The ID of the certification + example: 2c9180835d2e5168015d32f890ca1581 + targetId: + type: string + description: The ID of the certification target + example: 2c9180835d2e5168015d32f890ca1581 + targetName: + type: string + description: The name of the certification target + example: john.smith + targetDisplayName: + type: string + description: The display name of the certification target + example: emailAddress + applicationName: + type: string + description: The name of the application/source + example: Active Directory + attributeName: + type: string + description: The name of the attribute being certified + example: phoneNumber + attributeOperation: + type: string + description: The operation of the certification on the attribute + example: update + attributeValue: + type: string + description: The value of the attribute being certified + example: 512-555-1212 + nativeIdentity: + type: string + description: The native identity of the target + example: jason.smith2 + approvalItems: + type: object + properties: + id: + type: string + description: The approval item's ID + example: 2c9180835d2e5168015d32f890ca1581 + account: + type: string + description: The account referenced by the approval item + example: john.smith + application: + type: string + description: The name of the application/source + example: Active Directory + name: + type: string + description: The attribute's name + example: emailAddress + operation: + type: string + description: The attribute's operation + example: update + value: + type: string + description: The attribute's value + example: a@b.com + state: + type: string + enum: + - FINISHED + - REJECTED + - RETURNED + - EXPIRED + - PENDING + - CANCELED + example: FINISHED + description: The state of a work item + name: + type: string + description: The work item name + example: Account Create + completed: + type: string + format: date-time + example: '2018-10-19T13:49:37.385Z' + description: The time at which the work item completed + numItems: + type: integer + format: int32 + description: The number of items in the work item + example: 19 + form: + type: object + properties: + id: + type: string + description: ID of the form + example: 2c9180835d2e5168015d32f890ca1581 + name: + type: string + description: Name of the form + example: AccountSelection Form + title: + type: string + description: The form title + example: Account Selection for John.Doe + subtitle: + type: string + description: The form subtitle. + example: Please select from the following + targetUser: + type: string + description: The name of the user that should be shown this form + example: Jane.Doe + sections: + type: object + allOf: + - type: object + properties: + name: + type: string + description: Name of the FormItem + example: Field1 + - type: object + properties: + label: + type: string + description: Label of the section + example: Section 1 + formItems: + type: array + items: + type: object + description: List of FormItems. FormItems can be SectionDetails and/or FieldDetails + example: [] + errors: + type: array + items: + type: string + example: + - The work item ID that was specified was not found. + description: An array of errors that ocurred during the work item '400': description: Client Error - Returned if the request body is invalid. content: diff --git a/postman/collections/sailpoint-api-v3.json b/postman/collections/sailpoint-api-v3.json index 2089b584..b27ca093 100644 --- a/postman/collections/sailpoint-api-v3.json +++ b/postman/collections/sailpoint-api-v3.json @@ -5,7 +5,7 @@ "description": "Use this API to implement and customize access profile functionality. \nWith this functionality in place, administrators can create access profiles and configure them for use throughout IdentityNow, enabling users to get the access they need quickly and securely.\n\nAccess profiles group entitlements, which represent access rights on sources. \n\nFor example, an Active Directory source in IdentityNow can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization.\n\nAn administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement.\n\nWhen users only need Active Directory employee access, they can request access to the 'Employees' entitlement.\n\nWhen users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile.\n\nAccess profiles are the most important units of access in IdentityNow. IdentityNow uses access profiles in many features, including the following:\n\n- Provisioning: When you use the Provisioning Service, lifecycle states and roles both grant access to users in the form of access profiles.\n\n- Certifications: You can approve or revoke access profiles in certification campaigns, just like entitlements. \n\n- Access Requests: You can assign access profiles to applications, and when a user requests access to the app associated with an access profile and someone approves the request, access is granted to both the application and its associated access profile.\n\n- Roles: You can group one or more access profiles into a role to quickly assign access items based on an identity's role. \n\nIn IdentityNow, administrators can use the Access drop-down menu and select Access Profiles to view, configure, and delete existing access profiles, as well as create new ones. \nAdministrators can enable and disable an access profile, and they can also make the following configurations: \n\n- Manage Entitlements: Manage the profile's access by adding and removing entitlements. \n\n- Access Requests: Configure access profiles to be requestable and establish an approval process for any requests that the access profile be granted or revoked. \nDo not configure an access profile to be requestable without first establishing a secure access request approval process for the access profile.\n\n- Multiple Account Options: Define the logic IdentityNow uses to provision access to an identity with multiple accounts on the source. \n\nRefer to [Managing Access Profiles](https://documentation.sailpoint.com/saas/help/access/access-profiles.html) for more information about access profiles.\n", "item": [ { - "id": "a09b75bf-ee2b-4b4d-a220-4816332627e8", + "id": "3daafb32-54bc-40f2-9958-e5d768a59a4c", "name": "List Access Profiles", "request": { "name": "List Access Profiles", @@ -107,7 +107,7 @@ }, "response": [ { - "id": "5ad4d02b-3137-482d-9f8b-940d844a22f5", + "id": "02eab88c-66e7-4fff-8f0f-90c0239e796a", "name": "List of Access Profiles", "originalRequest": { "url": { @@ -218,12 +218,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n },\n {\n \"owner\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n }\n]", + "body": "[\n {\n \"owner\": {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n },\n {\n \"owner\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d7672e62-3c30-4383-b848-aa7d5198f2c4", + "id": "b03ba563-688f-40da-a215-08eaf4c6563c", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -334,12 +334,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b9bb3a16-69b4-4811-87ba-d2f309ba654d", + "id": "96ac3b71-6f78-45b0-8948-ea89b09a7f36", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -455,7 +455,7 @@ "_postman_previewlanguage": "json" }, { - "id": "840d523c-8842-43c7-b4e0-e572ac112bc1", + "id": "488b342d-9411-4fcb-935e-7c8be2e50308", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -566,12 +566,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1094e192-dc69-4915-bb9b-fe2fc7eb11e6", + "id": "a1e7d661-ba62-42bb-a550-b455b1ff6709", "name": "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.", "originalRequest": { "url": { @@ -687,7 +687,7 @@ "_postman_previewlanguage": "json" }, { - "id": "778cb178-470f-4b1b-af08-dc6c597d1256", + "id": "b8d632c4-17e9-4d04-9472-239a39ddaa71", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -798,7 +798,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -809,7 +809,7 @@ } }, { - "id": "06373e1a-0c19-4b9c-b959-c6c0ef45abee", + "id": "f4838c43-3d23-4468-a04d-5ea629ad9a89", "name": "Create an Access Profile", "request": { "name": "Create an Access Profile", @@ -840,7 +840,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"owner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "raw": "{\n \"owner\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -851,7 +851,7 @@ }, "response": [ { - "id": "116a1068-db07-4e90-beac-b1de05bf427b", + "id": "6730a2e2-0981-493a-ab0d-6098ef082f4e", "name": "Access Profile created", "originalRequest": { "url": { @@ -885,7 +885,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"owner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "raw": "{\n \"owner\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -902,12 +902,12 @@ "value": "application/json" } ], - "body": "{\n \"owner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "body": "{\n \"owner\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "db4969c7-e8cd-4a2c-973d-e77c4491573c", + "id": "51c9dd58-bbe0-4c47-8995-8e40d9c43f13", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -941,7 +941,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"owner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "raw": "{\n \"owner\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -958,12 +958,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3bdd75e8-4646-4baa-9fbe-d113deb7c1d9", + "id": "1bf794c3-3c3d-44c0-8756-9d636d0961d4", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -997,7 +997,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"owner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "raw": "{\n \"owner\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -1019,7 +1019,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9c99b772-f1a3-418c-8c66-54190f4c8354", + "id": "b90604f6-45e5-4d25-a9ab-232f139fbd1e", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -1053,7 +1053,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"owner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "raw": "{\n \"owner\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -1070,12 +1070,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "9923874f-6ab2-456a-abc0-9ca92f65a521", + "id": "88561264-51f8-4cb1-975f-c2d75303743c", "name": "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.", "originalRequest": { "url": { @@ -1109,7 +1109,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"owner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "raw": "{\n \"owner\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -1131,7 +1131,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7bc4b5d6-33ab-449b-af30-e8fee41bd586", + "id": "ec8cf592-ffed-4a08-bb07-390d1e407c0b", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -1165,7 +1165,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"owner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "raw": "{\n \"owner\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -1182,7 +1182,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -1193,7 +1193,7 @@ } }, { - "id": "0cfedd58-011c-49d6-9cc9-7661f6684f73", + "id": "431a4c30-03a2-4677-9bb4-2838f3483ddb", "name": "Get an Access Profile", "request": { "name": "Get an Access Profile", @@ -1230,7 +1230,7 @@ }, "response": [ { - "id": "d0347d45-899d-4172-98da-998a939c7f9e", + "id": "da6d56a6-55ec-4b1e-9806-76b55a3ace4c", "name": "An AccessProfile", "originalRequest": { "url": { @@ -1269,12 +1269,12 @@ "value": "application/json" } ], - "body": "{\n \"owner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "body": "{\n \"owner\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e10ea410-9816-4263-890c-bc3bebd81a44", + "id": "bf054a5d-7d74-47de-9b39-1a178730edb6", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -1313,12 +1313,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3df13ea6-7dfe-4877-b392-2f95b958b842", + "id": "eb081901-a065-44f0-91ff-0f92da874bcb", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -1362,7 +1362,7 @@ "_postman_previewlanguage": "json" }, { - "id": "968b4012-e6d2-4f59-83ef-9f8307c8cb60", + "id": "f75f0da4-fc6f-42a5-a184-cc2466c8a5c8", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -1401,12 +1401,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7da4793a-c12a-4ef4-b6e6-5a9b9ebb0093", + "id": "272b4833-14d7-4087-bb84-7ac04683f8ab", "name": "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.", "originalRequest": { "url": { @@ -1450,7 +1450,7 @@ "_postman_previewlanguage": "json" }, { - "id": "92d164d9-4fb9-4b1d-b6cd-d738f7bee818", + "id": "12402dc8-c1b8-432a-942a-f607c13ea93a", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -1489,7 +1489,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -1500,7 +1500,7 @@ } }, { - "id": "85eb3be5-048f-44aa-9816-f9e8dd3e0101", + "id": "c2d9a4b7-0af9-4174-b416-7e8a5da24923", "name": "Patch a specified Access Profile", "request": { "name": "Patch a specified Access Profile", @@ -1539,7 +1539,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -1550,7 +1550,7 @@ }, "response": [ { - "id": "ea802b50-6a14-4116-ae97-06afbce87bbe", + "id": "61c82c63-c109-4cdb-b62a-d377700ea3e2", "name": "Responds with the Access Profile as updated.", "originalRequest": { "url": { @@ -1585,7 +1585,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -1602,12 +1602,12 @@ "value": "application/json" } ], - "body": "{\n \"owner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "body": "{\n \"owner\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "861576d7-3ea9-43d7-97c1-8df324a4a172", + "id": "35601a4c-d7ac-4db3-9d23-edd9ea4815f6", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -1642,7 +1642,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -1659,12 +1659,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "9dc19a43-f9f2-4db7-b02c-437afb67355e", + "id": "c8e099eb-cab9-4115-b521-7926493c3843", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -1699,7 +1699,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -1721,7 +1721,7 @@ "_postman_previewlanguage": "json" }, { - "id": "56ad496d-c7b0-46ed-a4ef-8051b8bb2724", + "id": "e3b81b14-6d58-4053-9c6c-0f86885e1245", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -1756,7 +1756,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -1773,12 +1773,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1e8d85d9-db12-4dd0-a36b-d2765952ede0", + "id": "0d76e467-a220-47a4-addf-bf90ad2fbe45", "name": "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.", "originalRequest": { "url": { @@ -1813,7 +1813,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -1835,7 +1835,7 @@ "_postman_previewlanguage": "json" }, { - "id": "bf54f353-47c8-4d50-b3d7-7aa5f830f0de", + "id": "f2f7b5e5-d339-4f16-8a82-46adbbf71040", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -1870,7 +1870,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -1887,7 +1887,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -1898,7 +1898,7 @@ } }, { - "id": "fe51fc23-f68b-4c79-8398-d1d58ac785bf", + "id": "28c19a6d-bdb4-48e1-b71e-14df1f37c850", "name": "Delete Access Profile(s)", "request": { "name": "Delete Access Profile(s)", @@ -1941,7 +1941,7 @@ }, "response": [ { - "id": "ebc1a93d-a321-4209-a9e5-d9068f556508", + "id": "798fd3a3-70e4-472d-8c8a-faadc93d097c", "name": "Returned only if **bestEffortOnly** is **false**, and one or more Access Profiles are in use.", "originalRequest": { "url": { @@ -1993,12 +1993,12 @@ "value": "application/json" } ], - "body": "{\n \"taskId\": \"\",\n \"pending\": [\n \"\",\n \"\"\n ],\n \"inUse\": [\n {\n \"accessProfileId\": \"\",\n \"usedBy\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n {\n \"accessProfileId\": \"\",\n \"usedBy\": [\n {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n ]\n}", + "body": "{\n \"taskId\": \"\",\n \"pending\": [\n \"\",\n \"\"\n ],\n \"inUse\": [\n {\n \"accessProfileId\": \"\",\n \"usedBy\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n {\n \"accessProfileId\": \"\",\n \"usedBy\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a9b2edb4-acca-4b34-b341-09eb55d83686", + "id": "a9eeceb8-d46c-49be-b14f-0409b1e36127", "name": "Returned if at least one deletion will be performed.", "originalRequest": { "url": { @@ -2050,12 +2050,12 @@ "value": "application/json" } ], - "body": "{\n \"taskId\": \"\",\n \"pending\": [\n \"\",\n \"\"\n ],\n \"inUse\": [\n {\n \"accessProfileId\": \"\",\n \"usedBy\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n {\n \"accessProfileId\": \"\",\n \"usedBy\": [\n {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n ]\n}", + "body": "{\n \"taskId\": \"\",\n \"pending\": [\n \"\",\n \"\"\n ],\n \"inUse\": [\n {\n \"accessProfileId\": \"\",\n \"usedBy\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n {\n \"accessProfileId\": \"\",\n \"usedBy\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "f8fcd7d0-fd00-4e81-8d67-aab551cdc8f4", + "id": "a6370fcf-3bed-4a13-b9db-ccad1f4c1162", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -2107,12 +2107,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "09a21317-0856-4f31-916d-5642a30388aa", + "id": "e484a04f-c643-4ec7-9a17-3467e2bb1f9c", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -2169,7 +2169,7 @@ "_postman_previewlanguage": "json" }, { - "id": "555eec1c-8d08-4adc-bca3-24eb9363c980", + "id": "74c7b962-84b5-4643-bd29-73e1a2daba9a", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -2221,12 +2221,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "44695519-a194-451c-8fb8-d51631950ea2", + "id": "2711c290-73f9-4a74-95e9-b62b5cba78dd", "name": "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.", "originalRequest": { "url": { @@ -2283,7 +2283,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9fbbf042-4aa5-4554-97e6-f548779f10ef", + "id": "1787cdee-e527-47b2-826d-4afc4bb069f4", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -2335,7 +2335,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -2346,7 +2346,7 @@ } }, { - "id": "bbee660a-92ca-4854-86ff-a24010550a44", + "id": "7b106b5e-f3d4-4655-a1ab-ee7efa2639de", "name": "List Access Profile's Entitlements", "request": { "name": "List Access Profile's Entitlements", @@ -2430,7 +2430,7 @@ }, "response": [ { - "id": "01dca5c6-02b7-48ec-8b04-6d8a4371349c", + "id": "14701b36-478e-45c5-ba69-6086c944d5b1", "name": "List of Entitlements", "originalRequest": { "url": { @@ -2516,12 +2516,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n },\n \"attributes\": {\n \"quise4\": -29680669.912463784,\n \"occaecat_0\": false\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"directPermissions\": [\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n },\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n },\n \"attributes\": {\n \"in_041\": \"aliqua ullamco veniam\"\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"directPermissions\": [\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n },\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n }\n ]\n }\n]", + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n },\n \"attributes\": {\n \"laboris_c\": -37488471\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"directPermissions\": [\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n },\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n },\n \"attributes\": {\n \"ullamcoe7\": false,\n \"elit_19\": -46532300.62361087\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"directPermissions\": [\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n },\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "f37a8969-a254-4136-9462-c1ee4860253d", + "id": "517d25c4-04e6-4609-b481-697a784c005d", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -2607,12 +2607,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "fbb36ba1-63dd-41f1-8744-6b776019b369", + "id": "62e58fd9-1378-46ff-af72-2a2306de80c2", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -2703,7 +2703,7 @@ "_postman_previewlanguage": "json" }, { - "id": "64486043-a006-4826-a6c0-afbd6ba06619", + "id": "31ef13a7-c0d0-4e75-b2bd-612070286964", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -2789,12 +2789,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "76e38b1f-15fb-4f03-9717-a37b7231af23", + "id": "72a57e08-3c23-48a1-9220-efea0fb07f32", "name": "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.", "originalRequest": { "url": { @@ -2885,7 +2885,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e7a1f409-f1dd-4587-b28e-bd1a210df143", + "id": "d279e240-4183-4f87-b0f1-6bdfcb7dd7f7", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -2971,7 +2971,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -2988,7 +2988,7 @@ "description": "Use this API to implement and customize access request approval functionality. \nWith this functionality in place, administrators can delegate qualified users to review users' requests for access or managers' requests to revoke team members' access to applications, entitlements, or roles. \nThis enables more qualified users to review access requests and the others to spend their time on other tasks. \n\nIn IdentityNow, users can request access to applications, entitlements, and roles, and managers can request that team members' access be revoked. \nFor applications and entitlements, administrators can set access profiles to require approval from the access profile owner, the application owner, the source owner, the requesting user's manager, or a governance group for access to be granted or revoked. \nFor roles, administrators can also set roles to allow access requests and require approval from the role owner, the requesting user's manager, or a governance group for access to be granted or revoked. \nIf the administrator designates a governance group as the required approver, any governance group member can approve the requests.\n \nWhen a user submits an access request, IdentityNow sends the first required approver in the queue an email notification, based on the access request configuration's approval and reminder escalation configuration.\n\nIn Approvals in IdentityNow, required approvers can view pending access requests under the Requested tab and approve or deny them, or the approvers can reassign the requests to different reviewers for approval. \nIf the required approver approves the request and is the only reviewer required, IdentityNow grants or revokes access, based on the request. \nIf multiple reviewers are required, IdentityNow sends the request to the next reviewer in the queue, based on the access request configuration's approval reminder and escalation configuration. \nThe required approver can then view any completed access requests under the Reviewed tab. \n\nRefer to [Access Requests](https://documentation.sailpoint.com/saas/help/requests/index.html) for more information about access request approvals.\n", "item": [ { - "id": "909b89ad-758d-439a-a8cd-0b149641cb89", + "id": "25ce4c32-fcd7-4817-accc-b9b14c5b7875", "name": "Pending Access Request Approvals List", "request": { "name": "Pending Access Request Approvals List", @@ -3073,7 +3073,7 @@ }, "response": [ { - "id": "1f723a13-9685-4951-9d10-6b6920405b96", + "id": "780c583e-6b85-467f-af67-522ce981aa56", "name": "List of Pending Approvals.", "originalRequest": { "url": { @@ -3167,12 +3167,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"requestCreated\": \"\",\n \"requestType\": \"GRANT_ACCESS\",\n \"requester\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedFor\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedObject\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"ENTITLEMENT\"\n },\n \"requesterComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"previousReviewersComments\": [\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n }\n ],\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"MANUAL_REASSIGNMENT\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"SELF_REVIEW_DELEGATION\"\n }\n ],\n \"commentRequiredWhenRejected\": \"\",\n \"actionInProcess\": \"APPROVED\",\n \"removeDate\": \"\",\n \"removeDateUpdateRequested\": \"\",\n \"currentRemoveDate\": \"\",\n \"sodViolationContext\": {\n \"state\": \"SUCCESS\",\n \"uuid\": \"\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n \"clientMetadata\": {\n \"consequat_4\": \"\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"requestCreated\": \"\",\n \"requestType\": \"REVOKE_ACCESS\",\n \"requester\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedFor\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedObject\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n },\n \"requesterComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"previousReviewersComments\": [\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n }\n ],\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"MANUAL_REASSIGNMENT\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"SELF_REVIEW_DELEGATION\"\n }\n ],\n \"commentRequiredWhenRejected\": \"\",\n \"actionInProcess\": \"FORWARDED\",\n \"removeDate\": \"\",\n \"removeDateUpdateRequested\": \"\",\n \"currentRemoveDate\": \"\",\n \"sodViolationContext\": {\n \"state\": \"SUCCESS\",\n \"uuid\": \"\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n \"clientMetadata\": {\n \"pariatur_845\": \"\",\n \"ex_6\": \"\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n]", + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"requestCreated\": \"\",\n \"requestType\": \"GRANT_ACCESS\",\n \"requester\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedFor\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedObject\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"ROLE\"\n },\n \"requesterComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"previousReviewersComments\": [\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n }\n ],\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"SELF_REVIEW_DELEGATION\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTO_ESCALATION\"\n }\n ],\n \"commentRequiredWhenRejected\": \"\",\n \"actionInProcess\": \"FORWARDED\",\n \"removeDate\": \"\",\n \"removeDateUpdateRequested\": \"\",\n \"currentRemoveDate\": \"\",\n \"sodViolationContext\": {\n \"state\": \"SUCCESS\",\n \"uuid\": \"\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n \"clientMetadata\": {\n \"mollit_a\": \"\",\n \"mollit9b\": \"\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"requestCreated\": \"\",\n \"requestType\": \"REVOKE_ACCESS\",\n \"requester\": {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedFor\": {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedObject\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"ROLE\"\n },\n \"requesterComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"previousReviewersComments\": [\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n }\n ],\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTO_ESCALATION\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTO_ESCALATION\"\n }\n ],\n \"commentRequiredWhenRejected\": \"\",\n \"actionInProcess\": \"REJECTED\",\n \"removeDate\": \"\",\n \"removeDateUpdateRequested\": \"\",\n \"currentRemoveDate\": \"\",\n \"sodViolationContext\": {\n \"state\": \"SUCCESS\",\n \"uuid\": \"\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n \"clientMetadata\": {\n \"ipsum_\": \"\",\n \"Duis_36\": \"\",\n \"labore38c\": \"\",\n \"doaa\": \"\",\n \"mollit_7_\": \"\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "43709c81-5f63-4152-811c-9671ec6bfe56", + "id": "e7badd54-948f-4702-88e3-6dc07dd44d52", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -3266,12 +3266,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8241e42c-3aa0-43d8-8dcb-6a419bf981d6", + "id": "89473dbd-628e-4ff8-98dc-e6ce265347a7", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -3370,7 +3370,7 @@ "_postman_previewlanguage": "json" }, { - "id": "10c96a0f-c74b-4faf-9e22-de9f85a7c44f", + "id": "b11923b6-55df-410e-b551-18a093cafc20", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -3464,12 +3464,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "398b1d3e-e549-4916-930b-2f767c57b678", + "id": "f18aa32d-999c-4f38-9d4b-d798ad75ef7c", "name": "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.", "originalRequest": { "url": { @@ -3568,7 +3568,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e80aebdb-c05d-4208-8a88-d4f0cd2ff0c9", + "id": "2650ca31-063f-4d09-b358-778debac0537", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -3662,7 +3662,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -3673,7 +3673,7 @@ } }, { - "id": "ba7636d0-8702-4de3-8d11-67b8c5d538e5", + "id": "b59a85d7-4a95-4dcf-ad2c-57df1fab4f39", "name": "Completed Access Request Approvals List", "request": { "name": "Completed Access Request Approvals List", @@ -3758,7 +3758,7 @@ }, "response": [ { - "id": "5fde5253-bc07-44c2-b35d-baa1178b2026", + "id": "e248c854-9a0a-41fe-8149-76c4c5e030b3", "name": "List of Completed Approvals.", "originalRequest": { "url": { @@ -3852,12 +3852,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"requestCreated\": \"\",\n \"requestType\": \"REVOKE_ACCESS\",\n \"requester\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedFor\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewedBy\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedObject\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"ROLE\"\n },\n \"requesterComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"reviewerComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"previousReviewersComments\": [\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n }\n ],\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTO_ESCALATION\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\n }\n ],\n \"commentRequiredWhenRejected\": \"\",\n \"state\": \"REJECTED\",\n \"removeDate\": \"\",\n \"removeDateUpdateRequested\": \"\",\n \"currentRemoveDate\": \"\",\n \"sodViolationContext\": {\n \"state\": \"SUCCESS\",\n \"uuid\": \"\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n \"clientMetadata\": {\n \"pariatur_e\": \"\",\n \"ea_01\": \"\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"requestCreated\": \"\",\n \"requestType\": \"GRANT_ACCESS\",\n \"requester\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedFor\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewedBy\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedObject\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n },\n \"requesterComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"reviewerComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"previousReviewersComments\": [\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n }\n ],\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTO_ESCALATION\"\n }\n ],\n \"commentRequiredWhenRejected\": \"\",\n \"state\": \"APPROVED\",\n \"removeDate\": \"\",\n \"removeDateUpdateRequested\": \"\",\n \"currentRemoveDate\": \"\",\n \"sodViolationContext\": {\n \"state\": \"SUCCESS\",\n \"uuid\": \"\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n \"clientMetadata\": {\n \"fugiat_6\": \"\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n]", + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"requestCreated\": \"\",\n \"requestType\": \"REVOKE_ACCESS\",\n \"requester\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedFor\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewedBy\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedObject\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"ENTITLEMENT\"\n },\n \"requesterComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"reviewerComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"previousReviewersComments\": [\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n }\n ],\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"MANUAL_REASSIGNMENT\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\n }\n ],\n \"commentRequiredWhenRejected\": \"\",\n \"state\": \"APPROVED\",\n \"removeDate\": \"\",\n \"removeDateUpdateRequested\": \"\",\n \"currentRemoveDate\": \"\",\n \"sodViolationContext\": {\n \"state\": \"ERROR\",\n \"uuid\": \"\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n \"clientMetadata\": {\n \"velit_ce1\": \"\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"requestCreated\": \"\",\n \"requestType\": \"REVOKE_ACCESS\",\n \"requester\": {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedFor\": {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewedBy\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedObject\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n },\n \"requesterComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"reviewerComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"previousReviewersComments\": [\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n }\n ],\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"SELF_REVIEW_DELEGATION\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTO_ESCALATION\"\n }\n ],\n \"commentRequiredWhenRejected\": \"\",\n \"state\": \"REJECTED\",\n \"removeDate\": \"\",\n \"removeDateUpdateRequested\": \"\",\n \"currentRemoveDate\": \"\",\n \"sodViolationContext\": {\n \"state\": \"SUCCESS\",\n \"uuid\": \"\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n \"clientMetadata\": {\n \"occaecat02\": \"\",\n \"laborum3ad\": \"\",\n \"Lorem63\": \"\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a2762794-a5ce-4010-8cf0-ca2260030707", + "id": "15e72cb8-6023-4aaa-b0b4-91d1ef3c8665", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -3951,12 +3951,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5616765e-882b-4a36-a94b-3ef895c023e3", + "id": "025669d4-6a14-474f-98c2-0518af0cca91", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -4055,7 +4055,7 @@ "_postman_previewlanguage": "json" }, { - "id": "dc96b550-fa5d-41ee-819d-908b23fee90f", + "id": "0699ac2e-77c8-4267-b9dd-7fbb262ca812", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -4149,12 +4149,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "46774202-d455-413f-8777-dde17a21fca5", + "id": "51b335df-05ea-459d-9222-abed25b98b67", "name": "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.", "originalRequest": { "url": { @@ -4253,7 +4253,7 @@ "_postman_previewlanguage": "json" }, { - "id": "80585a33-3b64-4b0f-81ea-ec50890aafb6", + "id": "b8eb600d-481e-48d8-8e05-e272cc9ab253", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -4347,7 +4347,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -4358,7 +4358,7 @@ } }, { - "id": "0b73cc17-cdc1-4f70-970c-61b3f816f52b", + "id": "b88f67bb-1cfc-45a4-86f1-e9364d7aa031", "name": "Approves an access request approval.", "request": { "name": "Approves an access request approval.", @@ -4398,7 +4398,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -4409,7 +4409,7 @@ }, "response": [ { - "id": "e8ebc0ca-9f01-4eed-96d3-a57299e31d4f", + "id": "3b26c14c-e5b6-43f1-ab2e-3c6ac85174fc", "name": "Accepted - Returned if the request was successfully accepted into the system.", "originalRequest": { "url": { @@ -4445,7 +4445,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -4467,7 +4467,7 @@ "_postman_previewlanguage": "json" }, { - "id": "238e7c79-19f2-4973-a027-d872e7548f05", + "id": "e07636b6-4982-4981-8aa7-6c56c56c6b27", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -4503,7 +4503,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -4520,12 +4520,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5a901947-bd1c-4250-ae75-6a07219d05b5", + "id": "509cdc37-92a1-45cb-9667-090cc9f48c97", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -4561,7 +4561,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -4583,7 +4583,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d9440fc0-cc69-492c-9b2b-86c553681025", + "id": "59fb9b02-2f57-4d6f-95a8-fb7375ad0ace", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -4619,7 +4619,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -4636,12 +4636,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ea7da7b3-5cf9-458e-9730-8cd44070193b", + "id": "096bd628-32bf-49ed-b524-8450f0bb4b9d", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -4677,7 +4677,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -4694,12 +4694,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7faea734-09e6-43cc-9b44-77fd9c400a76", + "id": "732c4625-8a1b-4f68-ab4f-8dbf89fab5e9", "name": "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.", "originalRequest": { "url": { @@ -4735,7 +4735,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -4757,7 +4757,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c885a2d9-9ae6-4fd4-9940-39327aac60ca", + "id": "60de1519-ef9e-4e4a-b905-c8029c3b7dec", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -4793,7 +4793,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -4810,7 +4810,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -4821,7 +4821,7 @@ } }, { - "id": "247c317f-ab3d-47e9-90c9-b591b08fdce7", + "id": "673182f1-51d8-4aeb-be94-ef3505971001", "name": "Rejects an access request approval.", "request": { "name": "Rejects an access request approval.", @@ -4861,7 +4861,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -4872,7 +4872,7 @@ }, "response": [ { - "id": "d4b41b58-1716-4edb-be21-eba7b5bd5060", + "id": "a1af298a-9211-4dc6-adb5-a30941886188", "name": "Accepted - Returned if the request was successfully accepted into the system.", "originalRequest": { "url": { @@ -4908,7 +4908,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -4930,7 +4930,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b1432f66-a693-4908-aeb2-94a7b76e59da", + "id": "0d5d7b2e-4faf-4ebc-9023-e240c4d8d2f5", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -4966,7 +4966,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -4983,12 +4983,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0f81817f-9913-4b9a-9178-2fae4b0a234a", + "id": "11aef3b1-966b-43a3-947d-755339593e31", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -5024,7 +5024,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -5046,7 +5046,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6377065c-2090-45c6-b9b5-76f80f1ac6ab", + "id": "df8f9156-a055-4e44-a11b-2e476290e194", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -5082,7 +5082,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -5099,12 +5099,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "19a019a4-9737-4d73-8230-6b51b5217727", + "id": "10934d0e-bf38-49f3-80b2-32928f368385", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -5140,7 +5140,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -5157,12 +5157,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8150856c-ba02-4456-a3e9-b4dbccbfaa57", + "id": "7429ff21-03f7-41e9-888e-3599d88ece51", "name": "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.", "originalRequest": { "url": { @@ -5198,7 +5198,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -5220,7 +5220,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c09a73ab-e841-4288-8abe-dc0904dbda94", + "id": "71f830cc-f082-4eda-b3f3-c1f460c72378", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -5256,7 +5256,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -5273,7 +5273,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -5284,7 +5284,7 @@ } }, { - "id": "3dbcd422-5289-4833-9e9d-35e8aeb671ad", + "id": "4ea61418-3364-4c0a-82b6-090fefa6e915", "name": "Forwards an access request approval.", "request": { "name": "Forwards an access request approval.", @@ -5335,7 +5335,7 @@ }, "response": [ { - "id": "c252cd97-504e-46c6-aa46-08670e648cd4", + "id": "45621479-45c1-4ef4-b1e3-f0d5241b46fe", "name": "Accepted - Returned if the request was successfully accepted into the system.", "originalRequest": { "url": { @@ -5393,7 +5393,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9c966f18-ecbf-416a-b9ec-22ac475d9c42", + "id": "fd0b329a-29b8-4656-b994-17b3190fdeb1", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -5446,12 +5446,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "02510a92-55db-4115-b036-6ff22305a3f9", + "id": "e245f093-751a-40c7-bc38-8650c3ed918a", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -5509,7 +5509,7 @@ "_postman_previewlanguage": "json" }, { - "id": "be1e5add-5e00-4523-8749-8c0962fcecfb", + "id": "c240f526-637b-4252-9e14-42c60b0afcc0", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -5562,12 +5562,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ea0d3144-5783-4da8-a566-32452026c267", + "id": "c1033d5e-c2b3-46e7-a4a4-b76bb535a850", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -5620,12 +5620,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0759946a-0d11-4709-9d6a-78b9aee99fbb", + "id": "d2f9259a-0c91-44b4-8061-aa6d744f3b38", "name": "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.", "originalRequest": { "url": { @@ -5683,7 +5683,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ead0ebce-ad1d-4aa1-ad44-ce31ca2c4bd9", + "id": "0ad71396-c88a-4093-881f-9e072f3d7ca7", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -5736,7 +5736,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -5747,7 +5747,7 @@ } }, { - "id": "6504c5b8-aaa9-49a1-a511-780586469ead", + "id": "7c76f89d-3012-480a-a60c-7a86969676c9", "name": "Get the number of access-requests-approvals", "request": { "name": "Get the number of access-requests-approvals", @@ -5796,7 +5796,7 @@ }, "response": [ { - "id": "be97a582-c543-4cfe-8af5-8c4b6657b154", + "id": "d6749f46-3be9-4064-bbd9-fde25caafad1", "name": "Number of pending, approved, rejected access request approvals.", "originalRequest": { "url": { @@ -5859,7 +5859,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ce62431b-ee92-4d6e-b419-895025dff19d", + "id": "9e2dfc35-ef56-404f-8da1-dde977d130bc", "name": "Client Error - Returned if the query parameter is invalid.", "originalRequest": { "url": { @@ -5917,12 +5917,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a57fd7ad-43fe-4fc0-911f-526e56896c11", + "id": "3987d32c-81c7-4876-bcf6-4ae420c66d37", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -5985,7 +5985,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ce17c197-8a2e-4cab-a33e-0f5c558a5b91", + "id": "5355ffd7-23b3-4d1e-b8ea-99666b8917d2", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -6043,12 +6043,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "9ac0d0a0-068a-489f-af2c-417135bec5c8", + "id": "ee5b1b38-81c3-4b96-bda7-bec96cb5458d", "name": "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.", "originalRequest": { "url": { @@ -6111,7 +6111,7 @@ "_postman_previewlanguage": "json" }, { - "id": "998addd7-53ca-4b87-a986-2454f62af60a", + "id": "510dcc2b-aa26-4df7-9fa7-c64c04637131", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -6169,7 +6169,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -6186,7 +6186,7 @@ "description": "Use this API to implement and customize access request functionality. \nWith this functionality in place, users can request access to applications, entitlements, or roles, and managers can request that team members' access be revoked.\nThis allows users to get access to the tools they need quickly and securely, and it allows managers to take away access to those tools. \n\nIdentityNow's Access Request service allows end users to request access that requires approval before it can be granted to users and enables qualified users to review those requests and approve or deny them.\n\nIn the Request Center in IdentityNow, users can view available applications, roles, and entitlements and request access to them. \nIf the requested tools requires approval, the requests appear as 'Pending' under the My Requests tab until the required approver approves, rejects, or cancels them. \n\nUsers can use My Requests to track and/or cancel the requests.\n\nIn My Team on the IdentityNow Home, managers can submit requests to revoke their team members' access. \nThey can use the My Requests tab under Request Center to track and/or cancel the requests.\n\nRefer to [Requesting Access](https://documentation.sailpoint.com/saas/user-help/requests/requesting_access.html) for more information about access requests.\n", "item": [ { - "id": "ea951e25-350a-42da-bdb6-0e161ecf83ac", + "id": "6a6b0582-4e68-4f9a-903e-ecafa6e71789", "name": "Submit an Access Request", "request": { "name": "Submit an Access Request", @@ -6217,7 +6217,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"temporaad\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"anim_a\": \"\",\n \"Lorem_5c\": \"\",\n \"Ut_c6\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"REVOKE_ACCESS\",\n \"clientMetadata\": {\n \"quis_0\": \"\",\n \"dolore8\": \"\"\n }\n}", + "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"esse_b53\": \"\",\n \"ea85e\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"irure_391\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"GRANT_ACCESS\",\n \"clientMetadata\": {\n \"quis_a7\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -6228,7 +6228,7 @@ }, "response": [ { - "id": "4443a9b9-9588-4598-a15b-4fd7fbb3ae3c", + "id": "ea0ba25a-5d66-4e21-8f0e-7c8633add063", "name": "Accepted - Returned if the request was successfully accepted into the system.", "originalRequest": { "url": { @@ -6262,7 +6262,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"temporaad\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"anim_a\": \"\",\n \"Lorem_5c\": \"\",\n \"Ut_c6\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"REVOKE_ACCESS\",\n \"clientMetadata\": {\n \"quis_0\": \"\",\n \"dolore8\": \"\"\n }\n}", + "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"esse_b53\": \"\",\n \"ea85e\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"irure_391\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"GRANT_ACCESS\",\n \"clientMetadata\": {\n \"quis_a7\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -6284,7 +6284,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e7c0a5a2-1d65-4a63-8910-1bb47c32a965", + "id": "27061889-ae9f-48ae-9c51-ab344021aa31", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -6318,7 +6318,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"temporaad\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"anim_a\": \"\",\n \"Lorem_5c\": \"\",\n \"Ut_c6\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"REVOKE_ACCESS\",\n \"clientMetadata\": {\n \"quis_0\": \"\",\n \"dolore8\": \"\"\n }\n}", + "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"esse_b53\": \"\",\n \"ea85e\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"irure_391\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"GRANT_ACCESS\",\n \"clientMetadata\": {\n \"quis_a7\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -6335,12 +6335,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c196cb08-8fad-418b-889e-3bb064d0b240", + "id": "3fca8f46-cd72-4eeb-8747-5bfc9643e590", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -6374,7 +6374,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"temporaad\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"anim_a\": \"\",\n \"Lorem_5c\": \"\",\n \"Ut_c6\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"REVOKE_ACCESS\",\n \"clientMetadata\": {\n \"quis_0\": \"\",\n \"dolore8\": \"\"\n }\n}", + "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"esse_b53\": \"\",\n \"ea85e\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"irure_391\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"GRANT_ACCESS\",\n \"clientMetadata\": {\n \"quis_a7\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -6396,7 +6396,7 @@ "_postman_previewlanguage": "json" }, { - "id": "bcfa8633-9713-42ac-992c-6fafc03cf9c3", + "id": "12acaaaf-244f-4190-8f4b-f736bd2273bf", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -6430,7 +6430,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"temporaad\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"anim_a\": \"\",\n \"Lorem_5c\": \"\",\n \"Ut_c6\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"REVOKE_ACCESS\",\n \"clientMetadata\": {\n \"quis_0\": \"\",\n \"dolore8\": \"\"\n }\n}", + "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"esse_b53\": \"\",\n \"ea85e\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"irure_391\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"GRANT_ACCESS\",\n \"clientMetadata\": {\n \"quis_a7\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -6447,12 +6447,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "45150837-7a88-4f46-a1b0-ddcf493918cc", + "id": "f2e5a74a-4b66-4d12-8406-e63799a8d428", "name": "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.", "originalRequest": { "url": { @@ -6486,7 +6486,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"temporaad\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"anim_a\": \"\",\n \"Lorem_5c\": \"\",\n \"Ut_c6\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"REVOKE_ACCESS\",\n \"clientMetadata\": {\n \"quis_0\": \"\",\n \"dolore8\": \"\"\n }\n}", + "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"esse_b53\": \"\",\n \"ea85e\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"irure_391\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"GRANT_ACCESS\",\n \"clientMetadata\": {\n \"quis_a7\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -6508,7 +6508,7 @@ "_postman_previewlanguage": "json" }, { - "id": "700bee98-8af8-4b06-8bb2-8af5129a2b65", + "id": "6ddb04a9-181c-40a9-9ae5-7b78cf7b2e6a", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -6542,7 +6542,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"temporaad\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"anim_a\": \"\",\n \"Lorem_5c\": \"\",\n \"Ut_c6\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"REVOKE_ACCESS\",\n \"clientMetadata\": {\n \"quis_0\": \"\",\n \"dolore8\": \"\"\n }\n}", + "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"esse_b53\": \"\",\n \"ea85e\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"irure_391\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"GRANT_ACCESS\",\n \"clientMetadata\": {\n \"quis_a7\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -6559,7 +6559,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -6570,7 +6570,7 @@ } }, { - "id": "aecccef1-7cd0-4297-89a0-69b2c6a49b0a", + "id": "fa17f670-ca24-4deb-82b9-471340ef56ca", "name": "Cancel Access Request", "request": { "name": "Cancel Access Request", @@ -6613,7 +6613,7 @@ }, "response": [ { - "id": "9beb7b3f-744e-4392-ae40-08eb68863dd0", + "id": "8fce3904-b502-4fbc-8984-31fa54f77256", "name": "Accepted - Returned if the request was successfully accepted into the system.", "originalRequest": { "url": { @@ -6670,7 +6670,7 @@ "_postman_previewlanguage": "json" }, { - "id": "59a00ba0-c0d3-4b8f-8dc8-a481b69645c0", + "id": "8eda8d61-d3e9-4ddd-9610-2316787c2bcb", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -6722,12 +6722,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "fe2bdeda-8af3-4f75-861c-e4ca23aa3521", + "id": "e45dfd4f-d1aa-4fe1-be78-5b8ee9541673", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -6784,7 +6784,7 @@ "_postman_previewlanguage": "json" }, { - "id": "613820c8-9639-4296-8ba9-a995ff66c1c7", + "id": "bec2b7a1-234e-42d6-96af-865db979cb7e", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -6836,12 +6836,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "757324bd-cb17-405e-bdac-e69e16c9778f", + "id": "32e6514e-db2a-481a-88e4-31180ae191fb", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -6893,12 +6893,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "9dc1791c-6296-4437-899c-9a99781dc655", + "id": "71c24d8d-f7bd-41a9-a842-8c755483d8bb", "name": "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.", "originalRequest": { "url": { @@ -6955,7 +6955,7 @@ "_postman_previewlanguage": "json" }, { - "id": "bebc8a55-ffce-4bf8-867f-00dd13830fa5", + "id": "38e8757d-2d37-4495-be0c-0d8165303e67", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -7007,7 +7007,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -7018,7 +7018,7 @@ } }, { - "id": "3f5f6058-0444-444d-b252-08c3443af9fe", + "id": "09bc3934-7329-4013-95f2-0d4439884ae3", "name": "Get Access Request Configuration", "request": { "name": "Get Access Request Configuration", @@ -7047,7 +7047,7 @@ }, "response": [ { - "id": "6cbdb052-57f2-453d-ab41-c90a4c3ec9b9", + "id": "91d9b852-d45a-48e7-be70-04f88d95d6ca", "name": "Access Request Configuration Details.", "originalRequest": { "url": { @@ -7090,7 +7090,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0efb4b5d-7062-4cbd-b81d-1b208a0145c8", + "id": "aae9fd98-7dc1-467e-aa07-8c86b9a28e3c", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -7128,12 +7128,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "af0c8d4b-2365-4baa-a29d-36f49a218006", + "id": "8aaa9384-270e-4cc9-850a-ea56a6967dba", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -7176,7 +7176,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9ff09979-5a77-4b86-9dd6-fdda747bda09", + "id": "a9d3075b-ef88-48e4-9981-241e5c54cf0a", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -7214,12 +7214,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1747d5ae-a5c2-4759-a951-f3c331d638bb", + "id": "2824aafe-5842-4f60-8121-ee3b3dcb5854", "name": "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.", "originalRequest": { "url": { @@ -7262,7 +7262,7 @@ "_postman_previewlanguage": "json" }, { - "id": "37e0e515-8d41-4e38-806f-e9163ffc40f2", + "id": "b8f16d6a-5c54-45b1-a375-a953f9195551", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -7300,7 +7300,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -7311,7 +7311,7 @@ } }, { - "id": "f599a326-9058-4ef0-ac14-716c903b7e3f", + "id": "0fd25ed9-a9c5-4a47-80a6-eb75fa7a4ecc", "name": "Update Access Request Configuration", "request": { "name": "Update Access Request Configuration", @@ -7353,7 +7353,7 @@ }, "response": [ { - "id": "e1572d0b-5f08-492d-a9b9-7529cbe83640", + "id": "35a8d83d-2179-4249-809e-6a3192023c86", "name": "Access Request Configuration Details.", "originalRequest": { "url": { @@ -7409,7 +7409,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f0cdffdd-4cd0-4418-8cf3-c5a7a0b5f7aa", + "id": "30b4d763-ce33-444d-95bf-fc10da3a400d", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -7460,12 +7460,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7a0d6cba-657d-46bd-98cd-4df0ddef5fa4", + "id": "650d370b-182c-417a-a81d-b9dd10bbfcd7", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -7521,7 +7521,7 @@ "_postman_previewlanguage": "json" }, { - "id": "2107cd10-c0dc-42c3-9087-30dfc51929c6", + "id": "ebe78431-68e9-4767-9ad7-b61544556d94", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -7572,12 +7572,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6b5722b7-5b3d-4afe-86ae-8a853762c886", + "id": "38f0f7e4-a2ee-443f-8c0d-6fb18ab46a07", "name": "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.", "originalRequest": { "url": { @@ -7633,7 +7633,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5b38fb59-f87f-4288-84e2-dd992bc112fb", + "id": "122832ac-8f4d-4809-af8c-84496d2d87b8", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -7684,7 +7684,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -7695,7 +7695,7 @@ } }, { - "id": "855e0066-2f7a-4e80-aba4-01228a6fd85a", + "id": "27ad3ccb-514f-4697-813c-2dc0c2ca1c6d", "name": "Access Request Status", "request": { "name": "Access Request Status", @@ -7797,7 +7797,7 @@ }, "response": [ { - "id": "c5b2faac-a638-4655-ad94-e946c537ef4f", + "id": "38232113-0050-404b-bb8d-f5be34273735", "name": "List of requested item status.", "originalRequest": { "url": { @@ -7908,12 +7908,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"name\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"cancelledRequestDetails\": {\n \"comment\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\"\n },\n \"errorMessages\": [\n [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n ],\n \"state\": \"ERROR\",\n \"approvalDetails\": [\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewedBy\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"PENDING\",\n \"scheme\": \"APP_OWNER\",\n \"errorMessages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"comment\": \"\",\n \"removeDate\": \"\"\n },\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewedBy\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"CANCELLED\",\n \"scheme\": \"ACCESS_PROFILE_OWNER\",\n \"errorMessages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"comment\": \"\",\n \"removeDate\": \"\"\n }\n ],\n \"manualWorkItemDetails\": [\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"REJECTED\",\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"MANUAL_REASSIGNMENT\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\n }\n ]\n },\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"ARCHIVED\",\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"MANUAL_REASSIGNMENT\"\n }\n ]\n }\n ],\n \"accountActivityItemId\": \"\",\n \"requestType\": \"REVOKE_ACCESS\",\n \"modified\": \"\",\n \"created\": \"\",\n \"requester\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedFor\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requesterComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"sodViolationContext\": {\n \"state\": \"ERROR\",\n \"uuid\": \"\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n \"clientMetadata\": {\n \"sed7\": \"\",\n \"commodo58d\": \"\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n },\n \"provisioningDetails\": {\n \"orderedSubPhaseReferences\": \"\"\n },\n \"preApprovalTriggerDetails\": {\n \"comment\": \"\",\n \"reviewer\": \"\",\n \"decision\": \"APPROVED\"\n },\n \"accessRequestPhases\": [\n {\n \"started\": \"\",\n \"finished\": \"\",\n \"name\": \"\",\n \"state\": \"EXECUTING\",\n \"result\": \"SUCCESSFUL\",\n \"phaseReference\": \"\"\n },\n {\n \"started\": \"\",\n \"finished\": \"\",\n \"name\": \"\",\n \"state\": \"EXECUTING\",\n \"result\": \"SUCCESSFUL\",\n \"phaseReference\": \"\"\n }\n ],\n \"description\": \"\",\n \"removeDate\": \"\",\n \"cancelable\": \"\",\n \"accessRequestId\": \"\",\n \"clientMetadata\": {\n \"sitd8\": \"\",\n \"eiusmodda\": \"\",\n \"labore54\": \"\",\n \"pariatur4\": \"\",\n \"tempor_97\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"cancelledRequestDetails\": {\n \"comment\": \"\",\n \"owner\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\"\n },\n \"errorMessages\": [\n [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n ],\n \"state\": \"PROVISIONING_VERIFICATION_PENDING\",\n \"approvalDetails\": [\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewedBy\": {\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"REJECTED\",\n \"scheme\": \"ENTITLEMENT_OWNER\",\n \"errorMessages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"comment\": \"\",\n \"removeDate\": \"\"\n },\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewedBy\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"PENDING\",\n \"scheme\": \"GOVERNANCE_GROUP\",\n \"errorMessages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"comment\": \"\",\n \"removeDate\": \"\"\n }\n ],\n \"manualWorkItemDetails\": [\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"EXPIRED\",\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTO_ESCALATION\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"SELF_REVIEW_DELEGATION\"\n }\n ]\n },\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"EXPIRED\",\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"SELF_REVIEW_DELEGATION\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"MANUAL_REASSIGNMENT\"\n }\n ]\n }\n ],\n \"accountActivityItemId\": \"\",\n \"requestType\": \"GRANT_ACCESS\",\n \"modified\": \"\",\n \"created\": \"\",\n \"requester\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedFor\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requesterComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"sodViolationContext\": {\n \"state\": \"SUCCESS\",\n \"uuid\": \"\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n \"clientMetadata\": {\n \"voluptate53\": \"\",\n \"sunt_c47\": \"\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n },\n \"provisioningDetails\": {\n \"orderedSubPhaseReferences\": \"\"\n },\n \"preApprovalTriggerDetails\": {\n \"comment\": \"\",\n \"reviewer\": \"\",\n \"decision\": \"APPROVED\"\n },\n \"accessRequestPhases\": [\n {\n \"started\": \"\",\n \"finished\": \"\",\n \"name\": \"\",\n \"state\": \"CANCELLED\",\n \"result\": \"SUCCESSFUL\",\n \"phaseReference\": \"\"\n },\n {\n \"started\": \"\",\n \"finished\": \"\",\n \"name\": \"\",\n \"state\": \"CANCELLED\",\n \"result\": \"SUCCESSFUL\",\n \"phaseReference\": \"\"\n }\n ],\n \"description\": \"\",\n \"removeDate\": \"\",\n \"cancelable\": \"\",\n \"accessRequestId\": \"\",\n \"clientMetadata\": {\n \"exercitation_422\": \"\",\n \"irure_921\": \"\",\n \"in3\": \"\"\n }\n }\n]", + "body": "[\n {\n \"name\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"cancelledRequestDetails\": {\n \"comment\": \"\",\n \"owner\": {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\"\n },\n \"errorMessages\": [\n [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n ],\n \"state\": \"NOT_ALL_ITEMS_PROVISIONED\",\n \"approvalDetails\": [\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewedBy\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"ARCHIVED\",\n \"scheme\": \"GOVERNANCE_GROUP\",\n \"errorMessages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"comment\": \"\",\n \"removeDate\": \"\"\n },\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewedBy\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"PENDING\",\n \"scheme\": \"ACCESS_PROFILE_OWNER\",\n \"errorMessages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"comment\": \"\",\n \"removeDate\": \"\"\n }\n ],\n \"manualWorkItemDetails\": [\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"APPROVED\",\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\n }\n ]\n },\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"ARCHIVED\",\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"MANUAL_REASSIGNMENT\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\n }\n ]\n }\n ],\n \"accountActivityItemId\": \"\",\n \"requestType\": \"REVOKE_ACCESS\",\n \"modified\": \"\",\n \"created\": \"\",\n \"requester\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedFor\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requesterComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"sodViolationContext\": {\n \"state\": \"SUCCESS\",\n \"uuid\": \"\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n \"clientMetadata\": {\n \"veniamc3\": \"\",\n \"proident19\": \"\",\n \"consequat_2b\": \"\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n },\n \"provisioningDetails\": {\n \"orderedSubPhaseReferences\": \"\"\n },\n \"preApprovalTriggerDetails\": {\n \"comment\": \"\",\n \"reviewer\": \"\",\n \"decision\": \"REJECTED\"\n },\n \"accessRequestPhases\": [\n {\n \"started\": \"\",\n \"finished\": \"\",\n \"name\": \"\",\n \"state\": \"COMPLETED\",\n \"result\": \"FAILED\",\n \"phaseReference\": \"\"\n },\n {\n \"started\": \"\",\n \"finished\": \"\",\n \"name\": \"\",\n \"state\": \"CANCELLED\",\n \"result\": \"SUCCESSFUL\",\n \"phaseReference\": \"\"\n }\n ],\n \"description\": \"\",\n \"removeDate\": \"\",\n \"cancelable\": \"\",\n \"accessRequestId\": \"\",\n \"clientMetadata\": {\n \"fugiat45\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"type\": \"ROLE\",\n \"cancelledRequestDetails\": {\n \"comment\": \"\",\n \"owner\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\"\n },\n \"errorMessages\": [\n [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n ],\n \"state\": \"PROVISIONING_FAILED\",\n \"approvalDetails\": [\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"PENDING\",\n \"scheme\": \"ENTITLEMENT_OWNER\",\n \"errorMessages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"comment\": \"\",\n \"removeDate\": \"\"\n },\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewedBy\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"ARCHIVED\",\n \"scheme\": \"ENTITLEMENT_OWNER\",\n \"errorMessages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"comment\": \"\",\n \"removeDate\": \"\"\n }\n ],\n \"manualWorkItemDetails\": [\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"EXPIRED\",\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"SELF_REVIEW_DELEGATION\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTO_ESCALATION\"\n }\n ]\n },\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"CANCELLED\",\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"MANUAL_REASSIGNMENT\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"SELF_REVIEW_DELEGATION\"\n }\n ]\n }\n ],\n \"accountActivityItemId\": \"\",\n \"requestType\": \"REVOKE_ACCESS\",\n \"modified\": \"\",\n \"created\": \"\",\n \"requester\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedFor\": {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requesterComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"sodViolationContext\": {\n \"state\": \"ERROR\",\n \"uuid\": \"\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n \"clientMetadata\": {\n \"cupidatat618\": \"\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n },\n \"provisioningDetails\": {\n \"orderedSubPhaseReferences\": \"\"\n },\n \"preApprovalTriggerDetails\": {\n \"comment\": \"\",\n \"reviewer\": \"\",\n \"decision\": \"REJECTED\"\n },\n \"accessRequestPhases\": [\n {\n \"started\": \"\",\n \"finished\": \"\",\n \"name\": \"\",\n \"state\": \"PENDING\",\n \"result\": \"SUCCESSFUL\",\n \"phaseReference\": \"\"\n },\n {\n \"started\": \"\",\n \"finished\": \"\",\n \"name\": \"\",\n \"state\": \"EXECUTING\",\n \"result\": \"SUCCESSFUL\",\n \"phaseReference\": \"\"\n }\n ],\n \"description\": \"\",\n \"removeDate\": \"\",\n \"cancelable\": \"\",\n \"accessRequestId\": \"\",\n \"clientMetadata\": {\n \"laboris_d05\": \"\"\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5429786c-189b-4b27-8cdf-198c0c57eb5e", + "id": "f40cccf4-efbb-416d-8a62-fcd3e7a4ca50", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -8024,12 +8024,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a02fe1b4-d20b-419a-8c52-a9478ebd5f2d", + "id": "0ed72d98-4237-45b9-8323-2f28b3f5e8bc", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -8145,7 +8145,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9bd866ba-ffc0-40cd-845c-31f05df47e9a", + "id": "3179717b-8534-485c-b52e-6b40bc24aa4a", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -8256,12 +8256,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "4e7161f1-c362-4fd0-9c92-fb1b1c196a64", + "id": "1a774dca-9cc7-40d4-a66b-3296ef30dd7e", "name": "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.", "originalRequest": { "url": { @@ -8377,7 +8377,7 @@ "_postman_previewlanguage": "json" }, { - "id": "2a3b4b95-acb7-49c9-81c5-0b9322e7b9ec", + "id": "0b8c9ac7-ba17-49d6-a4bb-45dd70a65429", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -8488,7 +8488,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -8505,7 +8505,7 @@ "description": "Use this API to implement and customize account functionality.\nWith this functionality in place, administrators can manage users' access across sources in IdentityNow. \n\nIn IdentityNow, an account refers to a user's account on a supported source.\nThis typically includes a unique identifier for the user, a unique password, a set of permissions associated with the source and a set of attributes. IdentityNow loads accounts through the creation of sources in IdentityNow.\n\nAdministrators can correlate users' identities with the users' accounts on the different sources they use. \nThis allows IdentityNow to govern the access of identities and all their correlated accounts securely and cohesively. \n\nTo view the accounts on a source and their correlated identities, administrators can use the Connections drop-down menu, select Sources, select the relevant source, and select its Account tab. \n\nTo view and edit source account statuses for an identity in IdentityNow, administrators can use the Identities drop-down menu, select Identity List, select the relevant identity, and select its Accounts tab. \nAdministrators can toggle an account's Actions to aggregate the account, enable/disable it, unlock it, or remove it from the identity. \n\nAccounts can have the following statuses: \n\n- Enabled: The account is enabled. The user can access it.\n\n- Disabled: The account is disabled, and the user cannot access it, but the identity is not disabled in IdentityNow. This can occur when an administrator disables the account or when the user's lifecycle state changes. \n\n- Locked: The account is locked. This may occur when someone has entered an incorrect password for the account too many times.\n\n- Pending: The account is currently updating. This status typically lasts seconds. \n\nAdministrators can select the source account to view its attributes, entitlements, and the last time the account's password was changed.\n\nRefer to [Managing User Accounts](https://documentation.sailpoint.com/saas/help/common/users/user_access.html#managing-user-accounts) for more information about accounts.\n", "item": [ { - "id": "05769d2e-e023-40aa-b18b-79b5b91fd13f", + "id": "786e2b11-c0c7-49e9-b403-da236f46822f", "name": "Accounts List", "request": { "name": "Accounts List", @@ -8580,7 +8580,7 @@ }, "response": [ { - "id": "c01e9fce-214b-4dc2-975f-a0b5dd7c4d7d", + "id": "2bf872f3-9d62-4c4e-a0fd-c61316f9144f", "name": "List of account objects", "originalRequest": { "url": { @@ -8664,12 +8664,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"attributes\": {\n \"nostrud9c2\": -78816428,\n \"nulla27\": 8641456.794075176\n },\n \"authoritative\": \"\",\n \"disabled\": \"\",\n \"hasEntitlements\": \"\",\n \"locked\": \"\",\n \"manuallyCorrelated\": \"\",\n \"name\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"sourceName\": \"\",\n \"systemAccount\": \"\",\n \"uncorrelated\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"identityId\": \"\",\n \"description\": \"\",\n \"uuid\": \"\"\n },\n {\n \"attributes\": {\n \"occaecat_c8\": true,\n \"dolor_054\": \"Duis officia dolor ex cillum\",\n \"amet_29\": 17015847,\n \"sit_9\": 12733150\n },\n \"authoritative\": \"\",\n \"disabled\": \"\",\n \"hasEntitlements\": \"\",\n \"locked\": \"\",\n \"manuallyCorrelated\": \"\",\n \"name\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"sourceName\": \"\",\n \"systemAccount\": \"\",\n \"uncorrelated\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"identityId\": \"\",\n \"description\": \"\",\n \"uuid\": \"\"\n }\n]", + "body": "[\n {\n \"attributes\": {\n \"sit_3\": 94588964.34013236,\n \"magna1c7\": \"aliqua eiusmod ali\",\n \"exd\": false,\n \"occaecat_d4\": -62789983.96775712\n },\n \"authoritative\": \"\",\n \"disabled\": \"\",\n \"hasEntitlements\": \"\",\n \"locked\": \"\",\n \"manuallyCorrelated\": \"\",\n \"name\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"sourceName\": \"\",\n \"systemAccount\": \"\",\n \"uncorrelated\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"identityId\": \"\",\n \"description\": \"\",\n \"uuid\": \"\"\n },\n {\n \"attributes\": {\n \"sitc6\": -80249720.24022503\n },\n \"authoritative\": \"\",\n \"disabled\": \"\",\n \"hasEntitlements\": \"\",\n \"locked\": \"\",\n \"manuallyCorrelated\": \"\",\n \"name\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"sourceName\": \"\",\n \"systemAccount\": \"\",\n \"uncorrelated\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"identityId\": \"\",\n \"description\": \"\",\n \"uuid\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5fc06e02-d6d8-428f-8991-e7524c0760cd", + "id": "6f819b6b-9e22-4fd5-bcdf-8d1064ba9b67", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -8753,12 +8753,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "73b73dd4-c3e4-4f0a-98c0-90f2153be248", + "id": "9b9d8b8d-7e72-4006-9c51-f83cff57efd5", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -8847,7 +8847,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a1abccd2-7cb8-4c3c-a581-9ad983a95a8d", + "id": "264f9c71-b8f0-44d6-a451-a210173d404d", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -8931,12 +8931,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "577ecd3b-0735-47ac-a27f-f86d361c851c", + "id": "f7f8276c-8e5b-405a-a04d-c2a97e82b84e", "name": "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.", "originalRequest": { "url": { @@ -9025,7 +9025,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5ba3cb48-55eb-4a1b-94b3-3fc9cb04a76e", + "id": "1c7ba926-c098-4696-a6a2-175fb1a87fc3", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -9109,7 +9109,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -9120,7 +9120,7 @@ } }, { - "id": "43833c28-88b9-40d1-a004-f061064a7dce", + "id": "16660ddf-aa2d-4d31-a495-c489de5feb43", "name": "Create Account", "request": { "name": "Create Account", @@ -9162,7 +9162,7 @@ }, "response": [ { - "id": "e9de57b1-3de5-431b-b8c3-9f9dab6ac5c7", + "id": "80de6283-c1df-4656-9c92-6c44e246c93d", "name": "Async task details", "originalRequest": { "url": { @@ -9218,7 +9218,7 @@ "_postman_previewlanguage": "json" }, { - "id": "85fc9969-488c-4cd5-88ce-eb035183d78c", + "id": "1dc7f367-4369-4f8b-8b96-326df79255d8", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -9269,12 +9269,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b1bccaf2-d45b-4050-bb6b-803bba96e231", + "id": "c8c3281d-f12d-4820-86e9-8ed0a54450b3", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -9330,7 +9330,7 @@ "_postman_previewlanguage": "json" }, { - "id": "566884c9-0f13-4bd5-bc94-0b22ac3749f7", + "id": "38344b3e-f23d-40af-a323-e2744c4f4ebb", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -9381,12 +9381,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e7974ac2-0f65-4695-8199-d9ab32d89d6b", + "id": "cdb50a6d-c963-4933-b9cf-200b0353465a", "name": "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.", "originalRequest": { "url": { @@ -9442,7 +9442,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c8f2a28c-6d6f-48a1-94b5-9f48b107446b", + "id": "4cce22e7-2200-4c50-b211-55dae65d2daa", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -9493,7 +9493,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -9504,7 +9504,7 @@ } }, { - "id": "bc74fdad-05a8-4fbb-9622-bba47ba2c80e", + "id": "218fc45b-315f-4271-aa92-45757fb907d5", "name": "Account Details", "request": { "name": "Account Details", @@ -9541,7 +9541,7 @@ }, "response": [ { - "id": "d5c6d8b8-dbb4-4ec1-bf43-9ae8a18c1497", + "id": "ed62d784-8f8a-4a83-9c4f-eae1ac74169e", "name": "An account object", "originalRequest": { "url": { @@ -9580,12 +9580,12 @@ "value": "application/json" } ], - "body": "{\n \"attributes\": {\n \"deserunt_9\": 13333458.379228562,\n \"nostrud800\": 61470576\n },\n \"authoritative\": \"\",\n \"disabled\": \"\",\n \"hasEntitlements\": \"\",\n \"locked\": \"\",\n \"manuallyCorrelated\": \"\",\n \"name\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"sourceName\": \"\",\n \"systemAccount\": \"\",\n \"uncorrelated\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"identityId\": \"\",\n \"description\": \"\",\n \"uuid\": \"\"\n}", + "body": "{\n \"attributes\": {\n \"irure_54f\": 72285596,\n \"doloreea9\": 67272172.03176078,\n \"aliqua_b\": \"aliquip commodo adipisicing laborum\"\n },\n \"authoritative\": \"\",\n \"disabled\": \"\",\n \"hasEntitlements\": \"\",\n \"locked\": \"\",\n \"manuallyCorrelated\": \"\",\n \"name\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"sourceName\": \"\",\n \"systemAccount\": \"\",\n \"uncorrelated\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"identityId\": \"\",\n \"description\": \"\",\n \"uuid\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c817a2c4-87e8-49b9-9083-3a3d0455c505", + "id": "125731ce-dd60-419f-b30b-f7470cb0fe0d", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -9624,12 +9624,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7a8ae275-6666-4f4f-b5cc-78bc6d720752", + "id": "da5f0244-a713-4597-b6f6-fce0920387b6", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -9673,7 +9673,7 @@ "_postman_previewlanguage": "json" }, { - "id": "83541223-4f94-4932-94d7-91e5649d448a", + "id": "bb6b832d-5f1d-43bf-bbc5-8d5d4ec8e450", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -9712,12 +9712,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "f0d3fd9f-21cc-4944-8fe9-275d7c03139c", + "id": "c4c5e21e-4350-401b-8850-0210f9ecb8b0", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -9756,12 +9756,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3e5c6444-0e85-48c7-bfb7-7d6f58c454f4", + "id": "7eb3a1e7-e8b6-4a88-9825-58c6b308a0b9", "name": "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.", "originalRequest": { "url": { @@ -9805,7 +9805,7 @@ "_postman_previewlanguage": "json" }, { - "id": "82b17a43-a2e9-46a8-ac16-b73b4ab0cd33", + "id": "c80cb33d-d218-4f60-931d-488541f51547", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -9844,7 +9844,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -9855,7 +9855,7 @@ } }, { - "id": "bd3f1e16-f357-474c-9e00-6720e6c6e2b6", + "id": "bf8f0b21-5357-44d9-b133-bc889cfa5888", "name": "Update Account", "request": { "name": "Update Account", @@ -9894,7 +9894,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -9905,7 +9905,7 @@ }, "response": [ { - "id": "57e99a94-964e-432f-9c35-6ba61eea4f07", + "id": "866f26d1-7858-47ab-91b4-afc14bcc81b4", "name": "Accepted. Update request accepted and is in progress.", "originalRequest": { "url": { @@ -9940,7 +9940,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -9962,7 +9962,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4c915493-6eb3-4117-81aa-1540b11e3e17", + "id": "051742a9-da29-4174-8432-d30720b36c5f", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -9997,7 +9997,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -10014,12 +10014,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "2fc8af5c-a655-4c62-96bf-a424cf57f713", + "id": "bbfce0a5-5db4-4dbd-ab12-d664b34e188a", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -10054,7 +10054,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -10076,7 +10076,7 @@ "_postman_previewlanguage": "json" }, { - "id": "bef74305-2a91-4a28-8015-84a3b102b7d1", + "id": "81ebb8d6-7c45-44c1-ae93-42b68c8b19a1", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -10111,7 +10111,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -10128,12 +10128,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "53deb858-a470-4216-a09b-b3065240399e", + "id": "b2bbfa25-5f88-420d-8f2d-4660de538660", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -10168,7 +10168,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -10185,12 +10185,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "bed0cbeb-85b6-4776-8473-423f0c3e133a", + "id": "7801688c-e798-40ff-815c-f357931d64a2", "name": "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.", "originalRequest": { "url": { @@ -10225,7 +10225,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -10247,7 +10247,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a2d31d62-7a09-4260-bc4f-717db8b7ca19", + "id": "9bdee633-d484-4c32-96a8-67d7796f83c5", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -10282,7 +10282,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -10299,7 +10299,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -10310,7 +10310,7 @@ } }, { - "id": "372adfec-c24a-49b7-af25-289ca80a5331", + "id": "6be12019-8b84-43b1-a503-b8d59f49ec56", "name": "Update Account", "request": { "name": "Update Account", @@ -10349,7 +10349,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"attributes\": {\n \"id_\": true,\n \"sed_e\": 66238140.48531392,\n \"dolor_d5\": -42237939.20540837,\n \"ut_a8\": \"incididunt voluptate qui dolor dolor\"\n }\n}", + "raw": "{\n \"attributes\": {\n \"eu_4d\": true,\n \"aliqua1\": true,\n \"Ut940\": -11148295.312369913,\n \"eu_ad8\": 24226078.26210341\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -10360,7 +10360,7 @@ }, "response": [ { - "id": "1a34945b-c90b-4820-859d-1d3b3d38a5a9", + "id": "964f914f-e238-44ba-a0cf-d26e8216f75e", "name": "Async task details", "originalRequest": { "url": { @@ -10395,7 +10395,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"attributes\": {\n \"id_\": true,\n \"sed_e\": 66238140.48531392,\n \"dolor_d5\": -42237939.20540837,\n \"ut_a8\": \"incididunt voluptate qui dolor dolor\"\n }\n}", + "raw": "{\n \"attributes\": {\n \"eu_4d\": true,\n \"aliqua1\": true,\n \"Ut940\": -11148295.312369913,\n \"eu_ad8\": 24226078.26210341\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -10417,7 +10417,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f9ee1ba6-5129-4e0d-b0a5-c94217af551d", + "id": "19640081-6733-4e9c-b250-3492fd8a1ba6", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -10452,7 +10452,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"attributes\": {\n \"id_\": true,\n \"sed_e\": 66238140.48531392,\n \"dolor_d5\": -42237939.20540837,\n \"ut_a8\": \"incididunt voluptate qui dolor dolor\"\n }\n}", + "raw": "{\n \"attributes\": {\n \"eu_4d\": true,\n \"aliqua1\": true,\n \"Ut940\": -11148295.312369913,\n \"eu_ad8\": 24226078.26210341\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -10469,12 +10469,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e07e8d59-6726-45e9-8a3b-dece2cd303a5", + "id": "5974113d-c339-4993-a183-4d3abf4bb199", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -10509,7 +10509,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"attributes\": {\n \"id_\": true,\n \"sed_e\": 66238140.48531392,\n \"dolor_d5\": -42237939.20540837,\n \"ut_a8\": \"incididunt voluptate qui dolor dolor\"\n }\n}", + "raw": "{\n \"attributes\": {\n \"eu_4d\": true,\n \"aliqua1\": true,\n \"Ut940\": -11148295.312369913,\n \"eu_ad8\": 24226078.26210341\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -10531,7 +10531,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5a6de974-12e1-45ac-bfb9-4a355d928200", + "id": "157d082c-2887-49d9-8c9f-f20a96fa83aa", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -10566,7 +10566,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"attributes\": {\n \"id_\": true,\n \"sed_e\": 66238140.48531392,\n \"dolor_d5\": -42237939.20540837,\n \"ut_a8\": \"incididunt voluptate qui dolor dolor\"\n }\n}", + "raw": "{\n \"attributes\": {\n \"eu_4d\": true,\n \"aliqua1\": true,\n \"Ut940\": -11148295.312369913,\n \"eu_ad8\": 24226078.26210341\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -10583,12 +10583,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8a86cd40-fcc4-4b3e-96ba-608f6f0c546f", + "id": "7cac3a81-d603-4a99-9fd0-8c5dafc39a15", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -10623,7 +10623,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"attributes\": {\n \"id_\": true,\n \"sed_e\": 66238140.48531392,\n \"dolor_d5\": -42237939.20540837,\n \"ut_a8\": \"incididunt voluptate qui dolor dolor\"\n }\n}", + "raw": "{\n \"attributes\": {\n \"eu_4d\": true,\n \"aliqua1\": true,\n \"Ut940\": -11148295.312369913,\n \"eu_ad8\": 24226078.26210341\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -10640,12 +10640,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5e8b1440-5762-44e3-8e14-ae1f52063881", + "id": "81fcd3d6-59a9-40fa-bac7-31afaa6bdf06", "name": "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.", "originalRequest": { "url": { @@ -10680,7 +10680,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"attributes\": {\n \"id_\": true,\n \"sed_e\": 66238140.48531392,\n \"dolor_d5\": -42237939.20540837,\n \"ut_a8\": \"incididunt voluptate qui dolor dolor\"\n }\n}", + "raw": "{\n \"attributes\": {\n \"eu_4d\": true,\n \"aliqua1\": true,\n \"Ut940\": -11148295.312369913,\n \"eu_ad8\": 24226078.26210341\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -10702,7 +10702,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e2b6850c-18a5-44d2-91e3-50579060ae44", + "id": "0ae47c62-0d00-4b85-991a-e4eddb56772a", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -10737,7 +10737,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"attributes\": {\n \"id_\": true,\n \"sed_e\": 66238140.48531392,\n \"dolor_d5\": -42237939.20540837,\n \"ut_a8\": \"incididunt voluptate qui dolor dolor\"\n }\n}", + "raw": "{\n \"attributes\": {\n \"eu_4d\": true,\n \"aliqua1\": true,\n \"Ut940\": -11148295.312369913,\n \"eu_ad8\": 24226078.26210341\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -10754,7 +10754,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -10765,7 +10765,7 @@ } }, { - "id": "ff553b5e-c798-4575-a6b6-a6d66a377cfb", + "id": "617c33e9-b9bf-41ff-8d8c-84bc853879ea", "name": "Delete Account", "request": { "name": "Delete Account", @@ -10802,7 +10802,7 @@ }, "response": [ { - "id": "027d011a-8d1b-416d-af1d-0e3bfa2e1c95", + "id": "2d82ecd9-e1c4-42d3-ab86-627a08886f8f", "name": "Async task details", "originalRequest": { "url": { @@ -10846,7 +10846,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a2a6de80-e001-4e9a-ad93-2674bd6752fa", + "id": "6483e09c-1388-4d63-acab-8a3dfd59e1c9", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -10885,12 +10885,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8ac72568-d898-4a0e-a335-f8b275352437", + "id": "f8eecf22-8b84-41f4-b92a-06f873e74f74", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -10934,7 +10934,7 @@ "_postman_previewlanguage": "json" }, { - "id": "77ac6677-73a2-46fd-982e-f12169909684", + "id": "9c63ac43-3fa0-4c41-966a-52285f75b1a4", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -10973,12 +10973,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8e4f450b-7b40-4b23-b0af-c824d4c3bbf2", + "id": "5902f506-e378-4cf4-8e93-924171dd1b56", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -11017,12 +11017,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "12feeb5d-a6ee-457e-b26d-1ae1ee9fd564", + "id": "60e8f6f9-7dec-4711-b429-36a7c32cd139", "name": "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.", "originalRequest": { "url": { @@ -11066,7 +11066,7 @@ "_postman_previewlanguage": "json" }, { - "id": "135aea8b-6b12-4295-8800-99c94f46c4e8", + "id": "1933c203-25ea-4fad-87eb-ac046cf3cc95", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -11105,7 +11105,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -11116,7 +11116,7 @@ } }, { - "id": "0c59b6bf-5e31-49e3-8353-1eda4690a18e", + "id": "3e5e0aa8-d242-45cd-89e8-b8d79cd1fa68", "name": "Account Entitlements", "request": { "name": "Account Entitlements", @@ -11182,7 +11182,7 @@ }, "response": [ { - "id": "0962112d-a0b5-4b03-b5e1-15bd1aa82684", + "id": "6110d5ef-7623-4086-bccf-9ed3432671f3", "name": "An array of account entitlements", "originalRequest": { "url": { @@ -11250,12 +11250,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"attributes\": {\n \"tempor_c\": \"cupidatat consectetur ut tempor\",\n \"irure_5\": \"ad aliqua est ut\",\n \"enim23b\": \"dolor veniam\"\n },\n \"sourceSchemaObjectType\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"source\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"attributes\": {\n \"sita\": false,\n \"consequat_f0\": 89596351.19249061\n },\n \"sourceSchemaObjectType\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"source\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n]", + "body": "[\n {\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"attributes\": {\n \"proident97\": -95547574\n },\n \"sourceSchemaObjectType\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"source\": {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"attributes\": {\n \"reprehenderit_6\": 41086577.86968833\n },\n \"sourceSchemaObjectType\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"source\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "483953dc-a0f0-46b1-9c84-f37363ec1cfb", + "id": "211bfbf7-b4c0-4440-92cd-9e09b1023000", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -11323,12 +11323,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "567e6e92-55b5-46b5-9804-14fc8478d59a", + "id": "0f451afd-89bd-4854-9da0-6e064f462eb3", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -11401,7 +11401,7 @@ "_postman_previewlanguage": "json" }, { - "id": "901a0240-4ece-4cfe-993e-3d650d6929c7", + "id": "7736d71b-3239-4011-ab80-4f8dcab127cc", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -11469,12 +11469,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "11019d12-bee0-4ea5-bce6-12c53c180645", + "id": "e4b85cee-f602-4e07-9c23-e495a81ad115", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -11542,12 +11542,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a66122d7-2555-4ddf-9367-01c99c1ce1e3", + "id": "7821e540-300b-494d-8e9a-fd8f6fb7dfc4", "name": "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.", "originalRequest": { "url": { @@ -11620,7 +11620,7 @@ "_postman_previewlanguage": "json" }, { - "id": "069287c8-cca4-4250-b35c-1e7827f6847c", + "id": "1657e822-f3dc-465d-9daa-52d0ed63c6dc", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -11688,7 +11688,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -11699,7 +11699,7 @@ } }, { - "id": "39b9f1d0-a848-4f69-8436-ff08d4c26880", + "id": "4d0fc566-cef7-4c3a-bf6a-e60340d7ae98", "name": "Reload Account", "request": { "name": "Reload Account", @@ -11737,7 +11737,7 @@ }, "response": [ { - "id": "bb60f15c-b073-46ff-8297-1ddde522d40c", + "id": "289bb75e-6ea1-45a2-9855-20d73f4e507d", "name": "Async task details", "originalRequest": { "url": { @@ -11782,7 +11782,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6c34bb79-3951-4153-9a15-93a89e4e5703", + "id": "f973efd9-0fb0-4190-88c0-4928cd43ece6", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -11822,12 +11822,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "f61a5ed7-7081-456a-9096-46e5091e58e6", + "id": "e67002f7-19f0-45cc-a986-e7f94f6a2dd1", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -11872,7 +11872,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4029131f-9049-4936-835e-387ac4660a0c", + "id": "f43b8823-6ae7-4d1a-b9e8-d22424bbe344", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -11912,12 +11912,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "dad13a1a-7da2-4092-a69e-3a35c69085aa", + "id": "fae726d7-7085-4ca8-9d44-8e10c6be1aec", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -11957,12 +11957,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0ffd94c9-d01f-4e09-87fc-d3e2cb5acf00", + "id": "acd85ca6-d28b-4bf1-b556-ea239dcd16f8", "name": "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.", "originalRequest": { "url": { @@ -12007,7 +12007,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e9d55dcc-470e-4f9e-8fe4-bc82ed732dc7", + "id": "137fa328-19a4-4bd2-b6c9-270421220979", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -12047,7 +12047,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -12058,7 +12058,7 @@ } }, { - "id": "ac796fdf-a248-44fd-a0ac-248ad3849da5", + "id": "83597b64-26bd-43d3-a50a-f26eeaf8b307", "name": "Enable Account", "request": { "name": "Enable Account", @@ -12109,7 +12109,7 @@ }, "response": [ { - "id": "5b4d0761-adca-4fff-963e-1d26cbccd353", + "id": "f777c16c-a603-4422-9c99-74dca2b6db82", "name": "Async task details", "originalRequest": { "url": { @@ -12167,7 +12167,7 @@ "_postman_previewlanguage": "json" }, { - "id": "23108798-86b7-42d7-8d3b-b268774901f5", + "id": "1fe7bd7f-9cf5-4d1d-9520-6b5dc03ea4ee", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -12220,12 +12220,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7c290017-7711-4f2f-9292-6871b52d5f42", + "id": "addf02a9-ef3e-41ae-898c-71536ced5fb5", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -12283,7 +12283,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1ac81be4-2b16-40b2-832b-5b140aaf96d0", + "id": "4ab1fefd-30a4-4c3e-80d1-6014c47ae393", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -12336,12 +12336,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ae5223ce-f41e-4f0a-85bd-a3515d36485c", + "id": "9fada91f-a2ab-44a8-9e4b-f8c1f0da5c1b", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -12394,12 +12394,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "86b1210d-5be1-4c68-bf70-9fb8c3be6999", + "id": "e2ce4f5b-2eba-4bf8-b7df-e96d3ea5ff2f", "name": "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.", "originalRequest": { "url": { @@ -12457,7 +12457,7 @@ "_postman_previewlanguage": "json" }, { - "id": "63b3ac36-444d-4341-8690-49f7f22c5aab", + "id": "2008939d-69bf-4fd7-a38a-54e7d5f0db89", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -12510,7 +12510,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -12521,7 +12521,7 @@ } }, { - "id": "670edca8-abf5-435b-bbe5-c3126d814026", + "id": "342428ef-df09-4479-a8c1-c7090fc7195e", "name": "Disable Account", "request": { "name": "Disable Account", @@ -12572,7 +12572,7 @@ }, "response": [ { - "id": "82f48ce8-9560-4359-b8d9-83f157e896dc", + "id": "b585be85-01c5-462d-a9b5-73a984413b70", "name": "Async task details", "originalRequest": { "url": { @@ -12630,7 +12630,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a7e84ef9-ea66-4b3d-b2fc-73e63f1542af", + "id": "74ec0aac-4a6d-45bd-98eb-4278dc0217d2", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -12683,12 +12683,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "4ef9ab6a-3953-4055-bcde-5064bdf73d69", + "id": "ea0e932c-6a37-46a1-a415-5a9edeba5ea0", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -12746,7 +12746,7 @@ "_postman_previewlanguage": "json" }, { - "id": "2e991f9b-5032-488a-8687-5c51240b3285", + "id": "a74a1bb5-2cc4-4ba3-bf54-15fcea0f1cb3", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -12799,12 +12799,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ccdfc6eb-ac14-4843-a05c-cc328cadbe32", + "id": "f9c7974b-aea7-499b-b72b-37acd4bad076", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -12857,12 +12857,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "44daee05-d81b-4fa2-a47b-2aad0425d548", + "id": "f8b918e9-31e9-4600-b415-665091c9b54f", "name": "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.", "originalRequest": { "url": { @@ -12920,7 +12920,7 @@ "_postman_previewlanguage": "json" }, { - "id": "af1b35da-984d-4c5f-bf1b-34a67b4e97e2", + "id": "e2d0161a-9e80-4d14-a57d-f77c21ae67d5", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -12973,7 +12973,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -12984,7 +12984,7 @@ } }, { - "id": "e1d6d956-31ed-4b2d-868d-6be15c2a2d90", + "id": "9430e24b-0b61-4956-9b42-fc4312a653c3", "name": "Unlock Account", "request": { "name": "Unlock Account", @@ -13035,7 +13035,7 @@ }, "response": [ { - "id": "5d727c3a-535f-44ed-af9d-7e7309329114", + "id": "4c672110-397e-4aa7-b0b6-0a05e99172c2", "name": "Async task details", "originalRequest": { "url": { @@ -13093,7 +13093,7 @@ "_postman_previewlanguage": "json" }, { - "id": "271f6e27-ec84-4fd8-9253-4bdb4ee93cf6", + "id": "a446ca81-3b7b-4d3b-b3d7-9eb101eb90c1", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -13146,12 +13146,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "f03a854a-b156-4670-b05c-248709b678c0", + "id": "355409e8-0c60-4151-88fc-bd435dcfeb8e", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -13209,7 +13209,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6a3fd892-8370-47ea-a41d-67dbc2c1e269", + "id": "55f06e0f-79ca-457f-8f17-66385032c970", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -13262,12 +13262,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1a34a0c3-c647-484e-81ad-97de342db423", + "id": "3e5504db-b3a7-4579-a8d5-97408a8e3189", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -13320,12 +13320,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "738047c5-8bc8-4745-a170-0f8fcf44e8a7", + "id": "4ca400c8-0e8c-4615-9922-cf2a8504ab53", "name": "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.", "originalRequest": { "url": { @@ -13383,7 +13383,7 @@ "_postman_previewlanguage": "json" }, { - "id": "04826575-699c-4717-9550-6188c6d57d13", + "id": "e53bc29e-302a-4593-a984-1ef407b1c960", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -13436,7 +13436,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -13453,7 +13453,7 @@ "description": "Use this API to implement account activity tracking functionality.\nWith this functionality in place, users can track source account activity in IdentityNow, which greatly improves traceability in the system. \n\nAn account activity refers to a log of each action performed on a source account. This is useful for auditing the changes performed on an account throughout its life. \nIn IdentityNow's Search, users can search for account activities and select the activity's row to get an overview of the activity's account action and view its progress, its involved sources, and its most basic metadata, such as the identity requesting the option and the recipient. \n\nAccount activity includes most actions IdentityNow completes on source accounts. Users can search in IdentityNow for the following account action types: \n\n- Access Request: These include any access requests the source account is involved in. \n\n- Account Attribute Updates: These include updates to a single attribute on an account on a source. \n\n- Account State Update: These include locking or unlocking actions on an account on a source. \n\n- Certification: These include actions removing an entitlement from an account on a source as a result of the entitlement's revocation during a certification.\n\n- Cloud Automated `Lifecyclestate`: These include automated lifecycle state changes that result in a source account's correlated identity being assigned to a different lifecycle state. \nIdentityNow replaces the `Lifecyclestate` variable with the name of the lifecycle state it has moved the account's identity to. \n\n- Identity Attribute Update: These include updates to a source account's correlated identity attributes as the result of a provisioning action. \nWhen you update an identity attribute that also updates an identity's lifecycle state, the cloud automated `Lifecyclestate` event also displays.\nAccount Activity does not include attribute updates that occur as a result of aggregation.\n\n- Identity Refresh: These include correlated identity refreshes that occur for an account on a source whenever the account's correlated identity profile gets a new role or updates. \nThese also include refreshes that occur whenever IdentityNow assigns an application to the account's correlated identity based on the application's being assigned to All Users From Source or Specific Users From Source. \n\n- Lifecycle State Refresh: These include the actions that took place when a lifecycle state changed. This event only occurs after a cloud automated `Lifecyclestate` change or a lifecycle state change. \n\n- Lifecycle State Change: These include the account activities that result from an identity's manual assignment to a null lifecycle state.\n\n- Password Change: These include password changes on sources.\n\nRefer to [Account Activity](https://documentation.sailpoint.com/saas/help/search/index.html#account-activity) for more information about account activities.\n", "item": [ { - "id": "d210c301-8193-405f-a24e-21cfda25e486", + "id": "4f80790b-03fe-43e7-b8f8-4b3f920f1d48", "name": "List Account Activities", "request": { "name": "List Account Activities", @@ -13555,7 +13555,7 @@ }, "response": [ { - "id": "111aebd6-2453-41ec-927a-2302599f60ff", + "id": "5dca2ccd-6ac4-4b53-97b6-3da32aed8543", "name": "List of account activities", "originalRequest": { "url": { @@ -13666,12 +13666,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"completed\": \"\",\n \"completionStatus\": \"PENDING\",\n \"type\": \"\",\n \"requesterIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"targetIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"errors\": [\n \"\",\n \"\"\n ],\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"requested\": \"\",\n \"approvalStatus\": \"PENDING\",\n \"provisioningStatus\": \"UNVERIFIABLE\",\n \"requesterComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"reviewerComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"operation\": \"CREATE\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"\",\n \"requestedObjectName\": \"\",\n \"requestedObjectType\": \"ACCESS_PROFILE\"\n },\n \"clientMetadata\": {\n \"anim_90\": \"\",\n \"deserunt_336\": \"\",\n \"deserunt_cf8\": \"\",\n \"Excepteur7f\": \"\",\n \"quis12\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"requested\": \"\",\n \"approvalStatus\": \"FINISHED\",\n \"provisioningStatus\": \"FAILED\",\n \"requesterComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"reviewerComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"operation\": \"ADD\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"\",\n \"requestedObjectName\": \"\",\n \"requestedObjectType\": \"ACCESS_PROFILE\"\n },\n \"clientMetadata\": {\n \"dolore_3b\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"executionStatus\": \"TERMINATED\",\n \"clientMetadata\": {\n \"veniam_3\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"completed\": \"\",\n \"completionStatus\": \"PENDING\",\n \"type\": \"\",\n \"requesterIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"targetIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"errors\": [\n \"\",\n \"\"\n ],\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"requested\": \"\",\n \"approvalStatus\": \"RETURNED\",\n \"provisioningStatus\": \"FAILED\",\n \"requesterComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"reviewerComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"operation\": \"MODIFY\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"\",\n \"requestedObjectName\": \"\",\n \"requestedObjectType\": \"ACCESS_PROFILE\"\n },\n \"clientMetadata\": {\n \"ullamco_b\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"requested\": \"\",\n \"approvalStatus\": \"EXPIRED\",\n \"provisioningStatus\": \"FAILED\",\n \"requesterComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"reviewerComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"operation\": \"UNLOCK\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"\",\n \"requestedObjectName\": \"\",\n \"requestedObjectType\": \"ROLE\"\n },\n \"clientMetadata\": {\n \"quis_a3\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"executionStatus\": \"EXECUTING\",\n \"clientMetadata\": {\n \"nostrude16\": \"\",\n \"reprehenderit_1a\": \"\",\n \"Excepteur_b5a\": \"\",\n \"sint995\": \"\"\n }\n }\n]", + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"completed\": \"\",\n \"completionStatus\": \"PENDING\",\n \"type\": \"\",\n \"requesterIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"targetIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"errors\": [\n \"\",\n \"\"\n ],\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"requested\": \"\",\n \"approvalStatus\": \"PENDING\",\n \"provisioningStatus\": \"PENDING\",\n \"requesterComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"reviewerComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"operation\": \"CREATE\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"\",\n \"requestedObjectName\": \"\",\n \"requestedObjectType\": \"ACCESS_PROFILE\"\n },\n \"clientMetadata\": {\n \"aliquip_06\": \"\",\n \"in0c9\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"requested\": \"\",\n \"approvalStatus\": \"FINISHED\",\n \"provisioningStatus\": \"PENDING\",\n \"requesterComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"reviewerComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"operation\": \"DISABLE\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"\",\n \"requestedObjectName\": \"\",\n \"requestedObjectType\": \"ROLE\"\n },\n \"clientMetadata\": {\n \"ut_0a\": \"\",\n \"cupidatat_ca8\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"executionStatus\": \"COMPLETED\",\n \"clientMetadata\": {\n \"doloree7\": \"\",\n \"reprehenderit721\": \"\",\n \"pariatur_7a6\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"completed\": \"\",\n \"completionStatus\": \"INCOMPLETE\",\n \"type\": \"\",\n \"requesterIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"targetIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"errors\": [\n \"\",\n \"\"\n ],\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"requested\": \"\",\n \"approvalStatus\": \"CANCELED\",\n \"provisioningStatus\": \"FINISHED\",\n \"requesterComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"reviewerComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"operation\": \"ADD\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"\",\n \"requestedObjectName\": \"\",\n \"requestedObjectType\": \"ROLE\"\n },\n \"clientMetadata\": {\n \"esseb30\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"requested\": \"\",\n \"approvalStatus\": \"REJECTED\",\n \"provisioningStatus\": \"COMMITED\",\n \"requesterComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"reviewerComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"operation\": \"UNLOCK\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"\",\n \"requestedObjectName\": \"\",\n \"requestedObjectType\": \"ROLE\"\n },\n \"clientMetadata\": {\n \"culpa_0\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"executionStatus\": \"EXECUTING\",\n \"clientMetadata\": {\n \"do_e0\": \"\",\n \"veniam1f\": \"\"\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "48292e05-118f-48c2-852e-4ffa34694589", + "id": "6ee0029f-2195-4623-b24e-3dc8e0888d80", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -13782,12 +13782,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3876547d-6187-4187-96f7-3c4d630fcc87", + "id": "31ef3514-c65c-4570-96ae-e80554af0746", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -13903,7 +13903,7 @@ "_postman_previewlanguage": "json" }, { - "id": "698a6b09-e910-49fd-90bd-99ab542a8328", + "id": "40545d5c-e483-4fef-8948-03c761eaeee2", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -14014,12 +14014,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6ffb9b45-2163-453b-a656-e5af8cb375c4", + "id": "545d148e-072f-40fc-b786-95f0608fc7e4", "name": "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.", "originalRequest": { "url": { @@ -14135,7 +14135,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d4416a38-a0cc-4bab-ad99-8b391d2833ca", + "id": "9e3ea048-4fac-46dc-b0b6-1237ad3084c1", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -14246,7 +14246,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -14257,7 +14257,7 @@ } }, { - "id": "0ceaf567-1aca-40ee-9439-7b0400242f8f", + "id": "8840b5d2-764f-4f68-a981-114cc67bc6ff", "name": "Get an Account Activity", "request": { "name": "Get an Account Activity", @@ -14294,7 +14294,7 @@ }, "response": [ { - "id": "144c74e5-e114-4e9e-a546-931470238737", + "id": "4e122c18-3c97-4cdb-b330-07c7c0077b2e", "name": "An account activity object", "originalRequest": { "url": { @@ -14333,12 +14333,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"completed\": \"\",\n \"completionStatus\": \"FAILURE\",\n \"type\": \"\",\n \"requesterIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"targetIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"errors\": [\n \"\",\n \"\"\n ],\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"requested\": \"\",\n \"approvalStatus\": \"CANCELED\",\n \"provisioningStatus\": \"UNVERIFIABLE\",\n \"requesterComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"reviewerComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"operation\": \"CREATE\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"\",\n \"requestedObjectName\": \"\",\n \"requestedObjectType\": \"ROLE\"\n },\n \"clientMetadata\": {\n \"inc7\": \"\",\n \"non_46d\": \"\",\n \"magna__\": \"\",\n \"sunt_3\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"requested\": \"\",\n \"approvalStatus\": \"CANCELED\",\n \"provisioningStatus\": \"COMMITED\",\n \"requesterComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"reviewerComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"operation\": \"CREATE\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"\",\n \"requestedObjectName\": \"\",\n \"requestedObjectType\": \"ACCESS_PROFILE\"\n },\n \"clientMetadata\": {\n \"et659\": \"\",\n \"sint__1\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"executionStatus\": \"VERIFYING\",\n \"clientMetadata\": {\n \"voluptate_280\": \"\"\n }\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"completed\": \"\",\n \"completionStatus\": \"PENDING\",\n \"type\": \"\",\n \"requesterIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"targetIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"errors\": [\n \"\",\n \"\"\n ],\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"requested\": \"\",\n \"approvalStatus\": \"PENDING\",\n \"provisioningStatus\": \"FINISHED\",\n \"requesterComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"reviewerComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"operation\": \"UNLOCK\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"\",\n \"requestedObjectName\": \"\",\n \"requestedObjectType\": \"ROLE\"\n },\n \"clientMetadata\": {\n \"consectetur23\": \"\",\n \"labore_289\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"requested\": \"\",\n \"approvalStatus\": \"EXPIRED\",\n \"provisioningStatus\": \"COMMITED\",\n \"requesterComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"reviewerComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"operation\": \"REMOVE\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"\",\n \"requestedObjectName\": \"\",\n \"requestedObjectType\": \"ACCESS_PROFILE\"\n },\n \"clientMetadata\": {\n \"deserunt71\": \"\",\n \"essecbe\": \"\",\n \"Loremdcf\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"executionStatus\": \"TERMINATED\",\n \"clientMetadata\": {\n \"adipisicing_9\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "fe76cdfa-5cc8-41d1-9cf4-0a460acf3dd6", + "id": "c9c9148c-8dd6-4783-b084-64550a69b6d4", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -14377,12 +14377,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e5fe95c0-5806-4867-a684-0779da383577", + "id": "ee19a5b6-7879-42bc-a513-007fc8dd903f", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -14426,7 +14426,7 @@ "_postman_previewlanguage": "json" }, { - "id": "23315763-722b-42e0-8147-e4ea6d2f6eaf", + "id": "9a7237f8-e011-4f0d-aab1-77d1cf1546bb", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -14465,12 +14465,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "07a9bc78-3bfd-46f2-9226-f4dfad946441", + "id": "56ed2666-b34a-48d7-b14e-7706ec86d31c", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -14509,12 +14509,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3316fad1-0422-4551-9471-e0c03c623279", + "id": "1db5c22a-cce2-4b59-add9-3d7db7b33656", "name": "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.", "originalRequest": { "url": { @@ -14558,7 +14558,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7acdd787-5594-478e-805e-3713593fcbbf", + "id": "bf3223fc-9ce4-45a5-8c64-b6d940284ebf", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -14597,7 +14597,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -14614,7 +14614,7 @@ "description": "Authentication service user retrieval and user capabilities update", "item": [ { - "id": "fabbdda6-155e-44d8-8c0b-0a5fa121381a", + "id": "36d91bc1-e7de-47e3-ba56-8e94fc50cd26", "name": "Auth User Details", "request": { "name": "Auth User Details", @@ -14651,7 +14651,7 @@ }, "response": [ { - "id": "b2216aac-c026-4ade-9976-96dd0ef5821e", + "id": "7430ba29-1079-40da-be4c-4d3291159b7e", "name": "The specified user's authentication system details.", "originalRequest": { "url": { @@ -14695,7 +14695,7 @@ "_postman_previewlanguage": "json" }, { - "id": "afbe2ec5-748d-4282-850b-18978e1fb9f9", + "id": "5bfdc542-3ee4-4ba0-919e-db3f62c91be1", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -14734,12 +14734,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6d7552f3-c891-4e4c-ae9d-f5da3e4f2a52", + "id": "04a67318-2607-451d-a56f-42d3a4724653", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -14783,7 +14783,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c3201e0c-28be-4a94-bb79-64e7ce062bc5", + "id": "14091b28-8181-4747-b7df-8d2a5a1e90ce", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -14822,12 +14822,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "18c38b2e-c61f-47e4-9a5c-2bdd7ccf2b22", + "id": "493dcd98-ed1c-4508-b773-adf40bc1cd17", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -14866,12 +14866,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b7863a90-da44-4178-b257-acd877dfa33d", + "id": "aee421d9-f65b-4d11-9352-a28dcdd383ff", "name": "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.", "originalRequest": { "url": { @@ -14915,7 +14915,7 @@ "_postman_previewlanguage": "json" }, { - "id": "fc5335d5-9533-4694-ad45-c3a06a0cad4c", + "id": "e0db6375-a5d2-4dd1-8875-88a9fc459f40", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -14954,7 +14954,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -14965,7 +14965,7 @@ } }, { - "id": "67210b45-f103-4756-9e36-5c0cfb8c694f", + "id": "b4c6be58-7265-4ab1-afb8-42150fe4dfdc", "name": "Auth User Update", "request": { "name": "Auth User Update", @@ -15004,7 +15004,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -15015,7 +15015,7 @@ }, "response": [ { - "id": "9f72a7e9-22b7-45ba-89b3-d441e599ff2a", + "id": "f75231ac-c8cc-4c52-a22b-f309180e7678", "name": "Auth user updated.", "originalRequest": { "url": { @@ -15050,7 +15050,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -15072,7 +15072,7 @@ "_postman_previewlanguage": "json" }, { - "id": "075d229c-c949-4fc5-97af-9736c1fd7b8d", + "id": "ab86be92-72b3-4f08-8881-6ff29f72b3ba", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -15107,7 +15107,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -15124,12 +15124,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "87a54942-4df8-4360-9072-59a88a5c36ac", + "id": "49e2876a-9833-431d-a90e-85338824184b", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -15164,7 +15164,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -15186,7 +15186,7 @@ "_postman_previewlanguage": "json" }, { - "id": "321cd974-de66-4ae8-8c85-9b248190fc9e", + "id": "0daa1539-6d19-43f2-9345-914c3c93ef6a", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -15221,7 +15221,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -15238,12 +15238,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1ca73083-82a6-4376-85d4-93c85fa99b96", + "id": "6d98aac2-a05e-44b9-b33e-0bf35efa22ce", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -15278,7 +15278,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -15295,12 +15295,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "39863222-c9dd-4db8-8a49-a65480c1867f", + "id": "c8b5a20a-2edf-4f9e-93c7-6735bb233225", "name": "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.", "originalRequest": { "url": { @@ -15335,7 +15335,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -15357,7 +15357,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0046cccd-a096-4a43-9f8e-8626130e0fab", + "id": "dd7c458a-5e1b-42ab-ad73-e5faa8d219c6", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -15392,7 +15392,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -15409,7 +15409,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -15426,7 +15426,7 @@ "description": "Use this API to implement certification campaign functionality.\nWith this functionality in place, administrators can create, customize, and manage certification campaigns for their organizations' use. \nCertification campaigns provide IdentityNow users with an interactive review process they can use to identify and verify access to systems. \nCampaigns help organizations reduce risk of inappropriate access and satisfy audit requirements. \n\nA certification refers to IdentityNow's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. \nThese certifications serve as a way of showing that a user's access has been reviewed and approved. \nMultiple certifications by different reviewers are often required to approve a user's access. \nA set of multiple certifications is called a certification campaign. \n\nFor example, an organization may use a Manager Certification campaign as a way of showing that a user's access has been reviewed and approved by multiple managers. \nOnce this campaign has been completed, IdentityNow would provision all the access the user needs, nothing more. \n\nIdentityNow provides two simple campaign types users can create without using search queries, Manager and Source Owner campaigns:\n\nYou can create these types of campaigns without using any search queries in IdentityNow: \n\n- ManagerCampaign: IdentityNow provides this campaign type as a way to ensure that an identity's access is certified by their managers. \nYou only need to provide a name and description to create one. \n\n- Source Owner Campaign: IdentityNow provides this campaign type as a way to ensure that an identity's access to a source is certified by its source owners. \nYou only need to provide a name and description to create one. \nYou can specify the sources whose owners you want involved or just run it across all sources. \n\nFor more information about these campaign types, refer to [Starting a Manager or Source Owner Campaign](https://documentation.sailpoint.com/saas/help/certs/starting_campaign.html).\n\nOne useful way to create certification campaigns in IdentityNow is to use a specific search and then run a campaign on the results returned by that search. \nThis allows you to be much more specific about whom you are certifying in your campaigns and what access you are certifying in your campaigns. \nFor example, you can search for all identities who are managed by \"Amanda.Ross\" and also have the access to the \"Accounting\" role and then run a certification campaign based on that search to ensure that the returned identities are appropriately certified. \n\nYou can use IdentityNow search queries to create these types of campaigns: \n\n- Identities: Use this campaign type to review and revoke access items for specific identities. \nYou can either build a search query and create a campaign certifying all identities returned by that query, or you can search for individual identities and add those identities to the certification campaign. \n\n- Access Items: Use this campaign type to review and revoke a set of roles, access profiles, or entitlements from the identities that have them. \nYou can either build a search query and create a campaign certifying all access items returned by that query, or you can search for individual access items and add those items to the certification campaign. \n\n- Role Composition: Use this campaign type to review a role's composition, including its title, description, and membership criteria. \nYou can either build a search query and create a campaign certifying all roles returned by that query, or you can search for individual roles and add those roles to the certification campaign. \n\n- Uncorrelated Accounts: Use this campaign type to certify source accounts that aren't linked to an authoritative identity in IdentityNow. \nYou can use this campaign type to view all the uncorrelated accounts for a source and certify them. \n\nFor more information about search-based campaigns, refer to [Starting a Campaign from Search](https://documentation.sailpoint.com/saas/help/certs/starting_search_campaign.html).\n\nOnce you have generated your campaign, it becomes available for preview. \nAn administrator can review the campaign and make changes, or if it's ready and accurate, activate it. \n\nOnce the campaign is active, organization administrators or certification administrators can designate other IdentityNow users as certification reviewers. \nThose reviewers can view any of the certifications they either need to review (active) or have already reviewed (completed).\n\nWhen a certification campaign is in progress, certification reviewers see the listed active certifications whose involved identities they can review. \nReviewers can then make decisions to grant or revoke access, as well as reassign the ceritifcation to another reviewer. If the reviewer chooses this option, they must provide a reason for reassignment in the form of a comment.\n\nOnce a reviewer has made decisions on all the certification's involved access items, he or she must \"Sign Off\" to complete the review process.\nDoing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. \n\nOnce all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. \nIn the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation.\nIn this situation, the certification campaign completes once all the remediation requests are completed. \n\nThe end of a certification campaign is determined by its deadline, its completion status, or by an administrator's decision. \n\nFor more information about certifications and certification campaigns, refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html).\n", "item": [ { - "id": "f8be6781-be92-427f-aa25-f18aa93c401c", + "id": "dffc3579-b67d-4448-8512-7f3b2306f046", "name": "List Campaigns", "request": { "name": "List Campaigns", @@ -15449,7 +15449,7 @@ "type": "text/plain" }, "key": "detail", - "value": "FULL" + "value": "SLIM" }, { "disabled": true, @@ -15510,7 +15510,7 @@ }, "response": [ { - "id": "366c3c38-caa8-4c49-9c81-0f2cc3c4833b", + "id": "9c0fc97d-0d43-4bc4-acd0-3b3d40ab56d0", "name": "A list of campaign objects.", "originalRequest": { "url": { @@ -15528,7 +15528,7 @@ "type": "text/plain" }, "key": "detail", - "value": "FULL" + "value": "SLIM" }, { "disabled": true, @@ -15603,12 +15603,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SEARCH\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"PENDING\",\n \"correlatedStatus\": \"CORRELATED\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SEARCH\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ACTIVE\",\n \"correlatedStatus\": \"UNCORRELATED\"\n }\n]", + "body": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"ROLE_COMPOSITION\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"STAGED\",\n \"correlatedStatus\": \"CORRELATED\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SEARCH\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ERROR\",\n \"correlatedStatus\": \"UNCORRELATED\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1d8bdc37-5796-4543-bfc2-4882c06a9c0f", + "id": "4965d3c2-b1cd-4665-8966-bd25c6ddb951", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -15626,7 +15626,7 @@ "type": "text/plain" }, "key": "detail", - "value": "FULL" + "value": "SLIM" }, { "disabled": true, @@ -15701,12 +15701,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "f7782ae4-ffbf-4644-9375-d395eb2d7f61", + "id": "c22688a7-77e5-4803-8266-81e831124308", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -15724,7 +15724,7 @@ "type": "text/plain" }, "key": "detail", - "value": "FULL" + "value": "SLIM" }, { "disabled": true, @@ -15804,7 +15804,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0f5cd237-d7e3-40f5-9f28-849899565da3", + "id": "a7799bee-b54c-446a-bb5e-c18449cd8a60", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -15822,7 +15822,7 @@ "type": "text/plain" }, "key": "detail", - "value": "FULL" + "value": "SLIM" }, { "disabled": true, @@ -15897,12 +15897,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "97d99081-5aff-4531-a6d6-f2b7eaf15b86", + "id": "5a057360-1cd1-444a-8d02-76109f11266f", "name": "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.", "originalRequest": { "url": { @@ -15920,7 +15920,7 @@ "type": "text/plain" }, "key": "detail", - "value": "FULL" + "value": "SLIM" }, { "disabled": true, @@ -16000,7 +16000,7 @@ "_postman_previewlanguage": "json" }, { - "id": "799d813e-1782-476a-ad2f-19d84f8d61aa", + "id": "090a862c-e657-4b29-a146-6a60d8c188b1", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -16018,7 +16018,7 @@ "type": "text/plain" }, "key": "detail", - "value": "FULL" + "value": "SLIM" }, { "disabled": true, @@ -16093,7 +16093,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -16104,7 +16104,7 @@ } }, { - "id": "6c21f4e6-772f-4265-bc76-633c3e04db57", + "id": "3b4292c1-bd57-43f4-9053-2263bfa232b5", "name": "Create a campaign", "request": { "name": "Create a campaign", @@ -16135,7 +16135,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"MANAGER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"COMPLETED\",\n \"correlatedStatus\": \"CORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ACTIVATING\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n}", "options": { "raw": { "headerFamily": "json", @@ -16146,7 +16146,7 @@ }, "response": [ { - "id": "a6ddd7b9-db65-4ad0-96b5-a4284b5c7793", + "id": "8ac39c8d-edb7-4fbc-b787-5cf4b44bfd24", "name": "Indicates that the campaign requested was successfully created and returns its representation.", "originalRequest": { "url": { @@ -16180,7 +16180,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"MANAGER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"COMPLETED\",\n \"correlatedStatus\": \"CORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ACTIVATING\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n}", "options": { "raw": { "headerFamily": "json", @@ -16197,12 +16197,12 @@ "value": "application/json" } ], - "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"MANAGER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"COMPLETED\",\n \"correlatedStatus\": \"CORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n}", + "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ACTIVATING\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "83c47c88-5bf5-4c76-8a3d-7115d9eb710a", + "id": "72e97514-7baf-4235-b4e7-06554be16cd6", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -16236,7 +16236,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"MANAGER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"COMPLETED\",\n \"correlatedStatus\": \"CORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ACTIVATING\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n}", "options": { "raw": { "headerFamily": "json", @@ -16253,12 +16253,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "14d996ef-9ee7-41df-b882-df2bab8127f2", + "id": "b7996871-1d07-40e7-85da-36859c5a991a", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -16292,7 +16292,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"MANAGER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"COMPLETED\",\n \"correlatedStatus\": \"CORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ACTIVATING\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n}", "options": { "raw": { "headerFamily": "json", @@ -16314,7 +16314,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f38447ff-6187-4087-8d3e-687e2ff9a4ca", + "id": "182f5b4c-4283-4548-8a5a-88c053f8c20a", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -16348,7 +16348,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"MANAGER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"COMPLETED\",\n \"correlatedStatus\": \"CORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ACTIVATING\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n}", "options": { "raw": { "headerFamily": "json", @@ -16365,12 +16365,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ae566c27-7c4c-49fc-82d7-79a50c6d107a", + "id": "2804eace-9253-4587-86c3-66500abe818c", "name": "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.", "originalRequest": { "url": { @@ -16404,7 +16404,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"MANAGER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"COMPLETED\",\n \"correlatedStatus\": \"CORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ACTIVATING\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n}", "options": { "raw": { "headerFamily": "json", @@ -16426,7 +16426,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b4a10f36-b5e1-47d1-9de9-b3cb4987b2cf", + "id": "77b69895-2ed3-46d6-923e-9478205d1ce6", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -16460,7 +16460,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"MANAGER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"COMPLETED\",\n \"correlatedStatus\": \"CORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ACTIVATING\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n}", "options": { "raw": { "headerFamily": "json", @@ -16477,7 +16477,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -16488,7 +16488,7 @@ } }, { - "id": "91306212-18b7-42c2-b1f6-1d7abfb9c7ba", + "id": "ddb9716d-bd31-40c7-af16-e29d9334d041", "name": "Get a campaign", "request": { "name": "Get a campaign", @@ -16525,7 +16525,7 @@ }, "response": [ { - "id": "371b2cdf-4a7a-482d-a39c-35210cadd7df", + "id": "a2a31ecc-a389-4763-861d-90d93ad95663", "name": "A campaign object", "originalRequest": { "url": { @@ -16564,12 +16564,12 @@ "value": "application/json" } ], - "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"MANAGER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ARCHIVED\",\n \"correlatedStatus\": \"UNCORRELATED\"\n}", + "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ERROR\",\n \"correlatedStatus\": \"CORRELATED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "09a9f2a5-4eb7-4cdd-9e34-5d96b6bba132", + "id": "71230c69-5d8d-448b-af79-9d7d0190394f", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -16608,12 +16608,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "4921f3f8-b9c7-4584-925f-5c034bebbacf", + "id": "421962a7-99eb-474a-a54d-c882ca82b1d8", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -16657,7 +16657,7 @@ "_postman_previewlanguage": "json" }, { - "id": "841cf7a2-1f72-4f53-a0be-daa1238c3b19", + "id": "5ce09ff7-5091-4bdf-b96f-6dbc192279a0", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -16696,12 +16696,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "516c5eed-2c38-4a16-b2d4-92c14788f3bf", + "id": "610f7dd1-1d07-4d30-9724-e8ef54c63bf9", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -16740,12 +16740,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1c74ad9a-8def-4542-833f-6c1b7ea41e36", + "id": "ec71272a-8baf-497b-902f-8e8fe9b3c9fc", "name": "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.", "originalRequest": { "url": { @@ -16789,7 +16789,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b833d29e-913a-4b9d-8aa4-885e15227b06", + "id": "7e17632f-d426-4507-8ed4-fff885d5242d", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -16828,7 +16828,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -16839,7 +16839,7 @@ } }, { - "id": "bf2837b4-7a07-40a5-952e-0307c659a6c8", + "id": "ae619dec-f5bd-4c88-bd05-260d87a8ab3e", "name": "Update a Campaign", "request": { "name": "Update a Campaign", @@ -16878,7 +16878,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -16889,7 +16889,7 @@ }, "response": [ { - "id": "dcb0d7b0-feb1-4119-bd43-96f5def5d61f", + "id": "b21e3591-2a4b-4d24-8228-d630bd5e8188", "name": "Indicates the PATCH operation succeeded, and returns the campaign's new representation.", "originalRequest": { "url": { @@ -16924,7 +16924,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -16941,12 +16941,12 @@ "value": "application/json" } ], - "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"MANAGER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ARCHIVED\",\n \"correlatedStatus\": \"UNCORRELATED\"\n}", + "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ERROR\",\n \"correlatedStatus\": \"CORRELATED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e3c43610-67f5-411d-95a6-e97069532773", + "id": "52d8c949-a1ea-4842-b5cc-79cd0932c28a", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -16981,7 +16981,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -16998,12 +16998,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "965272e1-0fab-4b61-8597-6da80d74a096", + "id": "5584c4ed-2275-4885-b060-c33f378e0e06", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -17038,7 +17038,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -17060,7 +17060,7 @@ "_postman_previewlanguage": "json" }, { - "id": "32c45803-40cc-4483-a7c7-153a0abcc960", + "id": "a8fa8621-e24d-4d2f-8719-0fb2ee7e2030", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -17095,7 +17095,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -17112,12 +17112,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "13ac0751-948f-4985-9a7c-b4be55da5ce4", + "id": "c5f60af4-9d00-4501-a62b-5b41fb871d07", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -17152,7 +17152,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -17169,12 +17169,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a1f6fa69-9a61-44e1-8279-dfe4e4020757", + "id": "4ec3909a-18ef-40d2-962d-fc583020ec2e", "name": "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.", "originalRequest": { "url": { @@ -17209,7 +17209,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -17231,7 +17231,7 @@ "_postman_previewlanguage": "json" }, { - "id": "cac07395-2c45-4727-9417-41db7f857c60", + "id": "847c6983-18b5-4e04-9625-494834bd090d", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -17266,7 +17266,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -17283,7 +17283,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -17294,7 +17294,7 @@ } }, { - "id": "e6134d10-d48a-49e4-994a-923279c45ce1", + "id": "7e022642-31b8-410f-bc71-da20befca6fa", "name": "Reassign Certifications", "request": { "name": "Reassign Certifications", @@ -17345,7 +17345,7 @@ }, "response": [ { - "id": "55b60b2e-3490-4c3c-9d47-5aea9c2096c4", + "id": "e012287b-5b33-4c5a-adf1-4bbfc9dd2550", "name": "The reassign task that has been submitted.", "originalRequest": { "url": { @@ -17398,12 +17398,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"type\": \"REASSIGN\",\n \"targetType\": \"CERTIFICATION\",\n \"targetId\": \"\",\n \"status\": \"ERROR\",\n \"errors\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"reassignmentTrailDTOs\": [\n {\n \"previousOwner\": \"\",\n \"newOwner\": \"\",\n \"reassignmentType\": \"\"\n },\n {\n \"previousOwner\": \"\",\n \"newOwner\": \"\",\n \"reassignmentType\": \"\"\n }\n ],\n \"created\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"type\": \"COMPLETE_CERTIFICATION\",\n \"targetType\": \"CAMPAIGN\",\n \"targetId\": \"\",\n \"status\": \"IN_PROGRESS\",\n \"errors\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"reassignmentTrailDTOs\": [\n {\n \"previousOwner\": \"\",\n \"newOwner\": \"\",\n \"reassignmentType\": \"\"\n },\n {\n \"previousOwner\": \"\",\n \"newOwner\": \"\",\n \"reassignmentType\": \"\"\n }\n ],\n \"created\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0ed050bd-4b57-4406-b08f-e9f1dbd635ca", + "id": "4ab8c166-2ae3-4198-9eff-c3a460bd90b3", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -17456,12 +17456,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "349f0ad7-979d-4815-9393-b6210207a7a0", + "id": "73874a23-ef27-42e7-b2aa-b5e5636f28e4", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -17519,7 +17519,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5e625a84-dc00-4a4b-9751-8ea0208532e7", + "id": "7f7a0fa7-90ae-495f-b4cb-5b6a0b0d19d0", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -17572,12 +17572,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0b0e3382-a8d5-4732-b716-088c909c7617", + "id": "d75670db-238a-4011-abee-f1a4a7aeb891", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -17630,12 +17630,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3017e798-24ad-4b3d-bb6a-c90686c605fd", + "id": "92e188a2-18f1-4eac-b44e-7d08d043a04c", "name": "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.", "originalRequest": { "url": { @@ -17693,7 +17693,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3155d106-37e1-4629-8c00-604a2949c5b6", + "id": "94bc51d9-6399-4d39-a8f8-9bb3997954bc", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -17746,7 +17746,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -17757,7 +17757,7 @@ } }, { - "id": "12ed3db5-b3d6-4992-bca1-ea918862f5a5", + "id": "a17924bc-8995-4f64-8692-a4273824fbae", "name": "Activate a Campaign", "request": { "name": "Activate a Campaign", @@ -17808,7 +17808,7 @@ }, "response": [ { - "id": "02a3e3b6-dd58-433b-9cc5-85b0931fb367", + "id": "2269a669-3bc1-4e39-8cd1-4339d59d2a3f", "name": "Accepted - Returned if the request was successfully accepted into the system.", "originalRequest": { "url": { @@ -17866,7 +17866,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0618e61d-17d4-4684-ae3d-66c4d4df4c05", + "id": "e221f8b8-d5f0-4ff2-80d4-72146b860226", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -17919,12 +17919,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "4dc1b559-5ed0-4a2a-9534-957621172328", + "id": "8f588640-2c34-4230-ac38-420249af286b", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -17982,7 +17982,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c6e63d80-0ba6-4f50-924d-0e7ffd99fa36", + "id": "508c4061-58e1-4997-98bc-d7a59b73d7fe", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -18035,12 +18035,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a2cb486e-481b-4236-aaf9-9342d0077baa", + "id": "7a20c7c7-ed4c-48cd-816e-58a639cad4e4", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -18093,12 +18093,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "fe1cba49-3479-420f-9f54-d05526ea2926", + "id": "ff8f5d13-bb9b-4c13-8a57-8bf9e617a025", "name": "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.", "originalRequest": { "url": { @@ -18156,7 +18156,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3993b418-43da-46ee-b1fd-73604ea0b938", + "id": "efe289b4-c9eb-4524-8fa7-51fc67a2e5f1", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -18209,7 +18209,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -18220,7 +18220,7 @@ } }, { - "id": "d310ebf4-aaee-4ba2-afa5-470aeafcf8d3", + "id": "5dae8b14-231d-4fa9-91e8-8887392a1452", "name": "Complete a Campaign", "request": { "name": "Complete a Campaign", @@ -18271,7 +18271,7 @@ }, "response": [ { - "id": "84ded3eb-924c-4dbe-9169-b3bb8e8a7619", + "id": "f6921e85-1cd5-44aa-9ea7-4ea03beb2ae4", "name": "Accepted - Returned if the request was successfully accepted into the system.", "originalRequest": { "url": { @@ -18329,7 +18329,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c658effa-1dec-4a31-b7a2-512fb1261ce6", + "id": "f68e7e46-b3c4-4db7-b047-24d2933ca7e5", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -18382,12 +18382,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "349d6f38-ff66-4ccf-85a3-fbaab98b50cf", + "id": "b0d320c4-7ce9-4f21-85cf-46c8525feff0", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -18445,7 +18445,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9855e6b5-af31-4e7d-979a-058b2336147e", + "id": "bfd07134-e068-4e30-b6a5-b576deeea37d", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -18498,12 +18498,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "f8f56c61-54a0-472e-83fb-496e909b706a", + "id": "c430e864-c803-4f56-a886-5c0e6a23dc5d", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -18556,12 +18556,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "53c11171-caa5-40d1-8d17-c584555e0c20", + "id": "0ccf479e-9152-422f-9176-edd07bcb8646", "name": "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.", "originalRequest": { "url": { @@ -18619,7 +18619,7 @@ "_postman_previewlanguage": "json" }, { - "id": "95ce04a9-2942-468d-91a8-e91b71ab5059", + "id": "4b171756-af1f-47c6-b379-7a1828b1c6ac", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -18672,7 +18672,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -18683,7 +18683,7 @@ } }, { - "id": "76a575e6-71d4-4ddb-8803-f443ca4e9f34", + "id": "7fe460f2-7a5d-4384-9aa5-f72f53441558", "name": "Deletes Campaigns", "request": { "name": "Deletes Campaigns", @@ -18726,7 +18726,7 @@ }, "response": [ { - "id": "daef1a2a-41cb-4edd-a274-0272d902400c", + "id": "eb86a895-a998-4ac8-86c6-56cb4ee2a3dd", "name": "Accepted - Returned if the request was successfully accepted into the system.", "originalRequest": { "url": { @@ -18783,7 +18783,7 @@ "_postman_previewlanguage": "json" }, { - "id": "05d10333-1cd0-48b0-897c-7274a6bdf3eb", + "id": "82653e69-3621-4d7c-bb34-7b0d77819fc9", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -18835,12 +18835,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "2b139709-32b8-4350-9a3b-91e00ed327d0", + "id": "79072577-5cb6-4dbc-a3cd-b1fbee517fab", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -18897,7 +18897,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7d62e643-13a1-4c65-a6d0-156079923bba", + "id": "3e0b29d3-673e-4314-a11e-a5a5173953d9", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -18949,12 +18949,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a5eb6baf-5388-41b8-ba4b-125a3693d95d", + "id": "7ea04f8e-0f35-48f6-89ed-ea3e249a707d", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -19006,12 +19006,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c3bf5971-38bd-4151-9eee-45cf415f54e6", + "id": "ad7dfc97-0274-4c03-978b-92df72e6697f", "name": "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.", "originalRequest": { "url": { @@ -19068,7 +19068,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3bf99be5-a569-4424-94a2-5aab94829cc3", + "id": "5d096da4-6630-449d-8769-50df139ecd64", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -19120,7 +19120,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -19131,7 +19131,7 @@ } }, { - "id": "8d2df251-1c73-4959-b691-9c2364fc5ec8", + "id": "7a4fda16-0d3a-4912-a77d-82e628d5bf9b", "name": "Get Campaign Reports", "request": { "name": "Get Campaign Reports", @@ -19177,7 +19177,7 @@ }, "response": [ { - "id": "ffcdf510-39e7-4540-a704-15dfab69d91b", + "id": "9726fd9e-d4a4-4bfa-9792-1d814415cb90", "name": "Array of campaign report objects.", "originalRequest": { "url": { @@ -19217,12 +19217,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"reportType\": \"CAMPAIGN_COMPOSITION_REPORT\",\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"SUCCESS\",\n \"lastRunAt\": \"\"\n },\n {\n \"reportType\": \"CAMPAIGN_STATUS_REPORT\",\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"TERMINATED\",\n \"lastRunAt\": \"\"\n }\n]", + "body": "[\n {\n \"reportType\": \"CAMPAIGN_REMEDIATION_STATUS_REPORT\",\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"ERROR\",\n \"lastRunAt\": \"\"\n },\n {\n \"reportType\": \"CERTIFICATION_SIGNOFF_REPORT\",\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"TEMP_ERROR\",\n \"lastRunAt\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "bd71fc22-f541-4ff2-8401-8f8a4f006e65", + "id": "4d9f4e4e-66e7-4b26-9e90-fa7f524b2894", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -19262,12 +19262,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1baee6fa-6cf6-48cd-abe5-2c96b7478f57", + "id": "f3235307-cf73-4e2a-b405-c6506681f9cb", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -19312,7 +19312,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a3cff3d6-e8ab-4b9a-8f4a-e6bb21647c81", + "id": "6a3f9c41-8631-44ae-a573-8bfcd39bef99", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -19352,12 +19352,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b86c323c-5ed6-4ce7-9e08-cac0c2c64704", + "id": "74142715-febf-439b-ab99-ba6c96cefe8c", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -19397,12 +19397,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ce3720aa-ace9-4465-9f1e-7679ea7b3457", + "id": "cdc193c3-4719-420c-b5b5-4a3d9c8295d5", "name": "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.", "originalRequest": { "url": { @@ -19447,7 +19447,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a7ae8fb5-94b0-4b89-840c-cd7cb867e7e4", + "id": "8b3e7fe6-55f8-4e23-b903-167edafc878c", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -19487,7 +19487,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -19498,7 +19498,7 @@ } }, { - "id": "b1dd3c1c-7e10-416a-bc4a-3bea02285621", + "id": "3b7b3ee9-8dc4-42ee-8d51-56bbcb6b5a2b", "name": "Run Campaign Report", "request": { "name": "Run Campaign Report", @@ -19526,7 +19526,7 @@ }, { "type": "any", - "value": "CAMPAIGN_COMPOSITION_REPORT", + "value": "CAMPAIGN_STATUS_REPORT", "key": "type", "disabled": true } @@ -19543,7 +19543,7 @@ }, "response": [ { - "id": "4571fd1b-1d44-4a35-8553-8993073b2656", + "id": "d1e2d2c9-d875-4c2a-8bf3-5fb7a5644b87", "name": "Accepted - Returned if the request was successfully accepted into the system.", "originalRequest": { "url": { @@ -19589,7 +19589,7 @@ "_postman_previewlanguage": "json" }, { - "id": "40d0a59b-8f46-472c-b3cd-fc2bd0831aa8", + "id": "5dc9e6e2-9d60-454c-9699-60995d3e4959", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -19630,12 +19630,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "cede748f-8c5c-458a-9ad9-b55cce734cfc", + "id": "88e028aa-1db1-4490-a6ce-f70c86f19917", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -19681,7 +19681,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7e555c3c-dac7-499c-99df-3ef4accfa211", + "id": "ffc05f45-df0a-41f7-9edd-604406bca65a", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -19722,12 +19722,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "122458a0-c712-4c84-a4c4-f9f430e33b5d", + "id": "1d9f160e-f5db-44d9-ba1c-c2f68e27ebc3", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -19768,12 +19768,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "dff3ab7f-8d32-406b-9a84-c8d7cab79bb3", + "id": "8ccfb8ed-23fb-47ea-a0ac-5b869937c4bc", "name": "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.", "originalRequest": { "url": { @@ -19819,7 +19819,7 @@ "_postman_previewlanguage": "json" }, { - "id": "56333abc-ee13-437e-8df4-6a6dc1835797", + "id": "505c9332-d413-4dfd-b2b9-59f09394d967", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -19860,7 +19860,307 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "9faa6463-c470-42c0-b0e5-cc544f24a9c4", + "name": "Get Campaign Reports Configuration", + "request": { + "name": "Get Campaign Reports Configuration", + "description": { + "content": "Fetches configuration for campaign reports. Currently it includes only one element - identity attributes defined as custom report columns.\nRequires roles of CERT_ADMIN and ORG_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "campaigns", + "reports-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "3ffdc2ee-961f-494b-a8ee-05ec3c7cfad8", + "name": "Campaign Report Configuration", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "reports-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"identityAttributeColumns\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d3fdc670-b960-4c29-97de-b9e0753f9e30", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "reports-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d7d93682-c333-4df7-9899-de8fddefdf7f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "reports-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9c357f9c-45a6-4805-965e-8ecba1f19a42", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "reports-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "678918e5-4b3c-4a13-8e45-b86a486f2f8f", + "name": "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.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "reports-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cf3a40bd-11e1-460f-bfef-8e4256559173", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "reports-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -19877,7 +20177,7 @@ "description": "Use this API to implement certification functionality. \nWith this functionality in place, administrators and designated certification reviewers can review users' access certifications and decide whether to approve access, revoke it, or reassign the review to another reviewer. \nImplementing certifications improves organizations' data security by reducing inappropriate access through a distributed review process and helping them satisfy audit and regulatory requirements. \n\nA certification refers to IdentityNow's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. \nThese serve as a way of showing that a user's access has been reviewed and approved. \nMultiple certifications by different reviewers are often required to approve a user's access. \nA set of multiple certifications is called a certification campaign.\n\nFor example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. \nOnce this certification has been completed, IdentityNow would provision all the access the user needs, nothing more. \n\nOrganization administrators or certification administrators can designate other IdentityNow users as certification reviewers. \nThose reviewers can select the 'Certifications' tab to view any of the certifications they either need to review or have already reviewed under the 'Active' and 'Completed' tabs, respectively. \n\nWhen a certification campaign is in progress, certification reviewers will see certifications listed under 'Active,' where they can review the involved identities. \nUnder the 'Decision' column on the right, next to each access item, reviewers can select the checkmark to approve access, select the 'X' to revoke access, or they can toggle the 'More Options' menu to reassign the certification to another reviewer and provide a reason for reassignment in the form of a comment. \n\nOnce a reviewer has made decisions on all the certification's involved access items, he or she must select 'Sign Off' to complete the review process.\nDoing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. \n\nOnce all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation.\nIn this situation, the certification campaign completes once all the remediation requests are completed. \n\nRefer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html) for more information about certifications.\n", "item": [ { - "id": "0ababf48-ffec-4d1d-ba70-0c6bf5acbc2c", + "id": "a7deabbd-90fc-498e-bf30-ad9ffdb12a89", "name": "Identity Campaign Certifications by IDs", "request": { "name": "Identity Campaign Certifications by IDs", @@ -19961,7 +20261,7 @@ }, "response": [ { - "id": "826ae61a-b444-40b5-97e8-c305c8084c25", + "id": "d253b250-1ea9-49be-b622-2ebe14106be4", "name": "List of identity campaign certifications", "originalRequest": { "url": { @@ -20054,12 +20354,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"campaign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"MANAGER\",\n \"description\": \"\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"mandatoryCommentRequirement\": \"REVOKE_ONLY_DECISIONS\"\n },\n \"completed\": \"\",\n \"identitiesCompleted\": \"\",\n \"identitiesTotal\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"decisionsMade\": \"\",\n \"decisionsTotal\": \"\",\n \"due\": \"\",\n \"signed\": \"\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"reassignment\": {\n \"from\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CERTIFICATION\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"comment\": \"\"\n },\n \"hasErrors\": \"\",\n \"errorMessage\": \"\",\n \"phase\": \"ACTIVE\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"campaign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"SEARCH\",\n \"description\": \"\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"mandatoryCommentRequirement\": \"REVOKE_ONLY_DECISIONS\"\n },\n \"completed\": \"\",\n \"identitiesCompleted\": \"\",\n \"identitiesTotal\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"decisionsMade\": \"\",\n \"decisionsTotal\": \"\",\n \"due\": \"\",\n \"signed\": \"\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"reassignment\": {\n \"from\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CERTIFICATION\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"comment\": \"\"\n },\n \"hasErrors\": \"\",\n \"errorMessage\": \"\",\n \"phase\": \"SIGNED\"\n }\n]", + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"campaign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"MANAGER\",\n \"description\": \"\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n },\n \"completed\": \"\",\n \"identitiesCompleted\": \"\",\n \"identitiesTotal\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"decisionsMade\": \"\",\n \"decisionsTotal\": \"\",\n \"due\": \"\",\n \"signed\": \"\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"reassignment\": {\n \"from\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CERTIFICATION\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"comment\": \"\"\n },\n \"hasErrors\": \"\",\n \"errorMessage\": \"\",\n \"phase\": \"SIGNED\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"campaign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"MANAGER\",\n \"description\": \"\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n },\n \"completed\": \"\",\n \"identitiesCompleted\": \"\",\n \"identitiesTotal\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"decisionsMade\": \"\",\n \"decisionsTotal\": \"\",\n \"due\": \"\",\n \"signed\": \"\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"reassignment\": {\n \"from\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CERTIFICATION\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"comment\": \"\"\n },\n \"hasErrors\": \"\",\n \"errorMessage\": \"\",\n \"phase\": \"SIGNED\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "eb66cd17-1edf-440d-8613-ed8fb2b8bb35", + "id": "d8321d19-a50d-4fb0-95b8-c5f31166d2a8", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -20152,12 +20452,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "9d978941-9242-4289-bb01-95cde546502c", + "id": "f2a92946-4e2f-4645-803f-16c8ba191c8c", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -20255,7 +20555,7 @@ "_postman_previewlanguage": "json" }, { - "id": "00c6ed8b-ec1e-47f9-92a9-c2a30ce75961", + "id": "b4e6fc3a-9305-4721-8a30-9c6ce2714b06", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -20348,12 +20648,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "aef4de49-0082-4e44-9ac4-d7b178e3c5ad", + "id": "7126f47c-042b-483a-92c6-fea4c8e06d77", "name": "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.", "originalRequest": { "url": { @@ -20451,7 +20751,7 @@ "_postman_previewlanguage": "json" }, { - "id": "fe3c0c19-c3aa-4127-8473-d8952ca45688", + "id": "f88a50ad-8b04-480f-b9ae-f994ea3d8a05", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -20544,7 +20844,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -20555,7 +20855,7 @@ } }, { - "id": "fa7256a5-8e51-4810-b179-3fa4069de341", + "id": "2eed3031-879d-41a3-9b19-d46f543621d4", "name": "Identity Certification by ID", "request": { "name": "Identity Certification by ID", @@ -20592,7 +20892,7 @@ }, "response": [ { - "id": "5be03f9f-18a1-4855-81cb-a4fc18435984", + "id": "062e8399-223d-4dda-8703-23213d276b25", "name": "An identity campaign certification object", "originalRequest": { "url": { @@ -20631,12 +20931,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"campaign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"MANAGER\",\n \"description\": \"\",\n \"correlatedStatus\": \"CORRELATED\",\n \"mandatoryCommentRequirement\": \"REVOKE_ONLY_DECISIONS\"\n },\n \"completed\": \"\",\n \"identitiesCompleted\": \"\",\n \"identitiesTotal\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"decisionsMade\": \"\",\n \"decisionsTotal\": \"\",\n \"due\": \"\",\n \"signed\": \"\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"reassignment\": {\n \"from\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CERTIFICATION\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"comment\": \"\"\n },\n \"hasErrors\": \"\",\n \"errorMessage\": \"\",\n \"phase\": \"SIGNED\"\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"campaign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"MANAGER\",\n \"description\": \"\",\n \"correlatedStatus\": \"CORRELATED\",\n \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n },\n \"completed\": \"\",\n \"identitiesCompleted\": \"\",\n \"identitiesTotal\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"decisionsMade\": \"\",\n \"decisionsTotal\": \"\",\n \"due\": \"\",\n \"signed\": \"\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"reassignment\": {\n \"from\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CERTIFICATION\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"comment\": \"\"\n },\n \"hasErrors\": \"\",\n \"errorMessage\": \"\",\n \"phase\": \"SIGNED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5c4e1e87-f5d2-4575-ae7c-26b971dd6a75", + "id": "4aa416ad-2099-4260-98f8-1f5723c681d0", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -20675,12 +20975,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "67d16f8b-5915-4813-ac8b-c0344b7c999e", + "id": "407906fe-d185-49fe-a768-e101d69d9093", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -20724,7 +21024,7 @@ "_postman_previewlanguage": "json" }, { - "id": "aec661ab-db9b-40c0-a0de-c978b27eea3c", + "id": "dd89aa25-56b9-4dcd-b5df-8a966a6734e5", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -20763,12 +21063,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "2da4c45b-1ab2-4d5c-9f00-e537cfb78391", + "id": "78103265-c74a-4fb3-b3a8-fa33f0b73a4a", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -20807,12 +21107,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "11381936-56fd-4059-a803-f84b5ce7e3e7", + "id": "5a657eb7-23f0-4363-92c7-0c3961eca35c", "name": "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.", "originalRequest": { "url": { @@ -20856,7 +21156,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3b6edaa5-c0cf-4400-87cc-edcf9190b9d7", + "id": "8d814ee4-b327-4bbb-a64d-bfc8fbe08967", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -20895,7 +21195,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -20906,7 +21206,7 @@ } }, { - "id": "e12e178b-5f74-4b5f-8a12-ee48721ca2b3", + "id": "21e4efd6-572c-40bb-af95-13c7d558ce52", "name": "List of Access Review Items", "request": { "name": "List of Access Review Items", @@ -21017,7 +21317,7 @@ }, "response": [ { - "id": "eb0fd8f6-bd2b-4a82-9283-a4e1520d3e73", + "id": "ae47ba1d-21d2-4cdb-ad65-83a9f1478a49", "name": "A list of access review items", "originalRequest": { "url": { @@ -21130,12 +21430,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"accessSummary\": {\n \"access\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlement\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"accessProfile\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"role\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"revocable\": \"\",\n \"endDate\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n }\n ]\n }\n },\n \"identitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"id\": \"\",\n \"completed\": \"\",\n \"newAccess\": \"\",\n \"decision\": \"REVOKE\",\n \"comments\": \"\"\n },\n {\n \"accessSummary\": {\n \"access\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlement\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"accessProfile\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"role\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"revocable\": \"\",\n \"endDate\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n }\n ]\n }\n },\n \"identitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"id\": \"\",\n \"completed\": \"\",\n \"newAccess\": \"\",\n \"decision\": \"APPROVE\",\n \"comments\": \"\"\n }\n]", + "body": "[\n {\n \"accessSummary\": {\n \"access\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlement\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"accessProfile\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"role\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"revocable\": \"\",\n \"endDate\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n }\n ]\n }\n },\n \"identitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"id\": \"\",\n \"completed\": \"\",\n \"newAccess\": \"\",\n \"decision\": \"APPROVE\",\n \"comments\": \"\"\n },\n {\n \"accessSummary\": {\n \"access\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlement\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"accessProfile\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"role\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"revocable\": \"\",\n \"endDate\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n }\n ]\n }\n },\n \"identitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"id\": \"\",\n \"completed\": \"\",\n \"newAccess\": \"\",\n \"decision\": \"REVOKE\",\n \"comments\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "f4d5444e-bcdf-4e70-af36-3a1db0033d7e", + "id": "69791f60-3b97-42aa-adc8-3dc3b7820e00", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -21248,12 +21548,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "24cc222e-e027-4c44-94c7-9b0b21943398", + "id": "36f0ead9-8ec8-4caa-becb-8e44b9ab19b6", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -21371,7 +21671,7 @@ "_postman_previewlanguage": "json" }, { - "id": "24bae250-7594-44a7-a76e-cb22524b8a21", + "id": "241ff5ee-de0b-45fc-8aef-b268f2e4f476", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -21484,12 +21784,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "32760903-1100-498d-b6e7-6ab6a00c3afd", + "id": "5ac1714a-dc19-4cb6-8403-8aa34fc91206", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -21602,12 +21902,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "91a60292-d6fb-4d0f-b9d7-e0e8c96067b5", + "id": "14322aa7-19a3-4c27-860c-d0b9f9d2f6b9", "name": "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.", "originalRequest": { "url": { @@ -21725,7 +22025,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9c586c55-1f2c-48a2-8ec5-c3b596d4ac6b", + "id": "85b4f3c9-2d02-4abe-b70a-e1fb04736025", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -21838,7 +22138,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -21849,7 +22149,7 @@ } }, { - "id": "1b9a4db6-eeec-456f-b1aa-6e36e518cdba", + "id": "8c7e1d56-82ed-4f83-b4f8-f635b2bd15c5", "name": "Decide on a Certification Item", "request": { "name": "Decide on a Certification Item", @@ -21889,7 +22189,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "[\n {\n \"id\": \"\",\n \"decision\": \"APPROVE\",\n \"bulk\": \"\",\n \"proposedEndDate\": \"\",\n \"recommendation\": {\n \"recommendation\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n },\n \"comments\": \"\"\n }\n]", + "raw": "[\n {\n \"id\": \"\",\n \"decision\": \"REVOKE\",\n \"bulk\": \"\",\n \"proposedEndDate\": \"\",\n \"recommendation\": {\n \"recommendation\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n },\n \"comments\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -21900,7 +22200,7 @@ }, "response": [ { - "id": "7fb2d21c-0094-498f-9a2d-1a14c778671f", + "id": "c637da5f-6cd7-4592-a231-41981f30b9ea", "name": "An identity campaign certification object", "originalRequest": { "url": { @@ -21936,7 +22236,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "[\n {\n \"id\": \"\",\n \"decision\": \"APPROVE\",\n \"bulk\": \"\",\n \"proposedEndDate\": \"\",\n \"recommendation\": {\n \"recommendation\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n },\n \"comments\": \"\"\n }\n]", + "raw": "[\n {\n \"id\": \"\",\n \"decision\": \"REVOKE\",\n \"bulk\": \"\",\n \"proposedEndDate\": \"\",\n \"recommendation\": {\n \"recommendation\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n },\n \"comments\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -21953,12 +22253,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"campaign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"MANAGER\",\n \"description\": \"\",\n \"correlatedStatus\": \"CORRELATED\",\n \"mandatoryCommentRequirement\": \"REVOKE_ONLY_DECISIONS\"\n },\n \"completed\": \"\",\n \"identitiesCompleted\": \"\",\n \"identitiesTotal\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"decisionsMade\": \"\",\n \"decisionsTotal\": \"\",\n \"due\": \"\",\n \"signed\": \"\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"reassignment\": {\n \"from\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CERTIFICATION\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"comment\": \"\"\n },\n \"hasErrors\": \"\",\n \"errorMessage\": \"\",\n \"phase\": \"SIGNED\"\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"campaign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"MANAGER\",\n \"description\": \"\",\n \"correlatedStatus\": \"CORRELATED\",\n \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n },\n \"completed\": \"\",\n \"identitiesCompleted\": \"\",\n \"identitiesTotal\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"decisionsMade\": \"\",\n \"decisionsTotal\": \"\",\n \"due\": \"\",\n \"signed\": \"\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"reassignment\": {\n \"from\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CERTIFICATION\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"comment\": \"\"\n },\n \"hasErrors\": \"\",\n \"errorMessage\": \"\",\n \"phase\": \"SIGNED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c39b3416-98b6-4f3b-a0a2-ebb4ddb7142f", + "id": "1a3b21c9-0faf-44ae-8c3d-92904419de1b", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -21994,7 +22294,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "[\n {\n \"id\": \"\",\n \"decision\": \"APPROVE\",\n \"bulk\": \"\",\n \"proposedEndDate\": \"\",\n \"recommendation\": {\n \"recommendation\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n },\n \"comments\": \"\"\n }\n]", + "raw": "[\n {\n \"id\": \"\",\n \"decision\": \"REVOKE\",\n \"bulk\": \"\",\n \"proposedEndDate\": \"\",\n \"recommendation\": {\n \"recommendation\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n },\n \"comments\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -22011,12 +22311,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b4816f40-c883-4cfa-af97-b2a781b2e4e0", + "id": "ebbc397a-8cc4-4ccd-a374-23c994ebcae1", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -22052,7 +22352,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "[\n {\n \"id\": \"\",\n \"decision\": \"APPROVE\",\n \"bulk\": \"\",\n \"proposedEndDate\": \"\",\n \"recommendation\": {\n \"recommendation\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n },\n \"comments\": \"\"\n }\n]", + "raw": "[\n {\n \"id\": \"\",\n \"decision\": \"REVOKE\",\n \"bulk\": \"\",\n \"proposedEndDate\": \"\",\n \"recommendation\": {\n \"recommendation\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n },\n \"comments\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -22074,7 +22374,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8a6ba496-acee-4559-98cb-75d016426c2f", + "id": "e5d7c561-e392-470d-b774-8933819882e3", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -22110,7 +22410,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "[\n {\n \"id\": \"\",\n \"decision\": \"APPROVE\",\n \"bulk\": \"\",\n \"proposedEndDate\": \"\",\n \"recommendation\": {\n \"recommendation\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n },\n \"comments\": \"\"\n }\n]", + "raw": "[\n {\n \"id\": \"\",\n \"decision\": \"REVOKE\",\n \"bulk\": \"\",\n \"proposedEndDate\": \"\",\n \"recommendation\": {\n \"recommendation\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n },\n \"comments\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -22127,12 +22427,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ee397e5e-d814-4f58-b1a5-fc53c7886210", + "id": "c0f6d7b3-5aa2-4fb8-aa12-122b1df7898b", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -22168,7 +22468,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "[\n {\n \"id\": \"\",\n \"decision\": \"APPROVE\",\n \"bulk\": \"\",\n \"proposedEndDate\": \"\",\n \"recommendation\": {\n \"recommendation\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n },\n \"comments\": \"\"\n }\n]", + "raw": "[\n {\n \"id\": \"\",\n \"decision\": \"REVOKE\",\n \"bulk\": \"\",\n \"proposedEndDate\": \"\",\n \"recommendation\": {\n \"recommendation\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n },\n \"comments\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -22185,12 +22485,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "4de714b4-b41b-4809-9f9f-e1a58193fdfc", + "id": "41384583-2c12-4b02-911d-fbefc98f9527", "name": "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.", "originalRequest": { "url": { @@ -22226,7 +22526,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "[\n {\n \"id\": \"\",\n \"decision\": \"APPROVE\",\n \"bulk\": \"\",\n \"proposedEndDate\": \"\",\n \"recommendation\": {\n \"recommendation\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n },\n \"comments\": \"\"\n }\n]", + "raw": "[\n {\n \"id\": \"\",\n \"decision\": \"REVOKE\",\n \"bulk\": \"\",\n \"proposedEndDate\": \"\",\n \"recommendation\": {\n \"recommendation\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n },\n \"comments\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -22248,7 +22548,7 @@ "_postman_previewlanguage": "json" }, { - "id": "708e9d34-cfbe-4739-8ddf-d863f4d9177a", + "id": "caf03500-122b-48a2-99c0-c401381a3f74", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -22284,7 +22584,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "[\n {\n \"id\": \"\",\n \"decision\": \"APPROVE\",\n \"bulk\": \"\",\n \"proposedEndDate\": \"\",\n \"recommendation\": {\n \"recommendation\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n },\n \"comments\": \"\"\n }\n]", + "raw": "[\n {\n \"id\": \"\",\n \"decision\": \"REVOKE\",\n \"bulk\": \"\",\n \"proposedEndDate\": \"\",\n \"recommendation\": {\n \"recommendation\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n },\n \"comments\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -22301,7 +22601,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -22312,7 +22612,7 @@ } }, { - "id": "04b3fe2b-929b-4981-81f0-9cfe039b50c9", + "id": "24507c03-2844-44b5-a738-3830b1abae87", "name": "Reassign Identities or Items", "request": { "name": "Reassign Identities or Items", @@ -22352,7 +22652,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n },\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", + "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY_SUMMARY\"\n },\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -22363,7 +22663,7 @@ }, "response": [ { - "id": "23f60aa8-4179-48b1-b5fc-179f69da51cf", + "id": "9810fe43-dd55-4c54-bd19-2de06601057a", "name": "An identity campaign certification details after completing the reassignment.", "originalRequest": { "url": { @@ -22399,7 +22699,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n },\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", + "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY_SUMMARY\"\n },\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -22416,12 +22716,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"campaign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"MANAGER\",\n \"description\": \"\",\n \"correlatedStatus\": \"CORRELATED\",\n \"mandatoryCommentRequirement\": \"REVOKE_ONLY_DECISIONS\"\n },\n \"completed\": \"\",\n \"identitiesCompleted\": \"\",\n \"identitiesTotal\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"decisionsMade\": \"\",\n \"decisionsTotal\": \"\",\n \"due\": \"\",\n \"signed\": \"\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"reassignment\": {\n \"from\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CERTIFICATION\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"comment\": \"\"\n },\n \"hasErrors\": \"\",\n \"errorMessage\": \"\",\n \"phase\": \"SIGNED\"\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"campaign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"MANAGER\",\n \"description\": \"\",\n \"correlatedStatus\": \"CORRELATED\",\n \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n },\n \"completed\": \"\",\n \"identitiesCompleted\": \"\",\n \"identitiesTotal\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"decisionsMade\": \"\",\n \"decisionsTotal\": \"\",\n \"due\": \"\",\n \"signed\": \"\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"reassignment\": {\n \"from\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CERTIFICATION\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"comment\": \"\"\n },\n \"hasErrors\": \"\",\n \"errorMessage\": \"\",\n \"phase\": \"SIGNED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "def43d91-410b-4bec-b86d-12467c2a0ef7", + "id": "7a7d67b0-828c-4baa-ba88-b0838fe4d0a6", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -22457,7 +22757,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n },\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", + "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY_SUMMARY\"\n },\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -22474,12 +22774,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6615edea-38d5-41a7-8018-4d29c34db95e", + "id": "dcf3eb3f-ca7e-4253-a869-8300e3f87291", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -22515,7 +22815,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n },\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", + "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY_SUMMARY\"\n },\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -22537,7 +22837,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c5196a99-2637-4c44-967b-2b2ea4de1165", + "id": "3ed83d02-c6be-47c5-974d-1692ff8c372f", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -22573,7 +22873,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n },\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", + "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY_SUMMARY\"\n },\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -22590,12 +22890,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "523d768f-8dc6-4d32-b097-1b6717fc880a", + "id": "c33e297a-bb8c-4a56-a8be-ba6611366a8a", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -22631,7 +22931,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n },\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", + "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY_SUMMARY\"\n },\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -22648,12 +22948,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b8837849-8991-4830-9547-50102da24cbe", + "id": "e1cd8056-d5ea-4d1d-a000-994ab5f074df", "name": "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.", "originalRequest": { "url": { @@ -22689,7 +22989,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n },\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", + "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY_SUMMARY\"\n },\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -22711,7 +23011,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c5d073b0-a200-449c-8b95-e6a1e312044e", + "id": "1cbec795-bd32-43f5-ad18-94e30f1f87ef", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -22747,7 +23047,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n },\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", + "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY_SUMMARY\"\n },\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -22764,7 +23064,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -22775,7 +23075,7 @@ } }, { - "id": "66d65a1a-af6e-452f-b969-1bd203d4bd99", + "id": "ae680dc5-e7b7-41f3-bfbc-147731ee90e1", "name": "Finalize Identity Certification Decisions", "request": { "name": "Finalize Identity Certification Decisions", @@ -22813,7 +23113,7 @@ }, "response": [ { - "id": "02257f9d-870d-41d6-9edc-1077b83a134d", + "id": "1ce4844d-35e8-4c8c-a38a-33877204eeca", "name": "An identity campaign certification object", "originalRequest": { "url": { @@ -22853,12 +23153,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"campaign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"MANAGER\",\n \"description\": \"\",\n \"correlatedStatus\": \"CORRELATED\",\n \"mandatoryCommentRequirement\": \"REVOKE_ONLY_DECISIONS\"\n },\n \"completed\": \"\",\n \"identitiesCompleted\": \"\",\n \"identitiesTotal\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"decisionsMade\": \"\",\n \"decisionsTotal\": \"\",\n \"due\": \"\",\n \"signed\": \"\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"reassignment\": {\n \"from\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CERTIFICATION\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"comment\": \"\"\n },\n \"hasErrors\": \"\",\n \"errorMessage\": \"\",\n \"phase\": \"SIGNED\"\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"campaign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"MANAGER\",\n \"description\": \"\",\n \"correlatedStatus\": \"CORRELATED\",\n \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n },\n \"completed\": \"\",\n \"identitiesCompleted\": \"\",\n \"identitiesTotal\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"decisionsMade\": \"\",\n \"decisionsTotal\": \"\",\n \"due\": \"\",\n \"signed\": \"\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"reassignment\": {\n \"from\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CERTIFICATION\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"comment\": \"\"\n },\n \"hasErrors\": \"\",\n \"errorMessage\": \"\",\n \"phase\": \"SIGNED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0a22dfb1-866c-4312-a2d0-5602691af900", + "id": "e88dab5a-24a8-4ff4-8770-6283a6b3b0d7", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -22898,12 +23198,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "2d912420-040c-4185-89bb-db4b5e53db64", + "id": "f8155a44-655b-41cc-b4f5-c494b0b70eba", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -22948,7 +23248,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4e820db2-5144-4f44-a0a1-81c89791dd04", + "id": "a7cd8ecb-0727-4f8d-ba45-1cc17c149ad7", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -22988,12 +23288,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7b2e88a1-ee92-4c3b-9cbb-91a4d347122f", + "id": "d3bf3725-5dc2-475a-a365-b14ceb04627f", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -23033,12 +23333,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5af4acc3-5fd3-4302-93f2-6b3993bf11c4", + "id": "9e1adce4-729c-44bc-bb18-642ee976d542", "name": "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.", "originalRequest": { "url": { @@ -23083,7 +23383,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6b0dc4bd-1bb9-411a-88fa-88f7fe0c0207", + "id": "ddbe1b46-d892-43b0-bf08-6d4f645abb23", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -23123,7 +23423,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -23140,7 +23440,7 @@ "description": "Use this API to implement certification summary functionality. \nWith this functionality in place, administrators and designated certification reviewers can review summaries of identity certification campaigns and draw conclusions about the campaigns' scope, security, and effectiveness. \nImplementing certification summary functionality improves organizations' ability to review their [certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html) and helps them satisfy audit and regulatory requirements by enabling them to trace access changes and the decisions made in their review processes. \n\nA certification refers to IdentityNow's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. \nThese certifications serve as a way of showing that a user's access has been reviewed and approved. \nMultiple certifications by different reviewers are often required to approve a user's access. \nA set of multiple certifications is called a certification campaign. \n\nFor example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. \nOnce this certification has been completed, IdentityNow would provision all the access the user needs, nothing more. \n\nCertification summaries provide information about identity certification campaigns such as the identities involved, the number of decisions made, and the access changed. \nFor example, an administrator or designated certification reviewer can examine the Manager Certification campaign to get an overview of how many entitlement decisions are made in that campaign as opposed to role decisions, which identities would be affected by changes to the campaign, and how those identities' access would be affected.\n", "item": [ { - "id": "c164b90a-fded-4eb4-9ed0-ff92a43367f3", + "id": "20ab68f9-4dce-4979-a453-24574f7d5806", "name": "Summary of Certification Decisions", "request": { "name": "Summary of Certification Decisions", @@ -23188,7 +23488,7 @@ }, "response": [ { - "id": "705b8a64-4617-4b11-bc4f-bafa4475c7da", + "id": "d9ae60ef-2ddb-4e13-9157-cf60344564eb", "name": "Summary of the decisions made", "originalRequest": { "url": { @@ -23243,7 +23543,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b6793636-435f-4ac8-b7e8-ee6701ffdc2a", + "id": "89082048-a603-4597-8daf-d11d7cd8bc18", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -23293,12 +23593,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "2a7e0fb3-11f5-4c23-a896-eb9095471787", + "id": "a304548e-22ea-4333-a34c-e29fb56fefa7", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -23353,7 +23653,7 @@ "_postman_previewlanguage": "json" }, { - "id": "305c6c34-2b8e-4241-ba32-c2557778588b", + "id": "8cb08453-8655-4ef7-a664-c3a3ab27061a", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -23403,12 +23703,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c472c61a-9a3f-4032-9398-59b44f0f8907", + "id": "7c0a7909-3c84-41c5-8c5f-4f1fafa5a06e", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -23458,12 +23758,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "35724d28-338f-4d47-b289-ed0f240282a3", + "id": "8d487f33-e0e3-4516-bfb6-21b6a34bbe47", "name": "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.", "originalRequest": { "url": { @@ -23518,7 +23818,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ab41b84b-7c13-4716-ba80-14e74720bc79", + "id": "49fb6a46-b246-44f2-a646-29bc0adea656", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -23568,7 +23868,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -23579,7 +23879,7 @@ } }, { - "id": "874073d3-afc1-46c4-b96c-a8857b24eea2", + "id": "ce04774d-b488-40e9-a356-2ac163e86d3d", "name": "Identity Summaries for Campaign Certification", "request": { "name": "Identity Summaries for Campaign Certification", @@ -23663,7 +23963,7 @@ }, "response": [ { - "id": "1ef0125e-b49f-4da7-9210-51f449214a4d", + "id": "3cdc9729-c4d8-4d1d-a63b-5a1b03a1de03", "name": "List of identity summaries", "originalRequest": { "url": { @@ -23754,7 +24054,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7049c8ef-2082-4ce2-b2f3-705b4257a7ee", + "id": "47e13e34-386c-4dbd-9222-0f52cbe7a0d6", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -23840,12 +24140,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3ceda9b9-2923-4020-aeed-d98918728d47", + "id": "56bb8391-0908-4adb-b0c4-d5b1de7c9eff", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -23936,7 +24236,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f170ea40-85fd-48a7-880e-583015c12ed5", + "id": "c0bf0294-4fd4-4fb1-8385-2749db41c26f", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -24022,12 +24322,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c7888dcc-c11c-4303-b461-77203dac6aa5", + "id": "5612d025-1de7-47ad-aa7f-37f15907c4ff", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -24113,12 +24413,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "2573704a-ce48-40ae-bd54-ffd371685fee", + "id": "47c85ba6-a288-4895-961f-b15084bca850", "name": "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.", "originalRequest": { "url": { @@ -24209,7 +24509,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a3aaebf0-e874-48b5-81c9-fca7040cd828", + "id": "3e14c3cb-fe99-4b63-9380-995865f41371", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -24295,7 +24595,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -24306,7 +24606,7 @@ } }, { - "id": "3a6e1ac0-49d0-4304-9b74-4f4010522974", + "id": "67db4396-d140-48cb-8fa5-703be2ac6ce5", "name": "Access Summaries", "request": { "name": "Access Summaries", @@ -24380,7 +24680,7 @@ }, { "type": "any", - "value": "ENTITLEMENT", + "value": "ACCESS_PROFILE", "key": "type", "disabled": true } @@ -24397,7 +24697,7 @@ }, "response": [ { - "id": "1b6f9fde-a3e2-4738-97f1-d6b8baf74448", + "id": "7488cf3d-ecb1-45df-838d-5f835f487491", "name": "List of access summaries", "originalRequest": { "url": { @@ -24484,12 +24784,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"access\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlement\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"accessProfile\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"role\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"revocable\": \"\",\n \"endDate\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n }\n ]\n }\n },\n {\n \"access\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlement\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"accessProfile\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"role\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"revocable\": \"\",\n \"endDate\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n }\n ]\n }\n }\n]", + "body": "[\n {\n \"access\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlement\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"accessProfile\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"role\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"revocable\": \"\",\n \"endDate\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n }\n ]\n }\n },\n {\n \"access\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlement\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"accessProfile\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"role\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"revocable\": \"\",\n \"endDate\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n }\n ]\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "34503af2-1d20-4e37-b5be-54e746c48219", + "id": "f51822f7-db1f-4662-bd82-7ddef9e4615b", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -24576,12 +24876,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "f7beb3c3-6335-4ecb-86c9-8daf264cb905", + "id": "fb77261e-70d6-4659-ae90-25813a703e04", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -24673,7 +24973,7 @@ "_postman_previewlanguage": "json" }, { - "id": "78d95497-957e-4c62-bfb8-c1fda597d2aa", + "id": "b484ea41-8d75-4501-b5d1-ee98566aa703", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -24760,12 +25060,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a2bf6cea-a325-4654-a497-395a39d5c270", + "id": "07704c2e-5707-4e8f-9fb2-2c705ac0c937", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -24852,12 +25152,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b98f7e8d-0114-4948-a4e2-729d3cf64bc2", + "id": "de778d5a-88cf-4b10-a243-5b96ff886414", "name": "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.", "originalRequest": { "url": { @@ -24949,7 +25249,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0408b73a-8f17-43e0-90ef-86981fb05167", + "id": "b3db3833-66e3-4bf0-bea0-b8d1f283b8df", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -25036,7 +25336,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -25047,7 +25347,7 @@ } }, { - "id": "d4f44f7c-677f-4fc5-bcac-b532184ed525", + "id": "d35b7957-4413-4dad-befc-af60f7f0907d", "name": "Summary for Identity", "request": { "name": "Summary for Identity", @@ -25092,7 +25392,7 @@ }, "response": [ { - "id": "3111a340-dd44-44cd-aaf1-90181263ed88", + "id": "f96de4e5-5ace-45ae-adb2-77179234211e", "name": "An identity summary", "originalRequest": { "url": { @@ -25138,7 +25438,7 @@ "_postman_previewlanguage": "json" }, { - "id": "80e2caf7-daaa-4ed7-b851-8f9aa5503e1c", + "id": "ac000217-4ac7-4214-b4cb-9ea082d54b60", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -25179,12 +25479,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6d417b59-6ed8-4427-9684-a0ee397ac750", + "id": "8a2b3aae-81b2-4ecd-803c-4f3b07766cd2", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -25230,7 +25530,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f6110069-adfa-47aa-a83b-82b0012d58e8", + "id": "3ccf1abc-7c4f-4634-a855-d02460f98bbc", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -25271,12 +25571,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e0d7a927-e87d-4a12-b78d-fc8ebd4c43d6", + "id": "040de33f-4e68-4bdc-8446-fa89c0c0e5b5", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -25317,12 +25617,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7d82f57a-4382-4cbe-94bc-5cd3185b09c3", + "id": "99dbc5ab-7a04-46bd-b8a2-ae60026b3347", "name": "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.", "originalRequest": { "url": { @@ -25368,7 +25668,7 @@ "_postman_previewlanguage": "json" }, { - "id": "25d5010e-7e98-4040-b970-71135b8c6ccf", + "id": "3aad6c79-edff-4515-976f-728c5e6b0f7e", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -25409,7 +25709,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -25426,7 +25726,7 @@ "description": "Use this API to implement and customize global tenant security settings.\nWith this functionality in place, administrators can manage the global security settings that a tenant/org has.\nThis API can be used to configure the networks and Geographies allowed to access IdentityNow URLs.\n", "item": [ { - "id": "b6ed8855-4be1-4d79-ac13-1d5b0ee84cc4", + "id": "c04c8b49-6d83-4622-9243-3ada09b8976a", "name": "Get security network configuration.", "request": { "name": "Get security network configuration.", @@ -25456,7 +25756,7 @@ }, "response": [ { - "id": "e1470c81-4e8a-4e99-a1a3-18dd3e90cecd", + "id": "a655f3cb-ba9b-4f63-872d-471999e025d4", "name": "Network configuration for the tenant's auth org.", "originalRequest": { "url": { @@ -25500,7 +25800,7 @@ "_postman_previewlanguage": "json" }, { - "id": "25810fa0-0625-405b-ad9f-9e42f94bad75", + "id": "cbda14c6-94e1-4a94-b5f9-a634053e58a7", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -25539,12 +25839,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "aae5c754-d3dd-4e1b-b2aa-6c8f8e757c33", + "id": "ff14c77d-b56f-4302-a906-e29f4cf252ea", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -25588,7 +25888,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7448745a-83ee-489e-8860-7fcb8fa8fbee", + "id": "7ff06a14-07b5-4c15-9cba-d5c1e3c392b8", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -25627,12 +25927,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1a098578-5b45-4880-9b32-8acb66b3070e", + "id": "086ac579-7012-4c21-a1d5-9dbbf65710d8", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -25671,12 +25971,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "87f39af8-820a-4beb-84a5-6153ac579f22", + "id": "5c318906-e783-41cb-b3af-f754f97efd9c", "name": "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.", "originalRequest": { "url": { @@ -25720,7 +26020,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0239c96f-e034-4544-9340-aa4dc35a0a1e", + "id": "04c2d144-063d-4088-903c-31098f19df87", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -25759,7 +26059,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -25770,7 +26070,7 @@ } }, { - "id": "e026acb3-1163-4b04-8539-8c40c8c2b8c0", + "id": "ede73bb1-7b25-49ee-b6da-8d54e977591a", "name": "Create security network configuration.", "request": { "name": "Create security network configuration.", @@ -25813,7 +26113,7 @@ }, "response": [ { - "id": "a1907480-3cc7-4f17-a6d0-e98bfaa4a633", + "id": "86c41789-c9f8-4186-95d9-d61a3b66e76c", "name": "Network configuration for the tenant.", "originalRequest": { "url": { @@ -25870,7 +26170,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ca630ac0-bf81-44b5-9120-a9698548d428", + "id": "0cde3c2a-9417-4ec2-b5b2-db1a78437b7f", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -25922,12 +26222,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "925be404-ce7f-4949-9d48-33edab0f08b9", + "id": "4b98d9d1-c322-4fef-a97d-fa0ac2b12719", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -25984,7 +26284,7 @@ "_postman_previewlanguage": "json" }, { - "id": "118b6fd4-084e-4122-992a-0e2920eef593", + "id": "00d681ca-5ef3-4927-8033-048cc2662757", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -26036,12 +26336,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "25dbd40b-9ee3-4163-9de3-f232afadab8b", + "id": "334a6aa2-0c04-48d7-8788-a1b8eecf507e", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -26093,12 +26393,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d1a5b1e6-bcd6-4478-98e3-4d2528be5148", + "id": "ed09658d-aec9-471b-b9fe-ebafbfc977ae", "name": "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.", "originalRequest": { "url": { @@ -26155,7 +26455,7 @@ "_postman_previewlanguage": "json" }, { - "id": "147fa222-9e28-4d9e-935c-01178c03ed51", + "id": "b5a86625-77da-48c5-9bed-3250d03735dc", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -26207,7 +26507,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -26218,7 +26518,7 @@ } }, { - "id": "b3e63858-c4a1-4614-a07f-b6037a0b9459", + "id": "3131124e-c24a-45e1-a8b1-bca143410275", "name": "Update security network configuration.", "request": { "name": "Update security network configuration.", @@ -26250,7 +26550,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -26261,7 +26561,7 @@ }, "response": [ { - "id": "96da5153-c6d1-4538-b06e-ec47f99fd082", + "id": "f658a7b5-aec8-4cc8-be25-a7c8f5ba8d0a", "name": "Updated Auth Org network configuration.", "originalRequest": { "url": { @@ -26296,7 +26596,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -26318,7 +26618,7 @@ "_postman_previewlanguage": "json" }, { - "id": "821a852c-37aa-4bb5-a9fe-47f9a03f32fc", + "id": "06b79ff4-93c3-4e03-986b-93cfa2973482", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -26353,7 +26653,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -26370,12 +26670,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8ddc548e-1c16-4943-82e3-f5cd0adaf1c1", + "id": "b4cc79da-4e63-4803-a82c-1fb6e5a37b70", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -26410,7 +26710,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -26432,7 +26732,7 @@ "_postman_previewlanguage": "json" }, { - "id": "2d9d7251-870e-4833-961c-82cc82265fda", + "id": "96e18081-4fe4-4e1e-b416-79f863ec49f3", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -26467,7 +26767,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -26484,12 +26784,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0cba9ca2-18ef-4aae-9c02-edb0e40fa338", + "id": "3b559a32-9020-46b2-a4a7-04beded46106", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -26524,7 +26824,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -26541,12 +26841,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6fc9bbaf-e466-4ae3-ba0d-938efc66240f", + "id": "900c6935-843f-454f-9690-70742d4decfb", "name": "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.", "originalRequest": { "url": { @@ -26581,7 +26881,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -26603,7 +26903,7 @@ "_postman_previewlanguage": "json" }, { - "id": "98f6616c-2bbc-47ef-bd85-5a6a399e57c9", + "id": "3d9b1bec-4dcf-4aff-b872-eb4bd3059fa8", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -26638,7 +26938,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -26655,7 +26955,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -26672,7 +26972,7 @@ "description": "Use this API to implement and customize lifecycle state functionality.\nWith this functionality in place, administrators can create and configure custom lifecycle states for use across their organizations, which is key to controlling which users have access, when they have access, and the access they have.\n\nA lifecycle state describes a user's status in a company. For example, two lifecycle states come by default with IdentityNow: 'Active' and 'Inactive.' \nWhen an active employee takes an extended leave of absence from a company, his or her lifecycle state may change to 'Inactive,' for security purposes. \nThe inactive employee would lose access to all the applications, sources, and sensitive data during the leave of absence, but when the employee returns and becomes active again, all that access would be restored. \nThis saves administrators the time that would otherwise be spent provisioning the employee's access to each individual tool, reviewing the employee's certification history, etc. \n\nAdministrators can create a variety of custom lifecycle states. Refer to [Planning New Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#planning-new-lifecycle-states) for some custom lifecycle state ideas.\n\nAdministrators must define the criteria for being in each lifecycle state, and they must define how IdentityNow manages users' access to apps and sources for each lifecycle state.\n\nIn IdentityNow, administrators can manage lifecycle states by going to Admin > Identities > Identity Profile, selecting the identity profile whose lifecycle states they want to manage, selecting the 'Provisioning' tab, and using the left panel to either select the lifecycle state they want to modify or create a new lifecycle state. \n\nIn the 'Provisioning' tab, administrators can make the following access changes to an identity profile's lifecycle state: \n\n- Enable/disable the lifecycle state for the identity profile.\n\n- Enable/disable source accounts for the identity profile's lifecycle state.\n\n- Add existing access profiles to grant to the identity profiles in that lifecycle state.\n\n- Create a new access profile to grant to the identity profile in that lifecycle state.\n\nAccess profiles granted in a previous lifecycle state are automatically revoked when the identity moves to a new lifecycle state. \nTo maintain access across multiple lifecycle states, administrators must grant the access profiles in each lifecycle state. \nFor example, if an administrator wants users with the 'HR Employee' identity profile to maintain their building access in both the 'Active' and 'Leave of Absence' lifecycle states, the administrator must grant the access profile for that building access to both lifecycle states.\n\nDuring scheduled refreshes, IdentityNow evaluates lifecycle states to determine whether their assigned identities have the access defined in the lifecycle states' access profiles. \nIf the identities are missing access, IdentityNow provisions that access. \n\nAdministrators can also use the 'Provisioning' tab to configure email notifications for IdentityNow to send whenever an identity with that identity profile has a lifecycle state change. \nRefer to [Configuring Lifecycle State Notifications](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#configuring-lifecycle-state-notifications) for more information on how to do so.\n\nAn identity's lifecycle state can have four different statuses: the lifecycle state's status can be 'Active,' it can be 'Not Set,' it can be 'Not Valid,' or it 'Does Not Match Technical Name Case.' \nRefer to [Moving Identities into Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#moving-identities-into-lifecycle-states) for more information about these different lifecycle state statuses. \n\nRefer to [Setting Up Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html) for more information about lifecycle states.\n", "item": [ { - "id": "881b5999-7e12-4389-8c48-d16d28d39b09", + "id": "335f0e81-3de2-475b-8696-b9e03a5ad5a3", "name": "Set Lifecycle State", "request": { "name": "Set Lifecycle State", @@ -26723,7 +27023,7 @@ }, "response": [ { - "id": "86669a11-8c60-4df4-84f2-bd987b05b703", + "id": "461b676c-17e8-46f0-a06e-e1810c65fda9", "name": "The request was successfully accepted into the system.", "originalRequest": { "url": { @@ -26781,7 +27081,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d9def84b-a9cc-4675-94eb-ed84518a62f8", + "id": "43a61453-45b9-4789-b2da-54c35673d684", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -26834,12 +27134,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "35bd85f7-e253-4478-9ac2-cf11ed2f5a92", + "id": "c6be5817-a1a0-4e95-8365-cf5dee8ed2bf", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -26897,7 +27197,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0216df12-d2b3-43df-97d7-b8de8a63e771", + "id": "e6d0c190-99f6-49c9-bde5-9a2ec388ab55", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -26950,12 +27250,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "de98e263-086d-4a75-9971-bbcb0008b118", + "id": "966b995b-662c-4e94-8328-bfc2216b1874", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -27008,12 +27308,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "f8370f27-1205-4be5-a7b8-6434350f9a3e", + "id": "9ed9bfb9-1178-4639-9221-b624865d6bba", "name": "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.", "originalRequest": { "url": { @@ -27071,7 +27371,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e2894df8-880d-4d07-b249-192c159270cc", + "id": "79a1ebcd-0b89-4e6e-8e49-dcf22f4abc2e", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -27124,7 +27424,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -27135,7 +27435,7 @@ } }, { - "id": "d37f173d-e070-4a88-a1c8-bdc6d7a5bca8", + "id": "bedde6ce-b806-4e20-8c11-24a58bdc0315", "name": "Lists LifecycleStates", "request": { "name": "Lists LifecycleStates", @@ -27210,7 +27510,7 @@ }, "response": [ { - "id": "d270b45c-126d-4b34-85ee-c37dc486ad47", + "id": "1317afe1-a635-4525-b23d-fa722ee7724f", "name": "List of LifecycleState objects", "originalRequest": { "url": { @@ -27287,12 +27587,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"DISABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n }\n]", + "body": "[\n {\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"DISABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"DISABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"DISABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "f3578135-ce48-4381-a994-794b012e1281", + "id": "d1440ee2-3233-40cf-a1fb-bcc3eab1d5d6", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -27369,12 +27669,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "2ac02eb8-4a55-4580-90fa-aeac35f24736", + "id": "6c408885-cf0a-4b65-86c7-a2cf9f446abd", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -27456,7 +27756,7 @@ "_postman_previewlanguage": "json" }, { - "id": "fcdfc28f-6123-45d2-b2e7-ce93816e4ac2", + "id": "d830e6a4-b450-4a06-b8b9-3f4e15f1ae9f", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -27533,12 +27833,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "db805a9a-6a3d-4575-ab38-3ca78c51e689", + "id": "c925fc17-bdb9-44c0-838f-d0214ba6b8ad", "name": "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.", "originalRequest": { "url": { @@ -27620,7 +27920,7 @@ "_postman_previewlanguage": "json" }, { - "id": "09b99923-0af2-433f-a2c9-a6ebc8a0bee6", + "id": "71b4772a-878a-48fa-b063-4902ba3dfa72", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -27697,7 +27997,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -27708,7 +28008,7 @@ } }, { - "id": "a3a0f44a-0fb9-45e1-9a36-d9641cc22436", + "id": "e472a300-695c-4203-9df6-0d9e64ae5872", "name": "Create Lifecycle State", "request": { "name": "Create Lifecycle State", @@ -27748,7 +28048,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"DISABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -27759,7 +28059,7 @@ }, "response": [ { - "id": "1231ecef-9831-452a-a2fa-be8a0edd3a24", + "id": "4a6c56e8-e22a-4149-8332-f111c93bdf89", "name": "Created LifecycleState object.", "originalRequest": { "url": { @@ -27795,7 +28095,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"DISABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -27812,12 +28112,12 @@ "value": "application/json" } ], - "body": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", + "body": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"DISABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "135b46a7-9ea3-49f5-9248-e0a984571cfb", + "id": "8ea9afc3-5bb8-4b62-928f-bba435d9dbf8", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -27853,7 +28153,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"DISABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -27870,12 +28170,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "96371937-ace9-4219-982b-d2b8d6709244", + "id": "55ce8353-e000-431a-b8a4-f48f0847b631", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -27911,7 +28211,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"DISABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -27933,7 +28233,7 @@ "_postman_previewlanguage": "json" }, { - "id": "57ddff2b-8197-4dae-9fc3-f810c5889ac8", + "id": "d6d0730c-71ee-47b5-9b04-847d5da0016a", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -27969,7 +28269,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"DISABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -27986,12 +28286,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5b030b46-c69d-4b91-b423-288b6a86c625", + "id": "74fd46ec-223a-41d6-9b5b-730d2a80b58e", "name": "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.", "originalRequest": { "url": { @@ -28027,7 +28327,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"DISABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -28049,7 +28349,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7a7a0a47-0d9e-4d12-9e01-475c77cd9c04", + "id": "76bdf0c6-d091-4a1e-acbd-777c57b06c33", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -28085,7 +28385,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"DISABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -28102,7 +28402,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -28113,7 +28413,7 @@ } }, { - "id": "6ff748de-6ff8-432d-bb33-84f5e3595102", + "id": "ad277f10-b764-47d9-ba8f-0653be64b2df", "name": "Retrieves Lifecycle State", "request": { "name": "Retrieves Lifecycle State", @@ -28158,7 +28458,7 @@ }, "response": [ { - "id": "c7e048df-33b8-4dad-817f-30e5f956dfa9", + "id": "d4f9c908-6dd2-421a-8acb-1ce6fa20d01c", "name": "The requested LifecycleState was successfully retrieved.", "originalRequest": { "url": { @@ -28199,12 +28499,12 @@ "value": "application/json" } ], - "body": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", + "body": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"DISABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "bad30e35-b9c2-44e8-aa61-932cdb634666", + "id": "4d32d7f1-a2ad-4c56-a2a6-0a709d0d346e", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -28245,12 +28545,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e9636141-de33-4bf0-8755-ed17b8364ff0", + "id": "2311ff59-469b-4bc2-a275-31975dbd5413", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -28296,7 +28596,7 @@ "_postman_previewlanguage": "json" }, { - "id": "308b7bda-9507-4c3e-adcb-ee4cdfc841e4", + "id": "efbcebf8-5e26-410a-924d-66a62ac9bf37", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -28337,12 +28637,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "9b591b94-1952-4a26-af65-cd6f1ac220b2", + "id": "659e2eeb-0d9b-48a3-8d36-16b25969d283", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -28383,12 +28683,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "095b1045-4f3c-4177-bb58-e436b8056488", + "id": "b462f28c-afb7-4b77-8eff-08435c90ea41", "name": "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.", "originalRequest": { "url": { @@ -28434,7 +28734,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3047e8f8-1f0a-4dcd-ada9-68d720b1bc8c", + "id": "8d211f7c-cda3-4e9d-97c1-dd7fe31d1ebe", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -28475,7 +28775,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -28486,7 +28786,7 @@ } }, { - "id": "a4478f13-e2c0-44dc-829f-96b5ef387f29", + "id": "0e7143ad-8118-4506-a4f1-2791a13327be", "name": "Update Lifecycle State", "request": { "name": "Update Lifecycle State", @@ -28533,7 +28833,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -28544,7 +28844,7 @@ }, "response": [ { - "id": "dd6dd7da-c641-43ee-9c7d-6a367a079a85", + "id": "4b208019-3acc-434b-9517-767f9446ea17", "name": "The LifecycleState was successfully updated.", "originalRequest": { "url": { @@ -28581,7 +28881,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -28598,12 +28898,12 @@ "value": "application/json" } ], - "body": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", + "body": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"DISABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "eb14e7a4-2ee9-4115-974e-8676a01c843d", + "id": "4cb2eea1-7861-4f69-b852-785141da0e76", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -28640,7 +28940,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -28657,12 +28957,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6faeaa6c-06ec-4c07-bc54-1e87ed457277", + "id": "0f508664-0e28-4915-8386-16f369484f48", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -28699,7 +28999,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -28721,7 +29021,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a07b38d0-44e6-4928-a9af-414b9995ec2d", + "id": "63d357e4-0e37-41e1-aed0-e8c48033fc65", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -28758,7 +29058,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -28775,12 +29075,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "90296d69-e49e-4b71-a8c3-ec1a3cc597ff", + "id": "130e9267-e4bc-464c-92ad-6dbe69b92e20", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -28817,7 +29117,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -28834,12 +29134,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "f1e85fc8-dd89-47bc-9ca7-7e9fbe710d3f", + "id": "63737c1a-49b5-4eeb-8775-c36e388d4849", "name": "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.", "originalRequest": { "url": { @@ -28876,7 +29176,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -28898,7 +29198,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b2b9864f-05ea-4900-bf25-fefbacdb9959", + "id": "23b292d7-528f-4647-afbf-ea1111de4457", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -28935,7 +29235,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -28952,7 +29252,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -28963,7 +29263,7 @@ } }, { - "id": "7585e94a-f29f-4f06-a7de-3110d1eba948", + "id": "e845996c-a7b5-4472-b6d0-8230805f8d7b", "name": "Delete Lifecycle State by ID", "request": { "name": "Delete Lifecycle State by ID", @@ -29008,7 +29308,7 @@ }, "response": [ { - "id": "75b2ae40-ef73-4334-8878-c5abbe0846c8", + "id": "5a4c4cf1-71ab-499d-9aa8-963c606aafe1", "name": "The request was successfully accepted into the system.", "originalRequest": { "url": { @@ -29049,12 +29349,12 @@ "value": "application/json" } ], - "body": "{\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n}", + "body": "{\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5c296109-fe25-451e-a064-766eaa714fd7", + "id": "6c4761c5-7e86-46c9-852a-df9516b3867a", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -29095,12 +29395,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e4acf44e-c36c-42ca-8ee0-123c2a315310", + "id": "73c68671-a1ec-42e9-a8de-8523db93a228", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -29146,7 +29446,7 @@ "_postman_previewlanguage": "json" }, { - "id": "040b633c-4b75-4c44-b813-674990873450", + "id": "5cfa3319-7073-449c-b5fa-d56f91635609", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -29187,12 +29487,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8e9e094f-28c6-4106-a69a-d5d310099364", + "id": "542d9407-d7bb-420c-9864-1db4a90faec2", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -29233,12 +29533,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1c810c9e-c27c-425e-a66b-c6602a3915f2", + "id": "1d595f28-1315-4242-8c17-e10226b518bf", "name": "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.", "originalRequest": { "url": { @@ -29284,7 +29584,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7ee24465-b5f7-4faf-8082-5fef6cfbd86d", + "id": "41c670ad-d09e-4d2a-b98b-0629c147beb1", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -29325,7 +29625,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -29342,7 +29642,7 @@ "description": "Use this API to implement identity profile functionality. \nWith this functionality in place, administrators can view identity profiles and their configurations. \n\nIdentity profiles represent the configurations that can be applied to identities as a way of granting them a set of security and access, as well as defining the mappings between their identity attributes and their source attributes. \n\nIn IdentityNow, administrators can use the Identities drop-down menu and select Identity Profiles to view the list of identity profiles. \nThis list shows some details about each identity profile, along with its status. \nThey can select an identity profile to view its settings, its mappings between identity attributes and correlating source account attributes, and its provisioning settings. \n\nRefer to [Creating Identity Profiles](https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html) for more information about identity profiles.\n", "item": [ { - "id": "c3f27287-24a8-4ae6-9d56-a2571bf9fa99", + "id": "e6dc27af-72b8-4955-9df7-f21e12e7a6fc", "name": "Identity Profiles List", "request": { "name": "Identity Profiles List", @@ -29417,7 +29717,7 @@ }, "response": [ { - "id": "aa8f9a52-30fd-4014-9fd3-49819c2742db", + "id": "ed4140dc-4db2-4fa1-bae0-d5d1eac97591", "name": "List of identityProfiles.", "originalRequest": { "url": { @@ -29501,12 +29801,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"irure_a\": \"\",\n \"ut___a\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"fugiat_80d\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n },\n {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"pariatur46\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"ullamco_9\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n]", + "body": "[\n {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"labore_3a\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"esse_26\": \"\",\n \"esseb98\": \"\",\n \"Duis_161\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n },\n {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"utc08\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"veniam_0\": \"\",\n \"magna_72\": \"\",\n \"Duis_e\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6450723a-fe19-4f27-8fea-b04eacfdbcc6", + "id": "afe9e7d9-9008-4d46-9a44-a13c088ce6e1", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -29590,12 +29890,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a74c6be0-c508-4c1d-a312-09fa8d27e3b7", + "id": "d0c1cc23-30d1-4260-944f-6d9e31ac8b78", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -29684,7 +29984,7 @@ "_postman_previewlanguage": "json" }, { - "id": "908d1817-7e38-4c0d-881c-7c692573b04d", + "id": "a52b4376-571a-40e0-b726-960698ab3817", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -29768,12 +30068,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "2214ed9a-07bf-4a6f-b54c-2f83a85644c6", + "id": "3c0216ac-624e-4838-8fc8-f9b646da2254", "name": "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.", "originalRequest": { "url": { @@ -29862,7 +30162,7 @@ "_postman_previewlanguage": "json" }, { - "id": "974a2055-07c1-4ab9-bc4f-8bf6f848e1a1", + "id": "2c01cdd1-2ffe-43c2-8ca8-fdd022545f40", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -29946,7 +30246,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -29957,7 +30257,7 @@ } }, { - "id": "a1103eef-ee61-47c8-8d1c-4db4cf412e7f", + "id": "d5813a17-4b5d-4321-81e5-9de9083a6f4a", "name": "Delete Identity Profiles", "request": { "name": "Delete Identity Profiles", @@ -30000,7 +30300,7 @@ }, "response": [ { - "id": "d0feafda-95fb-4cc8-9830-e7dfdf0366be", + "id": "e30052ef-e8b1-432c-aed0-b4770c3451df", "name": "Accepted - Returns a TaskResult object referencing the bulk delete job created.", "originalRequest": { "url": { @@ -30052,12 +30352,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"launcher\": \"\",\n \"completed\": \"\",\n \"launched\": \"\",\n \"completionStatus\": \"TempError\"\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"launcher\": \"\",\n \"completed\": \"\",\n \"launched\": \"\",\n \"completionStatus\": \"Error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ad180d3d-7586-48eb-a545-91d6e6c5f9d6", + "id": "9583d6ee-f157-41a3-b500-99d414092d5e", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -30109,12 +30409,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "810d9f07-60f3-4ff6-8243-0bc811cd87fe", + "id": "18b0355d-1beb-45c6-b283-c0d876abff74", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -30171,7 +30471,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4488d812-f9d8-4a2e-ab76-34b4d941ac07", + "id": "18fa3569-652e-4c3f-83ff-37017303db09", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -30223,12 +30523,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "4b57b84f-06fb-4957-9a84-8dbaf1f03527", + "id": "90f0400b-8572-4386-9e42-13992b2b9ca8", "name": "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.", "originalRequest": { "url": { @@ -30285,7 +30585,7 @@ "_postman_previewlanguage": "json" }, { - "id": "216c28ad-c398-4be7-a9f9-48b279bde81b", + "id": "1ebf785c-ccfa-4a70-bb93-1d20c597ce1a", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -30337,7 +30637,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -30348,7 +30648,7 @@ } }, { - "id": "854f273b-2a01-4e15-9512-6102806cd342", + "id": "48497c5c-03d9-47f4-aec3-f0438ccd8451", "name": "Export Identity Profiles", "request": { "name": "Export Identity Profiles", @@ -30424,7 +30724,7 @@ }, "response": [ { - "id": "c73cdf5a-74d0-454e-b1f2-47f67925adee", + "id": "0a9c5869-c048-45de-b505-2a3405eff64c", "name": "List of export objects with identity profiles.", "originalRequest": { "url": { @@ -30509,12 +30809,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"amet_64\": \"\",\n \"in740\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sunt90\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"quisc64\": \"\",\n \"eu43\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"Duis5\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", + "body": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"cupidatat6\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"aliquip136\": \"\",\n \"dolor8b3\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"nulla2fe\": \"\",\n \"eiusmod_fa\": \"\",\n \"exercitation_a\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"consecteturc\": \"\",\n \"ullamcoa\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "cf9a98b7-2585-4378-ad29-812dec60b71d", + "id": "6d4a5b90-6d4d-4380-aedd-533dd85e3006", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -30599,12 +30899,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a7820314-5b07-4c9e-9c31-0836aaf8d671", + "id": "112eae72-02c3-4a8f-b8e7-40c97fe9c026", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -30694,7 +30994,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ab95f8fd-ea7c-4e78-beed-0d485181e923", + "id": "504330cd-7d97-476e-875f-dd2ea15e1735", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -30779,12 +31079,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "fa6479c5-bef7-43dd-9814-81d7f6904f53", + "id": "9f1f2796-44c2-4aec-9834-d47a2dfe04c2", "name": "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.", "originalRequest": { "url": { @@ -30874,7 +31174,7 @@ "_postman_previewlanguage": "json" }, { - "id": "562d205e-b819-4356-9822-a019eb457e75", + "id": "a9338c7c-fef7-4ca9-9b71-fc67016276e4", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -30959,7 +31259,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -30970,7 +31270,7 @@ } }, { - "id": "f1837557-3538-4c0c-af06-c54e72ffb545", + "id": "7c869755-c105-4ac6-8445-1f311bb28e35", "name": "Import Identity Profiles", "request": { "name": "Import Identity Profiles", @@ -31002,7 +31302,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"amet_64\": \"\",\n \"in740\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sunt90\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"quisc64\": \"\",\n \"eu43\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"Duis5\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", + "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"cupidatat6\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"aliquip136\": \"\",\n \"dolor8b3\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"nulla2fe\": \"\",\n \"eiusmod_fa\": \"\",\n \"exercitation_a\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"consecteturc\": \"\",\n \"ullamcoa\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -31013,7 +31313,7 @@ }, "response": [ { - "id": "1db17e9c-4d88-4288-93f6-0d3ed5631f4e", + "id": "7759c1d3-c076-4c7a-8c11-ec69eae6a316", "name": "The result of importing Identity Profiles.", "originalRequest": { "url": { @@ -31048,7 +31348,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"amet_64\": \"\",\n \"in740\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sunt90\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"quisc64\": \"\",\n \"eu43\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"Duis5\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", + "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"cupidatat6\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"aliquip136\": \"\",\n \"dolor8b3\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"nulla2fe\": \"\",\n \"eiusmod_fa\": \"\",\n \"exercitation_a\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"consecteturc\": \"\",\n \"ullamcoa\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -31065,12 +31365,12 @@ "value": "application/json" } ], - "body": "{\n \"infos\": [\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"aliqua2\": -86041651.21202753\n }\n },\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"anim_27\": -32972114.306584865\n }\n }\n ],\n \"warnings\": [\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"sit_3\": 38307363,\n \"ea__5\": true\n }\n },\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"occaecat4\": -13401082\n }\n }\n ],\n \"errors\": [\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"in4\": -81186009.47104713\n }\n },\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"estc\": -52910344.09344881\n }\n }\n ],\n \"importedObjects\": [\n {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", + "body": "{\n \"infos\": [\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"Excepteur_60\": 60612843.99605867\n }\n },\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"ullamco_c7\": \"ipsum in\",\n \"amet311\": -74577879.43519545\n }\n }\n ],\n \"warnings\": [\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"exb\": true,\n \"et1d8\": -5664.129422292113,\n \"in_f\": false\n }\n },\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"eiusmod__\": true,\n \"proident_09a\": \"Lorem labore\"\n }\n }\n ],\n \"errors\": [\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"magna__0\": -67383035.68768047,\n \"nullac0\": 26096626.77551961,\n \"velite8f\": -95192288.15727931\n }\n },\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"labored9\": true\n }\n }\n ],\n \"importedObjects\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "907eeeb4-3374-42bb-8858-32dca969b420", + "id": "ce3fd6f8-f524-4ab0-9563-639504d2e387", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -31105,7 +31405,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"amet_64\": \"\",\n \"in740\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sunt90\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"quisc64\": \"\",\n \"eu43\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"Duis5\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", + "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"cupidatat6\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"aliquip136\": \"\",\n \"dolor8b3\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"nulla2fe\": \"\",\n \"eiusmod_fa\": \"\",\n \"exercitation_a\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"consecteturc\": \"\",\n \"ullamcoa\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -31122,12 +31422,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8de91acf-bfae-4a19-860d-bb17efa60479", + "id": "ea6b5441-f25c-4378-a123-bc3db9873bd2", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -31162,7 +31462,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"amet_64\": \"\",\n \"in740\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sunt90\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"quisc64\": \"\",\n \"eu43\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"Duis5\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", + "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"cupidatat6\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"aliquip136\": \"\",\n \"dolor8b3\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"nulla2fe\": \"\",\n \"eiusmod_fa\": \"\",\n \"exercitation_a\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"consecteturc\": \"\",\n \"ullamcoa\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -31184,7 +31484,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6eeee936-b8ec-422b-ad91-1027573e7c22", + "id": "0545800d-df99-44a2-84ee-d466d1af436c", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -31219,7 +31519,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"amet_64\": \"\",\n \"in740\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sunt90\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"quisc64\": \"\",\n \"eu43\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"Duis5\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", + "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"cupidatat6\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"aliquip136\": \"\",\n \"dolor8b3\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"nulla2fe\": \"\",\n \"eiusmod_fa\": \"\",\n \"exercitation_a\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"consecteturc\": \"\",\n \"ullamcoa\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -31236,12 +31536,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ec5a9c4f-4cfb-41bb-9d00-93457a0ba507", + "id": "df0307d4-8505-46ac-acb7-ae6ba9545869", "name": "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.", "originalRequest": { "url": { @@ -31276,7 +31576,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"amet_64\": \"\",\n \"in740\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sunt90\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"quisc64\": \"\",\n \"eu43\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"Duis5\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", + "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"cupidatat6\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"aliquip136\": \"\",\n \"dolor8b3\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"nulla2fe\": \"\",\n \"eiusmod_fa\": \"\",\n \"exercitation_a\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"consecteturc\": \"\",\n \"ullamcoa\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -31298,7 +31598,7 @@ "_postman_previewlanguage": "json" }, { - "id": "00cf518e-6dc2-4f77-9e13-45628ae58615", + "id": "b6ca4faa-f8fd-496f-b9a4-c7694cfad49a", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -31333,7 +31633,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"amet_64\": \"\",\n \"in740\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sunt90\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"quisc64\": \"\",\n \"eu43\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"Duis5\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", + "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"cupidatat6\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"aliquip136\": \"\",\n \"dolor8b3\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"nulla2fe\": \"\",\n \"eiusmod_fa\": \"\",\n \"exercitation_a\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"consecteturc\": \"\",\n \"ullamcoa\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -31350,7 +31650,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -31361,7 +31661,7 @@ } }, { - "id": "2b62b725-3157-40cb-a496-8b5b4775fd5e", + "id": "512b8970-8368-4d2a-9b80-7961c2a70aed", "name": "Get single Identity Profile", "request": { "name": "Get single Identity Profile", @@ -31398,7 +31698,7 @@ }, "response": [ { - "id": "5a9a1d24-d05a-45cd-9f68-012911f87005", + "id": "a1cd37b1-37cc-4467-a162-7f72fd4767d2", "name": "An Identity Profile object.", "originalRequest": { "url": { @@ -31437,12 +31737,12 @@ "value": "application/json" } ], - "body": "{\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"quis_8\": \"\",\n \"commodo9a\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"officia_ce\": \"\",\n \"esse__\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n}", + "body": "{\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"deserunt9c\": \"\",\n \"est6\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"in_7f\": \"\",\n \"deseruntd0\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "acbb7514-fa1b-4418-b02c-65e704548a26", + "id": "f8876878-3764-43e2-8412-8ac9aec58085", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -31481,12 +31781,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6532cd59-fd04-4405-b90c-461c4ce5287b", + "id": "d01f6cd5-b911-404c-a80b-43f8db1d8667", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -31530,7 +31830,7 @@ "_postman_previewlanguage": "json" }, { - "id": "757e7192-2712-4508-b4b4-a9fa78b89c94", + "id": "d727842c-1a43-4540-ae4b-42094f5c634f", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -31569,12 +31869,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ae2e5f71-ef9b-4c7e-8f47-4758792552cc", + "id": "2291be8f-af14-436a-a277-a4428f8c7010", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -31613,12 +31913,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0a55b8ee-0d19-41ec-9a68-d76a757bc892", + "id": "1faa3a8f-118b-4790-bdea-3556767d68ea", "name": "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.", "originalRequest": { "url": { @@ -31662,7 +31962,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e7c85968-9830-4f17-8959-58ef85bcfb30", + "id": "f5436513-20be-4958-ba1f-cc6e9ef075be", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -31701,7 +32001,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -31712,7 +32012,7 @@ } }, { - "id": "562bd39c-0463-43c9-bdc5-7992954dab96", + "id": "d0528bc8-4935-47ed-a947-284c90c06c11", "name": "Delete an Identity Profile", "request": { "name": "Delete an Identity Profile", @@ -31749,7 +32049,7 @@ }, "response": [ { - "id": "3ad383a2-6e54-4757-8413-5bbf8ee80cb8", + "id": "2d1063cb-5e80-42bc-85e3-9d9382c466b4", "name": "Accepted - Returns a TaskResult object referencing the bulk delete job created.", "originalRequest": { "url": { @@ -31793,7 +32093,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8666f22b-5446-49e3-a091-6b6983330d8d", + "id": "8a7528ba-f251-4100-ac15-867a538bc2f6", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -31832,12 +32132,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1035020d-05e6-4b02-baa4-d46f652f84c9", + "id": "3794da80-4fb9-4cc8-98b4-a036b8b860aa", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -31881,7 +32181,7 @@ "_postman_previewlanguage": "json" }, { - "id": "923279c0-8d1a-491b-a1c8-95cccd17f191", + "id": "873753da-42bf-41e6-a2c7-666e15fcf4c0", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -31920,12 +32220,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c28b0edc-3e98-40f7-8426-ca1a357771ac", + "id": "511a0f50-a8c9-41c0-811d-7996645d9dce", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -31964,12 +32264,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e3a81f8f-2c52-446d-a23c-9c49ecd35bca", + "id": "55bc7ced-6014-4f14-ab8b-6948d362c891", "name": "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.", "originalRequest": { "url": { @@ -32013,7 +32313,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ccf81e7a-0663-4c81-9089-ee97a2e3f2d1", + "id": "85d3994d-49f2-4fe4-a8dc-2bf7cd59414e", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -32052,7 +32352,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -32063,7 +32363,7 @@ } }, { - "id": "97279caf-a31d-49cd-b20e-53517938f05a", + "id": "4e58ef71-4fa0-4c3a-b424-428d25a203b5", "name": "Get default Identity Attribute Config", "request": { "name": "Get default Identity Attribute Config", @@ -32101,7 +32401,7 @@ }, "response": [ { - "id": "8c8ac2d7-d9a8-414d-83b4-c2147d0c8f31", + "id": "6cf193be-871d-451a-8f1c-e06558f95f0e", "name": "An Identity Attribute Config object.", "originalRequest": { "url": { @@ -32141,12 +32441,12 @@ "value": "application/json" } ], - "body": "{\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"elit4\": \"\",\n \"Excepteur9\": \"\",\n \"utb7\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"laboris4\": \"\",\n \"voluptateb6\": \"\"\n }\n }\n }\n ]\n}", + "body": "{\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"veniam_51\": \"\",\n \"aliquad6d\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"mollit__\": \"\",\n \"tempora\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "396e5cc2-46a6-40d9-9e97-3e772880de8e", + "id": "71ed24f1-4dc6-450b-b351-0b3333c52c53", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -32186,12 +32486,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "448c4a72-0458-4c38-b965-b9b2e1494002", + "id": "ea3d50b2-2e2c-4250-84ee-42df8087cc3c", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -32236,7 +32536,7 @@ "_postman_previewlanguage": "json" }, { - "id": "548b0286-b1c0-446c-91d6-528dca43ec98", + "id": "fc075f5f-4780-4880-869e-b658a455a9fd", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -32276,12 +32576,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "01e42115-456d-41e8-aead-ed17dfc970b4", + "id": "8ebcf798-1bea-41e3-af71-7cad2b97cf4f", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -32321,12 +32621,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "2a862627-fa29-4367-92a7-507bd3ba2178", + "id": "f7ed7135-24f3-46ac-9e2d-64754fb06b91", "name": "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.", "originalRequest": { "url": { @@ -32371,7 +32671,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ce40d5d0-0d8b-4fb9-b882-4d0c913c01cb", + "id": "0022f5f5-704d-4cdf-82eb-cf86b6f4b786", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -32411,7 +32711,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -32422,7 +32722,7 @@ } }, { - "id": "10b18354-b5e3-411d-9b2d-d4c155cc00d6", + "id": "659d9c80-706e-4918-8d34-063be4ef17d5", "name": "Process identities under profile", "request": { "name": "Process identities under profile", @@ -32460,7 +32760,7 @@ }, "response": [ { - "id": "82a6723d-62de-4788-8d06-de6fb5c9780c", + "id": "a3d9c6c8-1389-4945-9e5b-27f579adde85", "name": "Accepted status after refresh has launched", "originalRequest": { "url": { @@ -32505,7 +32805,7 @@ "_postman_previewlanguage": "json" }, { - "id": "fa06aa4e-bf4f-4f3d-bbb3-b1cc47d48e49", + "id": "8a5b7455-ff4c-4c30-96ae-d1bcd43d24df", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -32545,12 +32845,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e6927d46-a49f-471c-9972-bd9d10afd477", + "id": "07e97bee-cad8-444b-9348-e443e60db96c", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -32595,7 +32895,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e76e8f1b-30a7-466d-a879-71a23ef0a10c", + "id": "8459f7c6-79f1-41cc-9cdb-5586ce3b9cc5", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -32635,12 +32935,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "751d7968-5432-4050-ade9-64509a8157e4", + "id": "47fb61f0-0322-433d-89f8-d1fd0ccfe4d8", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -32680,12 +32980,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "76013e24-a57d-463c-b290-c18b3eb3accd", + "id": "198037c9-46e7-4470-b583-51dd0ca89757", "name": "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.", "originalRequest": { "url": { @@ -32730,7 +33030,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6aa8eb4b-0664-4534-8ba4-c24618c599b4", + "id": "bb9cc20e-cdbf-408b-8395-890d3c1a2e3d", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -32770,7 +33070,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -32787,7 +33087,7 @@ "description": "Use this API to implement non-employee lifecycle management functionality. \nWith this functionality in place, administrators can create non-employee records and configure them for use in their organizations. \nThis allows organizations to provide secure access to non-employees and control that access. \n\nThe 'non-employee' term refers to any consultant, contractor, intern, or other user in an organization who is not a full-time permanent employee. \nOrganizations can track non-employees' access and activity in IdentityNow by creating and maintaining non-employee sources. \nOrganizations can have a maximum of 50 non-employee sources. \n\nBy using SailPoint's Non-Employee Lifecycle Management functionality, you agree to the following:\n\n- SailPoint is not responsible for storing sensitive data. \nYou may only add account attributes to non-employee identities that are necessary for business operations and are consistent with your contractual limitations on data that may be sent or stored in IdentityNow.\n\n- You are responsible for regularly downloading your list of non-employee accounts for all the sources you create and storing this list of accounts in a managed location to maintain an authoritative system of record and backup data for these accounts.\n\nTo manage non-employees in IdentityNow, administrators must create a non-employee source and add accounts to the source. \n\nTo create a non-employee source in IdentityNow, administrators must use the Admin panel to go to Connections > Sources.\nThey must then specify 'Non-Employee' in the 'Source Type' field. \nRefer to [Creating a Non-Employee Source](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#creating-a-non-employee-source) for more details about how to create non-employee sources.\n\nTo add accounts to a non-employee source in IdentityNow, administrators can select the non-employee source and add the accounts. \nThey can also use the 'Manage Non-Employees' widget on their user dashboards to reach the list of sources and then select the non-employee source they want to add the accounts to. \n\nAdministrators can either add accounts individually or in bulk. Each non-employee source can have a maximum of 20,000 accounts. \nTo add accounts in bulk, they must select the 'Bulk Upload' option and upload a CSV file. \nRefer to [Adding Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#adding-accounts) for more details about how to add accounts to non-employee sources.\n\nOnce administrators have created the non-employee source and added accounts to it, they can create identity profiles to generate identities for the non-employee accounts and manage the non-employee identities the same way they would any other identities. \n\nRefer to [Managing Non-Employee Sources and Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html) for more information about non-employee lifecycle management.\n", "item": [ { - "id": "fc9d3843-a573-46c8-bda2-85a429c1a87e", + "id": "4cab242b-2409-43e3-bac0-535ef7e6f1e6", "name": "Create Non-Employee Record", "request": { "name": "Create Non-Employee Record", @@ -32818,7 +33118,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"Excepteur_c_9\": \"\",\n \"magnac1_\": \"\"\n }\n}", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"minim89\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -32829,7 +33129,7 @@ }, "response": [ { - "id": "4b28fc24-10a6-40de-8ab0-0e36985775df", + "id": "c2d6139b-3de9-489c-855e-3e8dd81b9e9d", "name": "Created non-employee record.", "originalRequest": { "url": { @@ -32863,7 +33163,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"Excepteur_c_9\": \"\",\n \"magnac1_\": \"\"\n }\n}", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"minim89\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -32880,12 +33180,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"data\": {\n \"minim_f0\": \"\",\n \"velit59\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"data\": {\n \"elit_4ee\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "15023072-8b7b-4149-b4e8-f4594393e19b", + "id": "d5f44977-51b6-41cf-893f-b2a56fa8cc13", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -32919,7 +33219,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"Excepteur_c_9\": \"\",\n \"magnac1_\": \"\"\n }\n}", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"minim89\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -32936,12 +33236,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b3f89817-5d6e-4f27-bd88-3d889d2caa93", + "id": "8afed507-c8ac-402a-8a52-faa614e3ac7e", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -32975,7 +33275,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"Excepteur_c_9\": \"\",\n \"magnac1_\": \"\"\n }\n}", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"minim89\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -32997,7 +33297,7 @@ "_postman_previewlanguage": "json" }, { - "id": "fd845c00-1fa6-44a2-b598-7eec90f001e4", + "id": "5b381641-1c37-4b98-a490-93a65b6db319", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -33031,7 +33331,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"Excepteur_c_9\": \"\",\n \"magnac1_\": \"\"\n }\n}", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"minim89\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -33048,12 +33348,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "90779162-0173-476c-a549-55e311ac424f", + "id": "91b7933f-1cb7-4e40-9d45-a978f75a0b1d", "name": "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.", "originalRequest": { "url": { @@ -33087,7 +33387,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"Excepteur_c_9\": \"\",\n \"magnac1_\": \"\"\n }\n}", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"minim89\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -33109,7 +33409,7 @@ "_postman_previewlanguage": "json" }, { - "id": "113497ce-9e11-4472-b749-908ab67c2450", + "id": "d68afb51-5fb5-418a-a535-f58d7a6dc874", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -33143,7 +33443,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"Excepteur_c_9\": \"\",\n \"magnac1_\": \"\"\n }\n}", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"minim89\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -33160,7 +33460,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -33171,7 +33471,7 @@ } }, { - "id": "5726aa1e-2f34-4a63-b496-1a4c982f2d71", + "id": "09acfabe-d2b2-495f-876e-fe746dbbc54e", "name": "List Non-Employee Records", "request": { "name": "List Non-Employee Records", @@ -33246,7 +33546,7 @@ }, "response": [ { - "id": "984a3024-b62f-45cd-8bf0-9af03aedf8c0", + "id": "72e51455-faf9-4900-9216-a8be053415f7", "name": "Non-Employee record objects", "originalRequest": { "url": { @@ -33330,12 +33630,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"id\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"data\": {\n \"Excepteur_9e4\": \"\",\n \"inac0\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"data\": {\n \"in_c\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n]", + "body": "[\n {\n \"id\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"data\": {\n \"nonb\": \"\",\n \"consectetur_04\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"data\": {\n \"officia5\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "dedf9ed6-d070-449f-9fe6-6a2f3d8989f9", + "id": "c0073bd3-ab8a-4277-b912-f0a6e2a7d8a7", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -33419,12 +33719,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "39a3bed6-4651-469b-9e3e-49d3ef9c5ec3", + "id": "22baa93a-4e09-40e3-844a-994710f53d50", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -33513,7 +33813,7 @@ "_postman_previewlanguage": "json" }, { - "id": "06137526-40a3-488b-be74-5d5442be20e1", + "id": "74c91110-a7c7-4134-b45c-bd6476e0f2eb", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -33597,12 +33897,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "72aac5ee-b9d0-4dbc-a030-e325b29536b8", + "id": "f0973c2e-e8bb-4386-8d6c-da2acdd58eeb", "name": "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.", "originalRequest": { "url": { @@ -33691,7 +33991,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b50c855c-7ec3-4bfb-a735-b8fa6da168fd", + "id": "2a385092-0f58-49a2-975d-710a557ef375", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -33775,7 +34075,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -33786,7 +34086,7 @@ } }, { - "id": "7405d947-587f-4cb9-8e07-4bff4922b463", + "id": "d04459cd-6971-4b7d-81cf-73bde18b62ef", "name": "Get a Non-Employee Record", "request": { "name": "Get a Non-Employee Record", @@ -33823,7 +34123,7 @@ }, "response": [ { - "id": "47c61d8f-928b-48af-944f-985f62b16d10", + "id": "31bf5329-0efa-43aa-b109-02f6698ff84a", "name": "Non-Employee record object", "originalRequest": { "url": { @@ -33862,12 +34162,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"data\": {\n \"minim_f0\": \"\",\n \"velit59\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"data\": {\n \"elit_4ee\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7696cc72-52cc-48ef-8e07-27a74e305d05", + "id": "68f7dd73-1015-42de-adb0-c6d7bfc08f2c", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -33906,12 +34206,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6689961d-12bd-461a-9d98-1f54822996f5", + "id": "60c7240c-93b4-424f-a890-56557ebbbc1c", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -33955,7 +34255,7 @@ "_postman_previewlanguage": "json" }, { - "id": "80077326-ab25-46c3-85c5-ee959b21f29d", + "id": "ef82fd66-fea1-454c-9149-56b1018ebf76", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -33994,12 +34294,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e0d26e20-f4ec-4fb1-ac97-a1afafc5bc38", + "id": "27940b67-a33e-400c-a25a-0d43b2626f8b", "name": "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.", "originalRequest": { "url": { @@ -34043,7 +34343,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f8213a06-c0a5-4cac-8c3c-2658770be3a7", + "id": "3e09870a-54f0-4899-a9d2-3f599f1fe987", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -34082,7 +34382,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -34093,7 +34393,7 @@ } }, { - "id": "6a56480e-65cb-44a7-8b5d-201b8c985463", + "id": "5bca6698-61c8-4b01-a78f-e473deee167a", "name": "Update Non-Employee Record", "request": { "name": "Update Non-Employee Record", @@ -34132,7 +34432,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"Excepteur_c_9\": \"\",\n \"magnac1_\": \"\"\n }\n}", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"minim89\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -34143,7 +34443,7 @@ }, "response": [ { - "id": "233b0a95-6568-46e2-abcc-b157381c2981", + "id": "8598685a-d1b7-4d5d-91a0-6f97994bea71", "name": "An updated non-employee record.", "originalRequest": { "url": { @@ -34178,7 +34478,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"Excepteur_c_9\": \"\",\n \"magnac1_\": \"\"\n }\n}", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"minim89\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -34195,12 +34495,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"data\": {\n \"minim_f0\": \"\",\n \"velit59\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"data\": {\n \"elit_4ee\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1ed117c7-cbe3-4811-aa5d-eb99c3cf07cf", + "id": "7bfaf9bf-c22d-422a-94ed-0e7be0dab739", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -34235,7 +34535,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"Excepteur_c_9\": \"\",\n \"magnac1_\": \"\"\n }\n}", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"minim89\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -34252,12 +34552,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3728590a-34a8-4b6b-b08c-19b35b8f0f85", + "id": "4260bfac-261d-465c-b3fd-d6b1ac6c44a0", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -34292,7 +34592,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"Excepteur_c_9\": \"\",\n \"magnac1_\": \"\"\n }\n}", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"minim89\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -34314,7 +34614,7 @@ "_postman_previewlanguage": "json" }, { - "id": "316a0cbe-c692-45ad-b9e9-d18809dc5b7f", + "id": "4880a0c1-02db-468f-8747-cb213d165e89", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -34349,7 +34649,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"Excepteur_c_9\": \"\",\n \"magnac1_\": \"\"\n }\n}", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"minim89\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -34366,12 +34666,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6d6f6f5d-a823-4d4a-b2ee-c9ef41c6bd59", + "id": "1186495a-a867-4b6c-b985-d67cfd41d8c0", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -34406,7 +34706,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"Excepteur_c_9\": \"\",\n \"magnac1_\": \"\"\n }\n}", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"minim89\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -34423,12 +34723,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "37d16f50-3ac9-4453-9116-472dabcc0c6c", + "id": "dd98e2ae-40e1-4f96-abca-cf25739ca639", "name": "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.", "originalRequest": { "url": { @@ -34463,7 +34763,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"Excepteur_c_9\": \"\",\n \"magnac1_\": \"\"\n }\n}", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"minim89\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -34485,7 +34785,7 @@ "_postman_previewlanguage": "json" }, { - "id": "efab7eb3-d6cc-4f21-b70b-7f6b32c67173", + "id": "141137f7-fdd9-4f4d-985b-1fe62d4b7027", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -34520,7 +34820,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"Excepteur_c_9\": \"\",\n \"magnac1_\": \"\"\n }\n}", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"minim89\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -34537,7 +34837,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -34548,7 +34848,7 @@ } }, { - "id": "4f6faaf9-b712-4db4-a3d0-c3a3cf402d93", + "id": "8b990cc0-b29f-4acb-919c-55392744615e", "name": "Patch Non-Employee Record", "request": { "name": "Patch Non-Employee Record", @@ -34587,7 +34887,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -34598,7 +34898,7 @@ }, "response": [ { - "id": "7d57dbbb-c890-4582-b798-6bcda4565285", + "id": "2272a469-48a4-4c5a-914b-d6f47a95b7e7", "name": "A patched non-employee record.", "originalRequest": { "url": { @@ -34633,7 +34933,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -34650,12 +34950,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"data\": {\n \"minim_f0\": \"\",\n \"velit59\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"data\": {\n \"elit_4ee\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "074d15af-f074-4ade-8332-f284d213fe4f", + "id": "838d40b4-5147-4a27-8b94-193c5b8b9b9a", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -34690,7 +34990,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -34707,12 +35007,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3f380451-bf98-474a-a5a7-108ccf4df22d", + "id": "fe2eab7d-e4ff-4951-836b-d5cc0135a7d4", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -34747,7 +35047,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -34769,7 +35069,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7c639f91-a91c-4ed4-ba77-085023aee72a", + "id": "03b943ba-f2f0-42e0-b9ee-d61cafffcb85", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -34804,7 +35104,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -34821,12 +35121,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "9b2dc5dd-f39f-4be8-936d-4760a3304453", + "id": "6fccc0b3-d59f-4df8-9c3b-17f2f1ac1162", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -34861,7 +35161,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -34878,12 +35178,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "061d420f-fe6c-49b1-bbdb-b083a4ef636b", + "id": "712ce78e-8843-4f39-9784-e3e414ac35c5", "name": "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.", "originalRequest": { "url": { @@ -34918,7 +35218,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -34940,7 +35240,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ee7a286f-3e40-4525-a666-0384480131f5", + "id": "0e3b30c1-7445-4e75-9ace-458574cc2170", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -34975,7 +35275,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -34992,7 +35292,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -35003,7 +35303,7 @@ } }, { - "id": "c00bc0bb-5cd3-4691-9e60-eb1450b71e11", + "id": "fd0f5aab-56d9-4649-82e1-68c133b906c3", "name": "Delete Non-Employee Record", "request": { "name": "Delete Non-Employee Record", @@ -35040,7 +35340,7 @@ }, "response": [ { - "id": "f37fbd06-0b56-4451-a1f8-3da2e397c9ed", + "id": "43592f56-65e3-4f29-96bb-d35f8fc14483", "name": "No content - indicates the request was successful but there is no content to be returned in the response.", "originalRequest": { "url": { @@ -35074,7 +35374,7 @@ "_postman_previewlanguage": "text" }, { - "id": "ba264548-f1af-4bc9-9c04-bc66de7e9223", + "id": "9178b0f9-6f7a-495a-90f5-9e5ecb743596", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -35113,12 +35413,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d8fa0429-7984-4cbc-b8b4-edf21ede4236", + "id": "baef5828-74c8-42d8-abff-f3d50d472831", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -35162,7 +35462,7 @@ "_postman_previewlanguage": "json" }, { - "id": "68514a0a-f7fd-4e15-9ae7-0ca6ce1b4edf", + "id": "8063d7ec-09a7-40c5-8b11-cf36116fdc9e", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -35201,12 +35501,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "163d761e-652b-4354-a3ba-243eac1a2801", + "id": "60c01540-be8a-4977-b643-b08d381344b1", "name": "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.", "originalRequest": { "url": { @@ -35250,7 +35550,7 @@ "_postman_previewlanguage": "json" }, { - "id": "74b27c65-b02f-4f42-ad6a-68a5bdaf8825", + "id": "99cc8fb4-82bd-4b73-ab17-2e0148dc8f12", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -35289,7 +35589,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -35300,7 +35600,7 @@ } }, { - "id": "4fb7f0fa-61ab-4af8-a1b1-b299273424ce", + "id": "cb26fd4d-77e6-47cd-93d6-f38de809f0de", "name": "Delete Multiple Non-Employee Records", "request": { "name": "Delete Multiple Non-Employee Records", @@ -35343,7 +35643,7 @@ }, "response": [ { - "id": "6e9f4b10-ec6d-4d16-9e8f-8f0f2269d394", + "id": "fc3ce1b2-2b60-4d76-94e1-611b7b28c7f2", "name": "No content - indicates the request was successful but there is no content to be returned in the response.", "originalRequest": { "url": { @@ -35390,7 +35690,7 @@ "_postman_previewlanguage": "text" }, { - "id": "768af60b-4ac1-442d-b5a0-30fcb507e5e1", + "id": "75d27e8b-5c7a-45c2-a30d-29355c97c9f9", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -35442,12 +35742,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8756cb46-2bcf-4ad5-842f-db434c658aed", + "id": "07768916-eaae-432d-831f-c43f87b4a2dd", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -35504,7 +35804,7 @@ "_postman_previewlanguage": "json" }, { - "id": "afb6b26b-a6a8-4fb7-8566-c0f31abe7e0b", + "id": "9d4ca580-e787-4e20-b9e5-61b8106ede7c", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -35556,12 +35856,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c1c60fb1-3ba6-4e10-bb8a-0d6e916d8f5d", + "id": "321aced5-0f3a-4c50-b05f-a4a04e420368", "name": "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.", "originalRequest": { "url": { @@ -35618,7 +35918,7 @@ "_postman_previewlanguage": "json" }, { - "id": "baaa9ff3-655f-4985-9d75-67f3a9403569", + "id": "e53335d5-7785-4a80-b842-6c6e72bd992a", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -35670,7 +35970,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -35681,7 +35981,7 @@ } }, { - "id": "a06904bc-a639-43ed-9289-aef56a893b9e", + "id": "5041268b-1b3d-4fcc-bc2e-e6169f80dd40", "name": "Create Non-Employee Request", "request": { "name": "Create Non-Employee Request", @@ -35712,7 +36012,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"Excepteur_c_9\": \"\",\n \"magnac1_\": \"\"\n }\n}", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"minim89\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -35723,7 +36023,7 @@ }, "response": [ { - "id": "025e711b-998b-49cf-a3e2-726100f70230", + "id": "24ecfa69-0c63-4a17-9760-a12abf401490", "name": "Non-Employee request creation object", "originalRequest": { "url": { @@ -35757,7 +36057,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"Excepteur_c_9\": \"\",\n \"magnac1_\": \"\"\n }\n}", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"minim89\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -35774,12 +36074,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"nonEmployeeSource\": {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\"\n },\n \"data\": {\n \"cillum5\": \"\"\n },\n \"approvalItems\": [\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"REJECTED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"CANCELLED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n ],\n \"approvalStatus\": \"CANCELLED\",\n \"comment\": \"\",\n \"completionDate\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"nonEmployeeSource\": {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\"\n },\n \"data\": {\n \"anim955\": \"\",\n \"veniamad\": \"\"\n },\n \"approvalItems\": [\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"APPROVED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"REJECTED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n ],\n \"approvalStatus\": \"NOT_READY\",\n \"comment\": \"\",\n \"completionDate\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d740b18c-3e8c-4133-b01a-829a40ae4291", + "id": "4b5d342c-e9cc-4df8-b934-5d22333f129d", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -35813,7 +36113,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"Excepteur_c_9\": \"\",\n \"magnac1_\": \"\"\n }\n}", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"minim89\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -35830,12 +36130,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a3e3ff30-1360-4794-a15c-cac3ce8d622a", + "id": "2b1785ee-8f97-48bb-b03b-081d265e3760", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -35869,7 +36169,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"Excepteur_c_9\": \"\",\n \"magnac1_\": \"\"\n }\n}", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"minim89\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -35891,7 +36191,7 @@ "_postman_previewlanguage": "json" }, { - "id": "56391c5b-84ac-4e8d-8026-33cc39e4683d", + "id": "36e82822-2e62-4606-9ceb-6008bdf88048", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -35925,7 +36225,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"Excepteur_c_9\": \"\",\n \"magnac1_\": \"\"\n }\n}", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"minim89\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -35942,12 +36242,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "161f6123-57ef-4a68-af85-fff6a880023b", + "id": "c35422ef-0714-4566-ac2b-765e7308d869", "name": "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.", "originalRequest": { "url": { @@ -35981,7 +36281,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"Excepteur_c_9\": \"\",\n \"magnac1_\": \"\"\n }\n}", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"minim89\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -36003,7 +36303,7 @@ "_postman_previewlanguage": "json" }, { - "id": "efe4775f-b588-4038-90c9-318ee5be1d19", + "id": "b5dfdb5e-fbac-4e92-a95d-22f6f660ba9d", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -36037,7 +36337,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"Excepteur_c_9\": \"\",\n \"magnac1_\": \"\"\n }\n}", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"minim89\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -36054,7 +36354,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -36065,7 +36365,7 @@ } }, { - "id": "35b700b5-01b8-44d6-988a-b0efe46ed323", + "id": "325c21a3-6d42-47c4-ba23-9d0d1da3faf6", "name": "List Non-Employee Requests", "request": { "name": "List Non-Employee Requests", @@ -36149,7 +36449,7 @@ }, "response": [ { - "id": "275aca1e-0564-4a17-97e5-dab278cb4e82", + "id": "5da9c43b-e632-43ef-9129-a19ae3d3df20", "name": "List of non-employee request objects.", "originalRequest": { "url": { @@ -36242,12 +36542,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"nonEmployeeSource\": {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\"\n },\n \"data\": {\n \"esse8\": \"\",\n \"eu50b\": \"\"\n },\n \"approvalItems\": [\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"NOT_READY\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"CANCELLED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n ],\n \"approvalStatus\": \"CANCELLED\",\n \"comment\": \"\",\n \"completionDate\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"nonEmployeeSource\": {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\"\n },\n \"data\": {\n \"reprehenderit_58d\": \"\"\n },\n \"approvalItems\": [\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"APPROVED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"APPROVED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n ],\n \"approvalStatus\": \"CANCELLED\",\n \"comment\": \"\",\n \"completionDate\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n]", + "body": "[\n {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"nonEmployeeSource\": {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\"\n },\n \"data\": {\n \"Ut90\": \"\",\n \"id_4e\": \"\"\n },\n \"approvalItems\": [\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"APPROVED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"CANCELLED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n ],\n \"approvalStatus\": \"REJECTED\",\n \"comment\": \"\",\n \"completionDate\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"nonEmployeeSource\": {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\"\n },\n \"data\": {\n \"ullamco_767\": \"\",\n \"est8\": \"\",\n \"laborum6b\": \"\"\n },\n \"approvalItems\": [\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"PENDING\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"CANCELLED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n ],\n \"approvalStatus\": \"NOT_READY\",\n \"comment\": \"\",\n \"completionDate\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "36825a6e-ed58-41ed-9c17-938d7aa0d2d1", + "id": "9138e105-883b-4581-999f-fab1ad03c9f5", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -36340,12 +36640,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3a4a5ab1-61f2-4854-bf14-6086adca4a3f", + "id": "d5fe2e59-67b4-426b-92f2-ef9b493c1be3", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -36443,7 +36743,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a903b240-583c-49a7-a4b3-e5a53fe963a9", + "id": "bf85f354-117f-4922-81f2-703da4e8af01", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -36536,12 +36836,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0b956a14-61c3-40a6-a25c-ef7658678196", + "id": "c55cf36e-7d92-48ad-b534-60d76ef500ae", "name": "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.", "originalRequest": { "url": { @@ -36639,7 +36939,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7b4c002a-2053-46f0-b4c2-23e17b4f3dea", + "id": "8a96124c-4d55-448b-8640-e21c5e1215c4", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -36732,7 +37032,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -36743,7 +37043,7 @@ } }, { - "id": "741b521c-6263-4edc-ba1a-e3125656d613", + "id": "f154ce08-3926-4e0e-a2be-d2c78dbd4b23", "name": "Get a Non-Employee Request", "request": { "name": "Get a Non-Employee Request", @@ -36780,7 +37080,7 @@ }, "response": [ { - "id": "d83c23e6-f4a4-4287-b490-6ebec3773374", + "id": "639d21fc-4956-40a2-a5c1-a6f5faa2f460", "name": "Non-Employee request object.", "originalRequest": { "url": { @@ -36819,12 +37119,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"nonEmployeeSource\": {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\"\n },\n \"data\": {\n \"cillum5\": \"\"\n },\n \"approvalItems\": [\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"REJECTED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"CANCELLED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n ],\n \"approvalStatus\": \"CANCELLED\",\n \"comment\": \"\",\n \"completionDate\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"nonEmployeeSource\": {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\"\n },\n \"data\": {\n \"anim955\": \"\",\n \"veniamad\": \"\"\n },\n \"approvalItems\": [\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"APPROVED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"REJECTED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n ],\n \"approvalStatus\": \"NOT_READY\",\n \"comment\": \"\",\n \"completionDate\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "260ea493-8604-4a72-b708-4b71f5ba45f4", + "id": "b250e75e-aa1d-437d-abf9-b936a05a3b9a", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -36863,12 +37163,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "fdd5f50d-eacd-4e90-b49a-026bd3219338", + "id": "b891fc7d-b693-4db1-9879-79586b6ca761", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -36912,7 +37212,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a9d8169b-5833-43b1-8acb-4d7e2161aa41", + "id": "a47ac3a5-7f17-479f-b102-3d312a36036a", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -36951,12 +37251,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "f756cf6e-1a10-481d-ad84-1bd6e2748619", + "id": "21d4b02e-619a-49e6-bc76-e6be6973d80a", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -36995,12 +37295,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0f96f3b5-f076-43b4-9c9a-d0330bb7865f", + "id": "b377ae73-7778-4ecb-adc6-054579015175", "name": "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.", "originalRequest": { "url": { @@ -37044,7 +37344,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e3268c9a-b963-4591-8ebe-defc4897152c", + "id": "7114031b-32f8-4bf2-8d10-1e00ea11ef76", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -37083,7 +37383,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -37094,7 +37394,7 @@ } }, { - "id": "4d7662ca-7198-43cd-82a9-adc9a098141e", + "id": "68ad21de-8789-4292-a49b-2a6ef5266031", "name": "Delete Non-Employee Request", "request": { "name": "Delete Non-Employee Request", @@ -37131,7 +37431,7 @@ }, "response": [ { - "id": "41cdfb29-9829-4518-ae8b-8cce6b906782", + "id": "71f768bf-3b6c-4ffa-a139-ebb89e80b2ab", "name": "No content - indicates the request was successful but there is no content to be returned in the response.", "originalRequest": { "url": { @@ -37165,7 +37465,7 @@ "_postman_previewlanguage": "text" }, { - "id": "d3e480ef-4574-42c3-9c53-f1889f979bd5", + "id": "9c984a15-d6ed-4aa0-8925-719a88de1930", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -37204,12 +37504,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1e42716e-8e15-4f7c-b902-e2292afaf1b3", + "id": "68fd1ba6-3618-4fac-8890-8c61d398bcdb", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -37253,7 +37553,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d1e25d1d-7538-4844-be60-342f1de7b34f", + "id": "2b5d2bc0-0c37-409c-9c45-fffdb74b3040", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -37292,12 +37592,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "4278aadb-1b90-44a4-a5ae-506a77614530", + "id": "19b69cdd-7d0c-45c3-afec-a87e41674fdf", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -37336,12 +37636,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "fc7ec51c-1d96-4aa2-9b95-84c3c7e28ab1", + "id": "d3539e34-d9a5-4c4c-bfc4-94a1c9a28138", "name": "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.", "originalRequest": { "url": { @@ -37385,7 +37685,7 @@ "_postman_previewlanguage": "json" }, { - "id": "51282a73-f967-4bdb-b623-5862a85011a5", + "id": "0de0be3c-34fc-4ee0-a065-9fc27e3a6ffe", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -37424,7 +37724,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -37435,7 +37735,7 @@ } }, { - "id": "65617090-be36-47ad-bdb5-24d607e4235f", + "id": "ace87c23-ad28-4ab8-8539-dd7bc2c8fa9a", "name": "Get Summary of Non-Employee Requests", "request": { "name": "Get Summary of Non-Employee Requests", @@ -37473,7 +37773,7 @@ }, "response": [ { - "id": "f27dcb51-67bd-48cb-8788-07714a27bd69", + "id": "c849ae49-b7de-4038-8d70-f96856e16888", "name": "Non-Employee request summary object.", "originalRequest": { "url": { @@ -37518,7 +37818,7 @@ "_postman_previewlanguage": "json" }, { - "id": "228b9dde-4c61-4f69-bf58-fead42603ebe", + "id": "1de3ca7d-1299-4aca-91c2-46f9c2708ee2", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -37558,12 +37858,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "76099093-36c2-4c50-b0e7-72c282cd9932", + "id": "6f0ae61f-77c3-4cda-9ea6-4c6ba8db965e", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -37608,7 +37908,7 @@ "_postman_previewlanguage": "json" }, { - "id": "cc7e9fa1-52fa-46bc-827a-5a14e12239a2", + "id": "c55586b9-e99b-49a8-bd31-6e356e20d3ef", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -37648,12 +37948,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "9e6a7410-f221-4ef9-bd14-5e675763f482", + "id": "87ab880c-be39-46bb-a271-bf5f7d78930d", "name": "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.", "originalRequest": { "url": { @@ -37698,7 +37998,7 @@ "_postman_previewlanguage": "json" }, { - "id": "208178de-ea7b-4973-84ad-2e10472dd09d", + "id": "8daa558f-c742-4405-9ff9-cf05f53d4d20", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -37738,7 +38038,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -37749,7 +38049,7 @@ } }, { - "id": "e61760ba-1f98-4986-8a75-360657e01449", + "id": "68936983-71e8-40e4-b8ae-453d45be938e", "name": "Create Non-Employee Source", "request": { "name": "Create Non-Employee Source", @@ -37791,7 +38091,7 @@ }, "response": [ { - "id": "03b6ec5c-27c1-4652-9b60-a366f79320e0", + "id": "d2c30829-fa5c-476d-b932-c71627cf9782", "name": "Created non-employee source.", "originalRequest": { "url": { @@ -37842,12 +38142,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"approvers\": [\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"modified\": \"\",\n \"created\": \"\",\n \"cloudExternalId\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"approvers\": [\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"modified\": \"\",\n \"created\": \"\",\n \"cloudExternalId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "4ecfd88b-8625-48e1-8b1c-9833b65662b6", + "id": "5e9bf7db-07b9-4f75-96b9-320b3854fde4", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -37898,12 +38198,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "9268ba73-8b18-44b4-bd53-05414cf1c171", + "id": "f2708d33-6476-4915-918b-5361ca90e163", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -37959,7 +38259,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1b96c045-ca0d-481e-86c7-fa6e58cd3d87", + "id": "7fb7421a-f352-40ce-a38d-9f980c858439", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -38010,12 +38310,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3f6f7b43-5125-409c-a9d6-3c7201f56f66", + "id": "1057c61f-56f6-4604-8aab-21d7a31a0a8d", "name": "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.", "originalRequest": { "url": { @@ -38071,7 +38371,7 @@ "_postman_previewlanguage": "json" }, { - "id": "041476b2-cfd2-4d8d-a164-82e1844e2fdd", + "id": "9734ebd5-f121-44a0-8337-0902cde2ac88", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -38122,7 +38422,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -38133,7 +38433,7 @@ } }, { - "id": "9136920c-9253-4117-968b-ceee2a2e850d", + "id": "85609cd8-7709-4279-b5a2-237ec47609be", "name": "List Non-Employee Sources", "request": { "name": "List Non-Employee Sources", @@ -38217,7 +38517,7 @@ }, "response": [ { - "id": "3e21a9b2-8ca1-4350-91a5-d796585de65e", + "id": "037c1dc7-fb10-4c40-b0b4-f5d1b690d059", "name": "List of non-employee sources objects.", "originalRequest": { "url": { @@ -38310,12 +38610,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"approvers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeCount\": \"\"\n },\n {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"approvers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n }\n ],\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeCount\": \"\"\n }\n]", + "body": "[\n {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"approvers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n }\n ],\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeCount\": \"\"\n },\n {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"approvers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n }\n ],\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeCount\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d4d773ba-7bef-4104-9c58-3d3ff39ed258", + "id": "b4586b27-dc9e-4a83-b5b6-2f5801320b6d", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -38408,12 +38708,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "22dbd654-9a22-4889-9795-0750a6832e03", + "id": "7b757669-6f03-4384-a5e9-fc231a3ac389", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -38511,7 +38811,7 @@ "_postman_previewlanguage": "json" }, { - "id": "907aade3-03af-4288-8b32-f4f2c41bf71e", + "id": "2e99c354-7d49-42de-a13b-48c43ed15cd5", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -38604,12 +38904,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "83db150d-bb78-4cfb-9609-5bff91a42b35", + "id": "2c739eb2-be39-409f-ab8a-f1df643a20cd", "name": "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.", "originalRequest": { "url": { @@ -38707,7 +39007,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8c78725d-0b44-48b8-9569-6c0372940c56", + "id": "c9f209ec-2d66-45b8-b594-5e0f5af6538a", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -38800,7 +39100,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -38811,7 +39111,7 @@ } }, { - "id": "c7cdb3cb-b89e-4283-a3d1-ff946c894443", + "id": "e25ebb27-5577-4d99-8bb2-d8b5a3e45ff0", "name": "Get a Non-Employee Source", "request": { "name": "Get a Non-Employee Source", @@ -38848,7 +39148,7 @@ }, "response": [ { - "id": "2f56294c-e3e6-4f2a-b2af-a3d3ca6e1101", + "id": "296ea5ba-c46c-4513-8c0b-759eddb8d88a", "name": "Non-Employee source object.", "originalRequest": { "url": { @@ -38887,12 +39187,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"approvers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"modified\": \"\",\n \"created\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"approvers\": [\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"modified\": \"\",\n \"created\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "00b00af4-655b-4b14-ad4c-b18205b3a5be", + "id": "af7f342c-6864-4cc8-ac84-395623799922", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -38931,12 +39231,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7ca53165-5535-4b76-8ad3-14c4293943f9", + "id": "26c27761-8738-46a2-8a23-0e5c09ee7a62", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -38980,7 +39280,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4b690b30-5ca9-4ae2-959c-885f01a5a7ee", + "id": "1d09a5c2-6c89-479e-b4d4-84b6c09dc8fa", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -39019,12 +39319,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b021304c-d4dd-49b3-b35d-3b0b299b9fbd", + "id": "40dc4c52-d6df-4781-b510-a41104e0a533", "name": "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.", "originalRequest": { "url": { @@ -39068,7 +39368,7 @@ "_postman_previewlanguage": "json" }, { - "id": "38c2b48b-b6ea-4c84-97cc-98afa24b3ec6", + "id": "a1da5da0-cf55-42d2-903a-faff8f2997f8", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -39107,7 +39407,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -39118,7 +39418,7 @@ } }, { - "id": "6f3de89f-93aa-4545-a454-cecb698373d1", + "id": "e76c7d0f-bbad-4d9c-aa9c-370909b67033", "name": "Patch a Non-Employee Source", "request": { "name": "Patch a Non-Employee Source", @@ -39157,7 +39457,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -39168,7 +39468,7 @@ }, "response": [ { - "id": "fd92f8d8-b86d-4b6b-ae94-579a072d6633", + "id": "a65a1832-7642-4b1f-8863-3ac431e2648a", "name": "A patched non-employee source object.", "originalRequest": { "url": { @@ -39203,7 +39503,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -39220,12 +39520,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"approvers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"modified\": \"\",\n \"created\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"approvers\": [\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"modified\": \"\",\n \"created\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "883b8780-11f2-4d10-80f6-11ce7d862160", + "id": "48413622-17e5-4495-b741-60ce6e96aeb6", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -39260,7 +39560,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -39277,12 +39577,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "39f0143a-4dcd-4bac-a920-01b8ddc17976", + "id": "1cfd2440-c8ff-4097-bb7c-6238e6c4263d", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -39317,7 +39617,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -39339,7 +39639,7 @@ "_postman_previewlanguage": "json" }, { - "id": "598dce7c-cbb6-41b3-a9ce-b8aac6e4fa28", + "id": "084872b7-1bf9-4c3e-9d58-5b4985279c78", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -39374,7 +39674,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -39391,12 +39691,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b57ea8d8-ea0a-4eb7-a8ad-7f739ccafc7d", + "id": "bee703d7-7db7-40bf-9056-04d29d32ac45", "name": "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.", "originalRequest": { "url": { @@ -39431,7 +39731,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -39453,7 +39753,7 @@ "_postman_previewlanguage": "json" }, { - "id": "33ceaf25-9377-4a71-95a0-f9f1dad14981", + "id": "732b52e3-ef54-41d0-8d9f-8cb1fd1c1e3e", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -39488,7 +39788,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -39505,7 +39805,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -39516,7 +39816,7 @@ } }, { - "id": "32f4fb4b-2f12-451a-a785-6e8769e32cf0", + "id": "d5c2ed67-41dd-45b2-9c00-fd26698b0641", "name": "Delete Non-Employee Source", "request": { "name": "Delete Non-Employee Source", @@ -39553,7 +39853,7 @@ }, "response": [ { - "id": "9bb6b8e9-f15b-47ff-aa8b-1fe432ccd19d", + "id": "724bb73c-1a79-4b48-a9d1-9c7a00e5c4d1", "name": "No content - indicates the request was successful but there is no content to be returned in the response.", "originalRequest": { "url": { @@ -39587,7 +39887,7 @@ "_postman_previewlanguage": "text" }, { - "id": "75cd959c-011b-474d-a3ee-59e5db293d9d", + "id": "ebda75ca-de38-44be-a3c8-773646b064aa", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -39626,12 +39926,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5601a56c-700c-4d44-bd7c-da643a15af38", + "id": "6e89aa16-b2bd-49db-8420-13d0263f47a5", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -39675,7 +39975,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8e07756c-9296-4282-bdf9-eb24b2719ab8", + "id": "e9b70825-a17c-4b85-b4d4-01b6b817406d", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -39714,12 +40014,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "63f147af-e336-4543-bef1-3d208aefb36d", + "id": "c2ba3379-4f2d-4194-9e25-8e84487b9d55", "name": "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.", "originalRequest": { "url": { @@ -39763,7 +40063,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5fcf091a-1467-4972-8313-a47883eeb794", + "id": "2479bfe9-6bfa-408d-a4c4-21770c7b730c", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -39802,7 +40102,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -39813,7 +40113,7 @@ } }, { - "id": "7980514a-14c0-4684-a807-6452b9d0e090", + "id": "751f7ebf-fa2b-4859-9149-858a5a711438", "name": "Exports Non-Employee Records to CSV", "request": { "name": "Exports Non-Employee Records to CSV", @@ -39852,7 +40152,7 @@ }, "response": [ { - "id": "b6cee665-f7c7-4743-b186-22bca970280e", + "id": "583e3c2a-5bef-4047-b8cf-8a86487d315d", "name": "Exported CSV", "originalRequest": { "url": { @@ -39898,7 +40198,7 @@ "_postman_previewlanguage": "text" }, { - "id": "86fc0bb9-fe89-494d-bf50-f1d97832fcd9", + "id": "0c52327e-1e4a-4b56-8f96-41e012e45d7d", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -39939,12 +40239,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ed743abe-4681-41bd-a0f2-4426fc4dc067", + "id": "910e0702-cd63-4a14-be4e-08d2cda992c6", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -39990,7 +40290,7 @@ "_postman_previewlanguage": "json" }, { - "id": "06af79c8-b58c-4003-a76e-fed59bf5589b", + "id": "29ceaca8-b2c5-41c1-a362-bef3bbd3c259", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -40031,12 +40331,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "93280472-2bf2-4c22-a7cf-c71ccc0f5225", + "id": "a34112b8-e741-4f20-867b-174b02bbe563", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -40077,12 +40377,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8549dd94-0531-4911-901d-6b6e96fde4f7", + "id": "58fea161-357b-4d53-a9e3-d96660f1ed1e", "name": "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.", "originalRequest": { "url": { @@ -40128,7 +40428,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a739fff5-fe94-44d3-8d11-6751754ebe3c", + "id": "5db0b856-dc5b-414b-a870-080c2d087aa3", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -40169,7 +40469,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -40180,7 +40480,7 @@ } }, { - "id": "b03d6311-c713-47de-9be1-e07be3af8949", + "id": "7784beb3-e5ef-4594-b827-d74bc0b5f121", "name": "Imports, or Updates, Non-Employee Records", "request": { "name": "Imports, or Updates, Non-Employee Records", @@ -40235,7 +40535,7 @@ }, "response": [ { - "id": "f279a679-286a-47ec-ac15-d018119acfdd", + "id": "a1713590-f6b3-4163-a5ea-d8aa6ca203dd", "name": "The CSV was accepted to be bulk inserted now or at a later time.", "originalRequest": { "url": { @@ -40297,7 +40597,7 @@ "_postman_previewlanguage": "json" }, { - "id": "64d5bcd3-06d4-4e39-a893-592142b6867c", + "id": "ea308154-60cf-4a89-836f-9ed5dec53dff", "name": "Client Error - Returned if the request body is invalid.\nThe response body will contain the list of specific errors with one on each line.\n", "originalRequest": { "url": { @@ -40354,12 +40654,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3c8815ac-d359-4775-9fce-7c159a23179c", + "id": "661b4f85-fbed-4735-b9d5-bf0b3f54c1fb", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -40421,7 +40721,7 @@ "_postman_previewlanguage": "json" }, { - "id": "97bddfb8-df7f-40d1-a782-df13ab0cf136", + "id": "4a817458-9026-404b-8b7d-d52628834554", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -40478,12 +40778,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c909d2e0-374a-4e4d-abfe-120a33165739", + "id": "4b28bf6a-9599-40b2-8536-20b902f938c6", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -40540,12 +40840,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "9bc4d21d-e15e-4bc2-9cab-59df5b5af19c", + "id": "1fd30507-a72b-4865-9524-4c54391d0a47", "name": "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.", "originalRequest": { "url": { @@ -40607,7 +40907,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d7aef132-833f-4033-85dc-cb543e611962", + "id": "6c8f8119-621b-46a0-b5fd-810ac321a807", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -40664,7 +40964,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -40675,7 +40975,7 @@ } }, { - "id": "3d478bd2-268c-4b31-8b86-95a618860852", + "id": "d28618b5-ea56-4d21-9010-c0642105da25", "name": "Obtain the status of bulk upload on the source", "request": { "name": "Obtain the status of bulk upload on the source", @@ -40714,7 +41014,7 @@ }, "response": [ { - "id": "78588ba7-1003-4e3f-9151-eb65ba52be02", + "id": "daa6f607-c56e-4a37-b52c-4209b9277a6d", "name": "Status of the newest bulk-upload job, if any.", "originalRequest": { "url": { @@ -40755,12 +41055,12 @@ "value": "application/json" } ], - "body": "{\n \"status\": \"PENDING\"\n}", + "body": "{\n \"status\": \"IN_PROGRESS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "cc2fa953-e813-4e72-9eb6-9f75058bad80", + "id": "bf0e9764-78c7-463d-89cc-a21af744aa05", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -40801,12 +41101,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "2783e06d-962b-41c4-924a-b8bbf3d8c0ed", + "id": "b9d03efc-7e05-418d-b735-82042bcb0d48", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -40852,7 +41152,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6985714c-892f-48cc-96bd-0b9bf8232a4c", + "id": "df7eab97-0859-4424-a5c1-d38ac86bbb97", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -40893,12 +41193,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ccb35e31-9c7f-4e22-92b0-3e86292a3199", + "id": "08aed9af-5436-4663-a5bf-e63eb27e63d9", "name": "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.", "originalRequest": { "url": { @@ -40944,7 +41244,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d02c2a69-95a3-4f4f-9009-62c4cdd22fbb", + "id": "ea185e72-d723-4389-9ceb-a1641b629502", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -40985,7 +41285,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -40996,7 +41296,7 @@ } }, { - "id": "9d46c8ac-4908-4b85-b541-cec2e28fa992", + "id": "34ca970d-b0c0-4e39-ad18-eb0deb010074", "name": "Exports Source Schema Template", "request": { "name": "Exports Source Schema Template", @@ -41035,7 +41335,7 @@ }, "response": [ { - "id": "56219855-e627-4761-9c78-4cb923fe71d6", + "id": "1c9f7f71-e9c9-467a-b344-aa77553cfff5", "name": "Exported Source Schema Template", "originalRequest": { "url": { @@ -41081,7 +41381,7 @@ "_postman_previewlanguage": "text" }, { - "id": "973f6077-4c18-466b-9a8b-dbd4cc463237", + "id": "807239fa-d974-4081-b682-3a8e731a8d56", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -41122,12 +41422,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e968216a-512d-41dd-8acb-5c862e85fca9", + "id": "da137ee3-37ac-43c0-92d7-ab3082f7cf1f", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -41173,7 +41473,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d0705e36-3729-47ef-83b9-36ae8853bca3", + "id": "179fc30c-609e-41c3-8f4a-6aaf1a1ac803", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -41214,12 +41514,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ef9617b6-3130-49bd-a244-fd63f8156d2b", + "id": "90ca933b-58d9-4d16-acc0-4362811d5bed", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -41260,12 +41560,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b10ac9cd-a076-4bd7-be70-23069663e35c", + "id": "5cfff844-9323-4deb-baa0-0f36d4b6ff32", "name": "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.", "originalRequest": { "url": { @@ -41311,7 +41611,7 @@ "_postman_previewlanguage": "json" }, { - "id": "2c2ab93b-7096-44ec-8f82-cca1f52e2706", + "id": "2881c905-374d-45bd-a914-533a3a07541d", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -41352,7 +41652,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -41363,7 +41663,7 @@ } }, { - "id": "a04c9421-5213-4bbd-8521-ee233a146191", + "id": "ffbaa3cc-c67a-40ae-94b7-d69e4d78f60b", "name": "Get List of Non-Employee Approval Requests", "request": { "name": "Get List of Non-Employee Approval Requests", @@ -41447,7 +41747,7 @@ }, "response": [ { - "id": "7b6b7a26-5451-4e7e-be1e-14a8837383b4", + "id": "9a34d071-e482-43f8-b088-47797d69f183", "name": "List of approval items.", "originalRequest": { "url": { @@ -41540,12 +41840,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"PENDING\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeRequest\": {\n \"id\": \"\",\n \"requester\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"NOT_READY\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeRequest\": {\n \"id\": \"\",\n \"requester\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n }\n }\n]", + "body": "[\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"PENDING\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeRequest\": {\n \"id\": \"\",\n \"requester\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"CANCELLED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeRequest\": {\n \"id\": \"\",\n \"requester\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6541f65a-a457-49c1-b8b5-4c2a79c22fc4", + "id": "b0b50eb0-88d4-44d1-aca2-b8c8f27e9768", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -41638,12 +41938,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "9d9e114b-d32a-4569-921f-3d74631d2ad4", + "id": "c42e5b16-5801-4612-9de8-598fdec7c42a", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -41741,7 +42041,7 @@ "_postman_previewlanguage": "json" }, { - "id": "97e0aef2-cb88-481b-9cb1-c81ba0e71f8e", + "id": "68680ac3-2f5b-425c-901f-9ac791323cce", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -41834,12 +42134,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6737c639-ca1e-4833-999d-38efe741dc7e", + "id": "7dfb0505-33ce-4df2-9d1b-4e505035fa2a", "name": "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.", "originalRequest": { "url": { @@ -41937,7 +42237,7 @@ "_postman_previewlanguage": "json" }, { - "id": "63877790-6972-4f46-ae6b-a1b87be9403b", + "id": "a7bd84ed-afd2-4e79-86c7-05e92919460b", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -42030,7 +42330,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -42041,7 +42341,7 @@ } }, { - "id": "2293ca21-7fad-4ce1-84e7-d8463b6126ce", + "id": "14c2eaa9-da62-4b36-9251-2c2f73c70a28", "name": "Get a non-employee approval item detail", "request": { "name": "Get a non-employee approval item detail", @@ -42088,7 +42388,7 @@ }, "response": [ { - "id": "c226cb3d-ec13-4998-a583-20e622a0b104", + "id": "1cd2ce63-d0a8-4264-99fe-78900b1315ef", "name": "Non-Employee approval item object.", "originalRequest": { "url": { @@ -42137,12 +42437,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"REJECTED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeRequest\": {\n \"id\": \"\",\n \"requester\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"nonEmployeeSource\": {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"schemaAttributes\": [\n {\n \"type\": \"IDENTITY\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n },\n {\n \"type\": \"DATE\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n }\n ]\n },\n \"data\": {\n \"ipsum_cc\": \"\",\n \"labore__\": \"\",\n \"occaecat_43\": \"\",\n \"Lorem75\": \"\",\n \"do_62f\": \"\"\n },\n \"approvalStatus\": \"APPROVED\",\n \"comment\": \"\",\n \"completionDate\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n}", + "body": "{\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"PENDING\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeRequest\": {\n \"id\": \"\",\n \"requester\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"nonEmployeeSource\": {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"schemaAttributes\": [\n {\n \"type\": \"IDENTITY\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n }\n ]\n },\n \"data\": {\n \"Lorem_747\": \"\",\n \"veniam3e\": \"\"\n },\n \"approvalStatus\": \"NOT_READY\",\n \"comment\": \"\",\n \"completionDate\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7adc819e-43ef-40e3-9a7b-a31119eec3f4", + "id": "344f891a-ba1b-4bef-9aea-283a1516d397", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -42191,12 +42491,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "76eb6972-7a8f-438d-b616-26678269a56e", + "id": "5a563359-9254-49ee-8033-d22f71006242", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -42250,7 +42550,7 @@ "_postman_previewlanguage": "json" }, { - "id": "200fdb29-2565-4763-b102-f7ccac1b3d25", + "id": "6724c539-5cfb-462f-a1f1-f6a831b77a5a", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -42299,12 +42599,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1c088315-028c-4dd0-8057-a641c7c0276c", + "id": "7273c460-489f-4d54-8a41-9c8898e9f6fb", "name": "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.", "originalRequest": { "url": { @@ -42358,7 +42658,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8d4c67ab-9a3a-43e6-a839-1610802577f3", + "id": "3c5d0137-f715-4d3b-93e3-414675848d62", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -42407,7 +42707,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -42418,7 +42718,7 @@ } }, { - "id": "c160854c-ed97-4341-b1a4-19ffa036ea91", + "id": "20823316-a499-4f42-9154-78e26f4c192b", "name": "Approve a Non-Employee Request", "request": { "name": "Approve a Non-Employee Request", @@ -42469,7 +42769,7 @@ }, "response": [ { - "id": "4432eade-482a-4f07-85d0-75ec9703db71", + "id": "e69d43f3-e334-48b8-9ef8-a16e095c91f3", "name": "Non-Employee approval item object.", "originalRequest": { "url": { @@ -42522,12 +42822,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"REJECTED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeRequest\": {\n \"id\": \"\",\n \"requester\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n }\n}", + "body": "{\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"PENDING\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeRequest\": {\n \"id\": \"\",\n \"requester\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3fd7fb67-686a-470b-91dc-cbd2280cb090", + "id": "2dcf4a12-be2a-4454-9fe2-9e78347de593", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -42580,12 +42880,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "f79d1324-8a41-4c4b-9e70-d3068070cbdd", + "id": "1c286432-1b03-451a-9177-e7a6a7192cd2", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -42643,7 +42943,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5dd11c8b-c91f-4838-b5bc-9f20ba02c237", + "id": "bbb52d44-efcf-4f97-a3f0-88123ca4ef33", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -42696,12 +42996,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "bea80917-fa7a-4fd9-8e24-335ee42c8512", + "id": "4d76b501-6913-4b75-9d24-8a425ca275a8", "name": "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.", "originalRequest": { "url": { @@ -42759,7 +43059,7 @@ "_postman_previewlanguage": "json" }, { - "id": "14f68ca4-5f0a-4495-8adc-15dbf64aba1f", + "id": "3ec0c1e0-f13b-4e12-8cce-d957a7a2ccdd", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -42812,7 +43112,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -42823,7 +43123,7 @@ } }, { - "id": "7aa55b55-9412-41aa-9a0b-d9a13f6e2a80", + "id": "b5e46b20-f73c-4b32-8b89-009d127b1937", "name": "Reject a Non-Employee Request", "request": { "name": "Reject a Non-Employee Request", @@ -42874,7 +43174,7 @@ }, "response": [ { - "id": "0d299aad-086b-4166-8086-7a25148f6034", + "id": "75b10ed3-d61c-42ea-b1fb-0cce16036030", "name": "Non-Employee approval item object.", "originalRequest": { "url": { @@ -42927,12 +43227,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"REJECTED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeRequest\": {\n \"id\": \"\",\n \"requester\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n }\n}", + "body": "{\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"PENDING\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeRequest\": {\n \"id\": \"\",\n \"requester\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6a471f5e-3ad3-4122-b1ca-3e30e689028e", + "id": "129970d9-ebf7-4fd5-9448-0dffbc00b36f", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -42985,12 +43285,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "fcaa4f33-5d5d-4ea7-89c2-ea4c74f2b6a6", + "id": "d1ac630c-5e89-45ba-bfbd-7707e6707515", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -43048,7 +43348,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5f4cc354-5499-4567-af98-feff42c37769", + "id": "eeefa481-07a3-4d0c-b464-d1a991707e6a", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -43101,12 +43401,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5f466382-e819-454c-9fbd-59203d582c28", + "id": "660b4b60-bc98-43ed-8998-d34349096ca9", "name": "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.", "originalRequest": { "url": { @@ -43164,7 +43464,7 @@ "_postman_previewlanguage": "json" }, { - "id": "38ca9cc1-baa8-4151-b4df-0a8bf6a75f2b", + "id": "0fb5272c-4817-4c65-a233-811102fba613", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -43217,7 +43517,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -43228,7 +43528,7 @@ } }, { - "id": "55d20bd9-81f9-4297-98a9-1ed06d89dcb8", + "id": "c26f0b92-0a46-4b1c-ae29-ba3c5bbf944c", "name": "Get Summary of Non-Employee Approval Requests", "request": { "name": "Get Summary of Non-Employee Approval Requests", @@ -43266,7 +43566,7 @@ }, "response": [ { - "id": "f2692ef7-95fe-4eed-8c62-66d925ae8dd4", + "id": "5c33cd85-458d-4c93-8a02-e55b4bd3e4ad", "name": "summary of non-employee approval requests", "originalRequest": { "url": { @@ -43311,7 +43611,7 @@ "_postman_previewlanguage": "json" }, { - "id": "34b0c74e-fd4b-426b-a467-9fad7874c503", + "id": "f49c4c36-eed8-4f96-a6d7-f06e01dec986", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -43351,12 +43651,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "2fc5ff9e-f2b7-4cba-a6fa-ae4cb4d3a343", + "id": "7035aba4-d8a4-4ea0-a472-587448fe9440", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -43401,7 +43701,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b5682888-9754-4091-a1f2-3e10bd896a0d", + "id": "7ac00d4e-29ab-4762-b87a-edba1b273d43", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -43441,12 +43741,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "14b5d072-9a75-4dcb-a048-95a8555088da", + "id": "46c7b4b3-21bc-4350-b429-a7bff584457d", "name": "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.", "originalRequest": { "url": { @@ -43491,7 +43791,7 @@ "_postman_previewlanguage": "json" }, { - "id": "fbfb43ca-2be2-4996-8f94-daf62a9cf3bd", + "id": "0b9f9d1e-f81c-4e60-8f70-3ff06196dd68", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -43531,7 +43831,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -43542,7 +43842,7 @@ } }, { - "id": "28ff9cfb-49f6-44b4-83b7-e1c2b5d01f30", + "id": "0f6ed251-0675-4b73-92b4-2030649f6417", "name": "List Schema Attributes Non-Employee Source", "request": { "name": "List Schema Attributes Non-Employee Source", @@ -43580,7 +43880,7 @@ }, "response": [ { - "id": "6ea58239-49f8-451a-b1c9-7d359477877a", + "id": "49af0066-3375-4872-88ca-f7c041275d6a", "name": "A list of Schema Attributes", "originalRequest": { "url": { @@ -43620,12 +43920,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"type\": \"TEXT\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n }\n]", + "body": "[\n {\n \"type\": \"DATE\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "47fcf778-1a05-4441-bdb5-76fa3dde5914", + "id": "dac38a28-585e-4ad3-afe3-8d90b1c781e7", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -43665,12 +43965,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "543465d2-1dff-4f75-8be3-e6bac073c392", + "id": "ab68d2ab-dcf9-429d-8d86-9655803d58ac", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -43715,7 +44015,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f530ee39-30dd-4736-a5be-9d441664d1e3", + "id": "e6efe9dc-6d58-49bf-a0a0-a1b5c448de22", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -43755,12 +44055,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1efccb2c-b0f1-426d-a63a-582ba2cba222", + "id": "a4e4c68d-d121-43ff-9439-f6e13be52fd2", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -43800,12 +44100,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "74df3de2-482b-4580-aa32-dbaa9cdf4760", + "id": "08875f79-c280-4414-8d78-76be4f4887d6", "name": "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.", "originalRequest": { "url": { @@ -43850,7 +44150,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8f42c7bc-3a97-4436-9c4d-562eef8b67c4", + "id": "66b25feb-f538-46fb-9828-4f990cd6399f", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -43890,7 +44190,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -43901,7 +44201,7 @@ } }, { - "id": "21ca8903-4b46-4728-b136-3a1d2f439021", + "id": "0042e650-f076-4353-b234-9d63a72c9d1f", "name": "Create a new Schema Attribute for Non-Employee Source", "request": { "name": "Create a new Schema Attribute for Non-Employee Source", @@ -43952,7 +44252,7 @@ }, "response": [ { - "id": "7d6c3290-4fb1-44cc-b94a-60cf18ba9dcc", + "id": "71f65b1f-50ef-4eb0-9092-b73038f61135", "name": "Schema Attribute created.", "originalRequest": { "url": { @@ -44005,12 +44305,12 @@ "value": "application/json" } ], - "body": "{\n \"type\": \"TEXT\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", + "body": "{\n \"type\": \"DATE\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5b2c143b-f819-40a9-bbf7-2d30790f43e0", + "id": "56853b14-3003-4f62-a840-178016511694", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -44063,12 +44363,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d45ed04e-bc2d-41e3-b79d-605e0ba9a84b", + "id": "623c5b7b-bf48-4f58-92eb-85a63c5ca30a", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -44126,7 +44426,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c83572ea-1aff-4402-bc98-6888831d7584", + "id": "5a480ff2-55ba-4232-8055-76937528893d", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -44179,12 +44479,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a4f58c50-d213-4e7c-922f-da8a07327d6a", + "id": "86ba9e25-a8a5-4a81-92a1-467229760ee4", "name": "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.", "originalRequest": { "url": { @@ -44242,7 +44542,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0c23e8be-48ad-471a-9a9c-a78ccf3e2881", + "id": "bcdbb138-01eb-4fd6-bef8-d602ba257e81", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -44295,7 +44595,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -44306,7 +44606,7 @@ } }, { - "id": "ddd1aaa2-8597-4ca8-accd-3049e31b4f0a", + "id": "b5f471ab-9e2d-4d2f-bdb4-a0fad70d7d87", "name": "Delete all custom schema attributes for Non-Employee Source", "request": { "name": "Delete all custom schema attributes for Non-Employee Source", @@ -44344,7 +44644,7 @@ }, "response": [ { - "id": "5db93165-ff86-4872-9327-d3e4243c9035", + "id": "0f781fd4-93de-440e-9d48-d2823813d402", "name": "All custon Schema Attributes were successfully deleted.", "originalRequest": { "url": { @@ -44379,7 +44679,7 @@ "_postman_previewlanguage": "text" }, { - "id": "ab76b0e5-b1c3-4b73-b6f6-024a14898906", + "id": "5859da5b-1517-460a-9986-c06822d022c6", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -44419,12 +44719,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "944b0851-d4c1-46a3-bd45-4d08ae6b87cf", + "id": "ea362e24-b944-4648-9f6c-70d5e19192d9", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -44469,7 +44769,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e0174e87-c12c-4fb3-adc2-fa0d7b99e1e9", + "id": "b8d991e5-0806-45fe-ad05-1db54723681f", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -44509,12 +44809,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a6946a53-b6b3-4f53-8852-7b5a14c942a2", + "id": "c8030761-b7b5-4d88-8438-25b5f1e8d510", "name": "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.", "originalRequest": { "url": { @@ -44559,7 +44859,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ddcee7ca-5385-4f64-bcd8-f687183bd68e", + "id": "8e6836dc-8149-46df-a7d6-134247676a13", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -44599,7 +44899,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -44610,7 +44910,7 @@ } }, { - "id": "640290c3-7254-42f0-9d9c-c918dd4b59ab", + "id": "7c3a5512-32c7-4195-b3f2-302ac026a70b", "name": "Get Schema Attribute Non-Employee Source", "request": { "name": "Get Schema Attribute Non-Employee Source", @@ -44655,7 +44955,7 @@ }, "response": [ { - "id": "846100f0-b9b2-4e51-a6f6-b9dd2ab36608", + "id": "ff71f4b5-f7ab-4387-8e22-a1031c15eb64", "name": "The Schema Attribute", "originalRequest": { "url": { @@ -44696,12 +44996,12 @@ "value": "application/json" } ], - "body": "{\n \"type\": \"TEXT\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", + "body": "{\n \"type\": \"DATE\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "fc630613-b841-45c8-bb82-853d0b8d7105", + "id": "372809f9-83d5-4057-bf3e-fe41aedde4d2", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -44742,12 +45042,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "df16b235-32c0-4053-965c-5d9e40717dea", + "id": "0476a308-d970-478d-9cd9-9ad166601a66", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -44793,7 +45093,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b49e2b47-cccc-449a-ac1b-50e3b9090785", + "id": "7ce60a74-f4eb-441c-ba1b-6ca5856660d3", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -44834,12 +45134,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "92f0523a-8890-4a64-8f8a-d60572bae105", + "id": "616bec03-82f2-4bc8-a903-bcfe3411ff7e", "name": "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.", "originalRequest": { "url": { @@ -44885,7 +45185,7 @@ "_postman_previewlanguage": "json" }, { - "id": "180ace65-0228-4c53-8e52-5dc1d1e02fcd", + "id": "fd855e96-ad67-43d6-bb80-c1eb2a800ebd", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -44926,7 +45226,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -44937,7 +45237,7 @@ } }, { - "id": "8ca284a2-2dee-4a43-9b29-1be28b7462a9", + "id": "572c512c-1f9d-4871-b696-463ef6c3a0a2", "name": "Patch a Schema Attribute for Non-Employee Source", "request": { "name": "Patch a Schema Attribute for Non-Employee Source", @@ -44984,7 +45284,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -44995,7 +45295,7 @@ }, "response": [ { - "id": "bd2d48dc-5221-4203-bf98-8f69ebbda1b4", + "id": "54f852ce-3b51-4f44-835f-e6fdc5f64d51", "name": "The Schema Attribute was successfully patched.", "originalRequest": { "url": { @@ -45032,7 +45332,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -45049,12 +45349,12 @@ "value": "application/json" } ], - "body": "{\n \"type\": \"TEXT\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", + "body": "{\n \"type\": \"DATE\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "f079f876-5e77-4dc2-93a0-a54a070b4dac", + "id": "3c822601-78cf-4566-95c1-32decb52575f", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -45091,7 +45391,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -45108,12 +45408,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c58fc406-6a6f-425e-8acd-e47975963a3e", + "id": "9aa11ba5-8944-4244-ac7e-f167463ed7ca", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -45150,7 +45450,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -45172,7 +45472,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8b230577-9569-476c-9e4f-d69c65e3f86d", + "id": "55005162-fea1-44c9-93f3-419e86844aea", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -45209,7 +45509,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -45226,12 +45526,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b2319e83-4f8c-4d28-abe8-93a42b052c8f", + "id": "7a307d9a-7d28-4b04-95b9-58baf0434001", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -45268,7 +45568,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -45285,12 +45585,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "91b79a1e-46e7-4ab3-86ac-248a0f404325", + "id": "0fdff736-8c41-4079-bb62-027905a7cdfb", "name": "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.", "originalRequest": { "url": { @@ -45327,7 +45627,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -45349,7 +45649,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8a9f5943-79d2-4d34-83d6-ecd7250f317a", + "id": "72dadd32-0371-4480-9c50-b6d1c2f37bd7", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -45386,7 +45686,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -45403,7 +45703,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -45414,7 +45714,7 @@ } }, { - "id": "e99734fe-7621-4d85-8c0e-c059e59272aa", + "id": "6d7e1f95-ec39-4692-bf0b-b515fab251c1", "name": "Delete a Schema Attribute for Non-Employee Source", "request": { "name": "Delete a Schema Attribute for Non-Employee Source", @@ -45459,7 +45759,7 @@ }, "response": [ { - "id": "ee9f3157-c4ea-41eb-b0fe-00f53ed8ff70", + "id": "1b82dee2-3db3-429b-bfcc-fa2e013d2492", "name": "The Schema Attribute was successfully deleted.", "originalRequest": { "url": { @@ -45495,7 +45795,7 @@ "_postman_previewlanguage": "text" }, { - "id": "96506c80-2900-4510-b381-f4e1f2095a6c", + "id": "9098fa7e-bcf3-4653-8976-f0fe3651f100", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -45536,12 +45836,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "06bbd236-679a-4b1f-88c8-b4bc9ecb6473", + "id": "09ddb684-000f-4688-a61e-d1d1293aa022", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -45587,7 +45887,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6f59cf6c-0275-4684-9d78-b7624872ece1", + "id": "ad972a59-7fc4-4abd-8548-bec18151edaf", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -45628,12 +45928,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ebd99604-e168-48da-9a0c-4c7a264f421a", + "id": "73f41106-c013-4352-bde5-85eab44f9509", "name": "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.", "originalRequest": { "url": { @@ -45679,7 +45979,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ed3e4472-6a41-437b-8d6e-0c8b09842918", + "id": "10015093-cb37-4fab-9111-dd8438f4b34a", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -45720,7 +46020,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -45737,7 +46037,7 @@ "description": "Use this API to implement OAuth client functionality. \nWith this functionality in place, users with the appropriate security scopes can create and configure OAuth clients to use as a way to obtain authorization to use the IdentityNow REST API.\nRefer to [Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information about OAuth and how it works with the IdentityNow REST API.\n", "item": [ { - "id": "bbebe4e7-786c-4af8-a5c0-10b6b45ac090", + "id": "76c65b63-a198-4664-bf55-c517984087f1", "name": "List OAuth Clients", "request": { "name": "List OAuth Clients", @@ -45776,7 +46076,7 @@ }, "response": [ { - "id": "ac739522-58f8-404e-9c49-636068445861", + "id": "8de75df6-c3f2-4d6c-827c-3166db766524", "name": "List of OAuth clients.", "originalRequest": { "url": { @@ -45824,12 +46124,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"id\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"REFRESH_TOKEN\",\n \"CLIENT_CREDENTIALS\"\n ],\n \"accessType\": \"ONLINE\",\n \"type\": \"PUBLIC\",\n \"internal\": \"\",\n \"enabled\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"lastUsed\": \"\"\n },\n {\n \"id\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"CLIENT_CREDENTIALS\"\n ],\n \"accessType\": \"ONLINE\",\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"enabled\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"lastUsed\": \"\"\n }\n]", + "body": "[\n {\n \"id\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"CLIENT_CREDENTIALS\",\n \"CLIENT_CREDENTIALS\"\n ],\n \"accessType\": \"ONLINE\",\n \"type\": \"PUBLIC\",\n \"internal\": \"\",\n \"enabled\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"lastUsed\": \"\"\n },\n {\n \"id\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"type\": \"PUBLIC\",\n \"internal\": \"\",\n \"enabled\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"lastUsed\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "4c9a638a-0c63-42e0-aad0-9e9679d1aa0b", + "id": "57c0a7e0-b634-48d2-9b08-78f360840b80", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -45877,12 +46177,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "abb3377a-da9a-445e-b0fc-fd90bda54182", + "id": "bceb1dfa-4893-4e54-83cb-1be33b424975", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -45935,7 +46235,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9329a019-99e0-4acc-8fb0-b91daca56561", + "id": "41e4f0f0-20b4-4e59-be2a-2b82f1f99ce7", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -45983,12 +46283,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "2307f64e-d47e-4889-a97e-42122b173261", + "id": "50d9174d-4d78-43e0-a5a4-5375349451a5", "name": "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.", "originalRequest": { "url": { @@ -46041,7 +46341,7 @@ "_postman_previewlanguage": "json" }, { - "id": "2acdbc83-39a9-4944-819b-60276001e64d", + "id": "c1fbdc8c-8d1a-4a7e-a89d-0907c6d73f03", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -46089,7 +46389,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -46100,7 +46400,7 @@ } }, { - "id": "0c6ccc8c-76ca-4b79-b637-f5e968d6a62f", + "id": "80d6bc0d-3d59-4d09-bb85-6dbc6f1a37dd", "name": "Create OAuth Client", "request": { "name": "Create OAuth Client", @@ -46131,7 +46431,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"PUBLIC\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"REFRESH_TOKEN\",\n \"AUTHORIZATION_CODE\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -46142,7 +46442,7 @@ }, "response": [ { - "id": "fa46ed46-5831-4e83-9201-6ce27f8b0460", + "id": "e45420ee-a688-4ae3-8360-8a2439ed8956", "name": "Request succeeded.", "originalRequest": { "url": { @@ -46176,7 +46476,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"PUBLIC\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"REFRESH_TOKEN\",\n \"AUTHORIZATION_CODE\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -46193,12 +46493,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"secret\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"CLIENT_CREDENTIALS\"\n ],\n \"accessType\": \"OFFLINE\",\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"enabled\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "body": "{\n \"id\": \"\",\n \"secret\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"type\": \"PUBLIC\",\n \"internal\": \"\",\n \"enabled\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ab8ccef2-6780-4697-9a3e-007a8b3d5a65", + "id": "37d33941-def6-4786-81b6-2944d3eb65f9", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -46232,7 +46532,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"PUBLIC\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"REFRESH_TOKEN\",\n \"AUTHORIZATION_CODE\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -46249,12 +46549,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5abad2d1-0b03-4e23-be30-1b00fc161e5c", + "id": "3a4f724a-77e8-4d28-b045-4dc3485ab932", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -46288,7 +46588,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"PUBLIC\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"REFRESH_TOKEN\",\n \"AUTHORIZATION_CODE\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -46310,7 +46610,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a20de3e1-a637-4d2b-a782-d9a2386e9550", + "id": "8d4ff891-e874-44bf-a427-1fd05ce620d7", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -46344,7 +46644,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"PUBLIC\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"REFRESH_TOKEN\",\n \"AUTHORIZATION_CODE\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -46361,12 +46661,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "180d0864-1908-4a58-bf18-b68447e35278", + "id": "b1af39f8-54de-4600-920e-2a81247f27f1", "name": "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.", "originalRequest": { "url": { @@ -46400,7 +46700,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"PUBLIC\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"REFRESH_TOKEN\",\n \"AUTHORIZATION_CODE\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -46422,7 +46722,7 @@ "_postman_previewlanguage": "json" }, { - "id": "69cebf13-be6c-4483-9962-fe06c6621631", + "id": "0cd879c4-6293-4e55-80ad-a7046ef23104", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -46456,7 +46756,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"PUBLIC\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"REFRESH_TOKEN\",\n \"AUTHORIZATION_CODE\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -46473,7 +46773,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -46484,7 +46784,7 @@ } }, { - "id": "479dccfd-c544-4191-99da-b910864c246e", + "id": "232f7ca8-682a-49d6-a9cb-1053f10428c3", "name": "Get OAuth Client", "request": { "name": "Get OAuth Client", @@ -46521,7 +46821,7 @@ }, "response": [ { - "id": "1642368c-77fb-4404-bc57-643a76bf8106", + "id": "dbcb959b-c92f-4034-8229-48dea2366954", "name": "Request succeeded.", "originalRequest": { "url": { @@ -46560,12 +46860,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"enabled\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"lastUsed\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"CLIENT_CREDENTIALS\",\n \"AUTHORIZATION_CODE\"\n ],\n \"accessType\": \"ONLINE\",\n \"type\": \"PUBLIC\",\n \"internal\": \"\",\n \"enabled\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"lastUsed\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c77e4d94-e944-40bc-851b-d72b68f50c37", + "id": "25c1ade1-a32b-4919-8eb7-788ea9d22baa", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -46604,12 +46904,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6940cd21-c6b6-4d07-9fd4-c4d77f27e389", + "id": "44de744e-2aa2-4139-8ad7-00b8ff61621e", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -46653,7 +46953,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7e05c845-0b1b-46f4-920b-635ac86ccaef", + "id": "3652b57a-a4c1-4d6a-8ceb-5997a2af8155", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -46692,12 +46992,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "46976ca0-497b-4305-a779-9ccd085b7681", + "id": "97279a27-543b-4d6a-aa27-74622287b86d", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -46736,12 +47036,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8faf6f8e-64bd-43f8-bda5-71e2aa885cf0", + "id": "415360ca-2cbc-4c97-9ec2-c3db298aa054", "name": "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.", "originalRequest": { "url": { @@ -46785,7 +47085,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1b662a4a-6d92-4eb1-b0f6-4bc315f0e603", + "id": "136fa669-54b2-4ece-9247-5e6d7a645ada", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -46824,7 +47124,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -46835,7 +47135,7 @@ } }, { - "id": "77c2c7c7-065c-4eea-9ed3-b55d8457d31e", + "id": "3ad916b3-00e3-41d6-9e4d-8826ac7df8c3", "name": "Delete OAuth Client", "request": { "name": "Delete OAuth Client", @@ -46872,7 +47172,7 @@ }, "response": [ { - "id": "ec7feeed-5c82-46cf-84c2-d485157c3976", + "id": "fe2cd135-c3f4-4fc2-b5b5-6c1d24917715", "name": "No content.", "originalRequest": { "url": { @@ -46906,7 +47206,7 @@ "_postman_previewlanguage": "text" }, { - "id": "7dbf05b8-2ce0-47d7-88cb-57057c05b18c", + "id": "9b74e687-c3e7-478a-9807-24f9913beba8", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -46945,12 +47245,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6699227f-6d0c-4dc2-9db0-16bf5e5e5e91", + "id": "013cdbd1-9e78-48ea-b764-e688406a8edb", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -46994,7 +47294,7 @@ "_postman_previewlanguage": "json" }, { - "id": "af0b48e0-dd99-4ede-9df1-b98f24387081", + "id": "95188303-2346-446c-a136-15e1ae485fe7", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -47033,12 +47333,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e90897c8-199e-4ccf-af27-dd62f13c25ed", + "id": "9154a0b1-3a77-47e2-b441-3ea9e963c826", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -47077,12 +47377,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6d22a0b2-3d3d-473a-b116-3e60ba7baa56", + "id": "81d4780a-e867-457a-bbb2-4fc7a1ca23ff", "name": "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.", "originalRequest": { "url": { @@ -47126,7 +47426,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a949ac5b-6904-43ee-a39f-575a622676b8", + "id": "d5341aef-ee9a-484b-9287-6481410ff3bb", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -47165,7 +47465,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -47176,7 +47476,7 @@ } }, { - "id": "8c7aedc8-d411-4dbf-9944-fe834bccd6ae", + "id": "e0029b6e-661a-40c4-82dd-713be8f819cb", "name": "Patch OAuth Client", "request": { "name": "Patch OAuth Client", @@ -47215,7 +47515,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -47226,7 +47526,7 @@ }, "response": [ { - "id": "370b389a-162c-4457-bbbe-fb6f586efdec", + "id": "5325c927-f023-4a78-8a69-7cd37395cba6", "name": "Indicates the PATCH operation succeeded, and returns the OAuth client's new representation.", "originalRequest": { "url": { @@ -47261,7 +47561,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -47278,12 +47578,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"enabled\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"lastUsed\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"CLIENT_CREDENTIALS\",\n \"AUTHORIZATION_CODE\"\n ],\n \"accessType\": \"ONLINE\",\n \"type\": \"PUBLIC\",\n \"internal\": \"\",\n \"enabled\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"lastUsed\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "4081b1b2-160a-4da8-8b3e-63b208693448", + "id": "652f2728-5330-46cd-998e-babc629baaad", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -47318,7 +47618,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -47335,12 +47635,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "4f9636f9-ae35-4a15-9aa8-1d82576b6b66", + "id": "8acc5a94-f50c-4192-8093-cd9d0ce6cebd", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -47375,7 +47675,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -47397,7 +47697,7 @@ "_postman_previewlanguage": "json" }, { - "id": "970b130c-ef0d-4f5c-b575-fba278800399", + "id": "c1b12b47-22ae-44a1-b50e-ddc26a1c25bc", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -47432,7 +47732,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -47449,12 +47749,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "43623041-84f2-45b4-91bd-a38fbfea8417", + "id": "7c90775b-0b56-481d-bd98-17edc466badb", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -47489,7 +47789,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -47506,12 +47806,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3e5b13f2-c030-41f9-963b-22559398e678", + "id": "68aac2b8-e5b0-4547-8a52-c310af5018f5", "name": "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.", "originalRequest": { "url": { @@ -47546,7 +47846,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -47568,7 +47868,7 @@ "_postman_previewlanguage": "json" }, { - "id": "39b4be86-e70e-47cf-b0f2-00f3dbc13703", + "id": "34458bbb-c75d-4301-861a-22839b71861d", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -47603,7 +47903,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -47620,7 +47920,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -47637,7 +47937,7 @@ "description": "Use this API to implement organization password configuration functionality. \nWith this functionality in place, organization administrators can create organization-specific password configurations. \n\nThese configurations include details like custom password instructions, as well as digit token length and duration. \n\nRefer to [Configuring User Authentication for Password Resets](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html) for more information about organization password configuration functionality.\n", "item": [ { - "id": "e8692117-2789-46a4-9a14-193fcc04cfa6", + "id": "a6f0d920-0f56-4e9a-8fd2-d65d46b69695", "name": "Get Password Org Config", "request": { "name": "Get Password Org Config", @@ -47666,7 +47966,7 @@ }, "response": [ { - "id": "155b3342-b7ca-4b91-8a87-b2d4e3dc17c7", + "id": "1bb02534-c11b-46b5-b8cd-6de765b42b49", "name": "Reference to the password org config.", "originalRequest": { "url": { @@ -47709,7 +48009,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d793bbc5-f311-4c2c-be25-094e063cd051", + "id": "548c9169-7223-4b8e-b666-569e6d343e6e", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -47747,12 +48047,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c3b69a2a-f933-4647-a741-e393701224ff", + "id": "2d22b3c7-6903-4a33-a754-41414218265f", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -47795,7 +48095,7 @@ "_postman_previewlanguage": "json" }, { - "id": "78299b26-e53a-4a02-a9a9-97d58375c53c", + "id": "33f69476-55fa-49b0-833e-ef6dbc7996f0", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -47833,12 +48133,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "86d8792d-a18e-443a-92d5-3f63c8968e5f", + "id": "51fa9c00-bfee-4e74-b1c7-0ae3a0bd4c03", "name": "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.", "originalRequest": { "url": { @@ -47881,7 +48181,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ba5cf232-c1d3-42ff-b519-9e7101f3440d", + "id": "48656719-c24b-4957-a482-387af449f947", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -47919,7 +48219,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -47930,7 +48230,7 @@ } }, { - "id": "1081ea2d-d1d2-4059-905f-ebe373c35b12", + "id": "0380f769-53a9-41bc-abd9-403d3af85a4d", "name": "Update Password Org Config", "request": { "name": "Update Password Org Config", @@ -47972,7 +48272,7 @@ }, "response": [ { - "id": "2388e12e-e026-4373-982d-8dd566d5ef75", + "id": "3325de31-d343-4ce4-823f-6efea47bdb6f", "name": "Reference to the password org config.", "originalRequest": { "url": { @@ -48028,7 +48328,7 @@ "_postman_previewlanguage": "json" }, { - "id": "cbfb4478-952f-4585-8de2-9b8a8f8dc579", + "id": "c906fe99-8d03-4f60-b0af-9bd8f7899c88", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -48079,12 +48379,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1ff45748-7c50-4490-9041-ce99e2bf0368", + "id": "08ebeb5e-2d2e-4548-9e67-1e9746b6fa9d", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -48140,7 +48440,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3cb47840-b84c-4c7b-b740-df91c371f923", + "id": "88ee8ab7-7c20-4023-a25a-06d9a898b4c7", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -48191,12 +48491,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0a10bf5a-b970-477e-bd0a-1aeece315e30", + "id": "704a2ef3-3ad8-412b-bd19-ccfd9498a155", "name": "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.", "originalRequest": { "url": { @@ -48252,7 +48552,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6dbb74ce-a5e1-444d-9708-cae39cbb417f", + "id": "4959ec65-217d-4176-bcb7-adfd02d6d641", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -48303,7 +48603,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -48314,7 +48614,7 @@ } }, { - "id": "d6ba2bf1-f959-459c-b6be-c78155eaa27e", + "id": "f0d692ed-80f5-4cbb-a52f-ad50bcb9c6d0", "name": "Create Password Org Config", "request": { "name": "Create Password Org Config", @@ -48356,7 +48656,7 @@ }, "response": [ { - "id": "1329688a-91c4-42a4-86c2-b2eb215ed8e0", + "id": "a15d4a65-925c-4cfa-9f12-e7b78a7b0149", "name": "Reference to the password org config.", "originalRequest": { "url": { @@ -48412,7 +48712,7 @@ "_postman_previewlanguage": "json" }, { - "id": "eacdf139-e424-4b7a-bcd9-0825878b1270", + "id": "54339dae-fef8-469f-97b5-7dde77bf709f", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -48463,12 +48763,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "2cc04c99-c9cd-4abc-a8bc-57eeee9df4df", + "id": "dd083647-cd41-4dee-8add-be59aea8946b", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -48524,7 +48824,7 @@ "_postman_previewlanguage": "json" }, { - "id": "539bc4ea-0972-4f1e-841b-78985df4371e", + "id": "ad6ce685-cb3a-49af-b3f5-0181d2815135", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -48575,12 +48875,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "cfad385f-c0ea-4f47-a48e-9d3b2ff1d4a5", + "id": "1f98ef3e-8e41-4a6f-b026-77571cb85870", "name": "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.", "originalRequest": { "url": { @@ -48636,7 +48936,7 @@ "_postman_previewlanguage": "json" }, { - "id": "180c29ba-bd08-4dc4-b8d9-4c6f680b17e6", + "id": "78670eff-3725-4b8b-9ad5-2a8ebacdbe25", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -48687,7 +48987,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -48704,7 +49004,7 @@ "description": "Use this API to implement password management functionality. \nWith this functionality in place, users can manage their identity passwords for all their applications.\n\nIn IdentityNow, users can select their names in the upper right corner of the page and use the drop-down menu to select Password Manager. \nPassword Manager lists the user's identity's applications, possibly grouped to share passwords. \nUsers can then select 'Change Password' to update their passwords. \n\nGrouping passwords allows users to update their passwords more broadly, rather than requiring them to update each password individually. \nPassword Manager may list the applications and sources in the following groups:\n\n- Password Group: This refers to a group of applications that share a password. \nFor example, a user can use the same password for Google Drive, Google Mail, and YouTube. \nUpdating the password for the password group updates the password for all its included applications.\n\n- Multi-Application Source: This refers to a source with multiple applications that share a password. \nFor example, a user can have a source, G Suite, that includes the Google Calendar, Google Drive, and Google Mail applications. \nUpdating the password for the multi-application source updates the password for all its included applications. \n\n- Applications: These are applications that do not share passwords with other applications.\n\nAn organization may require some authentication for users to update their passwords. \nUsers may be required to answer security questions or use a third-party authenticator before they can confirm their updates. \n\nRefer to [Managing Passwords](https://documentation.sailpoint.com/saas/user-help/accounts/passwords.html) for more information about password management.\n", "item": [ { - "id": "468c68d2-a86a-4b54-ba00-1acaef10e908", + "id": "3137c9a7-d9dd-43d0-be61-067efc8d6a4b", "name": "Query Password Info", "request": { "name": "Query Password Info", @@ -48746,7 +49046,7 @@ }, "response": [ { - "id": "576f1c35-a327-4bb8-9df9-195296d3f185", + "id": "44d8a538-1dc6-4511-906b-4f6fb492802c", "name": "Reference to the password info.", "originalRequest": { "url": { @@ -48802,7 +49102,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6bfd1226-c937-4588-a17b-e018b5a4e4cf", + "id": "49b75095-f20c-41c5-a391-5bec3e49ee8f", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -48853,12 +49153,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "42d1e408-d2fc-4c98-820c-1de98cb718b5", + "id": "1e7a9755-8080-4d9d-ae7a-2b2bb5259d03", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -48914,7 +49214,7 @@ "_postman_previewlanguage": "json" }, { - "id": "657f11bb-8aa8-4854-bd68-c8dd2e167c62", + "id": "36591d20-8402-4eee-aa89-5c1e7f699c55", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -48965,12 +49265,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "78179710-b194-47bf-8353-be5db9f5f31b", + "id": "1cca7c78-6e27-4740-811d-1ba6ef33e4b9", "name": "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.", "originalRequest": { "url": { @@ -49026,7 +49326,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0ca9c0bd-9344-4d96-8e69-ffcc5b122575", + "id": "887cada0-372a-45ef-ae21-05bc90a7320c", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -49077,7 +49377,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -49088,7 +49388,7 @@ } }, { - "id": "06e715f7-2175-48a3-8eb8-c6c18dbfbbbe", + "id": "dd7c10d3-d9da-46e0-91c7-37220cc28264", "name": "Set Identity's Password", "request": { "name": "Set Identity's Password", @@ -49130,7 +49430,7 @@ }, "response": [ { - "id": "a29476d2-953a-468a-933c-985aaf13ba1a", + "id": "252e2053-c419-4bc9-ae32-98c83c87fb9b", "name": "Reference to the password change.", "originalRequest": { "url": { @@ -49181,12 +49481,12 @@ "value": "application/json" } ], - "body": "{\n \"requestId\": \"\",\n \"state\": \"FINISHED\"\n}", + "body": "{\n \"requestId\": \"\",\n \"state\": \"IN_PROGRESS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "513edbea-f0e1-47e8-bbe9-2474f3c11f68", + "id": "ecb1da99-f8cc-40db-9a95-36710710a015", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -49237,12 +49537,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a57bab95-7fa5-484f-b1af-60dc33aa0e9c", + "id": "5fd441ab-3289-4c81-b7a2-7f346c5216ee", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -49298,7 +49598,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1b828ed5-0b15-47dd-b660-a6ac83e7854f", + "id": "1457d06d-7c0a-4ad6-9500-b09d40455441", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -49349,12 +49649,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "4c927f94-7e9e-473e-a6b0-05e26e4811fb", + "id": "0422b28e-f5d9-45e8-97db-97e74e5b8fe8", "name": "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.", "originalRequest": { "url": { @@ -49410,7 +49710,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0e320b82-2054-4ee6-886d-411f5f4e6786", + "id": "1bd3cfdd-421c-40ff-9bc3-fa29e8a708be", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -49461,7 +49761,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -49472,7 +49772,7 @@ } }, { - "id": "1b192df3-26a1-44e4-a0f8-2f3f61a8544e", + "id": "83ee7f95-768c-4875-b8b5-301a8cb526b4", "name": "Get Password Change Request Status", "request": { "name": "Get Password Change Request Status", @@ -49509,7 +49809,7 @@ }, "response": [ { - "id": "ec17ba00-c6ed-4263-8296-cf152883290a", + "id": "96665e10-d6e5-4c45-87b6-19d1001e22e4", "name": "Status of the password change request", "originalRequest": { "url": { @@ -49548,12 +49848,12 @@ "value": "application/json" } ], - "body": "{\n \"requestId\": \"\",\n \"state\": \"IN_PROGRESS\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "body": "{\n \"requestId\": \"\",\n \"state\": \"FAILED\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6f005851-10ad-4825-84d7-c95076db3a0a", + "id": "c0cf6ab0-7d45-48f0-b1b5-de8abb238c50", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -49592,12 +49892,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "647521a8-b39a-41cc-8bda-63b8dce7fc5e", + "id": "0a47386e-5fb7-4524-ba9c-1d392bbbca86", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -49641,7 +49941,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5627a447-e6d8-431b-abb7-e8d4be27b031", + "id": "ea7abdab-4ef3-464f-8bcc-54a85d932127", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -49680,12 +49980,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "9df1c8f3-b17c-45b3-8c7c-a411be19f006", + "id": "bf55d0d4-851e-4790-9b53-98fa61a770d6", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -49724,12 +50024,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b0a92799-1fc4-41f3-ad66-715fb293eaa5", + "id": "a2dd5bce-4d67-41bc-b8a4-98f11d00829f", "name": "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.", "originalRequest": { "url": { @@ -49773,7 +50073,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8d14c3c4-e838-467a-8d5c-b064a2eae122", + "id": "54838c18-9d1c-401a-b237-c42033f77c59", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -49812,7 +50112,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -49829,7 +50129,7 @@ "description": "Use this API to implement password dictionary functionality. \nWith this functionality in place, administrators can create password dictionaries to prevent users from using certain words or characters in their passwords. \n\nA password dictionary is a list of words or characters that users are prevented from including in their passwords. \nThis can help protect users from themselves and force them to create passwords that are not easy to break. \n\nA password dictionary must meet the following requirements to for the API to handle them correctly: \n\n- It must be in .txt format.\n\n- All characters must be UTF-8 characters. \n\n- Each line must contain a single word or character with no spaces or whitespace characters.\n\n- It must contain at least one line other than the locale string.\n\n- Each line must not exceed 128 characters.\n\n- The file must not exceed 2500 lines. \n\nAdministrators should also consider the following when they create their dictionaries: \n\n- Lines starting with a # represent comments.\n\n- All words in the password dictionary are case-insensitive. \nFor example, adding the word \"password\" to the dictionary also disallows the following: PASSWORD, Password, and PassWord.\n\n- The dictionary uses substring matching. \nFor example, adding the word \"spring\" to the dictionary also disallows the following: Spring124, 345SprinG, and 8spring.\nUsers can then select 'Change Password' to update their passwords. \n\nAdministrators must do the following to create a password dictionary: \n\n- Create the text file that will contain the prohibited password values.\n\n- If the dictionary is not in English, they must add a locale string to the top line: locale:`languageCode`_`countryCode`\n\nThe languageCode value refers to the language's 2-letter ISO 639-1 code.\nThe countryCode value refers to the country's 2-letter ISO 3166-1 code.\n\nRefer to this list https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html to see all the available ISO 639-1 language codes and ISO 3166-1 country codes.\n\n- Upload the .txt file to IdentityNow with [Update Password Dictionary](https://developer.sailpoint.com/idn/api/v3/update-password-dictionary). Uploading a new file always overwrites the previous dictionary file.\n\nAdministrators can then specify which password policies check new passwords against the password dictionary by doing the following: In the Admin panel, they can use the Password Mgmt dropdown menu to select Policies, select the policy, and select the 'Prevent use of words in this site's password dictionary' checkbox beside it.\n\nRefer to [Configuring Advanced Password Management Options](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html) for more information about password dictionaries.\n", "item": [ { - "id": "e0d2897c-cf7e-47ac-a2be-5c95865e80c3", + "id": "bd5135cb-42cc-4ddf-a696-f0cc3fe4150d", "name": "Get Password Dictionary", "request": { "name": "Get Password Dictionary", @@ -49858,7 +50158,7 @@ }, "response": [ { - "id": "331a5ccd-4114-471a-bddf-dd4cc3e439cb", + "id": "39e5888c-2a77-4b21-81b2-490d34e579a5", "name": "\nThe password dictionary file can contain lines that are:\n1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing\n2. empty lines\n3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines\n4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed;\n maximum length of the line is 128 Unicode codepoints\n\n\nPassword dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line).\n Password dict file must contain UTF-8 characters only.\n\n# Sample password text file\n\n```\n\n# Password dictionary small test file\n\nlocale=en_US\n\n# Password dictionary prohibited words\n\nqwerty\nabcd\naaaaa\npassword\nqazxsws\n\n```", "originalRequest": { "url": { @@ -49901,7 +50201,7 @@ "_postman_previewlanguage": "text" }, { - "id": "73c7f436-2ef4-49d6-9a82-32bc544e339c", + "id": "615da5a4-3fa9-4fea-a043-23a31cc03fed", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -49939,12 +50239,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1eb81eb0-5755-4256-b4fc-12e1cc8f1884", + "id": "2d303020-4607-4ece-8f83-baec5a4723fe", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -49987,7 +50287,7 @@ "_postman_previewlanguage": "json" }, { - "id": "94b66ace-d454-4704-8fbb-00d2ce6a1280", + "id": "793fee10-6f09-41e5-acfc-bf61725fe52c", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -50025,12 +50325,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "392a45ac-7032-4109-9a98-be00ccd47afe", + "id": "bff64e7f-55cb-4924-b1df-ade7cd18b4fa", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -50068,12 +50368,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5ffe925b-ccb9-4f2a-baf4-6bba48519d99", + "id": "27a94ae8-7280-4697-8018-55cac474ffff", "name": "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.", "originalRequest": { "url": { @@ -50116,7 +50416,7 @@ "_postman_previewlanguage": "json" }, { - "id": "67dd61f9-9e91-4012-b383-744f6af4d9cf", + "id": "deb45904-14e6-4e8d-b883-4117a9aee09b", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -50154,7 +50454,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -50165,7 +50465,7 @@ } }, { - "id": "46064eed-5f58-48cc-b23f-bd2b9e217eb2", + "id": "b9cfea60-f64b-4e40-9884-5cee0acbda49", "name": "Update Password Dictionary", "request": { "name": "Update Password Dictionary", @@ -50211,7 +50511,7 @@ }, "response": [ { - "id": "04ca34ed-ccce-4495-8da7-8fca2e376805", + "id": "71a2911a-efa9-4a79-aa72-946d8a9dfc4b", "name": "Successfully updated.", "originalRequest": { "url": { @@ -50261,7 +50561,7 @@ "_postman_previewlanguage": "text" }, { - "id": "e0202e9a-0fdc-45ee-b452-0fd10ef21633", + "id": "8f6f96b2-b9f6-45f7-ba6b-d25aba11c472", "name": "Created.", "originalRequest": { "url": { @@ -50311,7 +50611,7 @@ "_postman_previewlanguage": "text" }, { - "id": "a557d3ac-f4ef-4a73-a675-9c3d534b0391", + "id": "8cb187a5-ef6d-4eb2-8149-1fef641bee56", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -50366,12 +50666,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d148f295-2a9b-4f2c-8244-2246d04b6efa", + "id": "f197b832-b67c-4dbb-bb71-da6ef0cd9239", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -50431,7 +50731,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8eb18125-6950-4000-9dae-83a378fd76c5", + "id": "0cbcfbc3-fa57-4009-b90f-86b00b387327", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -50486,12 +50786,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0ef47d0a-bf4b-4fa6-8dc0-9b681702141c", + "id": "8f1963d0-bfe8-4546-9777-dab61dbdc4e6", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -50546,12 +50846,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "931388c1-65e1-4d13-9924-73e4ff65a125", + "id": "6b992b00-a4c5-43ec-af9b-a7ca8a3c5e50", "name": "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.", "originalRequest": { "url": { @@ -50611,7 +50911,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b88ac9c4-07ba-499e-a14d-23b12b0e6f82", + "id": "f904a4e1-7344-43b8-83e5-c0a9a5152a38", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -50666,7 +50966,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -50683,7 +50983,7 @@ "description": "Use this API to implement password sync group functionality. \nWith this functionality in place, administrators can group sources into password sync groups so that all their applications share the same password. \nThis allows users to update the password for all the applications in a sync group if they want, rather than updating each password individually. \n\nA password sync group is a group of applications that shares a password. \nAdministrators create these groups by grouping the applications' sources. \nFor example, an administrator can group the ActiveDirectory, GitHub, and G Suite sources together so that all those sources' applications can also be grouped to share a password. \nA user can then update his or her password for ActiveDirectory, GitHub, Gmail, Google Drive, and Google Calendar all at once, rather then updating each one individually.\n\nThe following are required for administrators to create a password sync group in IdentityNow: \n\n- At least two direct connect sources connected to IdentityNow and configured for Password Management.\n\n- Each authentication source in a sync group must have at least one application. Refer to [Adding and Resetting Application Passwords](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html#adding-and-resetting-application-passwords) for more information about adding applications to sources.\n\n- At least one password policy. Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/policies.html) for more information about password policies. \n\nIn the Admin panel in IdentityNow, administrators can use the Password Mgmt dropdown menu to select Sync Groups. \nTo create a sync group, administrators must provide a name, choose a password policy to be enforced across the sources in the sync group, and select the sources to include in the sync group. \n\nAdministrators can also delete sync groups in IdentityNow, but they should know the following before they do: \n\n- Passwords related to the associated sources will become independent, so changing one will not change the others anymore. \n\n- Passwords for the sources' connected applications will also become independent. \n\n- Password policies assigned to the sync group are then assigned directly to the associated sources. \nTo change the password policy for a source, administrators must edit it directly. \n\nOnce the password sync group has been created, users can update the password for the group in Password Manager.\n\nRefer to [Managing Password Sync Groups](https://documentation.sailpoint.com/saas/help/pwd/sync_grps.html) for more information about password sync groups.\n", "item": [ { - "id": "df3a5b4d-15a0-453e-b4b4-7c0a0b8f98bf", + "id": "feb8e4aa-b1ac-4763-b68f-8449d504d6a6", "name": "Get Password Sync Group List", "request": { "name": "Get Password Sync Group List", @@ -50740,7 +51040,7 @@ }, "response": [ { - "id": "73f90a9d-ad85-4633-8412-754c5e8bbeab", + "id": "01d9fe24-193b-4640-b9cd-fdd3e3d68618", "name": "A list of password sync groups.", "originalRequest": { "url": { @@ -50811,7 +51111,7 @@ "_postman_previewlanguage": "json" }, { - "id": "14ad6b39-176e-488a-b075-77d8dee9f148", + "id": "f28c30bf-82f5-41f6-945f-a67c6ba23346", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -50877,12 +51177,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "9d61719d-acc3-4fa2-bd1f-644b6cf219df", + "id": "14584182-7d0f-4cba-8be9-439e6f415f87", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -50953,7 +51253,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ce18d52a-767f-4a1e-b9db-00f11a9fa40b", + "id": "ce6aea9a-4b52-47e0-bb9a-e4c7e05e4d29", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -51019,12 +51319,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "81787cae-d011-4cf6-8592-e982f7d23bae", + "id": "f7f7d29a-5762-45ab-9156-d8d371d01cab", "name": "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.", "originalRequest": { "url": { @@ -51095,7 +51395,7 @@ "_postman_previewlanguage": "json" }, { - "id": "23ebbf73-f64f-479d-aaa6-3a98f3252fdf", + "id": "319c225f-40c1-4142-a834-de73eec747eb", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -51161,7 +51461,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -51172,7 +51472,7 @@ } }, { - "id": "3e755271-bc36-4df2-9905-66a02c26d545", + "id": "7f00ee36-0861-41e1-8a9b-b5b6dd6e2a2b", "name": "Create Password Sync Group", "request": { "name": "Create Password Sync Group", @@ -51214,7 +51514,7 @@ }, "response": [ { - "id": "aa471d3b-c736-458c-8a35-e0be3b9a5eff", + "id": "a951ba3a-5cc5-40f8-aeeb-2bb619717f92", "name": "Reference to the password sync group.", "originalRequest": { "url": { @@ -51270,7 +51570,7 @@ "_postman_previewlanguage": "json" }, { - "id": "07a67f07-1a85-4259-97f9-41ee21fee284", + "id": "c6e246f9-5f81-408c-ba43-0a0c5e407020", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -51321,12 +51621,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "53cdb8fc-dda2-4187-be87-82b08b3094db", + "id": "76ef97f0-daa9-4dcb-9bc8-5f042114a3db", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -51382,7 +51682,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1c526b63-503b-4578-b6db-355993663fdb", + "id": "fefd00b4-c51c-4547-9db2-b304f0bf8944", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -51433,12 +51733,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "37b1f18f-89dc-4c04-8c90-5fc185368c1a", + "id": "816913cc-7549-44a2-880e-9cfdd5a7e5be", "name": "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.", "originalRequest": { "url": { @@ -51494,7 +51794,7 @@ "_postman_previewlanguage": "json" }, { - "id": "04456cee-af12-428b-aeea-3e331dc86ded", + "id": "9f93e113-d9c9-4233-9f02-34dfd50f8906", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -51545,7 +51845,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -51556,7 +51856,7 @@ } }, { - "id": "0da7fe33-3dbf-400d-a432-7b15a9a16575", + "id": "8b1b39d3-2b36-46d2-8c8e-c02b0fb77819", "name": "Get Password Sync Group by ID", "request": { "name": "Get Password Sync Group by ID", @@ -51593,7 +51893,7 @@ }, "response": [ { - "id": "f18eb802-9b79-4927-9772-08d1f359c289", + "id": "2ffee547-8da5-40b9-865a-fad098a70442", "name": "Reference to the password sync group.", "originalRequest": { "url": { @@ -51637,7 +51937,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1114e379-0584-4863-a878-ff640a1e458c", + "id": "18eedec3-dfc3-446d-9ede-30d24e658f49", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -51676,12 +51976,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "61bc910f-747a-4d49-8739-7e9520057a6c", + "id": "0a3910ef-e7f9-4b31-b2c9-c96acb747cc5", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -51725,7 +52025,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0cc685c1-a3a5-40c0-a684-0e2a5128654b", + "id": "c64f711a-9d96-4926-b5ad-d0d574195278", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -51764,12 +52064,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "225e6a38-94fb-49ae-b269-80bce38c6da9", + "id": "93ff7da8-1a0d-49b4-9b41-77ccb601e5c5", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -51808,12 +52108,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "872ff7ae-870f-4641-8dd7-e327e24f86ca", + "id": "67360d2e-0513-464d-a1eb-34113bafc141", "name": "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.", "originalRequest": { "url": { @@ -51857,7 +52157,7 @@ "_postman_previewlanguage": "json" }, { - "id": "81b2523b-7baa-4237-9afc-9ff01b1a611c", + "id": "f761d65d-8f80-4620-9a37-313509f1fb4a", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -51896,7 +52196,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -51907,7 +52207,7 @@ } }, { - "id": "bc676ff8-8cec-4b62-9399-0f7d64234320", + "id": "41e2b6d5-de59-4f17-a211-c0d6cb70141b", "name": "Update Password Sync Group by ID", "request": { "name": "Update Password Sync Group by ID", @@ -51957,7 +52257,7 @@ }, "response": [ { - "id": "b60b398b-478b-4780-8ea7-a1a804fe96be", + "id": "78037d47-df85-49d1-8ebb-bcf0b631d11a", "name": "Reference to the password sync group.", "originalRequest": { "url": { @@ -52014,7 +52314,7 @@ "_postman_previewlanguage": "json" }, { - "id": "715103c2-0754-4e4b-8854-c8bb263070d4", + "id": "75da14f7-e08b-4666-adca-10ea589b64a2", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -52066,12 +52366,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "2bcebfab-05d6-4987-8a49-71960e637921", + "id": "f1038c9e-143c-4b4c-a05d-c5f4e7a627f6", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -52128,7 +52428,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f274513b-1c2b-484b-80cb-60f91101f431", + "id": "c6af7e93-229e-40a4-b313-f81433c8c826", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -52180,12 +52480,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "cdf2ea31-5282-4814-9aeb-909be5a7df8c", + "id": "f8d256ac-d311-4140-b50a-221cae16ea3c", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -52237,12 +52537,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "09900e04-adb9-4228-80d8-a909f587eab6", + "id": "30771d7a-141e-49ca-8ef6-4c1879859bd4", "name": "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.", "originalRequest": { "url": { @@ -52299,7 +52599,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c57f7c73-c6f9-470e-8e5f-322fdbb5cbe6", + "id": "c46cf298-b8f5-4fd6-99c3-17eba4bf0d82", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -52351,7 +52651,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -52362,7 +52662,7 @@ } }, { - "id": "9bcb9dca-f634-48a3-a544-281ced4a3c10", + "id": "26d022f4-5edd-4de6-9539-2eafcf494621", "name": "Delete Password Sync Group by ID", "request": { "name": "Delete Password Sync Group by ID", @@ -52399,7 +52699,7 @@ }, "response": [ { - "id": "03c9e38d-3ffd-4fb6-9626-d64e96c892bb", + "id": "e537b3f3-75e6-43b4-b039-8f6d08780d64", "name": "No content - indicates the request was successful but there is no content to be returned in the response.", "originalRequest": { "url": { @@ -52433,7 +52733,7 @@ "_postman_previewlanguage": "text" }, { - "id": "a4d6b9ff-7961-44bd-aa95-40c5b482a24b", + "id": "02072feb-2539-4dfd-86bf-a29911deb9a6", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -52472,12 +52772,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7a84404d-c27d-44dd-8164-fead7f7a3608", + "id": "3eace732-b5b6-4248-95c4-355f620af374", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -52521,7 +52821,7 @@ "_postman_previewlanguage": "json" }, { - "id": "03ea0dad-ff63-460f-b0ed-3f7b7680cdbc", + "id": "0b28caef-5f39-42a9-baa2-f2e5ce114c33", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -52560,12 +52860,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6a1f4366-aa59-40b3-b126-175aa3dca8e3", + "id": "37db838a-7a26-47e7-a830-b2807e1d2dfd", "name": "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.", "originalRequest": { "url": { @@ -52609,7 +52909,7 @@ "_postman_previewlanguage": "json" }, { - "id": "cd761894-fe69-4bdc-93a3-b4da72603718", + "id": "b5d1edd3-813d-43a0-86e3-b0588c2c3f1b", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -52648,7 +52948,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -52665,7 +52965,7 @@ "description": "Use this API to implement personal access token (PAT) functionality. \nWith this functionality in place, users can use PATs as an alternative to passwords for authentication in IdentityNow. \n\nPATs embed user information into the client ID and secret. \nThis replaces the API clients' need to store and provide a username and password to establish a connection, improving IdentityNow organizations' integration security. \n\nIn IdentityNow, users can do the following to create and manage their PATs: Select the dropdown menu under their names, select Preferences, and then select Personal Access Tokens. \nThey must then provide a description about the token's purpose. \nThey can then select 'Create Token' at the bottom of the page to generate and view the Secret and Client ID. \n\nRefer to [Managing Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/generate_tokens.html) for more information about PATs.\n", "item": [ { - "id": "3493cf5e-45db-43f6-9d03-3d82cf772909", + "id": "92d294fb-75b8-40ca-9a0e-281524c4fe92", "name": "List Personal Access Tokens", "request": { "name": "List Personal Access Tokens", @@ -52713,7 +53013,7 @@ }, "response": [ { - "id": "91ff037c-6f59-43ea-ac65-04c805acfe85", + "id": "76e3a1c1-825c-4943-b2d2-eab4bd100f4f", "name": "List of personal access tokens.", "originalRequest": { "url": { @@ -52770,12 +53070,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"owner\": {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\",\n \"lastUsed\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"owner\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\",\n \"lastUsed\": \"\"\n }\n]", + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"owner\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\",\n \"lastUsed\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"owner\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\",\n \"lastUsed\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6d40af30-5eef-43fa-a274-b89d79838dd3", + "id": "b0104a09-08fe-4f0e-90f7-badba76aab64", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -52832,12 +53132,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7bba57e9-fabe-4f63-91a3-5ee835803298", + "id": "79d1a94f-cbd7-403d-b670-15e17884d061", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -52899,7 +53199,7 @@ "_postman_previewlanguage": "json" }, { - "id": "591d6618-ab0a-4752-8804-5247491dd255", + "id": "eaa1f6b8-126f-40d1-b175-124555234b92", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -52956,12 +53256,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "deebee0c-7b1c-44fc-b640-3a1bac55c3f7", + "id": "3cdbe36c-6c67-44d1-b91e-77fa49616444", "name": "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.", "originalRequest": { "url": { @@ -53023,7 +53323,7 @@ "_postman_previewlanguage": "json" }, { - "id": "32a689c7-a524-4579-929e-40b61ec84c5d", + "id": "53f43186-61f7-4f24-877f-7c53831dfc36", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -53080,7 +53380,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -53091,7 +53391,7 @@ } }, { - "id": "63629b40-7415-49c4-8293-9586fe6d74c6", + "id": "51f92908-c773-4bea-93cb-6b1de7a2add9", "name": "Create Personal Access Token", "request": { "name": "Create Personal Access Token", @@ -53133,7 +53433,7 @@ }, "response": [ { - "id": "1c6a3ced-93bd-4e89-a5ff-0e54992993d9", + "id": "61ccf0f1-8019-4d58-8c07-06cf6418d339", "name": "Created. Note - this is the only time Personal Access Tokens' secret attribute will be displayed.", "originalRequest": { "url": { @@ -53184,12 +53484,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"secret\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"name\": \"\",\n \"owner\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"secret\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"name\": \"\",\n \"owner\": {\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "dadaa397-c138-4469-95fb-b6a0e2ea6e10", + "id": "84debb2d-41f4-425f-aa7b-de8e14e4ca77", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -53240,12 +53540,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6285256a-3338-4b8d-9561-d0629a226439", + "id": "5152ea50-590d-40af-9f54-b1628697a9d9", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -53301,7 +53601,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ec907fe0-833c-4074-bdbf-3b9f744915f5", + "id": "c7dc30d8-828a-4c7a-a390-db43b3c87a1b", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -53352,12 +53652,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e8490c70-4aec-46d3-a247-f78c81529a59", + "id": "600c4dcd-5528-4801-8202-9d0c3a751a25", "name": "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.", "originalRequest": { "url": { @@ -53413,7 +53713,7 @@ "_postman_previewlanguage": "json" }, { - "id": "65a185a9-f691-4eef-af0e-ca746aa861f3", + "id": "6ea7f4c0-0bc9-4b9a-b1b4-2efdfb216a8b", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -53464,7 +53764,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -53475,7 +53775,7 @@ } }, { - "id": "a0dc12dc-f575-4af1-9dca-40c750257a32", + "id": "38647fdd-04c4-4a51-8389-f4bffd66594c", "name": "Patch Personal Access Token", "request": { "name": "Patch Personal Access Token", @@ -53514,7 +53814,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -53525,7 +53825,7 @@ }, "response": [ { - "id": "47dd870a-663e-4991-a12c-b624210a3e5f", + "id": "75cfd095-f08a-4114-b7ce-115cf41142de", "name": "Indicates the PATCH operation succeeded, and returns the PAT's new representation.", "originalRequest": { "url": { @@ -53560,7 +53860,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -53577,12 +53877,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"owner\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\",\n \"lastUsed\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"owner\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\",\n \"lastUsed\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8717e638-42e6-4655-8264-828ffe7d1f37", + "id": "ee99e792-d9ee-47ff-ac75-d90525cd37ca", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -53617,7 +53917,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -53634,12 +53934,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "aa257499-aed4-4766-b3b3-2ccf2d1c62f8", + "id": "483bab3b-32a0-4061-baeb-0860d8b52b4b", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -53674,7 +53974,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -53696,7 +53996,7 @@ "_postman_previewlanguage": "json" }, { - "id": "aaae1430-7304-41ca-bd0d-79f7d5d2a444", + "id": "a0ad19dc-1f15-42ab-b4af-d865693fc451", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -53731,7 +54031,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -53748,12 +54048,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "386475ff-9d69-4954-8788-85a9ae5a26b2", + "id": "5ff80390-8fd4-42df-8fae-1b9105600152", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -53788,7 +54088,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -53805,12 +54105,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b630b6f2-076f-45ee-af7c-7e4551a1b2ca", + "id": "c8efa899-d49e-4d53-92d4-3cd431a9671b", "name": "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.", "originalRequest": { "url": { @@ -53845,7 +54145,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -53867,7 +54167,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ce342596-cb94-4167-9fbf-1b50b6998c5c", + "id": "e5e65093-b1d7-411b-8b0f-a90e4d516fa1", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -53902,7 +54202,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -53919,7 +54219,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -53930,7 +54230,7 @@ } }, { - "id": "ded72130-c2a4-45f0-b5af-23924d08c1c9", + "id": "30039f84-180f-40d5-b68f-2d68c5cf8b80", "name": "Delete Personal Access Token", "request": { "name": "Delete Personal Access Token", @@ -53967,7 +54267,7 @@ }, "response": [ { - "id": "aabda0be-a784-4103-b783-e3c15669db44", + "id": "8112fc9c-4ac6-4cb7-93a4-5eef86bad5dc", "name": "No content.", "originalRequest": { "url": { @@ -54001,7 +54301,7 @@ "_postman_previewlanguage": "text" }, { - "id": "282c0ece-f3e0-4d5f-a369-977896060505", + "id": "775681b8-2ad3-4473-9beb-d99c27ebeff7", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -54040,12 +54340,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "399cb032-2994-41ed-beb9-3bc165fa8e91", + "id": "5b781493-4a9b-4c71-a0d0-56ad86d02573", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -54089,7 +54389,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f671209b-0f91-4253-9e3f-83543c989210", + "id": "82912416-91d6-4b5a-8a7c-e96df7ee4865", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -54128,12 +54428,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e3c75c5c-29e8-4051-a861-142ceff0c1ab", + "id": "010b1eef-4f8c-4fd4-9acc-db6504dd82ec", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -54172,12 +54472,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "2bcabc08-9dab-4b45-8fc7-7656033c3d61", + "id": "88937dcf-01b5-4175-afc6-1b79aa03d6f1", "name": "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.", "originalRequest": { "url": { @@ -54221,7 +54521,7 @@ "_postman_previewlanguage": "json" }, { - "id": "83d338cc-d714-4398-9012-de2989cf7400", + "id": "2e079c5c-365b-4d75-9d82-a5a7cf7666a4", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -54260,7 +54560,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -54277,7 +54577,7 @@ "description": "Use this API in conjunction with [Public Identites Config](https://developer.sailpoint.com/idn/api/v3/public-identities-config) to enable non-administrators to view identities' publicly visible attributes. \nWith this functionality in place, non-administrators can view identity attributes other than the default attributes (email, lifecycle state, and manager), depending on which identity attributes their organization administrators have made public. \nThis can be helpful for access approvers, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks.\n", "item": [ { - "id": "e6d40bf4-7819-4a30-a79b-446a19c39832", + "id": "2026953e-6a4e-42a7-b2cd-adf3457fedb5", "name": "Get a list of public identities", "request": { "name": "Get a list of public identities", @@ -54358,7 +54658,7 @@ }, "response": [ { - "id": "917d4071-774b-46d0-a82a-cbdd02dff58d", + "id": "aef6371d-8b34-4037-8799-02e593d77141", "name": "A list of public identity objects.", "originalRequest": { "url": { @@ -54451,12 +54751,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"alias\": \"\",\n \"email\": \"\",\n \"status\": \"\",\n \"manager\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"alias\": \"\",\n \"email\": \"\",\n \"status\": \"\",\n \"manager\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n]", + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"alias\": \"\",\n \"email\": \"\",\n \"status\": \"\",\n \"manager\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"alias\": \"\",\n \"email\": \"\",\n \"status\": \"\",\n \"manager\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "eb8cf202-4ffa-4555-9db1-8633471ef5be", + "id": "7bb966ab-eeff-485d-980d-6eadbd77f795", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -54549,12 +54849,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "858467da-6c8a-4d12-adcd-efa447427d5e", + "id": "fa7b75f7-ff39-403c-aac2-b59da5a18e74", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -54652,7 +54952,7 @@ "_postman_previewlanguage": "json" }, { - "id": "cd6a3fea-555a-474d-9054-bf1762c891cf", + "id": "73093d2e-71e7-4b3d-9984-8d30fefb2e6e", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -54745,12 +55045,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b94ee1c3-ef4f-4277-adae-4a452ed7b1cb", + "id": "4b900caa-a0c3-4a0f-8214-a620f4b6c103", "name": "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.", "originalRequest": { "url": { @@ -54848,7 +55148,7 @@ "_postman_previewlanguage": "json" }, { - "id": "fd79af6d-6a0e-46c9-9bd4-ac08194acbab", + "id": "3aadfd24-f23f-4c6a-8135-967777dbd392", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -54941,7 +55241,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -54958,7 +55258,7 @@ "description": "Use this API to implement public identity configuration functionality. \nWith this functionality in place, administrators can make up to 5 identity attributes publicly visible so other non-administrator users can see the relevant information they need to make decisions. \nThis can be helpful for approvers making approvals, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks.\n\nBy default, non-administrators can select an identity and view the following attributes: email, lifecycle state, and manager. \nHowever, it may be helpful for a non-administrator reviewer to see other identity attributes like department, region, title, etc.\nAdministrators can use this API to make those necessary identity attributes public to non-administrators. \n\nFor example, a non-administrator deciding whether to approve another identity's request for access to the Workday application, whose access may be restricted to members of the HR department, would want to know whether the identity is a member of the HR department. \nIf an administrator has used [Update Public Identity Config](https://developer.sailpoint.com/idn/api/v3/update-public-identity-config) to make the \"department\" attribute public, the approver can see the department and make a decision without requesting any more information.\n", "item": [ { - "id": "06aa6e2c-536f-4c47-a6d9-5e5d103be047", + "id": "98becbc4-5eb2-4f03-a8bf-bf54cf79e168", "name": "Get the Public Identities Configuration", "request": { "name": "Get the Public Identities Configuration", @@ -54987,7 +55287,7 @@ }, "response": [ { - "id": "eed43272-ac7e-4154-ac5c-0c63b47487a0", + "id": "653a598b-6adb-460e-8c8b-932f8dbde64e", "name": "Request succeeded.", "originalRequest": { "url": { @@ -55025,12 +55325,12 @@ "value": "application/json" } ], - "body": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "body": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6f71ca76-ea2c-4182-834e-b2c19ae47201", + "id": "8551f4bc-32bb-482f-a15d-8483b7090dd7", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -55068,12 +55368,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3c8e1443-76ef-446c-99fe-e26bafb5371a", + "id": "556aa849-9295-4dc8-b696-c192b253caf6", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -55116,7 +55416,7 @@ "_postman_previewlanguage": "json" }, { - "id": "23c0ffb6-16a2-4192-a5f9-65ec3fde11ea", + "id": "cbf14eae-403a-4775-962c-ed619b2de6f2", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -55154,12 +55454,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a9fdc367-ad11-4a0a-b396-eebeed9d5ef4", + "id": "b9550f9b-822a-4089-a649-612cdf324ae1", "name": "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.", "originalRequest": { "url": { @@ -55202,7 +55502,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9b3808d8-5533-45bb-bea1-685533b15195", + "id": "32b39f67-688e-4a37-8c08-1ff9d36e27df", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -55240,7 +55540,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -55251,7 +55551,7 @@ } }, { - "id": "8c903b79-a9e3-47e3-809e-e0daed277c48", + "id": "a137b01f-c6db-419e-a207-e99cdab3a079", "name": "Update the Public Identities Configuration", "request": { "name": "Update the Public Identities Configuration", @@ -55282,7 +55582,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -55293,7 +55593,7 @@ }, "response": [ { - "id": "724228bf-8e0b-4ab4-b75f-f3147ecfba05", + "id": "4901cd3f-73f7-4bfd-aef2-f7f598f53f7c", "name": "Request succeeded.", "originalRequest": { "url": { @@ -55327,7 +55627,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -55344,12 +55644,12 @@ "value": "application/json" } ], - "body": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "body": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "632d8840-f943-4333-bd0e-e5efb00a6300", + "id": "dd71b0dc-3723-443f-bafc-bf81bc77edc2", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -55383,7 +55683,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -55400,12 +55700,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "81dd6080-a5c9-495e-ad61-3820888600bf", + "id": "d6935754-d30e-4bcb-9ce2-46183aa6c506", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -55439,7 +55739,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -55461,7 +55761,7 @@ "_postman_previewlanguage": "json" }, { - "id": "81003ab2-8105-4e6c-8c67-ca705f05c6e2", + "id": "6fe72cc9-defc-4ef7-8e91-fea75066e01d", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -55495,7 +55795,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -55512,12 +55812,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "2b916fcf-6e59-4844-8c26-270d812af399", + "id": "13ccfd44-735c-4da8-88c0-c839159c683e", "name": "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.", "originalRequest": { "url": { @@ -55551,7 +55851,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -55573,7 +55873,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e7860103-e163-433a-bffb-f60c1c9a76cc", + "id": "00ea85c1-2eaf-4841-9aa8-1a189083f545", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -55607,7 +55907,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -55624,7 +55924,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -55641,7 +55941,7 @@ "description": "Use this API to implement requestable object functionality. \nWith this functionality in place, administrators can determine which access items can be requested with the [Access Request APIs](https://developer.sailpoint.com/idn/api/v3/access-requests), along with their statuses. \nThis can be helpful for administrators who are implementing and customizing access request functionality as a way of checking which items are requestable as they are created, assigned, and made available.\n", "item": [ { - "id": "9b7b948c-42f3-47e4-ac5d-b8038caa09e6", + "id": "e3de4c60-dbf1-4083-abc4-22318958678c", "name": "Requestable Objects List", "request": { "name": "Requestable Objects List", @@ -55691,7 +55991,7 @@ "type": "text/plain" }, "key": "statuses", - "value": "PENDING,AVAILABLE" + "value": "PENDING,ASSIGNED" }, { "disabled": true, @@ -55752,7 +56052,7 @@ }, "response": [ { - "id": "70292d72-e7d2-43ee-85c9-4e0a737fbe2e", + "id": "81650133-1ece-4b83-b95e-eb926b52d340", "name": "List of requestable objects", "originalRequest": { "url": { @@ -55797,7 +56097,7 @@ "type": "text/plain" }, "key": "statuses", - "value": "PENDING,AVAILABLE" + "value": "PENDING,ASSIGNED" }, { "disabled": true, @@ -55872,12 +56172,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"requestStatus\": \"AVAILABLE\",\n \"identityRequestId\": \"\",\n \"ownerRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"requestCommentsRequired\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"type\": \"ROLE\",\n \"requestStatus\": \"AVAILABLE\",\n \"identityRequestId\": \"\",\n \"ownerRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"requestCommentsRequired\": \"\"\n }\n]", + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"type\": \"ROLE\",\n \"requestStatus\": \"ASSIGNED\",\n \"identityRequestId\": \"\",\n \"ownerRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"requestCommentsRequired\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"type\": \"ROLE\",\n \"requestStatus\": \"AVAILABLE\",\n \"identityRequestId\": \"\",\n \"ownerRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"requestCommentsRequired\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0d87ca19-8b2e-4060-8c84-e13704907cef", + "id": "f3c99ebd-40a7-43c8-9973-fba9ee946318", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -55922,7 +56222,7 @@ "type": "text/plain" }, "key": "statuses", - "value": "PENDING,AVAILABLE" + "value": "PENDING,ASSIGNED" }, { "disabled": true, @@ -55997,12 +56297,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d63fbcf7-e2bd-4a36-a369-4e37aaf29468", + "id": "3ab125b4-6f76-4a37-9f31-85c3759ecf9a", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -56047,7 +56347,7 @@ "type": "text/plain" }, "key": "statuses", - "value": "PENDING,AVAILABLE" + "value": "PENDING,ASSIGNED" }, { "disabled": true, @@ -56127,7 +56427,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4a9cc804-6cce-481c-bad7-2b82a806582a", + "id": "1a700f3c-66d5-432a-8406-96779a0970f5", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -56172,7 +56472,7 @@ "type": "text/plain" }, "key": "statuses", - "value": "PENDING,AVAILABLE" + "value": "PENDING,ASSIGNED" }, { "disabled": true, @@ -56247,12 +56547,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c96f4de1-c6dc-495e-9f1e-fabac3e08c98", + "id": "52a43434-fcf8-411d-9258-1f43f801bd4d", "name": "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.", "originalRequest": { "url": { @@ -56297,7 +56597,7 @@ "type": "text/plain" }, "key": "statuses", - "value": "PENDING,AVAILABLE" + "value": "PENDING,ASSIGNED" }, { "disabled": true, @@ -56377,7 +56677,7 @@ "_postman_previewlanguage": "json" }, { - "id": "be2bc5c7-2af7-4b00-a1a3-bc2082d678e9", + "id": "ef05e9b3-5a6f-44da-be2e-a3ab0c5d36fb", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -56422,7 +56722,7 @@ "type": "text/plain" }, "key": "statuses", - "value": "PENDING,AVAILABLE" + "value": "PENDING,ASSIGNED" }, { "disabled": true, @@ -56497,7 +56797,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -56514,7 +56814,7 @@ "description": "Use this API to implement and customize role functionality.\nWith this functionality in place, administrators can create roles and configure them for use throughout IdentityNow. \nIdentityNow can use established criteria to automatically assign the roles to qualified users. This enables users to get all the access they need quickly and securely and administrators to spend their time on other tasks.\n\nEntitlements represent the most granular level of access in IdentityNow. \nAccess profiles represent the next level and often group entitlements. \nRoles represent the broadest level of access and often group access profiles. \n\nFor example, an Active Directory source in IdentityNow can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization.\n\nAn administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement.\n\nAn administrator can then create an even broader set of access in the form of a role grouping the 'AD Developers' access profile with another profile, 'GitHub Developers,' grouping entitlements for the GitHub source.\n\nWhen users only need Active Directory employee access, they can request access to the 'Employees' entitlement.\n\nWhen users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile.\n\nWhen users need both the 'AD Developers' access profile and the 'GitHub Developers' access profile, they can request access to the role grouping both. \n\nRoles often represent positions within organizations. \nFor example, an organization's accountant can access all the tools the organization's accountants need with the 'Accountant' role. \nIf the accountant switches to engineering, a qualified member of the organization can quickly revoke the accountant's 'Accountant' access and grant access to the 'Engineer' role instead, granting access to all the tools the organization's engineers need.\n\nIn IdentityNow, adminstrators can use the Access drop-down menu and select Roles to view, configure, and delete existing roles, as well as create new ones. \nAdministrators can enable and disable the role, and they can also make the following configurations: \n\n- Manage Access: Manage the role's access by adding or removing access profiles.\n\n- Define Assignment: Define the criteria IdentityNow uses to assign the role to identities. \nUse the first option, 'Standard Criteria,' to provide specific criteria for assignment like specific account attributes, entitlements, or identity attributes. \nUse the second, 'Identity List,' to specify the identities for assignment.\n\n- Access Requests: Configure roles to be requestable and establish an approval process for any requests that the role be granted or revoked. \nDo not configure a role to be requestable without establishing a secure access request approval process for that role first. \n\nRefer to [Working with Roles](https://documentation.sailpoint.com/saas/help/provisioning/roles.html) for more information about roles.\n", "item": [ { - "id": "0f2172f3-4da8-40af-a4be-b2d57843d996", + "id": "5161ef2a-8fda-4f01-81e8-b1dfa996ea6e", "name": "List Roles", "request": { "name": "List Roles", @@ -56616,7 +56916,7 @@ }, "response": [ { - "id": "fe394214-14ad-423a-94c0-07125af3c3c8", + "id": "857f4457-86e3-4c3e-9749-d723a5476dad", "name": "List of Roles", "originalRequest": { "url": { @@ -56727,12 +57027,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"name\": \"\",\n \"owner\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"laborum_a\": -43328327.39349217,\n \"ad66\": false\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"owner\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"est3\": false\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n }\n]", + "body": "[\n {\n \"name\": \"\",\n \"owner\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"IDENTITY_LIST\",\n \"criteria\": {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"Duis_4c\": 72861628\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"owner\": {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"magna37\": \"commodo magna Lorem ipsum\",\n \"in_b\": \"elit in ut nulla\"\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d08e5c75-a63f-44d6-b2a0-b768878dd4d1", + "id": "ba318e29-8651-4873-8f18-911c8ebd3e8e", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -56843,12 +57143,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "cc5d0e22-e93e-4681-bf2c-018f21978fce", + "id": "8503551c-598a-4f4f-9791-ba42b6c45a35", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -56964,7 +57264,7 @@ "_postman_previewlanguage": "json" }, { - "id": "af147df3-e25e-4847-9cdb-e056b135d1e9", + "id": "d39fbe72-38fa-4906-82e5-cba0ee820df6", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -57075,12 +57375,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "49f080cd-d9d1-4965-ab22-06fcba284356", + "id": "72f378e9-df8b-480a-bd81-44e7503acb09", "name": "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.", "originalRequest": { "url": { @@ -57196,7 +57496,7 @@ "_postman_previewlanguage": "json" }, { - "id": "941a318c-4998-41ed-80f9-ae83d33891b8", + "id": "ae8ccb29-ed57-416f-b175-dd88ca1a1f8a", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -57307,7 +57607,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -57318,7 +57618,7 @@ } }, { - "id": "5ed21144-4f29-4018-9a37-a126a77dc593", + "id": "9b4aab97-bfde-4727-bd0d-e156b114ae2b", "name": "Create a Role", "request": { "name": "Create a Role", @@ -57349,7 +57649,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"IDENTITY_LIST\",\n \"criteria\": {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"ipsum4\": -5147911,\n \"ad_3c\": true,\n \"ut_439\": -93054213.92815138\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"dolor2ec\": -96294071,\n \"commodo_1f\": -17114455.855600223\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -57360,7 +57660,7 @@ }, "response": [ { - "id": "dfa1f273-f365-4c12-ace0-6fb9dcf5ed52", + "id": "aa7f9bfe-acc9-4798-be07-251a9e6508f6", "name": "Role created", "originalRequest": { "url": { @@ -57394,7 +57694,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"IDENTITY_LIST\",\n \"criteria\": {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"ipsum4\": -5147911,\n \"ad_3c\": true,\n \"ut_439\": -93054213.92815138\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"dolor2ec\": -96294071,\n \"commodo_1f\": -17114455.855600223\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -57411,12 +57711,12 @@ "value": "application/json" } ], - "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"IDENTITY_LIST\",\n \"criteria\": {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"ipsum4\": -5147911,\n \"ad_3c\": true,\n \"ut_439\": -93054213.92815138\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"dolor2ec\": -96294071,\n \"commodo_1f\": -17114455.855600223\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "94fbea5f-304a-43f0-be9c-14356cf911fd", + "id": "67a96adc-cff1-4021-b6b9-fbc9bb0fc975", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -57450,7 +57750,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"IDENTITY_LIST\",\n \"criteria\": {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"ipsum4\": -5147911,\n \"ad_3c\": true,\n \"ut_439\": -93054213.92815138\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"dolor2ec\": -96294071,\n \"commodo_1f\": -17114455.855600223\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -57467,12 +57767,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "295ff1b5-5790-4b4f-a0f1-68cb80e626f7", + "id": "efc13fcf-309e-4f45-919c-8a0db5cca448", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -57506,7 +57806,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"IDENTITY_LIST\",\n \"criteria\": {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"ipsum4\": -5147911,\n \"ad_3c\": true,\n \"ut_439\": -93054213.92815138\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"dolor2ec\": -96294071,\n \"commodo_1f\": -17114455.855600223\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -57528,7 +57828,7 @@ "_postman_previewlanguage": "json" }, { - "id": "64d5585a-9b57-4749-8265-a287092f6bf0", + "id": "d5d8a298-db92-4cc4-bcae-bd2358f9f65c", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -57562,7 +57862,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"IDENTITY_LIST\",\n \"criteria\": {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"ipsum4\": -5147911,\n \"ad_3c\": true,\n \"ut_439\": -93054213.92815138\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"dolor2ec\": -96294071,\n \"commodo_1f\": -17114455.855600223\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -57579,12 +57879,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5d4ab574-774c-43f2-b46e-65dbc1b2f8f5", + "id": "a6e575cd-3389-4204-b8dc-d8b2d1e2995d", "name": "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.", "originalRequest": { "url": { @@ -57618,7 +57918,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"IDENTITY_LIST\",\n \"criteria\": {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"ipsum4\": -5147911,\n \"ad_3c\": true,\n \"ut_439\": -93054213.92815138\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"dolor2ec\": -96294071,\n \"commodo_1f\": -17114455.855600223\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -57640,7 +57940,7 @@ "_postman_previewlanguage": "json" }, { - "id": "340e5e4f-eb17-4756-9418-b258664269a9", + "id": "334a4296-dbe2-4208-be13-401af2378ef7", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -57674,7 +57974,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"IDENTITY_LIST\",\n \"criteria\": {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"ipsum4\": -5147911,\n \"ad_3c\": true,\n \"ut_439\": -93054213.92815138\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"dolor2ec\": -96294071,\n \"commodo_1f\": -17114455.855600223\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -57691,7 +57991,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -57702,7 +58002,7 @@ } }, { - "id": "c28152c4-07d0-41e9-a01e-e4096f3da827", + "id": "5d9805ef-df7b-4a2b-a291-1f87efa2604a", "name": "Get a Role", "request": { "name": "Get a Role", @@ -57739,7 +58039,7 @@ }, "response": [ { - "id": "a954ca3c-a202-4e33-aede-6c9e7397529f", + "id": "75c57bdb-002c-45eb-93d6-05e116ee4bf3", "name": "List of all Roles", "originalRequest": { "url": { @@ -57778,12 +58078,12 @@ "value": "application/json" } ], - "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"IDENTITY_LIST\",\n \"criteria\": {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"ipsum4\": -5147911,\n \"ad_3c\": true,\n \"ut_439\": -93054213.92815138\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"dolor2ec\": -96294071,\n \"commodo_1f\": -17114455.855600223\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "dfecefb6-5cd5-462f-b8e4-48f0fa54059d", + "id": "6e7b0a9b-d8e8-4b45-980e-dd67e3931448", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -57822,12 +58122,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5e4047b4-57c8-41b6-8e26-f25c1a89b5bd", + "id": "8034beb7-d056-4161-9791-c422b7a96595", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -57871,7 +58171,7 @@ "_postman_previewlanguage": "json" }, { - "id": "91c2e16c-5fe6-4095-b565-35ff647b29ff", + "id": "877b9525-bd6c-4a16-b47b-7d626c7eb34e", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -57910,12 +58210,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "51c1268e-5098-4161-8520-a53fc346d2f5", + "id": "5c3903a3-255c-4661-8122-900007297347", "name": "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.", "originalRequest": { "url": { @@ -57959,7 +58259,7 @@ "_postman_previewlanguage": "json" }, { - "id": "74609edc-eb1c-420d-bd78-8552c6dbf57a", + "id": "214cb9cc-05a9-44ac-b6ba-88d6d61e26d1", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -57998,7 +58298,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -58009,7 +58309,7 @@ } }, { - "id": "a4b9e057-552d-4806-9492-68eaec79670a", + "id": "76825de2-b9f1-438b-980d-1d40befb471f", "name": "Patch a specified Role", "request": { "name": "Patch a specified Role", @@ -58048,7 +58348,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -58059,7 +58359,7 @@ }, "response": [ { - "id": "024e4cb0-68ae-4394-b40f-fe5aa0ea1a67", + "id": "3e6bedcd-a7c7-497e-a3e9-f2a866ace1ea", "name": "Responds with the Role as updated.", "originalRequest": { "url": { @@ -58094,7 +58394,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -58111,12 +58411,12 @@ "value": "application/json" } ], - "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"IDENTITY_LIST\",\n \"criteria\": {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"ipsum4\": -5147911,\n \"ad_3c\": true,\n \"ut_439\": -93054213.92815138\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"dolor2ec\": -96294071,\n \"commodo_1f\": -17114455.855600223\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "27a7242c-1cfc-4982-897e-65ec31592748", + "id": "0dd9b33d-3d4a-46f7-9954-c63287fc00a8", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -58151,7 +58451,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -58168,12 +58468,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a135995d-d7f8-4cad-959b-37f710385ba6", + "id": "fb56b31d-a2ca-42b8-af2d-3e6847ec5865", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -58208,7 +58508,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -58230,7 +58530,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7540bd16-564e-44a9-bea4-d99906e1b318", + "id": "533f95ea-12e0-4631-92f1-3e2f3a863282", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -58265,7 +58565,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -58282,12 +58582,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "180d65ed-2af7-4377-96a1-0571a3154633", + "id": "69264ab7-8064-4162-9f83-5dae453d0fe1", "name": "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.", "originalRequest": { "url": { @@ -58322,7 +58622,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -58344,7 +58644,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e6d04562-84b1-4cf8-899d-df56f4620139", + "id": "35b785a1-f5fb-4b51-aea8-304a2a8094f6", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -58379,7 +58679,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -58396,7 +58696,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -58407,7 +58707,7 @@ } }, { - "id": "cc717ad6-9dc7-4030-908e-3b7ae35564b6", + "id": "0ce0acf8-698d-4358-8485-ce96887cf281", "name": "List Identities assigned a Role", "request": { "name": "List Identities assigned a Role", @@ -58488,7 +58788,7 @@ }, "response": [ { - "id": "3fc73238-2629-422e-b22c-f22132c53722", + "id": "9367a4c2-50a1-4a16-a2a1-cc5b33651cbe", "name": "List of Identities assigned the Role", "originalRequest": { "url": { @@ -58574,12 +58874,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"id\": \"\",\n \"aliasName\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"roleAssignmentSource\": \"ROLE_MEMBERSHIP\"\n },\n {\n \"id\": \"\",\n \"aliasName\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"roleAssignmentSource\": \"ROLE_MEMBERSHIP\"\n }\n]", + "body": "[\n {\n \"id\": \"\",\n \"aliasName\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"roleAssignmentSource\": \"ROLE_MEMBERSHIP\"\n },\n {\n \"id\": \"\",\n \"aliasName\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"roleAssignmentSource\": \"ACCESS_REQUEST\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ab3ce718-b65b-4a83-bb8d-28c3ee8cde39", + "id": "ea990b0b-a324-4d66-a5cb-4bf4487c9087", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -58665,12 +58965,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "fa7b22b2-d882-4f81-9cf6-4ee1483031d3", + "id": "fad71923-6942-4a91-833b-56e3689be5ee", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -58761,7 +59061,7 @@ "_postman_previewlanguage": "json" }, { - "id": "182625e6-18b6-4d13-873d-879ba6088164", + "id": "de3478b9-22b2-429a-a289-4a34e26088d5", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -58847,12 +59147,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "cebe1e3c-55d3-4029-b30e-b8b6cfb5e341", + "id": "f972bd29-8d9b-413f-b22c-d8d26a56595c", "name": "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.", "originalRequest": { "url": { @@ -58943,7 +59243,7 @@ "_postman_previewlanguage": "json" }, { - "id": "10e50d84-8edf-4bea-ae4e-70f847271598", + "id": "91ffd538-6996-4e52-9e03-d1f254fca4ed", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -59029,7 +59329,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -59046,7 +59346,7 @@ "description": "Use this API to implement saved search functionality. \nWith saved search functionality in place, users can save search queries and then view those saved searches, as well as rerun them. \n\nSearch queries in IdentityNow can grow very long and specific, which can make reconstructing them difficult or tedious, so it can be especially helpful to save search queries. \nIt also opens the possibility to configure IdentityNow to run the saved queries on a schedule, which is essential to detecting user information and access changes throughout an organization's tenant and across all its sources. \nRefer to [Scheduled Search](https://developer.sailpoint.com/idn/api/v3/scheduled-search) for more information about running saved searches on a schedule. \n\nIn IdentityNow, users can save searches under a name, and then they can access that saved search and run it again when they want. \n\nRefer to [Managing Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html) for more information about saving searches and using them. \n", "item": [ { - "id": "6c6a8e57-8173-4209-83b4-66e2aa3e8cb7", + "id": "50a797a2-1c6e-4b62-9c2b-2a87804519e0", "name": "Create a saved search", "request": { "name": "Create a saved search", @@ -59077,7 +59377,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"entitlements\",\n \"*\"\n ],\n \"query\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"magna_3a\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"nisi4\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"laboref\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"commodo6\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "raw": "{\n \"indices\": [\n \"events\",\n \"accountactivities\"\n ],\n \"query\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"eu_a\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"elit1\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -59088,7 +59388,7 @@ }, "response": [ { - "id": "e252f57f-62dc-4e6c-9b65-36aca2a63840", + "id": "099d2efa-0edd-4992-b32e-dd2b8eb2fdef", "name": "The persisted saved search.", "originalRequest": { "url": { @@ -59122,7 +59422,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"entitlements\",\n \"*\"\n ],\n \"query\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"magna_3a\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"nisi4\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"laboref\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"commodo6\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "raw": "{\n \"indices\": [\n \"events\",\n \"accountactivities\"\n ],\n \"query\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"eu_a\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"elit1\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -59139,12 +59439,12 @@ "value": "application/json" } ], - "body": "{\n \"indices\": [\n \"events\",\n \"accountactivities\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"RULE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"exercitation73d\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "body": "{\n \"indices\": [\n \"roles\",\n \"entitlements\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"mollit_ea4\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"cillum12\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"ullamcoe69\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "85244a86-70b9-4d4c-9de1-4cdde21ad2eb", + "id": "90a2ed1d-3114-4940-8c22-cc12f05f80ae", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -59178,7 +59478,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"entitlements\",\n \"*\"\n ],\n \"query\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"magna_3a\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"nisi4\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"laboref\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"commodo6\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "raw": "{\n \"indices\": [\n \"events\",\n \"accountactivities\"\n ],\n \"query\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"eu_a\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"elit1\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -59195,12 +59495,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "301c990b-33fe-45ab-a692-d0d8f733ee55", + "id": "1795c113-e27b-4133-9c56-5b035df340ca", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -59234,7 +59534,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"entitlements\",\n \"*\"\n ],\n \"query\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"magna_3a\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"nisi4\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"laboref\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"commodo6\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "raw": "{\n \"indices\": [\n \"events\",\n \"accountactivities\"\n ],\n \"query\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"eu_a\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"elit1\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -59251,7 +59551,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -59262,7 +59562,7 @@ } }, { - "id": "77a7c482-4e89-4dfe-a014-4c1c14e4c9e8", + "id": "41347acc-1659-47e9-aa39-cde1b09bd73c", "name": "Return a list of Saved Searches", "request": { "name": "Return a list of Saved Searches", @@ -59328,7 +59628,7 @@ }, "response": [ { - "id": "83f66b51-4a76-415d-85d6-2f0d150b29af", + "id": "ec248219-3096-4eef-8320-52813ce4543b", "name": "The list of requested saved searches.", "originalRequest": { "url": { @@ -59412,12 +59712,12 @@ "value": "" } ], - "body": "[\n {\n \"indices\": [\n \"events\",\n \"*\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"aliquip0\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n },\n {\n \"indices\": [\n \"accessprofiles\",\n \"accountactivities\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"proidentc9\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n]", + "body": "[\n {\n \"indices\": [\n \"*\",\n \"events\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"doloree1\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n },\n {\n \"indices\": [\n \"identities\",\n \"identities\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"dolor3c\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"voluptate7\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"tempord5\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ca32568d-ec97-4f99-a19d-8d737fed4f13", + "id": "021a360a-a1a4-4576-85b6-931f8ffb214c", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -59492,12 +59792,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e75a465d-23ac-4bf1-befb-bb57f678b1d6", + "id": "756be309-e265-4ca5-bdf6-0f7bf4c20e65", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -59572,7 +59872,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -59583,7 +59883,7 @@ } }, { - "id": "47536572-24d5-4fe6-9ca5-d5cfb932f5a1", + "id": "b779de99-499c-4bbb-84de-df241157a040", "name": "Updates an existing saved search\n", "request": { "name": "Updates an existing saved search\n", @@ -59622,7 +59922,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"events\",\n \"accountactivities\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"RULE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"exercitation73d\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "raw": "{\n \"indices\": [\n \"roles\",\n \"entitlements\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"mollit_ea4\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"cillum12\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"ullamcoe69\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -59633,7 +59933,7 @@ }, "response": [ { - "id": "7dd1d7af-6129-4422-9df3-c9615f694476", + "id": "d03e90d0-6788-44ad-8b0f-0c1234e09d5d", "name": "The persisted saved search.", "originalRequest": { "url": { @@ -59668,7 +59968,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"events\",\n \"accountactivities\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"RULE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"exercitation73d\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "raw": "{\n \"indices\": [\n \"roles\",\n \"entitlements\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"mollit_ea4\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"cillum12\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"ullamcoe69\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -59685,12 +59985,12 @@ "value": "application/json" } ], - "body": "{\n \"indices\": [\n \"events\",\n \"accountactivities\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"RULE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"exercitation73d\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "body": "{\n \"indices\": [\n \"roles\",\n \"entitlements\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"mollit_ea4\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"cillum12\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"ullamcoe69\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "85e9962e-bafd-4ea2-a7c1-36b8a797e762", + "id": "696058b7-b697-48a8-83c4-fea2a1112e3d", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -59725,7 +60025,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"events\",\n \"accountactivities\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"RULE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"exercitation73d\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "raw": "{\n \"indices\": [\n \"roles\",\n \"entitlements\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"mollit_ea4\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"cillum12\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"ullamcoe69\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -59742,12 +60042,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "04e66365-4671-49f9-8baf-fdd754f2a463", + "id": "50342e70-7aa0-44ec-91d1-9f86468e9714", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -59782,7 +60082,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"events\",\n \"accountactivities\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"RULE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"exercitation73d\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "raw": "{\n \"indices\": [\n \"roles\",\n \"entitlements\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"mollit_ea4\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"cillum12\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"ullamcoe69\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -59804,7 +60104,7 @@ "_postman_previewlanguage": "json" }, { - "id": "420c1b94-42be-44e5-86a9-242169800058", + "id": "7835a051-1b97-4021-9c0f-4be706c9e7db", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -59839,7 +60139,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"events\",\n \"accountactivities\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"RULE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"exercitation73d\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "raw": "{\n \"indices\": [\n \"roles\",\n \"entitlements\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"mollit_ea4\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"cillum12\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"ullamcoe69\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -59856,12 +60156,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "956e83cc-b0fc-4e05-9d03-9d814ab71bbd", + "id": "3953d330-3f9a-46b8-8777-92c1d6573b7f", "name": "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.", "originalRequest": { "url": { @@ -59896,7 +60196,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"events\",\n \"accountactivities\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"RULE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"exercitation73d\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "raw": "{\n \"indices\": [\n \"roles\",\n \"entitlements\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"mollit_ea4\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"cillum12\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"ullamcoe69\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -59918,7 +60218,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0ea5f985-5f58-4226-9884-a0670d7cc3e1", + "id": "f78bb2ce-85bd-4264-ac03-5c370521947a", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -59953,7 +60253,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"events\",\n \"accountactivities\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"RULE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"exercitation73d\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "raw": "{\n \"indices\": [\n \"roles\",\n \"entitlements\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"mollit_ea4\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"cillum12\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"ullamcoe69\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -59970,7 +60270,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -59981,7 +60281,7 @@ } }, { - "id": "cd4c345c-b2bb-448e-8d10-bdefcbafd5a1", + "id": "7b3d7509-9106-4e6f-b710-d6ab27763d84", "name": "Return saved search by ID", "request": { "name": "Return saved search by ID", @@ -60018,7 +60318,7 @@ }, "response": [ { - "id": "85ee43c4-7f1f-44ef-b342-96382bda37b7", + "id": "39d58998-c1f7-4ee0-aedf-a246c83905a5", "name": "The requested saved search.", "originalRequest": { "url": { @@ -60057,12 +60357,12 @@ "value": "application/json" } ], - "body": "{\n \"indices\": [\n \"events\",\n \"accountactivities\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"RULE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"exercitation73d\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "body": "{\n \"indices\": [\n \"roles\",\n \"entitlements\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"mollit_ea4\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"cillum12\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"ullamcoe69\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "05df6342-70fd-470b-8aa7-c57c814e3d41", + "id": "9797e2bf-0ef3-4d22-970d-5c3bef5f6b0f", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -60101,12 +60401,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d6ed1931-a10b-4a05-88db-2e8cc91d3f93", + "id": "b7d0aad6-d4bb-4ecc-a34e-76f63341fced", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -60150,7 +60450,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ac1457f2-bf69-455b-9284-04d1b4489d21", + "id": "7e6e41fb-530a-4f79-b3f2-c8dba54c56ac", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -60189,12 +60489,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "fa59cd77-907f-40f1-b522-d7d5dd8df246", + "id": "a14140b5-9599-40bf-afd5-12efd5f40a5b", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -60233,12 +60533,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "84b1175f-710d-4f4f-91e4-ba456bf0753b", + "id": "90a124f4-f741-4631-a970-5d44a09af9af", "name": "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.", "originalRequest": { "url": { @@ -60282,7 +60582,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5b376a3d-206b-4bea-8fba-65d863a4d2ea", + "id": "e76c20eb-a80f-4900-9e99-c2769dbbf5df", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -60321,7 +60621,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -60332,7 +60632,7 @@ } }, { - "id": "c472e751-b255-433d-b927-02439dd34597", + "id": "4b3a4ced-d1fd-4d67-8e1f-55340d1c3df2", "name": "Delete document by ID", "request": { "name": "Delete document by ID", @@ -60369,7 +60669,7 @@ }, "response": [ { - "id": "dfaaed28-4348-4993-93f6-ca26e0cc5aec", + "id": "8b87cc16-021e-4f7a-8109-b94e6273d4a6", "name": "No Content - Indicates the request was successful but there is no content to be returned in the response.", "originalRequest": { "url": { @@ -60403,7 +60703,7 @@ "_postman_previewlanguage": "text" }, { - "id": "c86952ab-f3a9-47ad-8c6a-e76462044585", + "id": "d004f327-d1fb-4935-93d4-a47fca8f9a61", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -60442,12 +60742,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "bd902e13-491b-4320-b70b-b8b9f2a9b63f", + "id": "19939cd0-7d9f-4b91-977c-6281d4783168", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -60491,7 +60791,7 @@ "_postman_previewlanguage": "json" }, { - "id": "cc96802c-f11b-4e51-b068-27cb697ca4b4", + "id": "d1daafee-f9fc-43ef-bcdc-05ea71a50d06", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -60530,12 +60830,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "f7098a55-6881-4aab-8b97-3c49762b1dfb", + "id": "2cb9923f-cab7-4639-88cc-c9be7b5d1dfd", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -60574,12 +60874,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "55356be7-2609-4fd1-93bb-cf824fb2b9b8", + "id": "adc64a5f-90b7-44da-919f-bff0bbf1f768", "name": "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.", "originalRequest": { "url": { @@ -60623,7 +60923,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b4780a7e-a00b-4831-8f4e-44c7427a5cfe", + "id": "f4ef112f-e8a0-4d30-aaf6-f496242da2dc", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -60662,7 +60962,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -60673,7 +60973,7 @@ } }, { - "id": "e3ffb41a-4e43-4473-b18c-da759a319670", + "id": "6680e3d6-5a6f-4a80-a8fa-f127fca960fe", "name": "Execute a saved search by ID", "request": { "name": "Execute a saved search by ID", @@ -60713,7 +61013,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"scheduleId\": \"\",\n \"owner\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\"\n },\n {\n \"type\": \"RULE\",\n \"id\": \"\"\n }\n ]\n}", + "raw": "{\n \"scheduleId\": \"\",\n \"owner\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\"\n },\n {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -60724,7 +61024,7 @@ }, "response": [ { - "id": "11f41c9b-f035-4e5f-8c68-44a0aff07b00", + "id": "86654af4-bcc7-425f-86b4-129e273887c7", "name": "Accepted - Returned if the request was successfully accepted into the system.", "originalRequest": { "url": { @@ -60756,7 +61056,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"scheduleId\": \"\",\n \"owner\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\"\n },\n {\n \"type\": \"RULE\",\n \"id\": \"\"\n }\n ]\n}", + "raw": "{\n \"scheduleId\": \"\",\n \"owner\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\"\n },\n {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -60772,7 +61072,7 @@ "_postman_previewlanguage": "text" }, { - "id": "6fe54037-8b2a-4e4b-90b9-5438d62d92db", + "id": "58d138da-4e4d-4803-9021-585aa67e479e", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -60808,7 +61108,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"scheduleId\": \"\",\n \"owner\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\"\n },\n {\n \"type\": \"RULE\",\n \"id\": \"\"\n }\n ]\n}", + "raw": "{\n \"scheduleId\": \"\",\n \"owner\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\"\n },\n {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -60825,12 +61125,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d24ce735-06e9-4baf-ab71-a9705063da1b", + "id": "da04eb24-2b24-46af-8752-c1dc40ef3034", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -60866,7 +61166,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"scheduleId\": \"\",\n \"owner\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\"\n },\n {\n \"type\": \"RULE\",\n \"id\": \"\"\n }\n ]\n}", + "raw": "{\n \"scheduleId\": \"\",\n \"owner\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\"\n },\n {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -60888,7 +61188,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ca62811c-4051-4222-b06c-0eefdc38a78d", + "id": "16f494f6-2e5f-4fb6-b905-1726f3a01b2a", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -60924,7 +61224,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"scheduleId\": \"\",\n \"owner\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\"\n },\n {\n \"type\": \"RULE\",\n \"id\": \"\"\n }\n ]\n}", + "raw": "{\n \"scheduleId\": \"\",\n \"owner\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\"\n },\n {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -60941,12 +61241,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d73ecb9e-c0ac-47db-9fd8-288df9442552", + "id": "0109f3df-79f4-4bda-afc0-f7a3e484aeea", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -60982,7 +61282,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"scheduleId\": \"\",\n \"owner\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\"\n },\n {\n \"type\": \"RULE\",\n \"id\": \"\"\n }\n ]\n}", + "raw": "{\n \"scheduleId\": \"\",\n \"owner\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\"\n },\n {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -60999,12 +61299,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "f7ad0246-7f7e-4126-ad32-5fb376dd8bf3", + "id": "7a519714-45ef-4de0-9307-40bd01b985f8", "name": "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.", "originalRequest": { "url": { @@ -61040,7 +61340,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"scheduleId\": \"\",\n \"owner\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\"\n },\n {\n \"type\": \"RULE\",\n \"id\": \"\"\n }\n ]\n}", + "raw": "{\n \"scheduleId\": \"\",\n \"owner\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\"\n },\n {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -61062,7 +61362,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0a9a1f62-c29e-4404-953b-64489b05132c", + "id": "c89af9eb-77e6-4194-ac62-d470129e0939", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -61098,7 +61398,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"scheduleId\": \"\",\n \"owner\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\"\n },\n {\n \"type\": \"RULE\",\n \"id\": \"\"\n }\n ]\n}", + "raw": "{\n \"scheduleId\": \"\",\n \"owner\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\"\n },\n {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -61115,7 +61415,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -61132,7 +61432,7 @@ "description": "Use this API to implement scheduled search functionality. \nWith scheduled search functionality in place, users can run saved search queries on their tenants on a schedule, and IdentityNow emails them the search results. \nUsers can also share these search results with other users by email by adding those users as subscribers, or those users can subscribe themselves. \n\nOne of the greatest benefits of saving searches is the ability to run those searches on a schedule. \nThis is essential for organizations to constantly detect any changes to user information or access throughout their tenants and across all their sources. \nFor example, the manager Amanda Ross can schedule a saved search \"manager.name:amanda.ross AND attributes.location:austin\" on a schedule to regularly stay aware of changes with the Austin employees reporting to her.\nIdentityNow emails her the search results when the search runs, so she can work on other tasks instead of actively running this search.\n\nIn IdentityNow, scheduling a search involves a subscription. \nUsers can create a subscription for a saved search and schedule it to run daily, weekly, or monthly (you can only use one schedule option at a time). \nThe user can add other identities as subscribers so when the scheduled search runs, the subscribers and the user all receive emails. \n\nBy default, subscriptions exclude detailed results from the emails, for security purposes. \nIncluding detailed results about user access in an email may expose sensitive information.\nHowever, the subscription creator can choose to include the information in the emails. \n\nBy default, IdentityNow sends emails to the subscribers even when the searches do not return new results. \nHowever, the subscription creator can choose to suppress these empty emails. \n\nUsers can also subscribe to saved searches that already have existing subscriptions so they receive emails when the searches run. \nA saved search can have up to 10 subscriptions configured at a time. \n\nThe subscription creator can enable, disable, or delete the subscription. \n\nRefer to [Subscribing to Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html#subscribing-to-saved-searches) for more information about scheduling searches and subscribing to them.\n", "item": [ { - "id": "3cb212b2-e60b-45e0-837f-d501c867000e", + "id": "272dc1ce-cf98-4c6a-81d7-3be823f4954f", "name": "Create a new scheduled search", "request": { "name": "Create a new scheduled search", @@ -61163,7 +61463,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "raw": "{\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", "options": { "raw": { "headerFamily": "json", @@ -61174,7 +61474,7 @@ }, "response": [ { - "id": "5cca6617-692b-420f-a8ee-b7a7450f07f9", + "id": "30287abe-f8da-4e8b-b91d-1eeabbff4740", "name": "The persisted scheduled search.", "originalRequest": { "url": { @@ -61208,7 +61508,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "raw": "{\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", "options": { "raw": { "headerFamily": "json", @@ -61225,12 +61525,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "body": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "4b0f07c0-8c3f-4082-b623-90a567389e7a", + "id": "0c6a59ab-1f2d-449b-b5ef-88f56b94e113", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -61264,7 +61564,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "raw": "{\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", "options": { "raw": { "headerFamily": "json", @@ -61281,12 +61581,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e7382b45-e203-4a39-ad44-be95a993e444", + "id": "0a272aba-e5ca-40ff-a896-951179de37df", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -61320,7 +61620,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "raw": "{\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", "options": { "raw": { "headerFamily": "json", @@ -61342,7 +61642,7 @@ "_postman_previewlanguage": "json" }, { - "id": "33a3f2c6-0a16-48a2-a085-44b94b712b6a", + "id": "29189d6b-f5ec-4e4c-880c-7133a7198d86", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -61376,7 +61676,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "raw": "{\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", "options": { "raw": { "headerFamily": "json", @@ -61393,12 +61693,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a727c170-4ae6-4d63-b792-fd3017ff968a", + "id": "75a6cbbd-ba08-4c3c-a0b1-93ddc97112ee", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -61432,7 +61732,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "raw": "{\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", "options": { "raw": { "headerFamily": "json", @@ -61449,12 +61749,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "9768cbc7-4788-4dc5-a226-c6c900d3a2cc", + "id": "39def305-ad85-456e-a1c1-369cd49d187d", "name": "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.", "originalRequest": { "url": { @@ -61488,7 +61788,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "raw": "{\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", "options": { "raw": { "headerFamily": "json", @@ -61510,7 +61810,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7e6e9e98-12ee-4bbd-857b-16a31679cb0a", + "id": "f6420c10-e640-47f7-a3d7-f782f6c941ed", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -61544,7 +61844,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "raw": "{\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", "options": { "raw": { "headerFamily": "json", @@ -61561,7 +61861,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -61572,7 +61872,7 @@ } }, { - "id": "174c8c9e-fbf4-42a4-803e-9b075a218c31", + "id": "59af034c-87a2-4826-ae7a-9c0fbaed2910", "name": "List scheduled searches", "request": { "name": "List scheduled searches", @@ -61638,7 +61938,7 @@ }, "response": [ { - "id": "046599ed-e55c-4a82-a8be-7ac047ee7b6e", + "id": "9b5078cf-ec28-43c7-bd55-c36e74806828", "name": "The list of requested scheduled searches.", "originalRequest": { "url": { @@ -61722,12 +62022,12 @@ "value": "" } ], - "body": "[\n {\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"DAILY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n },\n {\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n }\n]", + "body": "[\n {\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n },\n {\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ec98d4e4-d71f-4cec-8ee1-ae4944d9abee", + "id": "ab8b439c-d0be-49ab-8932-85c5fe25766e", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -61802,12 +62102,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "31805a0d-c1ec-4234-b606-68370c9c359a", + "id": "03fb0c2c-5702-4201-9ab0-1164a6b37b8c", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -61887,7 +62187,7 @@ "_postman_previewlanguage": "json" }, { - "id": "cf87f231-05c7-4414-b912-ed084d342789", + "id": "86db758f-63aa-4474-bb2d-32b6e25ffe94", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -61962,12 +62262,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "2ee4b2bb-1583-4c61-8e6a-ac992311f3c2", + "id": "1400c83e-d594-45d9-b855-d9274566e2f2", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -62042,12 +62342,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "01f61cbe-9157-42e3-93b8-9869ed9c218f", + "id": "62fb9f92-b31c-46ed-86a2-6870e013ced3", "name": "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.", "originalRequest": { "url": { @@ -62127,7 +62427,7 @@ "_postman_previewlanguage": "json" }, { - "id": "455719b7-158c-4ea2-a207-136ee9e1bedf", + "id": "6b4535bb-bbed-41a7-bd88-cdf969320aec", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -62202,7 +62502,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -62213,7 +62513,7 @@ } }, { - "id": "b04e7d25-630a-42c7-a0a9-e79081bc34b3", + "id": "a3b38307-d5fc-46d5-8313-5916b3f24645", "name": "Update an existing Scheduled Search", "request": { "name": "Update an existing Scheduled Search", @@ -62252,7 +62552,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "raw": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", "options": { "raw": { "headerFamily": "json", @@ -62263,7 +62563,7 @@ }, "response": [ { - "id": "913d4e0c-d9b1-454b-84bb-f75ba45b40ae", + "id": "6a3a826c-2bb0-4b66-80ce-6e0887633313", "name": "The persisted scheduled search.", "originalRequest": { "url": { @@ -62298,7 +62598,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "raw": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", "options": { "raw": { "headerFamily": "json", @@ -62315,12 +62615,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "body": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d6c67d7d-bb74-4c1c-b5e2-4ac800888a11", + "id": "56560f1e-dae4-4138-b5a7-7f1ee2e74c8f", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -62355,7 +62655,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "raw": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", "options": { "raw": { "headerFamily": "json", @@ -62372,12 +62672,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6434dfe0-4378-4f2f-9e12-493c542c1159", + "id": "3ae656b8-7eb0-45ae-b506-4d1ae268d615", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -62412,7 +62712,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "raw": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", "options": { "raw": { "headerFamily": "json", @@ -62434,7 +62734,7 @@ "_postman_previewlanguage": "json" }, { - "id": "193431f6-4180-4dc7-a562-ca0d5a57735d", + "id": "20d37cdf-7531-45d9-bd09-dd8f8cf00406", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -62469,7 +62769,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "raw": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", "options": { "raw": { "headerFamily": "json", @@ -62486,12 +62786,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "414a1d56-8c4b-4518-b6a0-c882845e8651", + "id": "f09673ff-f066-4a43-b098-5991212e1781", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -62526,7 +62826,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "raw": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", "options": { "raw": { "headerFamily": "json", @@ -62543,12 +62843,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0787dae8-37d9-4905-b9d0-6ccd6a429506", + "id": "8438c624-f9db-4911-bf47-fd3c8a79da85", "name": "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.", "originalRequest": { "url": { @@ -62583,7 +62883,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "raw": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", "options": { "raw": { "headerFamily": "json", @@ -62605,7 +62905,7 @@ "_postman_previewlanguage": "json" }, { - "id": "edc41b27-9c03-499a-a155-cb7d5fe2a68a", + "id": "4565c5a2-2e99-4aec-a1e2-f68973d5d404", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -62640,7 +62940,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "raw": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", "options": { "raw": { "headerFamily": "json", @@ -62657,7 +62957,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -62668,7 +62968,7 @@ } }, { - "id": "cccca564-8fc7-4b36-afa9-dbc7d4e175ba", + "id": "40f59498-19a2-48ac-a303-4d0bf1cd6aaa", "name": "Get a Scheduled Search", "request": { "name": "Get a Scheduled Search", @@ -62705,7 +63005,7 @@ }, "response": [ { - "id": "326a1149-936c-410f-b343-e70b36f74bd9", + "id": "0667ae54-fb68-46e8-8b71-36f825fba055", "name": "The requested scheduled search.", "originalRequest": { "url": { @@ -62744,12 +63044,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "body": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "9022dad8-5fbe-42df-8f10-30c3787568ac", + "id": "b6efe0eb-3a9d-41ff-843e-410405f42295", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -62788,12 +63088,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "4fc4946e-a5f7-4918-ab2a-092db6f1e9d8", + "id": "cc9e93e8-5f88-4867-baac-df307d681d8c", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -62837,7 +63137,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c5565154-e2df-4ef2-b27c-fc55af059b66", + "id": "af6c8314-d446-406c-9244-4c2edc19ac2a", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -62876,12 +63176,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1a704d96-3739-4184-a8dd-61b70f7a61ee", + "id": "6da2179a-d55f-4991-8d56-887f8892b576", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -62920,12 +63220,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "be81dcd7-f59f-4ea5-9ed2-628c671eb8c6", + "id": "70ff8d45-ede8-4cd1-9ced-e487a845f946", "name": "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.", "originalRequest": { "url": { @@ -62969,7 +63269,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d8781885-93cd-4cbb-8a3e-645752b4b347", + "id": "cce168aa-ca32-4e37-be29-57abb27871f2", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -63008,7 +63308,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -63019,7 +63319,7 @@ } }, { - "id": "ccc4dec6-09b8-4e3f-b9da-82ad3a21cdc5", + "id": "3254b9fd-c0f7-42e5-a47e-43abd1191b22", "name": "Delete a Scheduled Search", "request": { "name": "Delete a Scheduled Search", @@ -63056,7 +63356,7 @@ }, "response": [ { - "id": "2cac3a94-03d3-41fe-9707-45cf0cdb818a", + "id": "f1404528-ef18-4a56-a833-5261f254dee4", "name": "No Content - Indicates the request was successful but there is no content to be returned in the response.", "originalRequest": { "url": { @@ -63090,7 +63390,7 @@ "_postman_previewlanguage": "text" }, { - "id": "6a7794ec-b0a5-4c29-9d80-8277f085c3cc", + "id": "2e2f5348-eabb-42ec-8a3b-d97429e63ceb", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -63129,12 +63429,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "2b02aad2-9e3e-4c87-a2c3-a6a9f23225a1", + "id": "34699bae-377e-4579-a343-2f129b721b02", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -63178,7 +63478,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6785a745-e346-44ad-b4e7-95960161e6dc", + "id": "536d27c8-40fa-47f4-afa0-28a34c2ab762", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -63217,12 +63517,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "49a2d961-7c6c-435f-b880-35b6c49b2b33", + "id": "ae21eac8-1d3c-4d2d-84c3-6fc043f68649", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -63261,12 +63561,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3471c58a-5843-4d56-a497-5e673b7dc8ad", + "id": "937caada-ad4a-4954-a34d-7e20bfc6a68e", "name": "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.", "originalRequest": { "url": { @@ -63310,7 +63610,7 @@ "_postman_previewlanguage": "json" }, { - "id": "761a4757-3291-41b0-b25a-a44c67c2203a", + "id": "3e53a7a3-4882-406d-a509-ab38344ab734", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -63349,7 +63649,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -63360,7 +63660,7 @@ } }, { - "id": "e3e3ff12-4213-4694-a5ad-b526d8851242", + "id": "8b3cbf9e-9461-4a14-a494-176573890941", "name": "Unsubscribe a recipient from Scheduled Search", "request": { "name": "Unsubscribe a recipient from Scheduled Search", @@ -63400,7 +63700,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"type\": \"ACCOUNT\",\n \"id\": \"\"\n}", + "raw": "{\n \"type\": \"ROLE\",\n \"id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -63411,7 +63711,7 @@ }, "response": [ { - "id": "29955c32-049a-456c-94ba-843aa265ec1b", + "id": "b572615d-1654-4dc2-ad3e-169d004fd721", "name": "No Content - Indicates the request was successful but there is no content to be returned in the response.", "originalRequest": { "url": { @@ -63443,7 +63743,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"type\": \"ACCOUNT\",\n \"id\": \"\"\n}", + "raw": "{\n \"type\": \"ROLE\",\n \"id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -63459,7 +63759,7 @@ "_postman_previewlanguage": "text" }, { - "id": "3163e01a-a6f7-40ee-900a-b487049e0ad2", + "id": "38c14959-c2ef-4482-8376-93c7c31b8f64", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -63495,7 +63795,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"type\": \"ACCOUNT\",\n \"id\": \"\"\n}", + "raw": "{\n \"type\": \"ROLE\",\n \"id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -63512,12 +63812,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c4cc28a5-231e-40ad-9a12-154f473e35cd", + "id": "a5ad9177-ab4d-4aba-8db8-f1cfaba0e99a", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -63553,7 +63853,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"type\": \"ACCOUNT\",\n \"id\": \"\"\n}", + "raw": "{\n \"type\": \"ROLE\",\n \"id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -63570,12 +63870,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e872d690-a5d3-4e22-ae1e-f7b4cffe40c1", + "id": "b0f00dac-63af-4f67-8552-87cac792c836", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -63611,7 +63911,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"type\": \"ACCOUNT\",\n \"id\": \"\"\n}", + "raw": "{\n \"type\": \"ROLE\",\n \"id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -63628,7 +63928,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -63645,7 +63945,7 @@ "description": "Use this API to implement search functionality. \nWith search functionality in place, users can search their tenants for nearly any information from throughout their organizations. \n\nIdentityNow enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential. \nIts search goes through all those sources and finds the results quickly and specifically. \n\nThe search query is flexible - it can be very broad or very narrow. \nThe search only returns results for searchable objects it is filtering for. \nThe following objects are searchable: identities, roles, access profiles, entitlements, events, and account activities. \nBy default, no filter is applied, so a search for \"Ad\" returns both the identity \"Adam.Archer\" as well as the role \"Administrator.\"\n\nUsers can further narrow their results by using IdentityNow's specific syntax and punctuation to structure their queries. \nFor example, the query \"attributes.location:austin AND NOT manager.name:amanda.ross\" returns all results associated with the Austin location, but it excludes those associated with the manager Amanda Ross.\nRefer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html) for more information about how to construct specific search queries. \n\nRefer to [Using Search](https://documentation.sailpoint.com/saas/help/search/index.html) for more information about IdentityNow's search and its different possibilities. \n\nThe search feature uses Elasticsearch as a datastore and query engine. \nThe power of Elasticsearch makes this feature suitable for ad-hoc reporting.\nHowever, data from the operational databases (ex. identities, roles, events, etc) has to be ingested into Elasticsearch. \nThis ingestion process introduces a latency from when the operational data is created to when it is available in search. \nDepending on the system load, this can take a few seconds to a few minutes. \nPlease keep this latency in mind when you use search. \n", "item": [ { - "id": "ea53e6ad-43a3-4c57-b450-cc3acd00cf97", + "id": "50c37261-3074-442b-812e-d96b02ad3940", "name": "Perform Search", "request": { "name": "Perform Search", @@ -63704,7 +64004,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"entitlements\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"minimbd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"cillum_c78\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"non81\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"ut_25d\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"proidentd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "raw": "{\n \"indices\": [\n \"*\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"doloref0\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"temporff0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -63715,7 +64015,7 @@ }, "response": [ { - "id": "ae95ac4d-f3c5-4156-965c-b306ddc9cea4", + "id": "569e81fe-ef6e-480b-9e4e-c659b9119070", "name": "List of matching documents.", "originalRequest": { "url": { @@ -63777,7 +64077,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"entitlements\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"minimbd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"cillum_c78\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"non81\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"ut_25d\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"proidentd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "raw": "{\n \"indices\": [\n \"*\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"doloref0\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"temporff0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -63803,12 +64103,12 @@ "value": "" } ], - "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"_type\": \"accessprofile\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"synced\": \"\",\n \"enabled\": \"\",\n \"requestable\": \"\",\n \"requestCommentsRequired\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"IDENTITY_PROFILE\",\n \"email\": \"\"\n },\n \"source\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ],\n \"entitlementCount\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"_type\": \"entitlement\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"synced\": \"\",\n \"enabled\": \"\",\n \"requestable\": \"\",\n \"requestCommentsRequired\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"APPLICATION\",\n \"email\": \"\"\n },\n \"source\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ],\n \"entitlementCount\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n }\n]", + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"_type\": \"aggregation\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"synced\": \"\",\n \"enabled\": \"\",\n \"requestable\": \"\",\n \"requestCommentsRequired\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"IDENTITY_PROFILE\",\n \"email\": \"\"\n },\n \"source\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ],\n \"entitlementCount\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"_type\": \"event\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"synced\": \"\",\n \"enabled\": \"\",\n \"requestable\": \"\",\n \"requestCommentsRequired\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"email\": \"\"\n },\n \"source\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ],\n \"entitlementCount\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7dc893aa-e077-48ce-918d-82ecace33690", + "id": "a70570c5-0586-4982-9f3c-11467e233752", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -63870,7 +64170,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"entitlements\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"minimbd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"cillum_c78\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"non81\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"ut_25d\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"proidentd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "raw": "{\n \"indices\": [\n \"*\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"doloref0\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"temporff0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -63887,12 +64187,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "dec0455d-2a1d-4201-ab3f-2c8b7e559fb1", + "id": "f786f5a0-8bfd-4543-ae06-24d11ca7581d", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -63954,7 +64254,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"entitlements\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"minimbd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"cillum_c78\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"non81\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"ut_25d\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"proidentd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "raw": "{\n \"indices\": [\n \"*\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"doloref0\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"temporff0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -63976,7 +64276,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9ded44d7-a9c7-4759-a729-6a806f93a0a5", + "id": "a84d176e-5269-4f4f-b94b-6cfeb6b765cc", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -64038,7 +64338,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"entitlements\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"minimbd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"cillum_c78\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"non81\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"ut_25d\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"proidentd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "raw": "{\n \"indices\": [\n \"*\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"doloref0\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"temporff0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -64055,12 +64355,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "656069d5-fcb3-4fc6-bc7c-6dda20711e2a", + "id": "74acf0f6-eb5c-4a60-ab47-1f28140e4323", "name": "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.", "originalRequest": { "url": { @@ -64122,7 +64422,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"entitlements\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"minimbd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"cillum_c78\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"non81\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"ut_25d\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"proidentd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "raw": "{\n \"indices\": [\n \"*\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"doloref0\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"temporff0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -64144,7 +64444,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0269b39d-4091-4256-b9f9-7c28ec9a55d0", + "id": "63eb17a1-954d-4c99-bd33-1bce60e1fa12", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -64206,7 +64506,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"entitlements\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"minimbd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"cillum_c78\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"non81\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"ut_25d\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"proidentd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "raw": "{\n \"indices\": [\n \"*\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"doloref0\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"temporff0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -64223,7 +64523,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -64234,7 +64534,7 @@ } }, { - "id": "4505191b-5fc2-4fdf-89d6-31593562a6ea", + "id": "c3fd5d4a-a3ea-4807-aca7-97fb51759f71", "name": "Count Documents Satisfying a Query", "request": { "name": "Count Documents Satisfying a Query", @@ -64266,7 +64566,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"entitlements\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"minimbd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"cillum_c78\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"non81\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"ut_25d\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"proidentd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "raw": "{\n \"indices\": [\n \"*\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"doloref0\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"temporff0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -64277,7 +64577,7 @@ }, "response": [ { - "id": "62b3303f-f8f0-45f1-b6ac-24dbe2931ae9", + "id": "7435df41-2f85-4729-8510-7c537b0d8c42", "name": "No content - indicates the request was successful but there is no content to be returned in the response.", "originalRequest": { "url": { @@ -64308,7 +64608,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"entitlements\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"minimbd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"cillum_c78\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"non81\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"ut_25d\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"proidentd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "raw": "{\n \"indices\": [\n \"*\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"doloref0\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"temporff0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -64334,7 +64634,7 @@ "_postman_previewlanguage": "text" }, { - "id": "4c151835-5d94-4446-a2fc-15f2cee7cf8c", + "id": "c623d7da-4342-40a9-bc3c-40c18b496d4f", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -64369,7 +64669,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"entitlements\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"minimbd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"cillum_c78\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"non81\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"ut_25d\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"proidentd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "raw": "{\n \"indices\": [\n \"*\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"doloref0\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"temporff0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -64386,12 +64686,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8a6e7442-20d3-4ae6-b7da-0482e83b391f", + "id": "8d0694a5-293a-43af-994c-ab16f3b1fb5e", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -64426,7 +64726,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"entitlements\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"minimbd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"cillum_c78\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"non81\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"ut_25d\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"proidentd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "raw": "{\n \"indices\": [\n \"*\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"doloref0\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"temporff0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -64448,7 +64748,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1424fc02-94bd-47fc-8e1e-88d5b5afbea0", + "id": "5c8e69d7-ffde-463d-97ff-b540cfaebfcf", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -64483,7 +64783,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"entitlements\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"minimbd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"cillum_c78\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"non81\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"ut_25d\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"proidentd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "raw": "{\n \"indices\": [\n \"*\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"doloref0\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"temporff0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -64500,12 +64800,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "38551d62-cda5-4baf-8ece-339cf24b8bb1", + "id": "6efa826b-b4d9-4a4c-abcc-4ea4fc67a7f8", "name": "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.", "originalRequest": { "url": { @@ -64540,7 +64840,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"entitlements\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"minimbd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"cillum_c78\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"non81\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"ut_25d\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"proidentd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "raw": "{\n \"indices\": [\n \"*\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"doloref0\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"temporff0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -64562,7 +64862,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f7b168e4-96ea-4b5e-ac33-b9ba0312d48f", + "id": "5e2d6d68-0f28-4581-aedf-6ba4536acc41", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -64597,7 +64897,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"entitlements\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"minimbd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"cillum_c78\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"non81\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"ut_25d\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"proidentd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "raw": "{\n \"indices\": [\n \"*\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"doloref0\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"temporff0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -64614,7 +64914,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -64625,7 +64925,7 @@ } }, { - "id": "67b4b7a2-cd9e-4b13-9f97-92e151ba4222", + "id": "97427aae-3e5c-4140-8821-5132fd7b6866", "name": "Perform a Search Query Aggregation", "request": { "name": "Perform a Search Query Aggregation", @@ -64685,7 +64985,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"entitlements\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"minimbd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"cillum_c78\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"non81\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"ut_25d\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"proidentd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "raw": "{\n \"indices\": [\n \"*\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"doloref0\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"temporff0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -64696,7 +64996,7 @@ }, "response": [ { - "id": "00e8f292-12a7-450b-abe3-2bbaf4f431bd", + "id": "99a42f15-4b7b-493d-9f1d-a277d43e0543", "name": "Aggregation results.", "originalRequest": { "url": { @@ -64759,7 +65059,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"entitlements\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"minimbd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"cillum_c78\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"non81\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"ut_25d\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"proidentd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "raw": "{\n \"indices\": [\n \"*\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"doloref0\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"temporff0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -64785,12 +65085,12 @@ "value": "" } ], - "body": "{\n \"aggregations\": {},\n \"hits\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"_type\": \"role\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"synced\": \"\",\n \"enabled\": \"\",\n \"requestable\": \"\",\n \"requestCommentsRequired\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"SOURCE\",\n \"email\": \"\"\n },\n \"source\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ],\n \"entitlementCount\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"_type\": \"role\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"synced\": \"\",\n \"enabled\": \"\",\n \"requestable\": \"\",\n \"requestCommentsRequired\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"ACCOUNT\",\n \"email\": \"\"\n },\n \"source\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ],\n \"entitlementCount\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "body": "{\n \"aggregations\": {},\n \"hits\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"_type\": \"account\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"synced\": \"\",\n \"enabled\": \"\",\n \"requestable\": \"\",\n \"requestCommentsRequired\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"TAG\",\n \"email\": \"\"\n },\n \"source\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ],\n \"entitlementCount\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"_type\": \"accessprofile\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"synced\": \"\",\n \"enabled\": \"\",\n \"requestable\": \"\",\n \"requestCommentsRequired\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"LIFECYCLE_STATE\",\n \"email\": \"\"\n },\n \"source\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ],\n \"entitlementCount\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6cc375ac-992b-47f0-8d6c-94bb5fc770e6", + "id": "411a1007-edc3-4b39-9858-367be0752734", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -64853,7 +65153,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"entitlements\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"minimbd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"cillum_c78\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"non81\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"ut_25d\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"proidentd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "raw": "{\n \"indices\": [\n \"*\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"doloref0\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"temporff0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -64870,12 +65170,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c6cffa9f-bae9-43b3-b5a0-77c6425a6916", + "id": "652c8d03-7c46-466c-a214-1b42166746d6", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -64938,7 +65238,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"entitlements\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"minimbd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"cillum_c78\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"non81\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"ut_25d\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"proidentd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "raw": "{\n \"indices\": [\n \"*\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"doloref0\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"temporff0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -64960,7 +65260,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9ed78a47-09d1-4f8a-935b-eb9926924217", + "id": "5946b3b3-a244-44de-8c47-7ab425335799", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -65023,7 +65323,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"entitlements\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"minimbd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"cillum_c78\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"non81\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"ut_25d\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"proidentd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "raw": "{\n \"indices\": [\n \"*\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"doloref0\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"temporff0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -65040,12 +65340,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0c890c82-4c17-412a-a163-5a44da1346bc", + "id": "fb6906fe-3772-4802-acd7-8472eb260d2d", "name": "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.", "originalRequest": { "url": { @@ -65108,7 +65408,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"entitlements\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"minimbd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"cillum_c78\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"non81\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"ut_25d\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"proidentd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "raw": "{\n \"indices\": [\n \"*\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"doloref0\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"temporff0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -65130,7 +65430,7 @@ "_postman_previewlanguage": "json" }, { - "id": "eca5df97-ec92-4c78-a5c1-9e8f11d35e2f", + "id": "de092228-6eaa-46a6-b266-1b3af4238a74", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -65193,7 +65493,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"indices\": [\n \"entitlements\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"minimbd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"cillum_c78\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"non81\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"ut_25d\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"proidentd1\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "raw": "{\n \"indices\": [\n \"*\",\n \"entitlements\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"doloref0\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"temporff0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -65210,7 +65510,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -65221,7 +65521,7 @@ } }, { - "id": "f3cf30ac-2d63-4387-a43f-70d6ce26981a", + "id": "4acf7e1b-f80d-46af-a998-70db2e890246", "name": "Get a Document by ID", "request": { "name": "Get a Document by ID", @@ -65265,7 +65565,7 @@ }, "response": [ { - "id": "aa1c6db2-706c-4a21-8c6a-7b0331fdb9ba", + "id": "072e4d86-6b42-441c-ab34-48be936961ac", "name": "The requested document.", "originalRequest": { "url": { @@ -65305,12 +65605,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"_type\": \"accessprofile\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"synced\": \"\",\n \"enabled\": \"\",\n \"requestable\": \"\",\n \"requestCommentsRequired\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"email\": \"\"\n },\n \"source\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ],\n \"entitlementCount\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"_type\": \"event\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"synced\": \"\",\n \"enabled\": \"\",\n \"requestable\": \"\",\n \"requestCommentsRequired\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"TASK_RESULT\",\n \"email\": \"\"\n },\n \"source\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ],\n \"entitlementCount\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e464fe78-27c3-4165-b557-71de6883fca2", + "id": "3c273662-7762-47fa-b6b3-c7e70d18cda3", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -65350,12 +65650,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e3810370-c7b7-4a3d-aa96-b3a4e8d93629", + "id": "51637e29-3df1-4a13-a948-7c9a4652d543", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -65400,7 +65700,7 @@ "_postman_previewlanguage": "json" }, { - "id": "38b92435-cd9c-4f11-a269-2d0ae9528188", + "id": "deba6d7f-f5ba-4e5c-b900-216e4b1c5bb7", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -65440,12 +65740,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8b0d5b26-7e87-4f7b-9179-0015f56364ea", + "id": "52c39ea4-2126-4f6d-811b-6d2b4ea73906", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -65485,12 +65785,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "bd48ab52-844e-47d4-9778-8d974fc418b8", + "id": "5fbb2c40-fba7-40f2-8d0a-6427848edc9d", "name": "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.", "originalRequest": { "url": { @@ -65535,7 +65835,7 @@ "_postman_previewlanguage": "json" }, { - "id": "abb54441-089a-4732-836e-bb04bff47a67", + "id": "d1d5b2bc-7d9d-4265-a8e2-c5fa805b3a6f", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -65575,7 +65875,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -65592,7 +65892,7 @@ "description": "Use this API to implement and customize access request segment functionality. \nWith this functionality in place, administrators can create and manage access request segments. \nSegments provide organizations with a way to make the access their users have even more granular - this can simply the access request process for the organization's users and improves security by reducing the risk of overprovisoning access. \n\nSegments represent sets of identities, all grouped by specified identity attributes, who are only able to see and access the access items associated with their segments.\nFor example, administrators could group all their organization's London office employees into one segment, \"London Office Employees,\" by their shared location. \nThe administrators could then define the access items the London employees would need, and the identities in the \"London Office Employees\" would then only be able to see and access those items.\n\nIn IdentityNow, administrators can use the 'Access' drop-down menu and select 'Segments' to reach the 'Access Requests Segments' page. \nThis page lists all the existing access request segments, along with their statuses, enabled or disabled. \nAdministrators can use this page to create, edit, enable, disable, and delete segments. \nTo create a segment, an administrator must provide a name, define the identities grouped in the segment, and define the items the identities in the segment can access.\nThese items can be access profiles, roles, or entitlements. \n\nWhen administrators use the API to create and manage segments, they use a JSON expression in the `visibilityCriteria` object to define the segment's identities and access items. \n\nRefer to [Managing Access Request Segments](https://documentation.sailpoint.com/saas/help/requests/segments.html) for more information about segments in IdentityNow. \n", "item": [ { - "id": "ca2dc0b3-7d06-4830-9c55-0594ed033e7f", + "id": "0a20454a-6cc9-4d8b-b789-eff6e51a9649", "name": "Create Segment", "request": { "name": "Create Segment", @@ -65623,7 +65923,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", "options": { "raw": { "headerFamily": "json", @@ -65634,7 +65934,7 @@ }, "response": [ { - "id": "18cdddc5-e7e4-483c-ad52-9f6a51c45f01", + "id": "d395db72-4233-48eb-882f-540133cbee7c", "name": "Segment created", "originalRequest": { "url": { @@ -65668,7 +65968,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", "options": { "raw": { "headerFamily": "json", @@ -65685,12 +65985,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e92d953e-877e-498f-b82c-c41eca893586", + "id": "144c54b9-4bac-4608-b58a-030d36a88a68", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -65724,7 +66024,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", "options": { "raw": { "headerFamily": "json", @@ -65741,12 +66041,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "954e3004-53d8-4d94-ad73-61634b1abed7", + "id": "a1b9edd3-6314-4c7e-96f6-d9fc6ebaeddd", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -65780,7 +66080,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", "options": { "raw": { "headerFamily": "json", @@ -65802,7 +66102,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6c81f3aa-3ce9-41ee-9db7-1fdd4b94d011", + "id": "d27e75ec-2cc3-4597-a376-e22631403ab4", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -65836,7 +66136,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", "options": { "raw": { "headerFamily": "json", @@ -65853,12 +66153,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "608ccdb1-02c5-4d59-8cfb-20677973f101", + "id": "b4fef381-64ef-442d-b2a1-0dc3e17a9754", "name": "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.", "originalRequest": { "url": { @@ -65892,7 +66192,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", "options": { "raw": { "headerFamily": "json", @@ -65914,7 +66214,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9795131c-a024-4a46-8382-0a386e3d86c3", + "id": "7bfcb87b-14eb-4370-aed5-ddde280bb543", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -65948,7 +66248,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", "options": { "raw": { "headerFamily": "json", @@ -65965,7 +66265,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -65976,7 +66276,7 @@ } }, { - "id": "75ddf018-a77b-4e9f-9f28-e67560584968", + "id": "6bfec41a-f8a8-4af9-aaef-5b8e79ff74d1", "name": "List Segments", "request": { "name": "List Segments", @@ -66033,7 +66333,7 @@ }, "response": [ { - "id": "5274f76f-40de-4bf8-b104-27a24314b566", + "id": "2a7f81b3-e7db-4e90-ac6d-d95c0057feb7", "name": "List of all segments", "originalRequest": { "url": { @@ -66099,12 +66399,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n }\n]", + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "bc8035b6-1f8e-4788-bd85-25470ef7239a", + "id": "990e054c-cb20-4058-b5c0-5494f242d80d", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -66170,12 +66470,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "9c55b0a5-ebd5-4330-aadc-b486c16357cb", + "id": "3d967689-7355-4b99-9475-eab317138ced", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -66246,7 +66546,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d1dc8891-ba04-4130-a822-a3464be60b8c", + "id": "8e05bcb3-d3c9-4054-8a57-3d5dda32f585", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -66312,12 +66612,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "50b55f44-1b53-453e-8c5e-a2134b16b0ee", + "id": "8cc5f4e4-7311-4fa5-9d02-d38d6259f8f9", "name": "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.", "originalRequest": { "url": { @@ -66388,7 +66688,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5344dd11-e816-446d-a53f-f56f0690de09", + "id": "f8e61da2-b1a5-49d2-aa88-adae6c7362b0", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -66454,7 +66754,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -66465,7 +66765,7 @@ } }, { - "id": "6a43f14b-105a-4b9b-9c96-e3ebb9de8003", + "id": "b6c204d7-dbf8-4f5c-a2d6-9978795458cd", "name": "Get Segment by ID", "request": { "name": "Get Segment by ID", @@ -66502,7 +66802,7 @@ }, "response": [ { - "id": "13302ffe-83a7-461a-b5fb-d6bd6d907f01", + "id": "0c1cd6a1-e226-4e7e-885f-2da1cf5556a2", "name": "Segment", "originalRequest": { "url": { @@ -66541,12 +66841,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3137adc0-4f86-4be5-a379-42248a81f22e", + "id": "3ec6e31f-1eb5-44f3-bc7e-7e42849895d2", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -66585,12 +66885,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "967b4d8c-f71b-46f5-99a3-e161e1112ac1", + "id": "59df41c3-f63a-4df4-9b06-30fd1174ce9d", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -66634,7 +66934,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3f69c150-d686-4ee6-8b8a-c7b65fe78061", + "id": "67aae85a-8424-4a94-8251-b15d140495d6", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -66673,12 +66973,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "bcbeb8c8-95aa-4c40-8d0a-cdc491888f5f", + "id": "ff2aa3e8-780b-42a8-b2c4-0eb737b458dc", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -66717,12 +67017,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3599db20-4d10-4f26-a3f6-fd068cdd6861", + "id": "78d42c97-d5bf-4476-85f8-f625041bc4b2", "name": "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.", "originalRequest": { "url": { @@ -66766,7 +67066,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1508ab46-7019-4a05-9492-5f5095aba2da", + "id": "3f621ecf-0eb9-4fd8-824b-4f4fb43c668a", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -66805,7 +67105,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -66816,7 +67116,7 @@ } }, { - "id": "6fc4aaca-33c0-4e67-90c8-af90717c2c01", + "id": "becc2f05-8769-4764-b33f-b18e4a38eba2", "name": "Delete Segment by ID", "request": { "name": "Delete Segment by ID", @@ -66853,7 +67153,7 @@ }, "response": [ { - "id": "2abcc325-4d39-4609-a61b-bdff92813d9f", + "id": "e7beb119-bf53-4003-b8a5-a2d1c1ace323", "name": "No content.", "originalRequest": { "url": { @@ -66887,7 +67187,7 @@ "_postman_previewlanguage": "text" }, { - "id": "bf81eb3a-afde-4ca4-8de3-0a636b40605d", + "id": "05f89afd-47aa-40e8-a43d-ea81a5957e1f", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -66926,12 +67226,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7bba09cb-a97c-4ce4-84f4-c507b9d91cd2", + "id": "1cf8dd87-b76c-4c0f-a302-4bfb489a7478", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -66975,7 +67275,7 @@ "_postman_previewlanguage": "json" }, { - "id": "fa3e11ee-4bfe-413e-96fa-3727d732d11c", + "id": "8d49246a-7dee-43a6-a9e0-661deaf9d197", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -67014,12 +67314,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ef078da0-62c3-44b2-88cf-6be0e90419f3", + "id": "bf438356-6579-48da-87dc-deafbf2d7a88", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -67058,12 +67358,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "85aa1e62-eb11-4c53-9bab-793f19559ca6", + "id": "e97369be-0375-457f-88d8-592003976f40", "name": "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.", "originalRequest": { "url": { @@ -67107,7 +67407,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e85c19e5-2747-41f5-83ff-20e95f9e8bb1", + "id": "cc8394f2-ca8e-4505-8305-4c2ba075271a", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -67146,7 +67446,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -67157,7 +67457,7 @@ } }, { - "id": "afcdf9cd-aedb-49d0-adfb-b78df3b4c2e1", + "id": "58d1a61b-d8e7-41ea-9240-2fa9332e040c", "name": "Update Segment", "request": { "name": "Update Segment", @@ -67207,7 +67507,7 @@ }, "response": [ { - "id": "40ee3855-ce41-4537-9cda-0d9f7da2535b", + "id": "8851e397-803a-4c45-b879-7b74b72577ba", "name": "Indicates the PATCH operation succeeded, and returns the segment's new representation.", "originalRequest": { "url": { @@ -67259,12 +67559,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6d091d4b-877e-42e3-a9c6-c8a8e974ed85", + "id": "0ca25c20-9193-4453-8b63-553b564803dd", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -67316,12 +67616,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "821d4a34-66e2-42c6-b7b3-52f971dd4d47", + "id": "e4187069-0a5c-4898-95f1-277cac0e0fec", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -67378,7 +67678,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8c236d9b-a922-4ba2-9545-734a93abf60e", + "id": "e6ae4e45-2a8d-4703-950b-40ae53955fe7", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -67430,12 +67730,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c61cd906-c0bd-48dd-b19a-066632900528", + "id": "9e02244a-492e-4acb-bd68-0692d862f4be", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -67487,12 +67787,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "fa8a6294-fc9b-401b-98b4-13ab32eec3b6", + "id": "9deb3542-42ff-406d-95be-3dca992d5d8c", "name": "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.", "originalRequest": { "url": { @@ -67549,7 +67849,7 @@ "_postman_previewlanguage": "json" }, { - "id": "12703e21-ae60-4b99-afea-7864d380deff", + "id": "4cf4555a-7265-48d1-9c92-8b501ec4e7e6", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -67601,7 +67901,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -67618,7 +67918,7 @@ "description": "Use this API to build an integration between IdentityNow and a service desk ITSM (IT service management) solution. \nOnce an administrator builds this integration between IdentityNow and a service desk, users can use IdentityNow to raise and track tickets that are synchronized between IdentityNow and the service desk. \n\nIn IdentityNow, administrators can create a service desk integration (sometimes also called an SDIM, or Service Desk Integration Module) by going to Admin > Connections > Service Desk and selecting 'Create.'\n\nTo create a Generic Service Desk integration, for example, administrators must provide the required information on the General Settings page, the Connectivity and Authentication information, Ticket Creation information, Status Mapping information, and Requester Source information on the Configure page. \nRefer to [Integrating SailPoint with Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) for more information about the process of setting up a Generic Service Desk in IdentityNow.\n\nAdministrators can create various service desk integrations, all with their own nuances. \nThe following service desk integrations are available: \n\n- [Atlassian Cloud Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_cloud/help/integrating_jira_cloud_sd/introduction.html)\n\n- [Atlassian Server Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_server/help/integrating_jira_server_sd/introduction.html)\n\n- [BMC Helix ITSM Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_ITSM_sd/help/integrating_bmc_helix_itsm_sd/intro.html)\n\n- [BMC Helix Remedyforce Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_remedyforce_sd/help/integrating_bmc_helix_remedyforce_sd/intro.html)\n\n- [Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html)\n\n- [ServiceNow Service Desk](https://documentation.sailpoint.com/connectors/servicenow/sdim/help/integrating_servicenow_sdim/intro.html)\n\n- [Zendesk Service Desk](https://documentation.sailpoint.com/connectors/zendesk/help/integrating_zendesk_sd/introduction.html)\n", "item": [ { - "id": "f609272e-5296-403c-a6ac-ca740a5234dd", + "id": "6e10853e-a0b7-4184-8a55-d7fcfc067a0a", "name": "List existing Service Desk Integrations", "request": { "name": "List existing Service Desk Integrations", @@ -67693,7 +67993,7 @@ }, "response": [ { - "id": "a4a69b19-b934-42a4-8bbd-8e696e9257fb", + "id": "a06eb51c-52c5-4dbc-aa4b-c2f5f6b7bd43", "name": "List of ServiceDeskIntegrationDto", "originalRequest": { "url": { @@ -67777,12 +68077,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"attributes\": {\n \"aliqua_f4\": false,\n \"Duis_3\": -6765295,\n \"reprehenderit_f\": -67261289.38844149,\n \"aliquada\": true\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"attributes\": {\n \"sint06\": \"quis labore non\",\n \"velit6\": 21890304.299609825\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n]", + "body": "[\n {\n \"attributes\": {\n \"non_6\": 30112820,\n \"labore94\": false\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"attributes\": {\n \"cupidatat_85f\": -81972205\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8cee67f5-9798-4b66-aad9-807f3473131f", + "id": "ca49af6f-8ad2-4839-8f33-b1cb7a07515b", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -67866,12 +68166,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1ab81fff-b461-4c47-b4e7-4dee8b1e82eb", + "id": "092a8b16-a67a-4ef5-b6ff-b611b44e89f9", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -67960,7 +68260,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f2b0ad49-f48c-4cbe-84a5-180e0b812e94", + "id": "bff4757f-c458-4b0a-8cca-c86fc13adf67", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -68044,12 +68344,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1fbad294-41ac-4bce-b546-ba55b76072ff", + "id": "122a2565-c743-4df1-9532-f581dc4e988a", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -68133,12 +68433,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ccd22691-9d84-46a8-9b33-169c95d2e338", + "id": "0e490a15-71b8-4c31-b9b9-ee2e85abddbf", "name": "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.", "originalRequest": { "url": { @@ -68227,7 +68527,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ce2d3c67-15ac-480e-99ea-8e2eb45f02ef", + "id": "5ab9f222-d1db-49f2-adb2-fbf6c7af1569", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -68311,7 +68611,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -68322,7 +68622,7 @@ } }, { - "id": "01c8f55f-d252-42bc-9f2d-bdd42fb81d91", + "id": "a4eb9a1a-29d3-41d4-b530-31d0e690dd5f", "name": "Create new Service Desk integration", "request": { "name": "Create new Service Desk integration", @@ -68353,7 +68653,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"attributes\": {\n \"veniam895\": false,\n \"sunte_\": -39474743,\n \"consequat_a\": -35226814.313738376\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "raw": "{\n \"attributes\": {\n \"consectetur08\": -93083189\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -68364,7 +68664,7 @@ }, "response": [ { - "id": "1c682981-d9d9-45d7-8bcf-cfbd6561a881", + "id": "778e0db2-478c-4c02-97bb-8c847c6a4941", "name": "details of the created integration", "originalRequest": { "url": { @@ -68398,7 +68698,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"attributes\": {\n \"veniam895\": false,\n \"sunte_\": -39474743,\n \"consequat_a\": -35226814.313738376\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "raw": "{\n \"attributes\": {\n \"consectetur08\": -93083189\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -68415,12 +68715,12 @@ "value": "application/json" } ], - "body": "{\n \"attributes\": {\n \"veniam895\": false,\n \"sunte_\": -39474743,\n \"consequat_a\": -35226814.313738376\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "body": "{\n \"attributes\": {\n \"consectetur08\": -93083189\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "575f1f25-4216-44cb-82e9-02e856e04654", + "id": "359f34e6-268e-4c68-b257-09ce62cf8dff", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -68454,7 +68754,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"attributes\": {\n \"veniam895\": false,\n \"sunte_\": -39474743,\n \"consequat_a\": -35226814.313738376\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "raw": "{\n \"attributes\": {\n \"consectetur08\": -93083189\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -68471,12 +68771,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "9513a9b3-a26b-4ec7-bda9-24f897d08339", + "id": "47ed7153-d0ec-4589-8102-585a6340e3c2", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -68510,7 +68810,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"attributes\": {\n \"veniam895\": false,\n \"sunte_\": -39474743,\n \"consequat_a\": -35226814.313738376\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "raw": "{\n \"attributes\": {\n \"consectetur08\": -93083189\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -68532,7 +68832,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1ff9d914-3817-4dd2-87ce-191d008137d6", + "id": "49726e6d-4e2c-41f5-aea8-a26d63517ebe", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -68566,7 +68866,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"attributes\": {\n \"veniam895\": false,\n \"sunte_\": -39474743,\n \"consequat_a\": -35226814.313738376\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "raw": "{\n \"attributes\": {\n \"consectetur08\": -93083189\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -68583,12 +68883,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "713fcd52-c4a3-4d2e-b863-d0dff9a3352b", + "id": "8c55af82-ca85-4fe3-a4ca-3009481d066a", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -68622,7 +68922,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"attributes\": {\n \"veniam895\": false,\n \"sunte_\": -39474743,\n \"consequat_a\": -35226814.313738376\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "raw": "{\n \"attributes\": {\n \"consectetur08\": -93083189\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -68639,12 +68939,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0f86808a-12d8-43d0-96e5-5d3c852d7be1", + "id": "a02b8063-bce7-42e8-83fc-f4e49913318e", "name": "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.", "originalRequest": { "url": { @@ -68678,7 +68978,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"attributes\": {\n \"veniam895\": false,\n \"sunte_\": -39474743,\n \"consequat_a\": -35226814.313738376\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "raw": "{\n \"attributes\": {\n \"consectetur08\": -93083189\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -68700,7 +69000,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d2a8ee9e-cedd-4dd1-81b8-6c6ee7d636f7", + "id": "82d64d27-6366-4a0d-9632-8e4ef778940a", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -68734,7 +69034,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"attributes\": {\n \"veniam895\": false,\n \"sunte_\": -39474743,\n \"consequat_a\": -35226814.313738376\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "raw": "{\n \"attributes\": {\n \"consectetur08\": -93083189\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -68751,7 +69051,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -68762,7 +69062,7 @@ } }, { - "id": "2b7b5d6e-81d6-42a6-a00c-857e7f26c19d", + "id": "44b8724e-dbf0-4c81-b51d-af75004020d3", "name": "Get a Service Desk integration", "request": { "name": "Get a Service Desk integration", @@ -68799,7 +69099,7 @@ }, "response": [ { - "id": "64c509b0-56ad-472d-bdd8-86b42fd04874", + "id": "dd888616-bc6b-4096-be06-112aeafc8a10", "name": "ServiceDeskIntegrationDto with the given ID", "originalRequest": { "url": { @@ -68838,12 +69138,12 @@ "value": "application/json" } ], - "body": "{\n \"attributes\": {\n \"veniam895\": false,\n \"sunte_\": -39474743,\n \"consequat_a\": -35226814.313738376\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "body": "{\n \"attributes\": {\n \"consectetur08\": -93083189\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "41a4480e-33e3-4e4d-a1cf-9a4757690d34", + "id": "1c681992-a61b-468f-8ab4-1cc4421b7d91", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -68882,12 +69182,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "49b65608-5480-4240-887d-029ae1d4d9eb", + "id": "02241ee4-e95b-4f70-9b39-c5c44be9f74b", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -68931,7 +69231,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a8639f7c-798c-4bb7-afd6-943c2fc2d07f", + "id": "09381b85-7554-4739-9822-6b6118c35024", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -68970,12 +69270,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "66b724c3-c5ad-435d-bc64-fbfc9fd3c388", + "id": "ee8743ad-add2-44ce-8bb0-00a7f6c02fa2", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -69014,12 +69314,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8c24f314-2d55-4b28-a1a2-d6184ab7005c", + "id": "ed0b7221-d150-424e-a410-8472c2c81307", "name": "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.", "originalRequest": { "url": { @@ -69063,7 +69363,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4db1740e-9e83-42fb-8452-d284a7662b56", + "id": "aec28c0a-3b53-4792-9f0f-68c4f06f46f3", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -69102,7 +69402,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -69113,7 +69413,7 @@ } }, { - "id": "327b1d08-350e-473a-8539-15abed49cd09", + "id": "e2aa3f06-37c9-451e-9603-05f42283f90c", "name": "Update a Service Desk integration", "request": { "name": "Update a Service Desk integration", @@ -69152,7 +69452,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"attributes\": {\n \"veniam895\": false,\n \"sunte_\": -39474743,\n \"consequat_a\": -35226814.313738376\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "raw": "{\n \"attributes\": {\n \"consectetur08\": -93083189\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -69163,7 +69463,7 @@ }, "response": [ { - "id": "a84cf055-8188-4b20-a4f3-cd6e0afab875", + "id": "d23e6c51-2132-4103-8bda-2572017d8cf5", "name": "ServiceDeskIntegrationDto as updated", "originalRequest": { "url": { @@ -69198,7 +69498,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"attributes\": {\n \"veniam895\": false,\n \"sunte_\": -39474743,\n \"consequat_a\": -35226814.313738376\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "raw": "{\n \"attributes\": {\n \"consectetur08\": -93083189\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -69215,12 +69515,12 @@ "value": "application/json" } ], - "body": "{\n \"attributes\": {\n \"veniam895\": false,\n \"sunte_\": -39474743,\n \"consequat_a\": -35226814.313738376\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "body": "{\n \"attributes\": {\n \"consectetur08\": -93083189\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "59149bb2-9b6b-4dba-b121-7bd23794a41d", + "id": "ce849585-8a61-4ff9-9555-07796a3de53f", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -69255,7 +69555,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"attributes\": {\n \"veniam895\": false,\n \"sunte_\": -39474743,\n \"consequat_a\": -35226814.313738376\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "raw": "{\n \"attributes\": {\n \"consectetur08\": -93083189\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -69272,12 +69572,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1638fd76-5d32-47c6-a470-3a5f15a7b64f", + "id": "b691cc3f-a7a8-4313-a22c-95db5649e12c", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -69312,7 +69612,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"attributes\": {\n \"veniam895\": false,\n \"sunte_\": -39474743,\n \"consequat_a\": -35226814.313738376\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "raw": "{\n \"attributes\": {\n \"consectetur08\": -93083189\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -69334,7 +69634,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7739a2d3-cac0-4e65-bf4f-91f16be5405f", + "id": "bd75acc8-66f4-4875-861c-cc6043311804", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -69369,7 +69669,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"attributes\": {\n \"veniam895\": false,\n \"sunte_\": -39474743,\n \"consequat_a\": -35226814.313738376\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "raw": "{\n \"attributes\": {\n \"consectetur08\": -93083189\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -69386,12 +69686,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6781df08-b453-4a6b-859b-ab1a86258c88", + "id": "8dfa6da8-4a64-4482-8857-3ce20b548a52", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -69426,7 +69726,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"attributes\": {\n \"veniam895\": false,\n \"sunte_\": -39474743,\n \"consequat_a\": -35226814.313738376\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "raw": "{\n \"attributes\": {\n \"consectetur08\": -93083189\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -69443,12 +69743,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e268efde-3504-49ba-a607-4e7cf45146c7", + "id": "b96d6aa0-8504-467f-b252-d866db9f671c", "name": "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.", "originalRequest": { "url": { @@ -69483,7 +69783,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"attributes\": {\n \"veniam895\": false,\n \"sunte_\": -39474743,\n \"consequat_a\": -35226814.313738376\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "raw": "{\n \"attributes\": {\n \"consectetur08\": -93083189\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -69505,7 +69805,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d575d319-e522-419a-8d28-85cedc087831", + "id": "ae5b59ac-62bb-4ff8-a352-a742acacb496", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -69540,7 +69840,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"attributes\": {\n \"veniam895\": false,\n \"sunte_\": -39474743,\n \"consequat_a\": -35226814.313738376\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "raw": "{\n \"attributes\": {\n \"consectetur08\": -93083189\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -69557,7 +69857,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -69568,7 +69868,7 @@ } }, { - "id": "d8339f9c-adc2-42f6-bc45-c85a7d14f386", + "id": "5f3fae4c-6301-4df4-8e8c-e21378be9bf7", "name": "Delete a Service Desk integration", "request": { "name": "Delete a Service Desk integration", @@ -69605,7 +69905,7 @@ }, "response": [ { - "id": "5dfcb094-d345-415e-a27b-a5864315a108", + "id": "ed359010-3294-4250-aecb-1d8f41c7953f", "name": "Service Desk integration with the given ID successfully deleted", "originalRequest": { "url": { @@ -69639,7 +69939,7 @@ "_postman_previewlanguage": "text" }, { - "id": "0968a261-51c3-4afa-9b49-4c65d658691b", + "id": "61456782-814c-427e-ad90-44b76e2b1d03", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -69678,12 +69978,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "73510489-8539-4db0-9b69-3b320aa56f4f", + "id": "1ee161b7-e914-4603-bd6e-f86b97fc7b0d", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -69727,7 +70027,7 @@ "_postman_previewlanguage": "json" }, { - "id": "489e2595-589d-43ea-9ab2-8a1824d232eb", + "id": "c77d7fff-7b3d-413d-a176-2eb566957b23", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -69766,12 +70066,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c7d8d952-cc8f-4d63-af19-a05ba345ff1a", + "id": "b5ec3f97-7803-455c-9146-36de0acbf9fd", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -69810,12 +70110,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b54b56f0-26a8-4a0e-80da-d966e70adf11", + "id": "0b33f824-4fe4-4538-bc7e-dc577140d8b0", "name": "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.", "originalRequest": { "url": { @@ -69859,7 +70159,7 @@ "_postman_previewlanguage": "json" }, { - "id": "14893c98-c93f-4bdd-a140-0de9285302f3", + "id": "a6815c72-4821-43ac-bd5e-97d146c333fb", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -69898,7 +70198,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -69909,7 +70209,7 @@ } }, { - "id": "5cc75a85-e4e1-49d8-b70e-177536fa2f6b", + "id": "be887d16-d661-4f39-993f-6683553c92be", "name": "Service Desk Integration Update PATCH", "request": { "name": "Service Desk Integration Update PATCH", @@ -69948,7 +70248,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "raw": "{\n \"operations\": [\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -69959,7 +70259,7 @@ }, "response": [ { - "id": "6705a9a8-764d-42d0-a8c6-258087f2dfab", + "id": "22adcca5-a0a5-487d-b339-3f2c070fe829", "name": "ServiceDeskIntegrationDto as updated", "originalRequest": { "url": { @@ -69994,7 +70294,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "raw": "{\n \"operations\": [\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -70011,12 +70311,12 @@ "value": "application/json" } ], - "body": "{\n \"attributes\": {\n \"veniam895\": false,\n \"sunte_\": -39474743,\n \"consequat_a\": -35226814.313738376\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "body": "{\n \"attributes\": {\n \"consectetur08\": -93083189\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c7035c4e-5f9b-432a-bcd1-938437f88134", + "id": "50999392-216c-466c-8f46-9b2f6e65e41c", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -70051,7 +70351,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "raw": "{\n \"operations\": [\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -70068,12 +70368,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "25750c59-0675-4998-b5d6-604239590bc7", + "id": "1a4b08a2-e1c6-4a92-a9a0-cc59f3d51f79", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -70108,7 +70408,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "raw": "{\n \"operations\": [\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -70130,7 +70430,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8df7c15d-d2e3-4a20-9bc7-be2f895cfa0d", + "id": "dccc1faf-da30-4b17-b2ef-1c7a843dfc02", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -70165,7 +70465,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "raw": "{\n \"operations\": [\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -70182,12 +70482,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "2158413c-0fcd-4a91-8454-ee46da89b73a", + "id": "025acd3a-0df6-45d0-a193-9d6feb0fea9e", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -70222,7 +70522,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "raw": "{\n \"operations\": [\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -70239,12 +70539,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "cb7d99ff-9b23-4c3e-bf20-e74fe09d7b4c", + "id": "8f5496dd-8d53-49d0-823d-529acb7173b7", "name": "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.", "originalRequest": { "url": { @@ -70279,7 +70579,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "raw": "{\n \"operations\": [\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -70301,7 +70601,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ade85543-78cf-43d2-b1fc-763fa1e65475", + "id": "3f8e400e-9340-4904-ae60-285dec447dc6", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -70336,7 +70636,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "raw": "{\n \"operations\": [\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -70353,7 +70653,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -70364,7 +70664,7 @@ } }, { - "id": "f3bf0fcf-211a-4de3-b5cc-036c66d29592", + "id": "47ccf75c-3e95-4e55-b27b-88344b652565", "name": "Service Desk Integration Types List.", "request": { "name": "Service Desk Integration Types List.", @@ -70394,7 +70694,7 @@ }, "response": [ { - "id": "b16c531f-d41f-4860-8035-26206d46183b", + "id": "ab87f256-2c90-4391-8eb1-2495cc002874", "name": "Responds with an array of the currently supported Service Desk integration types.", "originalRequest": { "url": { @@ -70438,7 +70738,7 @@ "_postman_previewlanguage": "json" }, { - "id": "cb0dee5f-6807-48d0-93ac-0742a559876f", + "id": "f42e3dc1-c64a-41ad-86f3-3163abfc9b89", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -70477,12 +70777,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1cee2c0f-e961-4a03-b94e-9ff59539cff6", + "id": "c3879efb-ec35-4ad8-ab72-b426dc6b122b", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -70526,7 +70826,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1ffd6222-a332-4a02-995a-a9d631ec662b", + "id": "d36721a6-658f-4fbc-a516-902de4a0d892", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -70565,12 +70865,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8cc8d596-a2d3-41ff-af80-c2de43231b1b", + "id": "a02d711d-6337-4cff-8b79-f23cbdd653b9", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -70609,12 +70909,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8d7b7355-1904-48b9-b9b2-da59853eac26", + "id": "2859fec9-d4aa-48b3-a00a-404364e6f1c1", "name": "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.", "originalRequest": { "url": { @@ -70658,7 +70958,7 @@ "_postman_previewlanguage": "json" }, { - "id": "edc33633-29ef-420b-8d30-78ff39644262", + "id": "9433dc2b-b06b-4697-a89b-ba2301c89e22", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -70697,7 +70997,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -70708,7 +71008,7 @@ } }, { - "id": "57a89c81-9636-4e00-a84d-df228ff90119", + "id": "1de8d88e-9366-452d-af71-f43947ee315f", "name": "Service Desk integration template by scriptName.", "request": { "name": "Service Desk integration template by scriptName.", @@ -70746,7 +71046,7 @@ }, "response": [ { - "id": "07a0777b-6626-4285-ab00-bb812ea9be3c", + "id": "f429a040-7789-44a5-92fd-dcb4d0373bb2", "name": "Responds with the ServiceDeskIntegrationTemplateDto with the specified scriptName.", "originalRequest": { "url": { @@ -70786,12 +71086,12 @@ "value": "application/json" } ], - "body": "{\n \"attributes\": {\n \"in_36c\": 43162758.21334207\n },\n \"name\": \"\",\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"type\": \"Web Service SDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n}", + "body": "{\n \"attributes\": {\n \"Lorem_b_\": false,\n \"quif\": \"in cupidatat Ut ut veniam\"\n },\n \"name\": \"\",\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"type\": \"Web Service SDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "21e28b9c-8440-4835-a2da-8295e7146c80", + "id": "dad91251-7175-4f26-83bc-c0cdb34bab7b", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -70831,12 +71131,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6f1e7427-d8f9-42a4-8ffb-f33d64c6adf3", + "id": "8da8eb9a-b35a-4daa-ba07-2425ef801195", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -70881,7 +71181,7 @@ "_postman_previewlanguage": "json" }, { - "id": "76812d20-4d03-44d7-a6d0-d5abc93bee69", + "id": "ae2b2fef-b3b1-4037-9d07-c2a18d59584e", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -70921,12 +71221,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "55b43326-f18b-49b0-be95-51130068206e", + "id": "1fd8ae03-ef03-4e69-b55d-c7936cfcfc3a", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -70966,12 +71266,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "aabd17c7-6421-4d65-8b15-45973312ead4", + "id": "1411705b-106e-4ba8-96be-18e54742eea4", "name": "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.", "originalRequest": { "url": { @@ -71016,7 +71316,7 @@ "_postman_previewlanguage": "json" }, { - "id": "eeb968b2-bb8b-4ee3-8541-584befa3e359", + "id": "eeef6b11-f08b-4728-9087-8d4ec820df1b", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -71056,7 +71356,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -71067,7 +71367,7 @@ } }, { - "id": "356e1dc5-53c0-483a-9070-1a117d8bfb76", + "id": "ae801932-3e7e-4b90-bf4e-7d2188ed10ee", "name": "Get the time check configuration", "request": { "name": "Get the time check configuration", @@ -71097,7 +71397,7 @@ }, "response": [ { - "id": "024ea185-2deb-42ff-83a3-d4da237f5873", + "id": "f8d31c2e-cd91-4e34-bd95-92c3fb81c0c3", "name": "QueuedCheckConfigDetails containing the configured values", "originalRequest": { "url": { @@ -71141,7 +71441,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ec458a2e-ef87-4468-9c88-ee1abc1b34c3", + "id": "3666c4de-2bb5-41ab-9712-6bbd8ce3dd11", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -71180,12 +71480,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ded2355d-ec88-4d76-9160-1844cad3ffe7", + "id": "b009b3b5-4c06-46a0-85c7-db7beb4a2722", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -71229,7 +71529,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ba10d62a-a2c5-4fdc-8374-ca56353adaf4", + "id": "0c0916d1-7e66-4d77-8c46-01a90a45bef6", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -71268,12 +71568,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c3cab33c-1800-402c-aba4-f624c6cec7f2", + "id": "33300b06-879a-4717-be24-d26d6e0f4e88", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -71312,12 +71612,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "954b3672-dc47-4353-b61b-505dab895860", + "id": "1a0656a2-3114-4cd0-93c6-83987cbde361", "name": "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.", "originalRequest": { "url": { @@ -71361,7 +71661,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1acdf895-3d6f-469c-8ff6-3032368843ac", + "id": "dadd7907-8e5c-4d43-8651-db6b598d6969", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -71400,7 +71700,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -71411,7 +71711,7 @@ } }, { - "id": "fb382d7a-85c6-4ef5-ae12-a905d2ec9680", + "id": "e11451a1-bff4-4e11-bfbb-f0dbe35d4078", "name": "Update the time check configuration", "request": { "name": "Update the time check configuration", @@ -71454,7 +71754,7 @@ }, "response": [ { - "id": "9e2f0b1e-ce4d-408d-9c58-9141918fcafe", + "id": "a8a867c5-a68f-4a10-9362-587df84fbdbd", "name": "QueuedCheckConfigDetails as updated", "originalRequest": { "url": { @@ -71511,7 +71811,7 @@ "_postman_previewlanguage": "json" }, { - "id": "16ecfd5b-c6bd-4783-9e68-63506e9b21bd", + "id": "9b3435ae-ffe4-4e33-b13c-d551934a94d7", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -71563,12 +71863,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "33ed83c8-6716-42a7-9aa1-e85740294a54", + "id": "1aa19e9f-f528-4df9-aba6-a6cf24958a2b", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -71625,7 +71925,7 @@ "_postman_previewlanguage": "json" }, { - "id": "06408092-0d2e-4c61-8474-fb314d587f25", + "id": "23090921-2126-44fb-bab6-576f3a6bfa6e", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -71677,12 +71977,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b7c705a5-107c-4aa9-a21f-fbd780b419fd", + "id": "07425e69-fcf8-4c59-8074-d3903b8b4647", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -71734,12 +72034,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5f3b6743-e43a-419f-8173-befd8c99166f", + "id": "ecdfa547-24cd-4ae8-b57a-42c6d0d953bf", "name": "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.", "originalRequest": { "url": { @@ -71796,7 +72096,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ac8312a5-51b7-4dfc-970c-ab602bc50bb7", + "id": "fdda9527-1420-44ce-92b8-b1c1fa9ad882", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -71848,7 +72148,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -71865,7 +72165,7 @@ "description": "Operations for Creating & Executing SOD (Seperation of Duties) policies", "item": [ { - "id": "ccf1c266-935b-4b6f-9e1f-74f88bdff9be", + "id": "c6d72016-c70e-45ed-b33a-5966c4d42008", "name": "Create SOD policy", "request": { "name": "Create SOD policy", @@ -71896,7 +72196,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": null,\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -71907,7 +72207,7 @@ }, "response": [ { - "id": "877b3852-77da-40a1-a205-aefe8020a096", + "id": "1719856d-10c5-4487-9f4e-6dd3fda62cdf", "name": "SOD policy created", "originalRequest": { "url": { @@ -71941,7 +72241,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": null,\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -71958,12 +72258,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": null,\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "f5286e1a-f239-44f1-8cb5-d53e3a447ba2", + "id": "c621608f-8007-4563-8579-c5cc4517f964", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -71997,7 +72297,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": null,\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -72014,12 +72314,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "fb229577-ff27-4499-8ad5-c83d26c4d137", + "id": "19ac1cf2-3d60-435c-b68c-6282c10f9af3", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -72053,7 +72353,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": null,\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -72075,7 +72375,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c1809b6b-7038-4690-8535-164653149e6a", + "id": "378a0f85-90f8-48bd-829d-09f366fc3bcb", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -72109,7 +72409,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": null,\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -72126,12 +72426,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "26511653-e987-4586-a497-c36bb0c6c9b3", + "id": "3826f618-5a86-4e5d-974c-455e3a2553b7", "name": "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.", "originalRequest": { "url": { @@ -72165,7 +72465,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": null,\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -72187,7 +72487,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4cae2028-29a3-4152-9f2c-ec58421cc762", + "id": "c6700af2-0042-4d19-b794-0379bec024c2", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -72221,7 +72521,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": null,\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -72238,7 +72538,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -72249,7 +72549,7 @@ } }, { - "id": "527fd4d1-3684-4292-b21b-aa6965b53b21", + "id": "b1b42abe-f7b0-4e37-8bc7-b1aa32ff947f", "name": "List SOD policies", "request": { "name": "List SOD policies", @@ -72315,7 +72615,7 @@ }, "response": [ { - "id": "bc31b048-13af-49d1-b718-f5a127c4cf79", + "id": "70371584-495d-483c-a72b-e6029ed0e5b9", "name": "List of all SOD policies.", "originalRequest": { "url": { @@ -72390,12 +72690,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": null,\n \"ownerRef\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n]", + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"STATIC\",\n \"ownerRef\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"NOT_ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"STATIC\",\n \"ownerRef\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ad73681e-c152-458a-b4c0-12d19397724a", + "id": "2055c9cc-0641-4391-97c5-7a36dc2349aa", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -72470,12 +72770,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "85d14e68-1f3c-400d-98ba-5c0461f24378", + "id": "796b1818-d7c4-4993-a185-9fa3964ecf07", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -72555,7 +72855,7 @@ "_postman_previewlanguage": "json" }, { - "id": "829144e7-fff8-4ad0-9802-a882c4928cf1", + "id": "6d048a0d-efda-4bf5-9e1c-b1d5d3c7b91b", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -72630,12 +72930,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d82b14e2-85db-4700-9fde-7edc81645484", + "id": "acaf12c7-e8c3-4832-ade4-a267e72cc0f6", "name": "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.", "originalRequest": { "url": { @@ -72715,7 +73015,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e3b86d80-9e2a-4cc2-9ad1-f5f67f93391a", + "id": "c11fcfce-c8cd-4e08-a287-1de6d425e9a3", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -72790,7 +73090,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -72801,7 +73101,7 @@ } }, { - "id": "78e926d0-e69c-4df6-b16d-f5414ae05cc6", + "id": "57602961-9184-49d9-9e99-cc7256f10580", "name": "Get SOD policy by ID", "request": { "name": "Get SOD policy by ID", @@ -72838,7 +73138,7 @@ }, "response": [ { - "id": "b29d4dec-5d2e-461b-9796-3dc8ef2bd9e8", + "id": "113554be-5ce8-451a-8f67-c03c7bafd176", "name": "SOD policy ID.", "originalRequest": { "url": { @@ -72877,12 +73177,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": null,\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8244b59f-7d31-443b-845b-34f31f554ff7", + "id": "88f5ded5-a18d-4c0b-8835-ea5f6118023d", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -72921,12 +73221,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3293e234-1486-486f-af61-ae2b32c6bcf2", + "id": "14f6fa1a-a047-4aea-9958-d652f47497dc", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -72970,7 +73270,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b6bb5b7a-c597-4406-afe5-0a242f4d1fa5", + "id": "e8dfa348-b88d-4477-8beb-cc4f7c1979f7", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -73009,12 +73309,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "f94ab9d2-4a73-4c2a-8b55-77ad129a053a", + "id": "75d21b5d-5bfe-4a48-879a-2cfd6dcb3a98", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -73053,12 +73353,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b962b7fd-a9ea-499f-8536-7bbc137c2ffc", + "id": "12b9bef2-9d3a-46bd-ad7b-3a48d93a26d8", "name": "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.", "originalRequest": { "url": { @@ -73102,7 +73402,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f38a9ed1-676d-46d4-bf09-3e4200b5b3e3", + "id": "f3bbf9e2-5bfd-4ef4-bc65-486b2de43972", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -73141,7 +73441,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -73152,7 +73452,7 @@ } }, { - "id": "e60da293-8412-4128-ad68-7908d2971fca", + "id": "4fa2fbe9-ce6a-4ade-aabd-99bb614e0127", "name": "Update SOD policy by ID", "request": { "name": "Update SOD policy by ID", @@ -73191,7 +73491,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": null,\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -73202,7 +73502,7 @@ }, "response": [ { - "id": "09d1de13-1117-4681-9f91-4c34c0731106", + "id": "cb40ff51-5b03-4f37-a8bb-9556d70dac3c", "name": "SOD Policy by ID", "originalRequest": { "url": { @@ -73237,7 +73537,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": null,\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -73254,12 +73554,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": null,\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "806646e2-6edb-43b0-bf5d-69abc34c348b", + "id": "de4bd137-f49d-49b3-b762-13aeb0858e80", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -73294,7 +73594,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": null,\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -73311,12 +73611,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7d09c09a-933b-4ade-9833-84512512908b", + "id": "877f7f3a-0949-4e2d-84d3-226d67bcd13a", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -73351,7 +73651,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": null,\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -73373,7 +73673,7 @@ "_postman_previewlanguage": "json" }, { - "id": "06eccc9a-476e-44dd-977e-ec1811560b87", + "id": "272cf558-7206-46c0-a086-551d9a8dcbe1", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -73408,7 +73708,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": null,\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -73425,12 +73725,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "28da89ea-3d14-47fa-9cf2-de6b10c8a2ba", + "id": "9b65b09c-4412-4045-b4ea-c487ee97bf82", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -73465,7 +73765,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": null,\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -73482,12 +73782,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "34adee1f-ab06-40f1-ae8e-6cdefcd1d74a", + "id": "1adb19b5-8f1a-4b2c-b5c4-65945bc1ea7f", "name": "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.", "originalRequest": { "url": { @@ -73522,7 +73822,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": null,\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -73544,7 +73844,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5afc0f50-ef98-4554-a761-fc07fd67535f", + "id": "bf81c984-cab8-4b24-907b-2eb41f2d78e3", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -73579,7 +73879,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": null,\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -73596,7 +73896,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -73607,7 +73907,7 @@ } }, { - "id": "158cbe65-3e3e-4c1b-a971-dd3f60295a50", + "id": "006bdbbe-e02b-445f-b608-52d9107546cd", "name": "Delete SOD policy by ID", "request": { "name": "Delete SOD policy by ID", @@ -73654,7 +73954,7 @@ }, "response": [ { - "id": "3887000e-0581-49b4-83fb-bd1883d34286", + "id": "2381ef53-62aa-454c-874c-6a7b7db99fd4", "name": "No content.", "originalRequest": { "url": { @@ -73698,7 +73998,7 @@ "_postman_previewlanguage": "text" }, { - "id": "d294a43c-e989-4efd-aff5-7bc83c27c5bf", + "id": "3638d0d6-9bd4-4352-b96a-96d6a8fc673b", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -73747,12 +74047,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "30fa379d-b31a-452d-9229-84feab238776", + "id": "43b4fe66-d793-4ffb-af7b-f9b49207d700", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -73806,7 +74106,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f452edd2-593b-4ebd-b9d9-69f2ab705bcf", + "id": "a0ab2f16-54db-494b-89e2-9ad3338f95ee", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -73855,12 +74155,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "08cf0ae0-79d8-4c5b-8315-f8f4c3b28055", + "id": "3ae55196-2b4d-49ea-8728-b6c691d85693", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -73909,12 +74209,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6af1b4c3-58fc-4e35-a486-0dcdee25632f", + "id": "b77daa85-3863-49ad-be1d-8ebae1c9bdaf", "name": "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.", "originalRequest": { "url": { @@ -73968,7 +74268,7 @@ "_postman_previewlanguage": "json" }, { - "id": "920d59c7-53b0-4de2-beb9-420a288c45eb", + "id": "3295c382-6eca-4973-8a0f-3fc623f3c0f1", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -74017,7 +74317,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -74028,7 +74328,7 @@ } }, { - "id": "0c87d489-18cc-414f-a933-9ffe67dde4e6", + "id": "ee8bd7c0-03cf-461f-a2d5-220ff6c8153f", "name": "Patch SOD policy by ID", "request": { "name": "Patch SOD policy by ID", @@ -74067,7 +74367,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -74078,7 +74378,7 @@ }, "response": [ { - "id": "f917e5e8-2d97-4468-8f47-e4810e667006", + "id": "bf9f96cb-755b-4da2-b757-8978fa0ae60c", "name": "Indicates the PATCH operation succeeded, and returns the SOD policy's new representation.", "originalRequest": { "url": { @@ -74113,7 +74413,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -74130,12 +74430,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": null,\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "153493a1-cccf-4872-ad6f-d1fb7e549475", + "id": "29c780b3-b03c-4380-9704-e96ee3e21eb7", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -74170,7 +74470,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -74187,12 +74487,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "9cd79854-96b1-4a10-a0bd-c5f2f916fe8a", + "id": "1f0a48a2-f6e0-4808-b1ba-408c78df9eca", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -74227,7 +74527,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -74249,7 +74549,7 @@ "_postman_previewlanguage": "json" }, { - "id": "2eb71b1f-fa5e-4903-82f4-a1670f2fd9f8", + "id": "605491b7-2d2f-47e4-b8e0-8b1b0b1791db", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -74284,7 +74584,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -74301,12 +74601,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "f07d50ac-99e9-4993-82db-3bddf25986f5", + "id": "4f5440fc-274d-44de-a286-a18082ea134c", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -74341,7 +74641,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -74358,12 +74658,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "66d2a554-4f2b-45f1-b78f-1c9672dd2f97", + "id": "98f2eaa7-4c71-446e-939e-886cc87fd02e", "name": "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.", "originalRequest": { "url": { @@ -74398,7 +74698,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -74420,7 +74720,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c9ee08c7-dccb-44cc-99ae-9f2a18f8540a", + "id": "01296d96-6ac1-4e3d-a4a5-e95760b7e744", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -74455,7 +74755,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -74472,7 +74772,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -74483,7 +74783,7 @@ } }, { - "id": "18dddf4f-8887-496e-91a2-bd4d60987d92", + "id": "a0685152-4db3-4b9e-bad5-671e48dd25db", "name": "Evaluate one policy by ID", "request": { "name": "Evaluate one policy by ID", @@ -74521,7 +74821,7 @@ }, "response": [ { - "id": "b47207b3-145f-4e90-b296-fa02250e45e5", + "id": "04102302-e675-448f-8ba4-c0c71f0a28ed", "name": "Reference to the violation report run task.", "originalRequest": { "url": { @@ -74561,12 +74861,12 @@ "value": "application/json" } ], - "body": "{\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"SUCCESS\"\n}", + "body": "{\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"WARNING\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5560db78-30b4-408c-a932-f1a031621c6a", + "id": "0f88a4ff-7d1e-4c46-b362-d84e1b136169", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -74606,12 +74906,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d3fde13f-64bb-4347-8f1a-fd122dbf1763", + "id": "c783bac9-cf63-42ce-8d8e-30fbfbb7781e", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -74656,7 +74956,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0765ebe7-2680-4651-88c5-5015189bf861", + "id": "be4a756d-343f-4d98-af10-e493b0724876", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -74696,12 +74996,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6b869e09-e5be-40bf-a70d-c58208bb3488", + "id": "26d322f9-d59d-48da-9ce7-76618830f156", "name": "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.", "originalRequest": { "url": { @@ -74746,7 +75046,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f6b4f0d4-30ce-4d5c-b81c-55399aa2fe4e", + "id": "6ea54e40-9033-4a65-963e-9e45854f57aa", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -74786,7 +75086,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -74797,7 +75097,7 @@ } }, { - "id": "75cb82cd-a1e0-4ad0-8a8a-0f39ebf481b5", + "id": "8aba8f18-8c49-4748-a710-8cde4f1a8180", "name": "Get SOD policy schedule", "request": { "name": "Get SOD policy schedule", @@ -74835,7 +75135,7 @@ }, "response": [ { - "id": "3f8476b9-c78b-49a7-9348-e1b764686b2d", + "id": "c4e2c4d6-64ba-4fe9-8267-83c7e3f6f5ae", "name": "SOD policy schedule.", "originalRequest": { "url": { @@ -74875,12 +75175,12 @@ "value": "application/json" } ], - "body": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "body": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1315ff53-2091-442d-9da3-0073726de6d2", + "id": "fdfeec8c-071f-4b41-981f-b39ff1f3c4e7", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -74920,12 +75220,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ad554800-ef11-4e74-8813-0e828f9d0a15", + "id": "8ad9cfff-9a6f-4dc1-94e8-5896e8d771e1", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -74970,7 +75270,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b1c60a02-b405-4001-a902-8ff95edfc4e5", + "id": "dd68adbf-b950-4c06-b619-71f6067c08cb", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -75010,12 +75310,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "88244004-5f64-47b2-923d-aa3457d0ad0d", + "id": "6040fdbd-5ebc-407f-99c8-cafef52803a9", "name": "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.", "originalRequest": { "url": { @@ -75060,7 +75360,7 @@ "_postman_previewlanguage": "json" }, { - "id": "643d065c-a7fa-4ee1-90e5-963bdff2aee1", + "id": "6bcaaa80-28c6-4e91-8dca-ac22e3183146", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -75100,7 +75400,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -75111,7 +75411,7 @@ } }, { - "id": "c636d2d5-db15-425f-beaa-0d06364d8022", + "id": "0dad28e7-aec3-4177-8f24-20466c6216cf", "name": "Update SOD Policy schedule", "request": { "name": "Update SOD Policy schedule", @@ -75151,7 +75451,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -75162,7 +75462,7 @@ }, "response": [ { - "id": "fd270335-af1b-4698-894a-1e763427011c", + "id": "4348baf0-c93e-4515-926a-15f8c944e44c", "name": "Created or updated SOD policy schedule.", "originalRequest": { "url": { @@ -75198,7 +75498,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -75215,12 +75515,12 @@ "value": "application/json" } ], - "body": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "body": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "594b8c8b-74db-48ae-80f6-1b90516eddeb", + "id": "0d8a0ed0-95e9-423d-804e-ea73542fea79", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -75256,7 +75556,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -75273,12 +75573,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "4bcc3af0-9045-4b5b-98e7-4bb070956de3", + "id": "622f56da-f343-44c5-b4c8-27c5e807b627", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -75314,7 +75614,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -75336,7 +75636,7 @@ "_postman_previewlanguage": "json" }, { - "id": "19ae266a-27d1-4d3a-b4a9-dc41a39528ba", + "id": "a62f3b36-32a1-4d91-866e-c5a9851478fe", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -75372,7 +75672,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -75389,12 +75689,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e5dbd88b-fecf-4c3e-a517-056fa76204e4", + "id": "002874e3-9446-48b1-a39b-bc67a53b9ba6", "name": "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.", "originalRequest": { "url": { @@ -75430,7 +75730,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -75452,7 +75752,7 @@ "_postman_previewlanguage": "json" }, { - "id": "fe39ccf1-ba01-4c97-a959-8fab69687ec8", + "id": "f69aabfb-b964-4537-9386-66272775590b", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -75488,7 +75788,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -75505,7 +75805,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -75516,7 +75816,7 @@ } }, { - "id": "c62e1900-3f23-4d04-bfb2-c00439fe9f20", + "id": "5e4c1375-3cea-4461-84ac-dc7af05109cd", "name": "Delete SOD policy schedule", "request": { "name": "Delete SOD policy schedule", @@ -75554,7 +75854,7 @@ }, "response": [ { - "id": "5346d780-ead7-4803-ba20-8729ff437baa", + "id": "df17f29b-6144-40a8-908e-d4c4ef883757", "name": "No content response.", "originalRequest": { "url": { @@ -75589,7 +75889,7 @@ "_postman_previewlanguage": "text" }, { - "id": "9b4fb5be-9602-4182-b5a9-5f83e8c45bad", + "id": "6ef1c66c-3fc9-43df-84d6-c70f7a9b914d", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -75629,12 +75929,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "2e4fd742-09ae-4005-b005-7f6feebfb01e", + "id": "ea818231-47ec-43c0-bbae-76a57db367c0", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -75679,7 +75979,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3484d24b-af8c-463e-999b-e76ac34bb07e", + "id": "aab855a2-8081-492e-a0cc-209091b60676", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -75719,12 +76019,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "60ccc079-4424-4cf5-b18e-e53f84f22f83", + "id": "28d454f4-556a-41d6-8259-a11271605551", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -75764,12 +76064,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ed996727-d4e4-4d28-ae55-19435504e872", + "id": "f00054d8-5372-4cd1-8a03-7e1178de88aa", "name": "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.", "originalRequest": { "url": { @@ -75814,7 +76114,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d0ad5099-af1d-450e-82d4-78bf54122f5a", + "id": "c9781771-5484-46a0-a5c8-270c300fae9b", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -75854,7 +76154,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -75865,7 +76165,7 @@ } }, { - "id": "82ed0bec-3be2-4e81-b9b2-686afaece071", + "id": "b72cde88-8db1-450a-88da-3ad37348d65a", "name": "Runs SOD policy violation report", "request": { "name": "Runs SOD policy violation report", @@ -75904,7 +76204,7 @@ }, "response": [ { - "id": "4de9b3c2-a915-4acb-a155-21630b3765bc", + "id": "c233457d-ad0a-4bf1-86b8-b0bb3fa99796", "name": "Reference to the violation report run task.", "originalRequest": { "url": { @@ -75945,12 +76245,12 @@ "value": "application/json" } ], - "body": "{\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"SUCCESS\"\n}", + "body": "{\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"WARNING\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "fc69973a-67d9-4899-979f-24c47115a294", + "id": "91bd517f-9a83-4c8f-af1f-db7727b630f3", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -75991,12 +76291,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d78022b1-1ab3-4fae-9fcc-0c2a9d6ad1ef", + "id": "25255a68-779d-42b2-a149-55513c8e6afd", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -76042,7 +76342,7 @@ "_postman_previewlanguage": "json" }, { - "id": "849b3ae4-0745-45e4-8871-bb11cfa6493f", + "id": "2916a773-046b-4147-9ea1-63c136f2c9d6", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -76083,12 +76383,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b2fe0a97-f90c-43c6-bb5c-ec7a8402de65", + "id": "aa138290-c551-496a-baed-011cfa7edd66", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -76129,12 +76429,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a334d8a0-cc19-4e27-b578-78db23b217c1", + "id": "96738148-8e19-4d4b-afca-ab75476d56fb", "name": "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.", "originalRequest": { "url": { @@ -76180,7 +76480,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c58248b6-2526-44bd-a439-d767151126ca", + "id": "c0d128db-567f-4f64-9e1f-f8740bb52b12", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -76221,7 +76521,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -76232,7 +76532,7 @@ } }, { - "id": "4912f8ac-f00b-4d8a-821b-30c64cda864c", + "id": "c794fbca-e414-4a42-993a-f4b986f3a9b6", "name": "Get SOD violation report status", "request": { "name": "Get SOD violation report status", @@ -76270,7 +76570,7 @@ }, "response": [ { - "id": "b4b42885-6170-4ea4-8dbb-763a7c4d7720", + "id": "2d4d50f2-cbed-46e8-a195-8360c33b64d2", "name": "Status of the violation report run task.", "originalRequest": { "url": { @@ -76310,12 +76610,12 @@ "value": "application/json" } ], - "body": "{\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"SUCCESS\"\n}", + "body": "{\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"WARNING\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "4d730bd8-513a-4930-b993-a658410dfd34", + "id": "0a906477-39a0-4ffd-8433-468e8cc869d9", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -76355,12 +76655,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5c4b5fb0-ab85-4dab-ada4-1e4a15fd9c55", + "id": "28e8978b-4314-4b1e-b413-29531b3d831e", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -76405,7 +76705,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8c53f996-6980-4d43-9662-bbc188a7c8f1", + "id": "8afb571a-c6eb-4cb3-8c6c-1a44e03b5fa5", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -76445,12 +76745,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5620a7ef-ac68-4638-87aa-370261429091", + "id": "eca9bb4f-2d7a-4be6-8619-6f121a678800", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -76490,12 +76790,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5511442c-e66a-42a4-a678-c86fbbaf20b7", + "id": "af8e39fc-ab5c-4433-8efc-a0ad713cd440", "name": "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.", "originalRequest": { "url": { @@ -76540,7 +76840,7 @@ "_postman_previewlanguage": "json" }, { - "id": "98ac22a7-3f78-4ab6-bad4-ba10e608770d", + "id": "48b3725a-35cd-4d8d-8509-c0f97fb7ad3f", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -76580,7 +76880,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -76591,7 +76891,7 @@ } }, { - "id": "9d32db79-e419-4ebe-8ff9-c648683d9102", + "id": "9eec9b51-8f43-4658-9d26-3ede1430cbbc", "name": "Get violation report run status", "request": { "name": "Get violation report run status", @@ -76629,7 +76929,7 @@ }, "response": [ { - "id": "bbec7578-66a7-444a-a422-93de2ca300e9", + "id": "f0f61bd2-cba6-42be-8333-52a0710dde12", "name": "Status of the violation report run task.", "originalRequest": { "url": { @@ -76669,12 +76969,12 @@ "value": "application/json" } ], - "body": "{\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"SUCCESS\"\n}", + "body": "{\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"WARNING\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "301eda83-2cef-4344-99a1-7bf87862bf40", + "id": "b7dff2ce-0ad6-4588-89ea-4b41e2c26de8", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -76714,12 +77014,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "fb549d2e-28bf-497e-b8a8-ef9283388663", + "id": "bc984047-e056-4c79-801d-11ba4c8bd565", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -76764,7 +77064,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6482bcbb-6b6b-4561-beaf-31360371c50b", + "id": "df27d33d-3cf2-4f18-a5e2-b94501beeb6f", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -76804,12 +77104,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b2e80ad3-931b-4515-a960-afc95238318f", + "id": "6ca4ba2d-9075-4401-ae2c-98944cb0ccef", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -76849,12 +77149,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "abe0076c-ed90-488c-a0a7-f94416d5fb7e", + "id": "f4da73bd-38b5-45c9-ae0d-d8a3849deb04", "name": "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.", "originalRequest": { "url": { @@ -76899,7 +77199,7 @@ "_postman_previewlanguage": "json" }, { - "id": "48eb7fbe-d4e4-4002-b6a5-4dbd8fd3fd13", + "id": "d982490e-b6f8-4f04-98bf-610016c60da0", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -76939,7 +77239,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -76950,7 +77250,7 @@ } }, { - "id": "8a78504b-1e32-44f8-9620-46d426f23259", + "id": "18318f5f-8f37-4229-8937-2de298aa2c60", "name": "Runs all policies for org", "request": { "name": "Runs all policies for org", @@ -76993,7 +77293,7 @@ }, "response": [ { - "id": "4fa8bceb-42ec-44a1-9d7a-5aa9abada48f", + "id": "f5bcd483-d882-4595-9bda-7d889c517a42", "name": "Reference to the violation report run task.", "originalRequest": { "url": { @@ -77045,12 +77345,12 @@ "value": "application/json" } ], - "body": "{\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"SUCCESS\"\n}", + "body": "{\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"WARNING\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d391e8ed-7dfb-4063-9e30-87784f24f8f2", + "id": "61fa0f08-37ed-4902-8302-f90f0ae890fb", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -77102,12 +77402,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "773f2262-0cac-4bca-9a76-882f0a42527e", + "id": "ef0fe193-8e3a-4e6e-a18f-9df37c0c9b39", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -77164,7 +77464,7 @@ "_postman_previewlanguage": "json" }, { - "id": "81b554be-5e39-4f96-babe-7b4bbd519251", + "id": "fddaba2c-c8b4-4e06-8a64-3c42d7e007f8", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -77216,12 +77516,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d737ed59-2fc5-4764-b384-9db811bcba61", + "id": "7e326f62-e273-49ce-a4ab-964f193b9a84", "name": "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.", "originalRequest": { "url": { @@ -77278,7 +77578,7 @@ "_postman_previewlanguage": "json" }, { - "id": "2b07a020-ddc9-422c-adac-75f4b4fd5105", + "id": "8e8c8241-6820-4c93-b1f9-5e70c3eb200b", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -77330,7 +77630,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -77341,7 +77641,7 @@ } }, { - "id": "e28027db-1435-4958-947c-9928a444712b", + "id": "176d371e-72c0-437d-8f1d-5f852ae1e6fb", "name": "Get multi-report run task status", "request": { "name": "Get multi-report run task status", @@ -77370,7 +77670,7 @@ }, "response": [ { - "id": "7a3eefad-b94c-429d-9fc5-0f3ae63e05fb", + "id": "9d04760e-238b-4358-a6d8-b41e13486342", "name": "Status of the violation report run task for all policy run.", "originalRequest": { "url": { @@ -77408,12 +77708,12 @@ "value": "application/json" } ], - "body": "{\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"SUCCESS\"\n}", + "body": "{\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"WARNING\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "82a3e81f-de7f-402f-9163-573881528c5b", + "id": "d5f3ddd5-91b1-4e86-a3a9-f9dedacf253a", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -77451,12 +77751,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "728bb72d-ee07-4362-8dc7-a1d67f796505", + "id": "5a21741e-0fec-436f-b09e-2179f7e71c9a", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -77499,7 +77799,7 @@ "_postman_previewlanguage": "json" }, { - "id": "235aee54-f310-4786-8f02-0c758817d0af", + "id": "56dbf1fd-b8c0-4b1d-b968-ec957c84a51e", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -77537,12 +77837,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d7ad2c16-02ae-4f2b-9141-3dee14b42baf", + "id": "5f3ac948-a7ce-4a23-a201-c68e99c88a80", "name": "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.", "originalRequest": { "url": { @@ -77585,7 +77885,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ed021820-e714-4459-9515-52fb8b75bb4d", + "id": "f202ca1a-c3f4-4743-9ef6-e05a2d36b3f2", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -77623,7 +77923,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -77634,7 +77934,7 @@ } }, { - "id": "c7d70529-cca0-4974-8811-3791b25ded14", + "id": "4bd8d812-c1a5-4443-ac02-717d043e3e35", "name": "Download violation report", "request": { "name": "Download violation report", @@ -77672,7 +77972,7 @@ }, "response": [ { - "id": "35f8bb3a-b82b-45fe-b4ad-1d503f738df2", + "id": "ecc10fbe-58e5-4e7d-9fe5-1cd4625ac493", "name": "Returns the PolicyReport.zip that contains the violation report file.", "originalRequest": { "url": { @@ -77717,7 +78017,7 @@ "_postman_previewlanguage": "text" }, { - "id": "104c9c88-2740-419e-9643-a2c3bd698762", + "id": "a60759ee-5035-4506-9e86-9cd6ea17d317", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -77757,12 +78057,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e00f33d0-4faf-49a6-9cb8-152f59655cac", + "id": "43552819-8161-450e-863f-1003d3c344bd", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -77807,7 +78107,7 @@ "_postman_previewlanguage": "json" }, { - "id": "08aee5f7-7875-49ca-b3ad-1ba6d5866b0e", + "id": "a6f11588-49af-436d-8f44-c652b43eda07", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -77847,12 +78147,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "da807ece-bf78-4669-97a1-5f7a5d1e44aa", + "id": "8bc0494e-3eac-47cd-a139-dc37cca2b3fb", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -77892,12 +78192,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7a89f926-0ad6-4843-bb2b-446686900b39", + "id": "057d892a-729f-41ef-b127-f4290d9ef0c5", "name": "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.", "originalRequest": { "url": { @@ -77942,7 +78242,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0040d65e-1012-46df-867a-04fd081b8bed", + "id": "4b88a8a4-66e0-4e25-92d9-ef836768ebe7", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -77982,7 +78282,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -77993,7 +78293,7 @@ } }, { - "id": "df08d8de-4f3b-4bfc-b3e7-4ed90b441274", + "id": "465f9d44-5481-4ef5-bf31-a49aaaea4a62", "name": "Download custom violation report", "request": { "name": "Download custom violation report", @@ -78038,7 +78338,7 @@ }, "response": [ { - "id": "cc8fbe64-5746-4299-b20c-8ecf07fd5807", + "id": "f48b46f6-b377-4e02-90f4-3b4a864d8e4e", "name": "Returns the zip file with given custom name that contains the violation report file.", "originalRequest": { "url": { @@ -78084,7 +78384,7 @@ "_postman_previewlanguage": "text" }, { - "id": "134be2f9-6b36-46ea-a1d6-8d89eaabe8b1", + "id": "37ab7474-8c0f-4311-80e3-02b447e60c0d", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -78125,12 +78425,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "db7a1a0a-ee69-4c24-861e-1abdd579291e", + "id": "da83d289-4b53-4ff2-a2d7-94b26ffe6fdc", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -78176,7 +78476,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d429ac14-64cc-4626-90c4-cdd90cb54bc7", + "id": "1d683091-3a05-45f0-9d6b-f66612b36a33", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -78217,12 +78517,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "08764d67-611b-4a53-a096-f7abb9abe0dc", + "id": "48416f49-cbf7-4dba-8199-b79fd6c84d5b", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -78263,12 +78563,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ec9d9ab5-9ae4-4c4a-be62-4d35b07c4128", + "id": "877c655b-6adf-4e5f-a2a5-3877eeba1db4", "name": "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.", "originalRequest": { "url": { @@ -78314,7 +78614,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9376a782-c81e-466e-9299-9e18f60ec0c5", + "id": "2efe9326-2dbe-4607-8956-dee2fd445a2e", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -78355,7 +78655,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -78372,7 +78672,7 @@ "description": "Operations for Predicting SOD (Seperation of Duties) violations", "item": [ { - "id": "4d9eb54c-87bc-468b-b222-8d6f79e67da5", + "id": "6077cf0f-aa13-42fa-9701-94a97b97c146", "name": "Predict SOD violations for identity.", "request": { "name": "Predict SOD violations for identity.", @@ -78415,7 +78715,7 @@ }, "response": [ { - "id": "961db11f-1f3e-4db7-9aec-e2b918daf583", + "id": "faf00dd1-0fb7-4ee8-be42-1b478caa3b07", "name": "Violation Contexts", "originalRequest": { "url": { @@ -78472,7 +78772,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4f4e7ab4-7c00-4d73-9230-15e7ed069f5a", + "id": "4a826c26-184d-40a1-990c-8d9c53630048", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -78524,12 +78824,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "711b37b4-ccb3-44de-a507-8ad7604fd70e", + "id": "0ba7f033-106b-4026-ad5f-49998a21d397", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -78586,7 +78886,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b1a25559-2b8f-4d70-845b-b18d0cf2bc59", + "id": "2c72eebd-9b46-47a2-a7d7-0980242885fb", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -78638,12 +78938,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "70a2767e-c7ca-43e5-91ed-659ef4c3451c", + "id": "e9b6e23e-8b86-4cb7-9a0f-019f00537151", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -78695,12 +78995,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "54b8a5c9-300b-4200-947a-35487ee2bcdf", + "id": "07a1611d-22f9-4a8d-8e97-f2afe70c5d52", "name": "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.", "originalRequest": { "url": { @@ -78757,7 +79057,7 @@ "_postman_previewlanguage": "json" }, { - "id": "93180c89-b93f-4482-83fe-a66b60a66a3d", + "id": "11aa9468-255e-4bff-95a5-3fb3a7223079", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -78809,7 +79109,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -78820,7 +79120,7 @@ } }, { - "id": "e98a8735-4618-4585-b817-5f117940b875", + "id": "67e229d2-503a-43df-a78c-68a03fc2db6f", "name": "Check SOD violations", "request": { "name": "Check SOD violations", @@ -78852,7 +79152,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"clientMetadata\": {\n \"quie\": \"\",\n \"sed_3c\": \"\"\n }\n}", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"clientMetadata\": {\n \"ipsum_bcc\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -78863,7 +79163,7 @@ }, "response": [ { - "id": "5e9260fc-75f9-4f72-8c88-7235cd1eb4b8", + "id": "04f013e9-de0b-43e4-8cdb-71841d9322b2", "name": "Request ID with a timestamp.", "originalRequest": { "url": { @@ -78898,7 +79198,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"clientMetadata\": {\n \"quie\": \"\",\n \"sed_3c\": \"\"\n }\n}", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"clientMetadata\": {\n \"ipsum_bcc\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -78920,7 +79220,7 @@ "_postman_previewlanguage": "json" }, { - "id": "af3350e4-ebb2-4ded-a193-1054b9f586ee", + "id": "bcf40f34-7a41-48e1-a726-c383f497fa16", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -78955,7 +79255,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"clientMetadata\": {\n \"quie\": \"\",\n \"sed_3c\": \"\"\n }\n}", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"clientMetadata\": {\n \"ipsum_bcc\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -78972,12 +79272,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "316d9056-47f3-4a6b-a23e-f0b0f0b0d4e7", + "id": "26a9ab89-ac45-427e-be10-722739314c03", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -79012,7 +79312,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"clientMetadata\": {\n \"quie\": \"\",\n \"sed_3c\": \"\"\n }\n}", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"clientMetadata\": {\n \"ipsum_bcc\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -79034,7 +79334,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1c53b448-e712-40fc-aa28-491cff658464", + "id": "becd4f5c-381a-4c13-92ab-19fd98e18d5d", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -79069,7 +79369,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"clientMetadata\": {\n \"quie\": \"\",\n \"sed_3c\": \"\"\n }\n}", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"clientMetadata\": {\n \"ipsum_bcc\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -79086,12 +79386,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a47b18b4-e097-47c4-b005-8fe87381a917", + "id": "a74d873b-6f97-4a1f-80b1-df0eeabc505b", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -79126,7 +79426,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"clientMetadata\": {\n \"quie\": \"\",\n \"sed_3c\": \"\"\n }\n}", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"clientMetadata\": {\n \"ipsum_bcc\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -79143,12 +79443,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5243bbe8-0b9c-4931-b0e2-5e7c378bdc27", + "id": "ea00e24c-85c3-4ceb-8d23-b48ab8e18e9f", "name": "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.", "originalRequest": { "url": { @@ -79183,7 +79483,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"clientMetadata\": {\n \"quie\": \"\",\n \"sed_3c\": \"\"\n }\n}", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"clientMetadata\": {\n \"ipsum_bcc\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -79205,7 +79505,7 @@ "_postman_previewlanguage": "json" }, { - "id": "dfa53beb-d61a-49c4-b9e9-eac5158ba318", + "id": "a3c780ab-e30b-4c82-b807-6bd16ed0d377", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -79240,7 +79540,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"clientMetadata\": {\n \"quie\": \"\",\n \"sed_3c\": \"\"\n }\n}", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"clientMetadata\": {\n \"ipsum_bcc\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -79257,7 +79557,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -79274,7 +79574,7 @@ "description": "Use this API to implement and customize source functionality. \nWith source functionality in place, organizations can use IdentityNow to connect their various sources and user data sets and manage access across all those different sources in a secure, scalable way. \n\n[Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) refer to the IdentityNow representations for external applications, databases, and directory management systems that maintain their own sets of users, like Dropbox, GitHub, and Workday, for example.\nOrganizations may use hundreds, if not thousands, of different source systems, and any one employee within an organization likely has a different user record on each source, often with different permissions on many of those records. \nConnecting these sources to IdentityNow makes it possible to manage user access across them all.\nThen, if a new hire starts at an organization, IdentityNow can grant the new hire access to all the sources they need.\nIf an employee moves to a new department and needs access to new sources but no longer needs access to others, IdentityNow can grant the necessary access and revoke the unnecessary access for all the employee's various sources. \nIf an employee leaves the company, IdentityNow can revoke access to all the employee's various source accounts immediately. \nThese are just a few examples of the many ways that source functionality makes identity governance easier, more efficient, and more secure. \n\nIn IdentityNow, administrators can create configure, manage, and edit sources, and they can designate other users as source admins to be able to do so.\nThey can also designate users as source sub-admins, who can perform the same source actions but only on sources associated with their governance groups.\nAdmins go to Connections > Sources to see a list of the existing source representations in their organizations. \nThey can create new sources or select existing ones. \n\nTo create a new source, the following must be specified: Source Name, Description, Source Owner, and Connection Type.\nRefer to [Configuring a Source](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html#configuring-a-source) for more information about the source configuration process. \n\nIdentityNow connects with its sources either by a direct communication with the source server (connection information specific to the source must be provided) or a flat file feed, a CSV file containing all the relevant information about the accounts to be loaded in.\nDifferent sources use different connectors to share data with IdentityNow, and each connector's setup process is specific to that connector. \nSailPoint has built a number of connectors to come out of the box and connect to the most common sources, and SailPoint actively maintains these connectors.\nRefer to [IdentityNow Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about these SailPoint supported connectors. \nRefer to the following links for more information about two useful connectors: \n\n- [JDBC Connector](https://documentation.sailpoint.com/connectors/jdbc/help/integrating_jdbc/introduction.html): This customizable connector an directly connect to databases that support JDBC (Java Database Connectivity).\n\n- [Web Services Connector](https://documentation.sailpoint.com/connectors/webservices/help/integrating_webservices/introduction.html): This connector can directly connect to databases that support Web Services. \n\nRefer to [SaaS Connectivity](https://developer.sailpoint.com/idn/docs/saas-connectivity) for more information about SailPoint's new connectivity framework that makes it easy to build and manage custom connectors to SaaS sources. \n\nWhen admins select existing sources, they can view the following information about the source:\n\n- Associated connections (any associated identity profiles, apps, or references to the source in a transform).\n\n- Associated user accounts. These accounts are linked to their identities - this provides a more complete picture of each user's access across sources.\n\n- Associated entitlements (sets of access rights on sources).\n\n- Associated access profiles (groupings of entitlements). \n\nThe user account data and the entitlements update with each data aggregation from the source. \nOrganizations generally run scheduled, automated data aggregations to ensure that their data is always in sync between their sources and their IdentityNow tenants so an access change on a source is detected quickly in IdentityNow.\nAdmins can view a history of these aggregations, and they can also run manual imports. \nRefer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about manual and scheduled aggregations. \n\nAdmins can also make changes to determine which user account data IdentityNow collects from the source and how it correlates that account data with identity data. \nTo define which account attributes the source shares with IdentityNow, admins can edit the account schema on the source.\nRefer to [Managing Source Account Schemas](https://documentation.sailpoint.com/saas/help/accounts/schema.html) for more information about source account schemas and how to edit them. \nTo define the mapping between the source account attributes and their correlating identity attributes, admins can edit the correlation configuration on the source. \nRefer to [Assigning Source Accounts to Identities](https://documentation.sailpoint.com/saas/help/accounts/correlation.html) for more information about this correlation process between source accounts and identities.\n\nAdmins can also delete sources, but they must first ensure that the sources no longer have any active connections: the source must not be associated with any identity profile or any app, and it must not be referenced by any transform.\nRefer to [Deleting Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html#deleting-sources) for more information about deleting sources. \n\nWell organized, mappped out connections between sources and IdentityNow are essential to achieving comprehensive identity access governance across all the source systems organizations need. \nRefer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about all the different things admins can do with sources once they are connected. \n", "item": [ { - "id": "df3d944a-7b74-49b6-8ec7-797e03f3e59d", + "id": "043d070b-647d-41e7-8f4c-3deb97c6280c", "name": "Lists all sources in IdentityNow.", "request": { "name": "Lists all sources in IdentityNow.", @@ -79358,7 +79658,7 @@ }, "response": [ { - "id": "7785d652-e8c4-47e3-a5dd-3967b9e9bc71", + "id": "2fdb8b1b-43be-4d04-8208-e941f65d1761", "name": "List of Source objects", "originalRequest": { "url": { @@ -79451,12 +79751,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_AGGREGATION\",\n \"PROXY\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n },\n {\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"TEMPLATE\",\n \"PROXY\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n }\n]", + "body": "[\n {\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"COMPOSITE\",\n \"PROXY\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n },\n {\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"SYNC_PROVISIONING\",\n \"SEARCH\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "82ef7d5a-60fe-4bd2-9d42-9a036b33642f", + "id": "d7d82761-a137-49aa-8c0f-cbf3994635d2", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -79549,12 +79849,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "90a5aebe-19cb-4185-b8d2-303d9968a088", + "id": "1b56d4f6-52a6-41c4-a8ec-1ad71d8098e1", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -79652,7 +79952,7 @@ "_postman_previewlanguage": "json" }, { - "id": "19e19290-864b-467b-b37e-a9b64225fd6f", + "id": "e08ff5da-8035-4dd4-8114-cbde81d47c85", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -79745,12 +80045,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "aa5522e2-4a92-4dc1-aafc-d7fe2973ae47", + "id": "87e3142a-5767-4135-9ce1-cff6f03def71", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -79843,12 +80143,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0edbb059-169b-4e19-8650-02a518e2baa4", + "id": "53245a0e-9fd0-48e0-9f73-d8faa2cf238b", "name": "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.", "originalRequest": { "url": { @@ -79946,7 +80246,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9762c684-c6de-462b-b50f-5f3ead8cf1b6", + "id": "d23e0849-9cd2-4f33-97f7-3980e47c762f", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -80039,7 +80339,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -80050,7 +80350,7 @@ } }, { - "id": "1acaf20b-4d06-4f2e-a6cd-c5c855379a27", + "id": "4242c291-ca21-49d1-b7c7-c7caa41b2db3", "name": "Creates a source in IdentityNow.", "request": { "name": "Creates a source in IdentityNow.", @@ -80091,7 +80391,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"ENABLE\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -80102,7 +80402,7 @@ }, "response": [ { - "id": "9b26c7a8-8e88-4bfa-9aec-ff1023ab4a03", + "id": "0d7d2e69-6c11-4db4-9675-5fe1fb0255fb", "name": "Created Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design.", "originalRequest": { "url": { @@ -80146,7 +80446,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"ENABLE\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -80163,12 +80463,12 @@ "value": "application/json" } ], - "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"ENABLE\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0b6255fe-f7ae-4b8c-9b8a-31307da32c2e", + "id": "c42609d5-ce2f-4aea-aa4c-ae1d603b828f", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -80212,7 +80512,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"ENABLE\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -80229,12 +80529,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "27caf272-77c4-4976-8f9d-9a9da7412520", + "id": "dc8d5b72-c40f-41bc-8ebd-65adb1aaa9e1", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -80278,7 +80578,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"ENABLE\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -80300,7 +80600,7 @@ "_postman_previewlanguage": "json" }, { - "id": "79e35d56-e561-4040-bc21-0b92eb6f7057", + "id": "3786c515-cbaf-44e2-b816-cf115685ed17", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -80344,7 +80644,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"ENABLE\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -80361,12 +80661,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "544889c3-5d9e-4000-8d61-d2284347a1e8", + "id": "3173b437-5fad-45bb-861e-1751ed53f1b9", "name": "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.", "originalRequest": { "url": { @@ -80410,7 +80710,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"ENABLE\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -80432,7 +80732,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ad5d15c8-9318-40a8-9af6-100cdfd10ffe", + "id": "85fc3c6a-e779-4ae7-83b4-022a6c897ba6", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -80476,7 +80776,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"ENABLE\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -80493,7 +80793,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -80504,7 +80804,7 @@ } }, { - "id": "6822cd81-b980-4536-bb39-3eeded624f14", + "id": "18628391-68a9-4331-b1f2-cba2059eecb6", "name": "Get Source by ID", "request": { "name": "Get Source by ID", @@ -80541,7 +80841,7 @@ }, "response": [ { - "id": "8e58e574-6e7d-4e76-ac90-455bdbda4ae0", + "id": "12c4484f-6ba8-42e5-9ce4-c729da63e6d2", "name": "A Source object", "originalRequest": { "url": { @@ -80580,12 +80880,12 @@ "value": "application/json" } ], - "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"ENABLE\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "f2af50d8-8284-4627-852f-75f9f6715da1", + "id": "01ba4ee9-bb9c-4eaa-a6b7-50bbc71684d6", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -80624,12 +80924,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b6f6aacc-f7fb-49a1-8ce6-c48c171f090e", + "id": "184ff368-d49a-4dd8-896a-26dca741a1fb", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -80673,7 +80973,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ce692a52-56ec-4735-b09b-952ef98a062f", + "id": "b7ad0d13-1fc5-4437-aa7d-51c77ff757cf", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -80712,12 +81012,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "4dcbebbe-fc9a-4cf6-9670-976a467b3c46", + "id": "29dce201-fae4-49e4-b709-97570a670b02", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -80756,12 +81056,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6addc3a5-186c-4ba1-8d3e-b06b9bc3ee50", + "id": "bbf4d4ad-e2c5-436c-a087-f356d356152b", "name": "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.", "originalRequest": { "url": { @@ -80805,7 +81105,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3f397f93-e4c4-44dc-b18a-a93e9e118592", + "id": "35035f73-6bbf-4f8c-9ef0-e41d07fbd49b", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -80844,7 +81144,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -80855,7 +81155,7 @@ } }, { - "id": "9362d7e7-3f60-496c-9f9a-970b392ffd79", + "id": "12457815-b7cc-4ebf-bf3c-26652c22f146", "name": "Update Source (Full)", "request": { "name": "Update Source (Full)", @@ -80894,7 +81194,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"ENABLE\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -80905,7 +81205,7 @@ }, "response": [ { - "id": "7723082d-eb6b-4157-8842-fff06e3c3374", + "id": "ffedc5d4-84e0-464f-911c-15ff235dd9b3", "name": "Updated Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design.", "originalRequest": { "url": { @@ -80940,7 +81240,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"ENABLE\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -80957,12 +81257,12 @@ "value": "application/json" } ], - "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"ENABLE\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8677b1cb-d6ff-4b7b-9c18-a659c0311c41", + "id": "3162a922-1916-4299-9a7d-93e499142937", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -80997,7 +81297,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"ENABLE\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -81014,12 +81314,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a3da57a6-ba72-4e0c-86bb-f8f54d1682cf", + "id": "5e004701-7cbb-46f6-92b3-9e889079a28f", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -81054,7 +81354,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"ENABLE\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -81076,7 +81376,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e6c27a75-d3b9-452f-bf4e-948a50f57644", + "id": "9368abe2-58a8-4c12-a5af-31ad3ef45bda", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -81111,7 +81411,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"ENABLE\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -81128,12 +81428,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e31dd28e-165f-4803-a2e9-b6ea40568d09", + "id": "25548c0a-ca2e-49b1-8bf9-96a1f139e8e5", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -81168,7 +81468,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"ENABLE\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -81185,12 +81485,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "53e2aa76-1b07-4b9c-a6f8-d3b007bc2c5e", + "id": "8b914a77-cc41-4a0f-99f4-bc87078a05e2", "name": "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.", "originalRequest": { "url": { @@ -81225,7 +81525,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"ENABLE\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -81247,7 +81547,7 @@ "_postman_previewlanguage": "json" }, { - "id": "664d7ba9-6f9c-47e8-b131-9b31d8767fae", + "id": "c3cc3661-5e8f-413a-aaed-f2e21ca7292f", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -81282,7 +81582,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"ENABLE\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -81299,7 +81599,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -81310,7 +81610,7 @@ } }, { - "id": "4fe9aeda-57d3-4bba-b0f2-893ba242ba39", + "id": "042de9ff-0cfd-4a81-8247-e3b30cecac21", "name": "Update Source (Partial)", "request": { "name": "Update Source (Partial)", @@ -81349,7 +81649,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -81360,7 +81660,7 @@ }, "response": [ { - "id": "a2337bb3-fa2a-429d-b80b-cf2b8272f5da", + "id": "10b76a9a-d7a3-48c0-9cde-ca5f0c2b83bd", "name": "Updated Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design.", "originalRequest": { "url": { @@ -81395,7 +81695,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -81412,12 +81712,12 @@ "value": "application/json" } ], - "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"ENABLE\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c7294af1-c36f-4b3b-9ba9-a5fab9372607", + "id": "d60ccfaf-06fc-474d-bf56-a1be0a725f44", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -81452,7 +81752,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -81469,12 +81769,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "48ca0950-5c29-4bfe-8563-c64f862e152d", + "id": "ea340a1b-3a43-4253-96a9-00fe37cd753d", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -81509,7 +81809,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -81531,7 +81831,7 @@ "_postman_previewlanguage": "json" }, { - "id": "dd3ea22a-decb-4ea5-8a42-985229fff604", + "id": "466288e1-025b-4314-9cb3-bdc69c07202a", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -81566,7 +81866,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -81583,12 +81883,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ebc80d70-709a-40a9-983d-9a6bf9a49aea", + "id": "530314b4-2628-4ea0-9cbe-d07fc4039e89", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -81623,7 +81923,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -81640,12 +81940,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a1a6ef22-aae1-4043-993d-f0876ec196a6", + "id": "41ac8e95-6d4d-47cc-832c-ce3982d718a7", "name": "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.", "originalRequest": { "url": { @@ -81680,7 +81980,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -81702,7 +82002,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1578e21d-7ef3-47bd-bd1b-bed579b672fd", + "id": "c0d58e21-4590-4cdc-970d-70b497599e84", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -81737,7 +82037,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -81754,7 +82054,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -81765,7 +82065,7 @@ } }, { - "id": "706f93dd-7d57-4fcc-979c-c10c149e101e", + "id": "8c738642-ddda-41f8-9b06-19b30401ba42", "name": "Delete Source by ID", "request": { "name": "Delete Source by ID", @@ -81802,7 +82102,7 @@ }, "response": [ { - "id": "5045e7c8-511c-4b84-9604-83855ee8061c", + "id": "244195fc-d119-45b2-afef-3b71657829ba", "name": "Accepted - Returned if the request was successfully accepted into the system.", "originalRequest": { "url": { @@ -81846,7 +82146,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4ba0aa52-8d4b-4382-aa4f-c35751d008ad", + "id": "9b47fcad-8f95-414b-bd8e-fb87d4c22bba", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -81885,12 +82185,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1152774f-5aa8-4024-a66a-efee7989390c", + "id": "03ce0f41-58d2-4914-9a44-5959f62b80b8", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -81934,7 +82234,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e0815f26-181f-4207-996f-f9eb6bb7a5c9", + "id": "c643262e-2402-492e-a5d3-cbe6c673aba3", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -81973,12 +82273,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "25b530a6-8aa7-49c3-bd68-228e714a510f", + "id": "c152c916-666a-476c-99b7-f7ac96e7b6cc", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -82017,12 +82317,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a2cb2ba2-da7a-4d8e-b306-29f933cbfcd5", + "id": "567e3749-7f47-4787-bb4d-9b6c6ee53f72", "name": "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.", "originalRequest": { "url": { @@ -82066,7 +82366,7 @@ "_postman_previewlanguage": "json" }, { - "id": "030f6ea0-2e66-4ca2-bc77-4382da5337af", + "id": "a7a139c4-f680-4101-92e6-45b57423bdbc", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -82105,7 +82405,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -82116,7 +82416,7 @@ } }, { - "id": "0603df2b-05bb-4d9c-89a0-67590b511f31", + "id": "22def453-ed69-4ace-bb22-76b3aea1e48d", "name": "Lists ProvisioningPolicies", "request": { "name": "Lists ProvisioningPolicies", @@ -82154,7 +82454,7 @@ }, "response": [ { - "id": "c96fbc65-70ca-4c60-8a97-dba65a2c4769", + "id": "79f4eaa0-b1c4-4d41-b5fa-d6c35dae2486", "name": "List of ProvisioningPolicyDto objects", "originalRequest": { "url": { @@ -82194,12 +82494,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "body": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "00e384ab-0472-49ec-8aa2-80730dcb1287", + "id": "0fa8fdbc-2bbc-4876-9b1e-907e43e4896d", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -82239,12 +82539,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "22ee8b24-dad7-4805-8fd5-319569e4d12f", + "id": "886a65ba-f707-432a-85cd-e3281d58e82d", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -82289,7 +82589,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a87bca68-5356-4dcb-b549-6fd156eb7cc1", + "id": "805403c3-2105-472a-959b-e0ac2890ba06", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -82329,12 +82629,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5c948cf4-ce2a-4e91-b692-d7e988cc8fe8", + "id": "3cb84358-7688-4c1a-ab6c-6de4146b2c26", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -82374,12 +82674,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "634d5f06-fb69-4cc3-8eca-560ff2247ee6", + "id": "90b1e445-d8f4-4619-8bbd-db964e3504f7", "name": "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.", "originalRequest": { "url": { @@ -82424,7 +82724,7 @@ "_postman_previewlanguage": "json" }, { - "id": "de78c6ed-a1d5-450c-88e1-2870891feff0", + "id": "d356d3f8-9a77-4aaa-adf6-880de21d66ee", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -82464,7 +82764,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -82475,7 +82775,7 @@ } }, { - "id": "c4d982f2-17b4-4083-a023-4d399673b70b", + "id": "1fe632dd-10f8-4cb1-a48a-f72512bfb77e", "name": "Create Provisioning Policy", "request": { "name": "Create Provisioning Policy", @@ -82515,7 +82815,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNLOCK\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -82526,7 +82826,7 @@ }, "response": [ { - "id": "761b5c48-d8e5-4317-a367-c8733d2548d7", + "id": "6cb00193-049f-4ae2-8866-4fa27d0eaa89", "name": "Created ProvisioningPolicyDto object", "originalRequest": { "url": { @@ -82562,7 +82862,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNLOCK\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -82579,12 +82879,12 @@ "value": "application/json" } ], - "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNLOCK\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e9ed2634-062d-4d45-9a97-5e9a739665c1", + "id": "b3c82bb8-501c-49b2-9c9c-3d74ae5e4c81", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -82620,7 +82920,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNLOCK\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -82637,12 +82937,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "fc753fb2-e8dd-4451-b48d-c648412ff091", + "id": "d4e1bec5-9267-42e2-8d04-9e21000df9d2", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -82678,7 +82978,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNLOCK\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -82700,7 +83000,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8128eb9e-4560-499e-be02-3e337f7d65b7", + "id": "2a3e6866-9c5e-47a3-a90f-9d8cdf6920bc", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -82736,7 +83036,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNLOCK\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -82753,12 +83053,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b83314ec-fca1-4bb7-b2c2-517f678dba44", + "id": "12acff8e-4d42-44f4-a41f-a7f8b642fd1d", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -82794,7 +83094,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNLOCK\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -82811,12 +83111,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "bd594473-2fcf-4dea-a056-8b1a78256a24", + "id": "1b41ca42-1bed-49ea-8f6d-4022ba37dc99", "name": "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.", "originalRequest": { "url": { @@ -82852,7 +83152,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNLOCK\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -82874,7 +83174,7 @@ "_postman_previewlanguage": "json" }, { - "id": "630ee3bc-26aa-46fc-9f00-98173f9ced27", + "id": "f8c5edc2-4301-49f7-bb26-d0a7b0102961", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -82910,7 +83210,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNLOCK\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -82927,7 +83227,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -82938,7 +83238,7 @@ } }, { - "id": "6889609a-701d-4898-a25b-6da37d36d6f4", + "id": "0ef75afd-112b-48ab-8f58-3e1055bcf357", "name": "Get Provisioning Policy by UsageType", "request": { "name": "Get Provisioning Policy by UsageType", @@ -82966,7 +83266,7 @@ }, { "type": "any", - "value": "CHANGE_PASSWORD", + "value": "UPDATE", "key": "usageType", "disabled": true } @@ -82983,7 +83283,7 @@ }, "response": [ { - "id": "63b070da-2a67-4a14-b376-d3a17a9d3d25", + "id": "2e4b9973-431e-4a7e-8f0b-952a7e6fd55c", "name": "The requested ProvisioningPolicyDto was successfully retrieved.", "originalRequest": { "url": { @@ -83024,12 +83324,12 @@ "value": "application/json" } ], - "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNLOCK\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "9150fb63-7aea-4d63-8c39-82e298c2418f", + "id": "00005b7f-c5e6-4032-8d5a-c43e7620225a", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -83070,12 +83370,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "81d7ddec-fb45-409d-8ca7-d1f9d0836d16", + "id": "c102cf76-dd5a-4d7a-a540-8996a6273685", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -83121,7 +83421,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1fedfc98-730c-430f-9efc-2185c2fe255f", + "id": "dd0b7677-bad5-4d38-92be-8c0e595f6c22", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -83162,12 +83462,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0dbdb16b-3641-4cf9-9fed-6b99914ac992", + "id": "37e22907-1c38-4120-b6cc-3dfd223759b8", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -83208,12 +83508,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c44e787c-505e-4d2c-a402-70d26ed2a23e", + "id": "998ac6aa-20df-4798-9d7b-fb3c04d4b823", "name": "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.", "originalRequest": { "url": { @@ -83259,7 +83559,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a2914a07-efdc-4b5f-9a86-65f374b043b4", + "id": "c2295507-0bc8-4f75-aa36-dde4636cf5aa", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -83300,7 +83600,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -83311,7 +83611,7 @@ } }, { - "id": "f8eefeaf-c63a-41a6-a856-8575f9462fff", + "id": "2a2e97ba-578f-45c2-aca8-01152897411e", "name": "Update Provisioning Policy by UsageType", "request": { "name": "Update Provisioning Policy by UsageType", @@ -83339,7 +83639,7 @@ }, { "type": "any", - "value": "CHANGE_PASSWORD", + "value": "UPDATE", "key": "usageType", "disabled": true } @@ -83358,7 +83658,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNLOCK\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -83369,7 +83669,7 @@ }, "response": [ { - "id": "e6b445fe-9efb-4073-a3e6-fe2aa0ceaa03", + "id": "a6060539-0a4d-4b78-8940-91f71615bbf4", "name": "The ProvisioningPolicyDto was successfully replaced.", "originalRequest": { "url": { @@ -83406,7 +83706,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNLOCK\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -83423,12 +83723,12 @@ "value": "application/json" } ], - "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNLOCK\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a46e69dd-f8ab-4775-8039-d7409cbea842", + "id": "4beaad57-e6a1-43f6-9bf4-defd6802579c", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -83465,7 +83765,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNLOCK\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -83482,12 +83782,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c2653c4b-e917-4217-8833-b93f7ac20382", + "id": "1fdd0216-9db2-4c8c-b57d-c11276977fd8", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -83524,7 +83824,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNLOCK\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -83546,7 +83846,7 @@ "_postman_previewlanguage": "json" }, { - "id": "bc034526-4fd8-4e2b-be45-4223d91c9b5b", + "id": "daf3fd4f-4398-4be3-9322-1a5407adc41d", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -83583,7 +83883,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNLOCK\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -83600,12 +83900,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a279cd7c-60cb-496a-88ce-e4ac74cedd76", + "id": "9c9585e5-3bf3-4544-84fb-d68ceb085699", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -83642,7 +83942,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNLOCK\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -83659,12 +83959,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "256cd150-20be-403d-b14c-1c1611ef1146", + "id": "2e853101-cbb3-4d82-9a1a-8f26fa5a89f3", "name": "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.", "originalRequest": { "url": { @@ -83701,7 +84001,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNLOCK\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -83723,7 +84023,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5a17e2a1-0184-495a-a6ce-85d54b9b62b0", + "id": "134f08ad-db34-4675-81e5-2f1a3929312b", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -83760,7 +84060,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNLOCK\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -83777,7 +84077,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -83788,7 +84088,7 @@ } }, { - "id": "ca6fd307-5245-45ed-86ce-da72d0834dd9", + "id": "95f0c9a9-774e-4617-a066-2fd188235409", "name": "Partial update of Provisioning Policy", "request": { "name": "Partial update of Provisioning Policy", @@ -83816,7 +84116,7 @@ }, { "type": "any", - "value": "CHANGE_PASSWORD", + "value": "UPDATE", "key": "usageType", "disabled": true } @@ -83835,7 +84135,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -83846,7 +84146,7 @@ }, "response": [ { - "id": "04120ba4-f6a9-4038-ac21-a2dfb6991087", + "id": "38166473-fbe2-4a47-8d0d-7d4af3b5fb9b", "name": "The ProvisioningPolicyDto was successfully updated.", "originalRequest": { "url": { @@ -83883,7 +84183,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -83900,12 +84200,12 @@ "value": "application/json" } ], - "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNLOCK\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d38f1d87-7282-42d8-b983-22f3ed997263", + "id": "1927905a-7d28-48f4-a931-f4ebd7627345", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -83942,7 +84242,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -83959,12 +84259,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6349121c-fb2c-47fb-805c-86fdea7547b8", + "id": "6ed69fad-2fef-429f-b3be-e66cba4c3578", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -84001,7 +84301,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -84023,7 +84323,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a34fd940-27ee-49a3-ae34-0c77724ae1d9", + "id": "109c6603-6f50-49e0-b980-0734723d84c6", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -84060,7 +84360,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -84077,12 +84377,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ecd0ce5f-29bf-4f51-9b62-2fab71124edd", + "id": "ce09101f-14ba-400e-a98f-89ac2fa9a88b", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -84119,7 +84419,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -84136,12 +84436,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "de44bd5d-876f-42f1-bf35-ef9b477da63b", + "id": "257d4fb1-1d40-4f05-b47e-d10e07461b72", "name": "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.", "originalRequest": { "url": { @@ -84178,7 +84478,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -84200,7 +84500,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d6808120-d1d1-40b3-9ccc-9e23073198b2", + "id": "8d45e493-83e8-47db-9ce1-e6821a52aa8a", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -84237,7 +84537,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -84254,7 +84554,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -84265,7 +84565,7 @@ } }, { - "id": "a7362b3e-98b1-489a-b436-1ba5dc5f4351", + "id": "e044560a-0b6e-4f85-9437-45bbe7d2d74c", "name": "Delete Provisioning Policy by UsageType", "request": { "name": "Delete Provisioning Policy by UsageType", @@ -84293,7 +84593,7 @@ }, { "type": "any", - "value": "CHANGE_PASSWORD", + "value": "UPDATE", "key": "usageType", "disabled": true } @@ -84310,7 +84610,7 @@ }, "response": [ { - "id": "0554467f-4238-4ea6-a5bb-c8ef8ea62657", + "id": "0ae60946-8ba4-4e78-8cdd-893ed9940cac", "name": "The ProvisioningPolicyDto was successfully deleted.", "originalRequest": { "url": { @@ -84346,7 +84646,7 @@ "_postman_previewlanguage": "text" }, { - "id": "86d01bef-e939-48bc-86b9-7fede765e863", + "id": "231695ac-553e-4d90-aba3-e102963f1721", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -84387,12 +84687,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0ea160ac-2864-437e-846a-9cc9dc0b360e", + "id": "5d3617a9-9950-40dd-a0f1-2ba1705b5f2c", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -84438,7 +84738,7 @@ "_postman_previewlanguage": "json" }, { - "id": "10efa29c-e7de-4690-a3ee-ee2b16f8f55e", + "id": "49e20641-fd73-44bc-8467-605ed9e10e1f", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -84479,12 +84779,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a2320093-ae9b-4a68-b960-356ecc2451b9", + "id": "522c2396-9403-4970-9909-52e87c5e4300", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -84525,12 +84825,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "45207a6d-d87d-446e-a25a-26c1b3f0e397", + "id": "e8b7ab11-f6d8-4056-a8fa-9b5113983b2e", "name": "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.", "originalRequest": { "url": { @@ -84576,7 +84876,7 @@ "_postman_previewlanguage": "json" }, { - "id": "cdfca7d0-4690-4207-9363-8c3e8a786596", + "id": "6986f176-26b7-4e10-9ae6-bb8924920ef0", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -84617,7 +84917,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -84628,7 +84928,7 @@ } }, { - "id": "2ede594a-74b7-4fde-b2ea-42b717d9113e", + "id": "5894dfc7-cee0-4e9b-8c27-e8bd1f1c595f", "name": "Bulk Update Provisioning Policies", "request": { "name": "Bulk Update Provisioning Policies", @@ -84669,7 +84969,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -84680,7 +84980,7 @@ }, "response": [ { - "id": "ec01bcf2-921f-4049-a1d9-da296a2f6ae7", + "id": "def82104-8f6a-43b2-8e65-d1b65cc61167", "name": "A list of the ProvisioningPolicyDto was successfully replaced.", "originalRequest": { "url": { @@ -84717,7 +85017,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -84734,12 +85034,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "body": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "54dc2570-0ba9-4c7e-8eb1-55d1dd205266", + "id": "aa325859-54fa-4d07-a3af-af0e4945ddba", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -84776,7 +85076,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -84793,12 +85093,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "4030ed1a-f81d-4852-89a9-a5fd66a19197", + "id": "4d84427d-4cb1-4d4d-a722-22870625cbe2", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -84835,7 +85135,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -84857,7 +85157,7 @@ "_postman_previewlanguage": "json" }, { - "id": "802f1f05-b9c9-4292-8a77-d46e28348b22", + "id": "26ba448c-bf33-4d86-9b02-5f7c4a5df2c9", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -84894,7 +85194,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -84911,12 +85211,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8b6cc864-4b76-45e1-afb0-c4d68afba36f", + "id": "19ad10f0-f405-4775-bb65-1913e2e7db40", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -84953,7 +85253,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -84970,12 +85270,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "45904172-5a49-4650-bf03-317e4f657c02", + "id": "6a5703a9-db86-48a6-86bd-d7b538e4fbeb", "name": "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.", "originalRequest": { "url": { @@ -85012,7 +85312,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -85034,7 +85334,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3e99d0c7-7dd8-4bf5-b09c-2f69a5114cc3", + "id": "d0ae526c-0b04-4e44-9e52-0f0c7ad1b5c3", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -85071,7 +85371,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"DELETE_GROUP\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -85088,7 +85388,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -85099,7 +85399,7 @@ } }, { - "id": "32e98e26-dc3f-46e9-8961-aabbd251c546", + "id": "c3b71658-0b65-48fb-b568-54d6ab83942d", "name": "List Schemas on a Source", "request": { "name": "List Schemas on a Source", @@ -85147,7 +85447,7 @@ }, "response": [ { - "id": "b0db10d6-9a98-4e1a-b34a-2691f72fc823", + "id": "9a806184-f55c-43f2-97ba-9a91399ec1e6", "name": "The Schemas were successfully retrieved.", "originalRequest": { "url": { @@ -85197,12 +85497,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"CURRENT_PASSWORD\",\n \"GROUP_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"ADDITIONAL_ACCOUNT_REQUEST\",\n \"DISCOVER_SCHEMA\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n }\n]", + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"UNLOCK\",\n \"CURRENT_PASSWORD\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"UNSTRUCTURED_TARGETS\",\n \"ACCOUNT_ONLY_REQUEST\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a10b67cf-2516-41b1-b3f5-6dc3e6974d71", + "id": "22534b89-2e4d-47d4-ab8c-67a09324cd40", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -85252,12 +85552,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "9bd8a67e-68ab-492e-9a9e-7fd170ad4050", + "id": "83705f51-42d1-4574-9b62-c5148461f78a", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -85312,7 +85612,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9df71753-4969-457c-bf0f-005ffffcd9f9", + "id": "072b9386-ff65-4e08-b5ac-adf5f9c43f14", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -85362,12 +85662,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d830fbe0-8cb1-4e0b-95b8-002f77f5587d", + "id": "db593181-e525-4324-b84f-bdf67d672e51", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -85417,12 +85717,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "71c24e2a-d93c-46a6-8c4d-64a46d47dc1b", + "id": "495e40fa-06da-4aeb-9f56-b93cb6a40826", "name": "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.", "originalRequest": { "url": { @@ -85477,7 +85777,7 @@ "_postman_previewlanguage": "json" }, { - "id": "eaf58db6-8709-4b34-897c-82a7d72fb8de", + "id": "d2bb25d7-1988-45ec-ad9c-9859b9359be5", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -85527,7 +85827,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -85538,7 +85838,7 @@ } }, { - "id": "359ae4ef-f832-49c3-9c48-7b52759b92c0", + "id": "addc366b-6320-4cbe-8316-0fe9977aef22", "name": "Create Schema on a Source", "request": { "name": "Create Schema on a Source", @@ -85578,7 +85878,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"PROXY\",\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\",\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -85589,7 +85889,7 @@ }, "response": [ { - "id": "20af43fb-d145-4f36-b13b-e044530f98af", + "id": "75fba3b5-7240-4eb4-85d2-7ebe66424ce3", "name": "The Schema was successfully created on the specified Source.", "originalRequest": { "url": { @@ -85625,7 +85925,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"PROXY\",\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\",\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -85642,12 +85942,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"PROXY\",\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\",\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "db71604c-8801-4dd0-825a-da57e4d9fe49", + "id": "595a7847-1f8d-4aae-b822-17608c20d970", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -85683,7 +85983,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"PROXY\",\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\",\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -85700,12 +86000,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "48c222b2-fed4-4e09-b2a2-0f90bfc9ccba", + "id": "6115c393-0057-45ed-91a0-01e487f22529", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -85741,7 +86041,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"PROXY\",\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\",\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -85763,7 +86063,7 @@ "_postman_previewlanguage": "json" }, { - "id": "fb75a5af-2751-40c8-857d-8833f0666991", + "id": "e3e1799c-62b0-4e8e-a765-30a6663229c9", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -85799,7 +86099,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"PROXY\",\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\",\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -85816,12 +86116,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0722a29e-e830-4c04-8610-4c27fc1c461e", + "id": "24abddff-6871-4516-9667-c09bb625bb23", "name": "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.", "originalRequest": { "url": { @@ -85857,7 +86157,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"PROXY\",\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\",\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -85879,7 +86179,7 @@ "_postman_previewlanguage": "json" }, { - "id": "33d4bc64-a6a9-4128-8923-03d35b2d5cb8", + "id": "2391d6a5-cdc6-434f-b134-79bce5678bd5", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -85915,7 +86215,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"PROXY\",\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\",\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -85932,7 +86232,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -85943,7 +86243,7 @@ } }, { - "id": "129156da-da40-4a0b-86fb-ddc53e376b23", + "id": "01ed183a-27d2-4faf-ae9e-29c8fbd1966c", "name": "Get Source Schema by ID", "request": { "name": "Get Source Schema by ID", @@ -85988,7 +86288,7 @@ }, "response": [ { - "id": "c43e04f4-2173-4e10-bc20-7119a2764672", + "id": "69320f6e-f134-43c7-8807-38bcdb489ab8", "name": "The requested Schema was successfully retrieved.", "originalRequest": { "url": { @@ -86029,12 +86329,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"PROXY\",\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\",\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d64cbf74-0d59-46be-8a0e-ebcee69459dd", + "id": "5f8aafb8-9d22-4693-b3dd-e8b11adab67b", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -86075,12 +86375,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ef0dd23a-5aa9-4a06-bfd9-e4cc85cea44f", + "id": "ed4eea7c-b88d-4bd6-bed2-f966bb993236", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -86126,7 +86426,7 @@ "_postman_previewlanguage": "json" }, { - "id": "72f4bbcb-182c-4bab-b367-136457057e8f", + "id": "f32c477e-4c14-45e6-b95d-93aa06539258", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -86167,12 +86467,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "854cac86-b2c2-4353-90c7-a35102688302", + "id": "879086da-5b23-4531-82bd-dbb14f91e267", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -86213,12 +86513,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d2b372d3-977d-4917-989b-54d4a6c3e090", + "id": "c947a16f-967b-495c-afa3-c3d10c0eed2b", "name": "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.", "originalRequest": { "url": { @@ -86264,7 +86564,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ae9789e9-0642-4de4-9ed3-ce580dc43d74", + "id": "37ed5c35-6ca5-4475-aea6-5ea9a2cff68a", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -86305,7 +86605,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -86316,7 +86616,7 @@ } }, { - "id": "99ea3ae6-0545-473d-b04b-5ef0f8fe38cc", + "id": "19878871-9712-4a1b-85fd-abb992b036fc", "name": "Update Source Schema (Full)", "request": { "name": "Update Source Schema (Full)", @@ -86363,7 +86663,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"PROXY\",\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\",\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -86374,7 +86674,7 @@ }, "response": [ { - "id": "edb47e29-782d-4dec-8610-d4528db497b2", + "id": "bc83148d-e19d-49b2-a0ad-d0175b283e04", "name": "The Schema was successfully replaced.", "originalRequest": { "url": { @@ -86411,7 +86711,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"PROXY\",\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\",\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -86428,12 +86728,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"PROXY\",\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\",\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8bdecbf4-a3d6-4339-b1dd-365675bf1dde", + "id": "d683ec0e-1801-4d34-96b9-77ee78126bff", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -86470,7 +86770,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"PROXY\",\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\",\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -86487,12 +86787,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3c9c7de8-209d-473b-8363-e28991b65815", + "id": "d42c8e79-eb6c-4e1c-8690-f3bd08212bc0", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -86529,7 +86829,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"PROXY\",\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\",\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -86551,7 +86851,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f727daec-21d5-4c07-a3c1-00ca19c25db4", + "id": "6b665cb2-2a18-435d-8936-d951fc82bd66", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -86588,7 +86888,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"PROXY\",\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\",\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -86605,12 +86905,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5d9d2f04-6b45-4486-964f-1e19dfb6c079", + "id": "5079c5f5-47dc-4446-8435-aa16573f4780", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -86647,7 +86947,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"PROXY\",\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\",\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -86664,12 +86964,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b17f828a-3405-4cff-97ff-9dd55422e894", + "id": "d2636dd6-29c3-4da1-8cae-359876dcd9c5", "name": "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.", "originalRequest": { "url": { @@ -86706,7 +87006,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"PROXY\",\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\",\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -86728,7 +87028,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d1e0e6ec-afd1-4995-95b2-dedb5f2da47e", + "id": "c5814af8-5b3d-47a7-bdf3-55ed1e974c5f", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -86765,7 +87065,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"PROXY\",\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\",\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -86782,7 +87082,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -86793,7 +87093,7 @@ } }, { - "id": "006420af-5192-4207-ae7e-c2a973ec920b", + "id": "0a025a2a-44e6-430c-89ae-3c956b157c38", "name": "Update Source Schema (Partial)", "request": { "name": "Update Source Schema (Partial)", @@ -86840,7 +87140,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -86851,7 +87151,7 @@ }, "response": [ { - "id": "9cf85b89-c2ba-427e-9474-a8136e1e3ab0", + "id": "68a0e330-ef79-4092-b36a-a316acf17a72", "name": "The Schema was successfully updated.", "originalRequest": { "url": { @@ -86888,7 +87188,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -86905,12 +87205,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"PROXY\",\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\",\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "be891e49-a4da-4756-ac3a-e802229742bd", + "id": "c5ea09e5-69d2-45bd-9d11-bcd4e38366b3", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -86947,7 +87247,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -86964,12 +87264,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c8ea91c0-f74d-4a98-b0e7-9e829fcbdf75", + "id": "f0202801-1e79-422a-ad39-55bc83f5adca", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -87006,7 +87306,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -87028,7 +87328,7 @@ "_postman_previewlanguage": "json" }, { - "id": "60e46e29-4f1c-4cc1-b6ae-9c5e39996be1", + "id": "f20003c2-c08e-480f-8356-473cc96032ad", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -87065,7 +87365,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -87082,12 +87382,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "84341630-43c5-4f05-8b6e-53d99045fbfe", + "id": "8894e300-8ce6-49d8-99b0-29fda1046c69", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -87124,7 +87424,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -87141,12 +87441,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c57a0ee4-485c-4d1f-ad33-6c95a0ed4da7", + "id": "dafa2f85-8839-44f4-a46f-f49e9b6556e1", "name": "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.", "originalRequest": { "url": { @@ -87183,7 +87483,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -87205,7 +87505,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3f531b5f-aaa9-4e14-bc3b-e6bd10033721", + "id": "d96d1326-ea51-4d6c-ad4f-5aa8ee45fb29", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -87242,7 +87542,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "[\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -87259,7 +87559,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -87270,7 +87570,7 @@ } }, { - "id": "efc3754f-23a5-4ced-91c3-8ab0dee645ab", + "id": "458d4e63-24c4-4831-bed2-13e7f68a1f05", "name": "Delete Source Schema by ID", "request": { "name": "Delete Source Schema by ID", @@ -87312,7 +87612,7 @@ }, "response": [ { - "id": "35991083-65ea-4546-9ae2-e8e8003ef6bc", + "id": "092afca9-b313-4b22-80ad-aef661a62b90", "name": "The Schema was successfully deleted.", "originalRequest": { "url": { @@ -87348,7 +87648,7 @@ "_postman_previewlanguage": "text" }, { - "id": "5235ad4b-9251-43e2-b681-52683968bf93", + "id": "64e1364b-2f9c-4135-b9f0-b45a3d179e87", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -87389,12 +87689,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "577202f9-6a57-42d6-b36b-b11b3e1dbe42", + "id": "f5455aa3-f46d-4bb2-8c72-726836251877", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -87440,7 +87740,7 @@ "_postman_previewlanguage": "json" }, { - "id": "eee470a3-d56f-460e-8d81-1f70b5a5de71", + "id": "21001326-5070-4766-a5bc-cf17516b4df9", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -87481,12 +87781,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "52084caa-441e-47b1-8736-1d52ac398860", + "id": "356c1fef-6cb6-447d-af78-27ea13af27cb", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -87527,12 +87827,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b2fa8999-1593-445e-a418-a9933456fb75", + "id": "47377585-9929-4c22-bcb1-707786994a9a", "name": "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.", "originalRequest": { "url": { @@ -87578,7 +87878,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f85fd930-3a9c-4fed-92d5-d8e20a9a1e17", + "id": "2cc02590-7473-4575-9805-b525bd7b7e72", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -87619,7 +87919,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -87630,7 +87930,7 @@ } }, { - "id": "83b0cb0b-cfa6-4ea1-8c76-674fa2690d65", + "id": "a6fb3c79-3694-498a-9172-c19e41eebd0a", "name": "Fetches source health by id", "request": { "name": "Fetches source health by id", @@ -87668,7 +87968,7 @@ }, "response": [ { - "id": "8f1acfc1-2491-43b0-a4b3-d153e8f8a580", + "id": "509af6e9-c9d9-4196-bfcf-8fc4cf0b7f05", "name": "Fetched source health successfully", "originalRequest": { "url": { @@ -87708,12 +88008,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"org\": \"\",\n \"isAuthoritative\": \"\",\n \"isCluster\": \"\",\n \"hostname\": \"\",\n \"pod\": \"\",\n \"iqServiceVersion\": \"\",\n \"status\": \"SOURCE_STATE_UNCHECKED_CLUSTER\"\n}", + "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"org\": \"\",\n \"isAuthoritative\": \"\",\n \"isCluster\": \"\",\n \"hostname\": \"\",\n \"pod\": \"\",\n \"iqServiceVersion\": \"\",\n \"status\": \"SOURCE_STATE_HEALTHY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ef24b56c-904d-4917-8a1d-9ebd4ea55fb4", + "id": "eac79b30-0197-490b-98a3-44a9665ff569", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -87753,12 +88053,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "dbcbb557-698c-4b3a-b39d-0d99dd89362f", + "id": "1abf7607-8cc7-4469-aaae-e5fa6719f416", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -87803,7 +88103,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ae71b17a-965f-4699-b440-c4e440e572eb", + "id": "f9686984-64a5-42b8-b4ad-4680e05b0787", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -87843,12 +88143,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ebe90baf-dc43-46b7-bb01-fe760d2699d3", + "id": "686f63a3-1ba9-446b-ad01-bfbfc5f2e36d", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -87888,12 +88188,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b6d307cc-d20d-4b0d-8830-57435dc17f19", + "id": "46d1f5c9-0ed9-4159-984e-250ab13407a2", "name": "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.", "originalRequest": { "url": { @@ -87938,7 +88238,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7c906ede-254f-4e86-874b-85b64bf821ce", + "id": "43a6f25e-fe9e-41f5-af57-0ed0dcc5f51c", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -87978,7 +88278,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -87989,7 +88289,7 @@ } }, { - "id": "cb35917b-16be-4faf-a2e3-a7e47435db41", + "id": "02641698-4053-44e5-9755-0952f1e52bf4", "name": "Downloads source accounts schema template", "request": { "name": "Downloads source accounts schema template", @@ -88028,7 +88328,7 @@ }, "response": [ { - "id": "e8cad6d1-e577-4655-b33c-c31b962ca750", + "id": "3cbdc6a9-bdf2-4850-9107-993314e4309c", "name": "Successfully downloaded the file", "originalRequest": { "url": { @@ -88074,7 +88374,7 @@ "_postman_previewlanguage": "text" }, { - "id": "d1ebc271-c043-4621-8e6a-42e13aa16d28", + "id": "3a3417a9-5e86-4554-8760-72781deb6e61", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -88115,12 +88415,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "2114ea4f-bd14-4318-aaae-628c3def8140", + "id": "5b462d2c-cb9d-4402-ac50-e539cf2bde86", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -88166,7 +88466,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0a2ad9d0-8b3f-4a6f-9b62-5079184e578f", + "id": "a6bb1e05-7439-40fd-a224-ad6686cefd9d", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -88207,12 +88507,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "4c0a8fb8-b2e8-4f80-b965-f44673588b29", + "id": "83af3288-2d62-4880-b05a-c3b2aba1395d", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -88253,12 +88553,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "796f7429-db03-433f-b2e5-a70024411981", + "id": "33003a7a-8d6f-43eb-a325-a7c0af283d50", "name": "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.", "originalRequest": { "url": { @@ -88304,7 +88604,7 @@ "_postman_previewlanguage": "json" }, { - "id": "2f61b64f-d94b-431f-92d0-e525ac6e1d2c", + "id": "ae7a642e-9855-4d46-8a27-bb9593543069", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -88345,7 +88645,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -88356,7 +88656,7 @@ } }, { - "id": "d0a02891-a3d7-44ab-b18e-9aa60e3e1cf3", + "id": "41b1566d-0d24-4d0a-9fd4-ac1768fb3c3d", "name": "Uploads source accounts schema template", "request": { "name": "Uploads source accounts schema template", @@ -88412,7 +88712,7 @@ }, "response": [ { - "id": "89dff33f-f02e-4668-9f2e-5fdde896f214", + "id": "e3212d8e-05b4-414a-b355-2742b9759c54", "name": "Successfully uploaded the file", "originalRequest": { "url": { @@ -88470,12 +88770,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"PROXY\",\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\",\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "384c995f-6b44-43bf-8c85-a22e44f770ed", + "id": "4d54511d-fc5a-40c0-ae38-4a89eebcc00c", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -88533,12 +88833,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8f68f55f-8772-4dd5-a18b-a1d9ec26a1ea", + "id": "ab4c746b-6e5c-456d-b353-925a3a46bdce", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -88601,7 +88901,7 @@ "_postman_previewlanguage": "json" }, { - "id": "cf18ab34-a2e5-4499-b9fc-c4648d8fa040", + "id": "28163b3a-e155-44a1-97d4-a8318d5feeee", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -88659,12 +88959,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e3d9c7e4-5f9d-4c33-9147-6a9ae5c00475", + "id": "75d1ef45-0855-4c4d-9f88-00b94ae188f8", "name": "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.", "originalRequest": { "url": { @@ -88727,7 +89027,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ac9528c5-bd7c-452f-872c-af0529169bfe", + "id": "63bb1524-6d0b-4d05-84be-dffc83979ace", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -88785,7 +89085,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -88796,7 +89096,7 @@ } }, { - "id": "02cd817b-f65c-4e64-9a33-f4a2532e070c", + "id": "d57a0cb3-c7c8-4fb7-9158-863da9db1eac", "name": "Downloads source entitlements schema template", "request": { "name": "Downloads source entitlements schema template", @@ -88845,7 +89145,7 @@ }, "response": [ { - "id": "e8d82ec8-5507-4a95-9de0-7eafcdcbf2da", + "id": "80637912-d9b0-4e91-8e58-4d414c738e85", "name": "Successfully downloaded the file", "originalRequest": { "url": { @@ -88901,7 +89201,7 @@ "_postman_previewlanguage": "text" }, { - "id": "8fdd8189-6d49-4847-b12e-62ff58042c39", + "id": "6c5c5b75-c357-482c-8776-260dfef37afc", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -88952,12 +89252,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "73f5eb2d-4ed1-4164-a4b6-cad11c51b651", + "id": "d5b96519-73c3-4fcf-8192-ddaeea786f53", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -89013,7 +89313,7 @@ "_postman_previewlanguage": "json" }, { - "id": "cd92e670-f003-441c-ba73-968c60d2e13c", + "id": "f7e38ffb-eadf-4acd-8149-0e677911294a", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -89064,12 +89364,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "91624229-4876-4a6d-9681-752242122bd3", + "id": "ae831148-0597-4033-b4e6-cceed3d38ceb", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -89120,12 +89420,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "60997440-3160-4a1c-9bd0-3655bdee7e39", + "id": "3878b985-714f-4f0c-b347-0d1d280dfbff", "name": "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.", "originalRequest": { "url": { @@ -89181,7 +89481,7 @@ "_postman_previewlanguage": "json" }, { - "id": "952ff7ae-dcdf-4760-9703-9733be6f8427", + "id": "fc4ce7b9-b8cc-41c6-b543-deb71d37e9e6", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -89232,7 +89532,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -89243,7 +89543,7 @@ } }, { - "id": "501d1d9a-6a82-4110-b315-281afb1b0b8d", + "id": "74dc3b19-5c56-4a47-a500-2140171fb388", "name": "Uploads source entitlements schema template", "request": { "name": "Uploads source entitlements schema template", @@ -89309,7 +89609,7 @@ }, "response": [ { - "id": "da105194-fa5a-4a84-9182-719efd0b51f3", + "id": "305569be-814a-49b4-b0a2-0404b932271c", "name": "Successfully uploaded the file", "originalRequest": { "url": { @@ -89377,12 +89677,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"PROXY\",\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\",\n \"NO_DIRECT_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "491221f0-6f51-4b29-90b5-1cfa12e5f952", + "id": "7f716445-1581-4c9c-88a8-c3c9ab436e5d", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -89450,12 +89750,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "528bbd1c-007e-4fb0-9084-155a7305f0df", + "id": "861fef73-8b1d-4a08-987e-38dab29282b1", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -89528,7 +89828,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8e54609c-6bd9-4815-b690-8d184efab483", + "id": "3c60e162-edb6-47d2-84ce-13df3a43cd77", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -89596,12 +89896,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0c8e15a0-b47e-4df6-8281-7a758ba1cc46", + "id": "02d11f56-9467-4966-abed-d2d3385b4041", "name": "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.", "originalRequest": { "url": { @@ -89674,7 +89974,7 @@ "_postman_previewlanguage": "json" }, { - "id": "37f0c176-67b2-41fa-8691-b0b44c1c9d9c", + "id": "5cdbae8f-805e-4c1f-a489-17b9f033373c", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -89742,7 +90042,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -89753,7 +90053,7 @@ } }, { - "id": "f411f57f-504e-400a-a628-5a8d087db2a5", + "id": "b891970e-d6ff-4681-af16-b3647d4a99ba", "name": "Upload connector file to source", "request": { "name": "Upload connector file to source", @@ -89808,7 +90108,7 @@ }, "response": [ { - "id": "3fc68c18-1b2f-416c-a290-4018f457bf7c", + "id": "7cf250f0-76cf-4820-812d-1c3c1effa15c", "name": "Uploaded the file successfully and sent all post-upload events", "originalRequest": { "url": { @@ -89865,12 +90165,12 @@ "value": "application/json" } ], - "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"ENABLE\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"CLUSTER\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\",\n \"PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": false,\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "77c40a26-d9a7-47b6-8a4a-71bc85c24713", + "id": "b2484de9-bc5d-49f1-bdf9-8243eea57102", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -89927,12 +90227,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "76da1ef9-18b1-4548-8ce2-ac886ae6d3e1", + "id": "903ef36c-79ae-4e9f-9ba7-782fdf45edff", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -89994,7 +90294,7 @@ "_postman_previewlanguage": "json" }, { - "id": "186225d0-9245-4cf9-9c93-9603edac10af", + "id": "a36b0f09-9824-4205-8c89-68f2ca693bb9", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -90051,12 +90351,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "cf68efe5-6d13-499b-aeae-67706fe341c8", + "id": "a9d3bf55-9c57-4cc6-921c-6c3623ea72ac", "name": "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.", "originalRequest": { "url": { @@ -90118,7 +90418,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c83d7d3c-2ae6-423e-ae54-7e6cf0810fe4", + "id": "5439d463-8756-4ae1-946d-a4e61380d909", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -90175,7 +90475,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -90192,7 +90492,7 @@ "description": "", "item": [ { - "id": "ee6582bc-0761-4991-80d5-7fedf052b386", + "id": "e7b43f39-082c-41cc-90dd-c87844b41f63", "name": "List Tagged Objects", "request": { "name": "List Tagged Objects", @@ -90258,7 +90558,7 @@ }, "response": [ { - "id": "6ecddf69-4f81-4f7e-b1e9-363a289ba0d9", + "id": "85f86d27-a87e-4c9f-a01b-b0db53d9ee13", "name": "List of all tagged objects.", "originalRequest": { "url": { @@ -90333,12 +90633,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"objectRef\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"objectRef\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n }\n]", + "body": "[\n {\n \"objectRef\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"objectRef\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a720cdbf-4f2b-44e4-bb72-c5c38c11fc0d", + "id": "497c0629-2cc2-483b-9a68-5bcc06d3ea15", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -90413,12 +90713,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "00ffdb96-595e-4dbf-9c38-23e6759ea9f5", + "id": "dfddb5f1-6722-4cfb-8ccd-347de2a06e9e", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -90498,7 +90798,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0a198a33-8073-4917-a13b-73a386403839", + "id": "62a1d32e-a82c-4d4c-a200-1cacfe5cd4b2", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -90573,12 +90873,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "122f19b7-7d94-4c59-8ea1-248706afdd3c", + "id": "ec0f2c4f-2b01-44a9-8cd9-c3faeec012aa", "name": "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.", "originalRequest": { "url": { @@ -90658,7 +90958,7 @@ "_postman_previewlanguage": "json" }, { - "id": "58549d2a-f616-4e9d-90bc-2257c435de21", + "id": "a1e11f0e-6e94-4b22-9894-b96e74b91391", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -90733,7 +91033,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -90744,7 +91044,7 @@ } }, { - "id": "4ac21457-cd07-47d9-a96a-e0af6ac2c929", + "id": "2d1f8860-00ce-4339-bcb9-e9f7ff74b445", "name": "Add Tag to Object", "request": { "name": "Add Tag to Object", @@ -90775,7 +91075,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"objectRef\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"objectRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -90786,7 +91086,7 @@ }, "response": [ { - "id": "a3fe20e2-d2f1-4076-9865-3f171a6f54b7", + "id": "24bdb7d0-7fe5-4756-bae8-72b53e0c1dc7", "name": "Created.", "originalRequest": { "url": { @@ -90816,7 +91116,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"objectRef\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"objectRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -90832,7 +91132,7 @@ "_postman_previewlanguage": "text" }, { - "id": "2274963f-4c92-407a-89ce-42c137fcde82", + "id": "cffe3824-015b-45d3-a944-8d3b3cb1a0dc", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -90866,7 +91166,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"objectRef\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"objectRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -90883,12 +91183,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "40cc3e00-a8fe-4eed-9460-edb4ea335dc2", + "id": "12b77d7e-5e5a-4248-a544-678be24434e1", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -90922,7 +91222,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"objectRef\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"objectRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -90944,7 +91244,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7aaabd97-9741-43ef-9b8d-50e2ec3ad15e", + "id": "bf8e95ac-634d-4dfa-9358-b02d6ce34b03", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -90978,7 +91278,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"objectRef\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"objectRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -90995,12 +91295,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "4b00e12e-474d-45e0-8746-eaf04aa554e0", + "id": "a9ff3d7e-60f5-49ef-b2fd-253e85f822d9", "name": "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.", "originalRequest": { "url": { @@ -91034,7 +91334,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"objectRef\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"objectRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -91056,7 +91356,7 @@ "_postman_previewlanguage": "json" }, { - "id": "07d320ec-3df2-4de5-8332-c72241f23da3", + "id": "f2f4e530-80c3-4c9e-9954-f85a768bc831", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -91090,7 +91390,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"objectRef\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"objectRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -91107,7 +91407,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -91118,7 +91418,7 @@ } }, { - "id": "7dff790a-5e41-475a-b63f-0062925c4334", + "id": "a6662bdc-d422-4797-9bb0-ef64b40af3aa", "name": "List Tagged Objects", "request": { "name": "List Tagged Objects", @@ -91192,7 +91492,7 @@ }, "response": [ { - "id": "a57b4a22-0892-42a9-ac5d-07a01dacba43", + "id": "3987e9e7-6c3a-49c6-8660-84d4be987dde", "name": "List of all tagged objects for specified type.", "originalRequest": { "url": { @@ -91268,12 +91568,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"objectRef\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"objectRef\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n }\n]", + "body": "[\n {\n \"objectRef\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"objectRef\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "28aaf129-7d48-48c7-acc7-f73d7ffa640e", + "id": "fa07764c-16b4-47b8-ae18-1bc0f519176c", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -91349,12 +91649,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "bd44e799-ea53-4ee1-83a0-85fac788e182", + "id": "44039f69-3548-4939-9341-5d8a7362b0b8", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -91435,7 +91735,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3bc5fd09-5d00-4f76-82bc-4076b66f042a", + "id": "14984d4b-d971-46a5-b5a2-58aacd306d63", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -91511,12 +91811,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ab183322-858c-480d-ae63-5bf2155dacb1", + "id": "c5856fe8-12e1-4bee-a427-0853049c1cac", "name": "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.", "originalRequest": { "url": { @@ -91597,7 +91897,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6fca27de-09b5-431a-9ad8-f2b9cca2c3e5", + "id": "1b95cef4-cd0f-449e-97ec-ab6076f5f932", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -91673,7 +91973,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -91684,7 +91984,7 @@ } }, { - "id": "26528e95-1d82-4b0c-9443-e4fc4d755850", + "id": "4f0deb6c-5fd1-4196-87b3-aa5aa835bfd6", "name": "Get Tagged Object", "request": { "name": "Get Tagged Object", @@ -91728,7 +92028,7 @@ }, "response": [ { - "id": "540e31f9-b29c-499d-914e-bcaaebd390cd", + "id": "c135756b-3061-46e7-ab88-d1dcf25acf85", "name": "Tagged object by type and ID.", "originalRequest": { "url": { @@ -91768,12 +92068,12 @@ "value": "application/json" } ], - "body": "{\n \"objectRef\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "body": "{\n \"objectRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ab109a0e-e363-4d88-99dc-9de9ff6ab494", + "id": "4d6ad3d0-6767-4b12-8955-39c0fb05bf4f", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -91813,12 +92113,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0f6c3079-5ddf-4b93-9ff7-b3581ff5e6f3", + "id": "86d483c2-dabc-4c6b-89fc-191ac6a37075", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -91863,7 +92163,7 @@ "_postman_previewlanguage": "json" }, { - "id": "392601d3-c2af-4540-8b14-fe6fff4e068e", + "id": "0d2fb948-d702-4830-bb6f-a2a2c76d8ecf", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -91903,12 +92203,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6d95fe6f-c7dc-4267-95bd-174fbc84b235", + "id": "195f6220-b617-46f2-b2db-77cfcafdf69c", "name": "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.", "originalRequest": { "url": { @@ -91953,7 +92253,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d1e4e013-5ec3-4854-b8a0-3a4f4b7b2b97", + "id": "29202563-9198-440f-82ba-9c81aac086cb", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -91993,7 +92293,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -92004,7 +92304,7 @@ } }, { - "id": "7ce1136a-16a1-45bd-8a9c-9d4cb25a6c26", + "id": "e9d41149-1706-4adc-b00d-0ec437c39398", "name": "Update Tagged Object", "request": { "name": "Update Tagged Object", @@ -92050,7 +92350,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"objectRef\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"objectRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -92061,7 +92361,7 @@ }, "response": [ { - "id": "e29a03ff-3e45-4e80-9283-dbe89b163b1c", + "id": "10427fac-2287-4a40-b89c-e06f2682dc27", "name": "Tagged object by type and ID.", "originalRequest": { "url": { @@ -92097,7 +92397,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"objectRef\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"objectRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -92114,12 +92414,12 @@ "value": "application/json" } ], - "body": "{\n \"objectRef\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "body": "{\n \"objectRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "31f77b10-00b2-4ec2-934b-fd64647bbed6", + "id": "f0456453-1904-4cdc-8ea5-25d92150d000", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -92155,7 +92455,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"objectRef\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"objectRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -92172,12 +92472,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a7a5a77c-445f-4f26-8336-ce52d91c1b11", + "id": "831d1ab4-3c7a-4fa3-bfd7-840793e54251", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -92213,7 +92513,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"objectRef\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"objectRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -92235,7 +92535,7 @@ "_postman_previewlanguage": "json" }, { - "id": "78660a72-5a82-4e8a-8749-aebd7e8fa916", + "id": "38d9f3f0-25e3-47ef-9433-4b5c9c27e731", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -92271,7 +92571,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"objectRef\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"objectRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -92288,12 +92588,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "97fff5ef-1cc9-40cf-96c5-09b80c0604a9", + "id": "441d1571-e89c-494c-9db3-d600f79a9b7d", "name": "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.", "originalRequest": { "url": { @@ -92329,7 +92629,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"objectRef\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"objectRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -92351,7 +92651,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1b8fc7e9-6387-4665-8f1d-99b143c24a5d", + "id": "4db9594e-451c-4ca4-9e1d-6ebb855878a0", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -92387,7 +92687,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"objectRef\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "raw": "{\n \"objectRef\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -92404,7 +92704,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -92415,7 +92715,7 @@ } }, { - "id": "54f0d90b-4abe-457a-b971-ec9a701f5769", + "id": "d896f04b-e0b4-46cb-90d3-0192dec38409", "name": "Delete Tagged Object", "request": { "name": "Delete Tagged Object", @@ -92459,7 +92759,7 @@ }, "response": [ { - "id": "d7e4d172-a660-42a6-8d89-56423485bf91", + "id": "5953fd73-dcd4-4cac-a52e-13c9316ff613", "name": "No content.", "originalRequest": { "url": { @@ -92494,7 +92794,7 @@ "_postman_previewlanguage": "text" }, { - "id": "1d27a1cb-5d1c-4290-bf10-c5593fe020a2", + "id": "5e1a0a25-60d9-4eba-aabd-7960650e6b0a", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -92534,12 +92834,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "135f8336-d4f9-4c6c-9c30-826775a6136d", + "id": "a8a1398b-d7db-42c8-90dd-7883a26ba440", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -92584,7 +92884,7 @@ "_postman_previewlanguage": "json" }, { - "id": "88e2ac83-6f0e-46a5-96da-cd5b8922e841", + "id": "672a4c6a-d292-47fb-95e6-945fd664bd4e", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -92624,12 +92924,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "771526b4-e59a-4e63-a23d-351795b8168a", + "id": "984f5d95-6eda-45b2-8c62-b5ce57b81d7f", "name": "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.", "originalRequest": { "url": { @@ -92674,7 +92974,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5ac38ad6-6705-4094-bb4e-c68d493051d8", + "id": "d98a0771-da30-4049-8a27-44b697958d89", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -92714,7 +93014,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -92725,7 +93025,7 @@ } }, { - "id": "ec02b3c1-766e-46a8-8ebb-249bcdf3e04c", + "id": "dadc177d-d26e-4c2e-a4d6-5c570f8054b1", "name": "Tag Multiple Objects", "request": { "name": "Tag Multiple Objects", @@ -92757,7 +93057,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", "options": { "raw": { "headerFamily": "json", @@ -92768,7 +93068,7 @@ }, "response": [ { - "id": "c58dd38c-8b5d-46a2-ab4a-8bc0f95aaa66", + "id": "ce1455d4-a93b-45a1-863b-73c42fef790e", "name": "Request succeeded.", "originalRequest": { "url": { @@ -92803,7 +93103,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", "options": { "raw": { "headerFamily": "json", @@ -92820,12 +93120,12 @@ "value": "application/json" } ], - "body": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "body": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3b0d77d6-417e-45b5-8d1b-8329c27166e6", + "id": "970004a9-49d3-4359-bdb1-79232d567256", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -92860,7 +93160,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", "options": { "raw": { "headerFamily": "json", @@ -92877,12 +93177,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "78dfc08b-3349-4578-b58c-86437e436ac7", + "id": "7af4de83-905f-48a7-b148-b2b8a7a9689b", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -92917,7 +93217,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", "options": { "raw": { "headerFamily": "json", @@ -92939,7 +93239,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d4e2050f-948b-45f9-8aa8-985f2f80a1d0", + "id": "d2d4a7c3-cbbf-4772-9fe4-f22d46c5d860", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -92974,7 +93274,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", "options": { "raw": { "headerFamily": "json", @@ -92991,12 +93291,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "36b81b64-a216-4fd2-9eda-b8517a0e3db9", + "id": "5d2fa836-8128-4ec3-8b4a-a80ba1b57b86", "name": "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.", "originalRequest": { "url": { @@ -93031,7 +93331,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", "options": { "raw": { "headerFamily": "json", @@ -93053,7 +93353,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a9e8ace9-d26e-4fa8-933e-dd92e87b3e11", + "id": "4229c6f7-1d6f-486f-9019-14022a6e91bb", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -93088,7 +93388,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", "options": { "raw": { "headerFamily": "json", @@ -93105,7 +93405,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -93116,7 +93416,7 @@ } }, { - "id": "e38bfe35-b4a3-4575-85af-ac3d2a6c3756", + "id": "d526eab1-b8d2-435f-b258-29ebe8e518a7", "name": "Remove Tags from Multiple Objects", "request": { "name": "Remove Tags from Multiple Objects", @@ -93148,7 +93448,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", "options": { "raw": { "headerFamily": "json", @@ -93159,7 +93459,7 @@ }, "response": [ { - "id": "83669601-222a-4d32-bf63-1b24b8a766e9", + "id": "cac989f3-f72c-486f-9f8b-4d4507fa7272", "name": "No content - indicates the request was successful but there is no content to be returned in the response.", "originalRequest": { "url": { @@ -93190,7 +93490,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", "options": { "raw": { "headerFamily": "json", @@ -93206,7 +93506,7 @@ "_postman_previewlanguage": "text" }, { - "id": "1a7b35dc-8c31-4f17-bfc6-b6d037b99fcc", + "id": "55df65ed-1f99-4dac-bbd1-ca01daedefae", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -93241,7 +93541,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", "options": { "raw": { "headerFamily": "json", @@ -93258,12 +93558,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "db949524-eb1b-41a7-8042-b04bc2362dd8", + "id": "098cb73a-bb8f-42ff-a91c-53e9a089a0e2", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -93298,7 +93598,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", "options": { "raw": { "headerFamily": "json", @@ -93320,7 +93620,7 @@ "_postman_previewlanguage": "json" }, { - "id": "01e74d81-40a8-4ea6-92c3-1be9af5fdf3b", + "id": "0e972313-2f93-4896-ba9b-6140738cd5e3", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -93355,7 +93655,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", "options": { "raw": { "headerFamily": "json", @@ -93372,12 +93672,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "46981c4d-6b06-47b9-8171-41e009c1b6aa", + "id": "5f92a294-3a48-40d8-ab15-7c0e7186670f", "name": "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.", "originalRequest": { "url": { @@ -93412,7 +93712,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", "options": { "raw": { "headerFamily": "json", @@ -93434,7 +93734,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c1b8885c-59f4-4bb6-808e-7547c7c45eda", + "id": "85aba9a6-e7ab-4379-a681-452a83c4a561", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -93469,7 +93769,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", "options": { "raw": { "headerFamily": "json", @@ -93486,7 +93786,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -93503,7 +93803,7 @@ "description": "The purpose of this API is to expose functionality for the manipulation of Transform objects.\nTransforms are a form of configurable objects which define an easy way to manipulate attribute data without having\nto write code. These endpoints don't require API calls to other resources, audit service is used for keeping track\nof which users have made changes to the Transforms.\n\nRefer to [Transforms](https://developer.sailpoint.com/idn/docs/transforms) for more information about transforms.\n", "item": [ { - "id": "c9f92be1-0036-42ab-bab2-dae616e84421", + "id": "798a7106-8a86-40b5-b8fb-db4bcf3a6d26", "name": "List transforms", "request": { "name": "List transforms", @@ -93578,7 +93878,7 @@ }, "response": [ { - "id": "53f7af9d-d5dc-4590-bc01-617cde4006d7", + "id": "b75b9808-0e13-4a0c-a3c9-a3e6cf7f6806", "name": "A list of transforms matching the given criteria.", "originalRequest": { "url": { @@ -93662,12 +93962,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"name\": \"\",\n \"type\": \"lower\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"laborised\": true\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"decomposeDiacriticalMarks\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"eiusmod__5\": 19566363.49913609\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n }\n]", + "body": "[\n {\n \"name\": \"\",\n \"type\": \"randomAlphaNumeric\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"consequat_6\": false,\n \"commodo9c\": -18093808.723111242,\n \"irure_895\": -30934722\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"leftPad\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"mollit_40\": \"nulla sit deserunt\"\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a2e38c57-bf46-4f38-9041-a3619d4e563f", + "id": "410d93b1-7f01-486a-a258-3f82374acde1", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -93751,12 +94051,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6fc4304b-c438-4f2d-b9ed-b1c5448ea454", + "id": "ca865be8-3ef9-4a84-b6db-e1ef76e5ce9a", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -93845,7 +94145,7 @@ "_postman_previewlanguage": "json" }, { - "id": "77cd51d6-6dae-47a7-8e9d-bf7254551b6a", + "id": "ef365694-17e4-449e-b021-e3216f8ba6ef", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -93929,12 +94229,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "187f4119-689a-4bd9-9c65-4c397a355468", + "id": "fb4ec08d-1eb5-4da2-810c-692773deeceb", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -94018,12 +94318,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "26936718-973b-48ce-b3c4-ab1313a0a4ac", + "id": "a2fd1bef-75ef-4d21-ba4a-e1e2ad37547b", "name": "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.", "originalRequest": { "url": { @@ -94112,7 +94412,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0b53a593-e6d0-47e5-a035-2939cad99569", + "id": "e0380ec1-0ad9-41b7-a37b-75692f6e09f8", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -94196,7 +94496,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -94207,7 +94507,7 @@ } }, { - "id": "8673f31a-a915-42af-b422-5c18cc6a79e8", + "id": "de68020f-6a4e-493b-871a-bc34a57e160b", "name": "Create transform", "request": { "name": "Create transform", @@ -94238,7 +94538,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"type\": \"dateCompare\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"dolor_9da\": -67050723,\n \"eiusmod_16\": -22409216,\n \"reprehenderitc7e\": 25272270\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"type\": \"lower\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"ad_81\": false,\n \"aliqua_24\": true\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -94249,7 +94549,7 @@ }, "response": [ { - "id": "48fe582f-3f32-4df4-bead-ede737b868a1", + "id": "4cd7433e-18e5-4faa-a4aa-b37bfb73d6dd", "name": "Indicates the transform was successfully created and returns its representation.", "originalRequest": { "url": { @@ -94283,7 +94583,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"type\": \"dateCompare\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"dolor_9da\": -67050723,\n \"eiusmod_16\": -22409216,\n \"reprehenderitc7e\": 25272270\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"type\": \"lower\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"ad_81\": false,\n \"aliqua_24\": true\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -94300,12 +94600,12 @@ "value": "application/json" } ], - "body": "{\n \"name\": \"\",\n \"type\": \"dateCompare\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"dolor_9da\": -67050723,\n \"eiusmod_16\": -22409216,\n \"reprehenderitc7e\": 25272270\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "body": "{\n \"name\": \"\",\n \"type\": \"lower\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"ad_81\": false,\n \"aliqua_24\": true\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3da2a997-5c74-40fa-ab58-53c690d13a8c", + "id": "3a0578e3-bbe2-4f9e-9e62-27b638308a96", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -94339,7 +94639,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"type\": \"dateCompare\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"dolor_9da\": -67050723,\n \"eiusmod_16\": -22409216,\n \"reprehenderitc7e\": 25272270\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"type\": \"lower\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"ad_81\": false,\n \"aliqua_24\": true\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -94356,12 +94656,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "720aaa49-fa80-4d71-be5a-91ae2fcc62d3", + "id": "e3ac483e-8c78-4bbd-b879-d1ddeb1c376c", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -94395,7 +94695,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"type\": \"dateCompare\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"dolor_9da\": -67050723,\n \"eiusmod_16\": -22409216,\n \"reprehenderitc7e\": 25272270\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"type\": \"lower\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"ad_81\": false,\n \"aliqua_24\": true\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -94417,7 +94717,7 @@ "_postman_previewlanguage": "json" }, { - "id": "021711c5-35d4-495e-bc53-f09528b1297a", + "id": "7fb44b2e-278f-4362-8b39-432a668051da", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -94451,7 +94751,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"type\": \"dateCompare\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"dolor_9da\": -67050723,\n \"eiusmod_16\": -22409216,\n \"reprehenderitc7e\": 25272270\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"type\": \"lower\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"ad_81\": false,\n \"aliqua_24\": true\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -94468,12 +94768,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e580d72d-9626-4348-bdca-8fdb018aa025", + "id": "c51886c3-4372-44ef-aa45-34f1fc3e472f", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -94507,7 +94807,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"type\": \"dateCompare\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"dolor_9da\": -67050723,\n \"eiusmod_16\": -22409216,\n \"reprehenderitc7e\": 25272270\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"type\": \"lower\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"ad_81\": false,\n \"aliqua_24\": true\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -94524,12 +94824,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6e7f7542-6c1f-4cc3-b1bf-9c7091075c0a", + "id": "bad3d9f4-912d-4924-b751-d5ea85aa6781", "name": "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.", "originalRequest": { "url": { @@ -94563,7 +94863,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"type\": \"dateCompare\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"dolor_9da\": -67050723,\n \"eiusmod_16\": -22409216,\n \"reprehenderitc7e\": 25272270\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"type\": \"lower\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"ad_81\": false,\n \"aliqua_24\": true\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -94585,7 +94885,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3d32418c-4eb5-4e46-afda-a70ef69343af", + "id": "9e3f1443-d72f-445e-8b75-e3c21008a30a", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -94619,7 +94919,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"type\": \"dateCompare\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"dolor_9da\": -67050723,\n \"eiusmod_16\": -22409216,\n \"reprehenderitc7e\": 25272270\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"type\": \"lower\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"ad_81\": false,\n \"aliqua_24\": true\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -94636,7 +94936,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -94647,7 +94947,7 @@ } }, { - "id": "35a786be-efeb-4469-9571-8028846635a5", + "id": "4a19dc1e-63f1-408f-b64c-455d992d6935", "name": "Transform by ID", "request": { "name": "Transform by ID", @@ -94684,7 +94984,7 @@ }, "response": [ { - "id": "0cfdf990-e5a1-4b8f-872e-825f04036e8c", + "id": "6bdbb128-8d21-40fe-ae4a-c7e15a832b68", "name": "Transform with the given ID", "originalRequest": { "url": { @@ -94723,12 +95023,12 @@ "value": "application/json" } ], - "body": "{\n \"name\": \"\",\n \"type\": \"dateCompare\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"dolor_9da\": -67050723,\n \"eiusmod_16\": -22409216,\n \"reprehenderitc7e\": 25272270\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "body": "{\n \"name\": \"\",\n \"type\": \"lower\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"ad_81\": false,\n \"aliqua_24\": true\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "665da1b9-ceaa-4030-9e95-242adfdf91a1", + "id": "d6afc0ff-af6d-439b-bb0a-9a1fd56476f8", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -94767,12 +95067,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "aafc8847-1333-4678-b237-7830cc8d0aee", + "id": "169078a1-aa37-472e-bf93-4433e0781150", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -94816,7 +95116,7 @@ "_postman_previewlanguage": "json" }, { - "id": "22aef8c8-e329-4d6f-899c-87a7e7523954", + "id": "8bc73a61-aa66-469e-909e-336ced883aa6", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -94855,12 +95155,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "97b97de6-c7f7-498a-9b47-eede2efde73a", + "id": "e4a306ab-88cb-4fc0-8c9f-164fbc26e7c6", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -94899,12 +95199,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "44835465-4769-46aa-ab63-bfa65d4a11d5", + "id": "86db13d7-a6a3-4c8d-8786-6b46606d0ab4", "name": "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.", "originalRequest": { "url": { @@ -94948,7 +95248,7 @@ "_postman_previewlanguage": "json" }, { - "id": "dce500c5-4db5-4470-924c-ce5796712379", + "id": "620d6ba8-c962-43d7-bbf2-f5c288428d6f", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -94987,7 +95287,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -94998,7 +95298,7 @@ } }, { - "id": "f407161e-f04a-4021-b85c-96aa5cf77246", + "id": "9fc73ced-f560-401e-92d3-7ef43a001ec2", "name": "Update a transform", "request": { "name": "Update a transform", @@ -95037,7 +95337,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"type\": \"dateCompare\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"dolor_9da\": -67050723,\n \"eiusmod_16\": -22409216,\n \"reprehenderitc7e\": 25272270\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"type\": \"lower\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"ad_81\": false,\n \"aliqua_24\": true\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -95048,7 +95348,7 @@ }, "response": [ { - "id": "0c4ad9d1-b647-4548-aeff-ee3ce61c9113", + "id": "1c17025e-ac5e-4bda-a747-d3becc1e5ea1", "name": "Indicates the transform was successfully updated and returns its new representation.", "originalRequest": { "url": { @@ -95083,7 +95383,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"type\": \"dateCompare\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"dolor_9da\": -67050723,\n \"eiusmod_16\": -22409216,\n \"reprehenderitc7e\": 25272270\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"type\": \"lower\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"ad_81\": false,\n \"aliqua_24\": true\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -95100,12 +95400,12 @@ "value": "application/json" } ], - "body": "{\n \"name\": \"\",\n \"type\": \"dateCompare\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"dolor_9da\": -67050723,\n \"eiusmod_16\": -22409216,\n \"reprehenderitc7e\": 25272270\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "body": "{\n \"name\": \"\",\n \"type\": \"lower\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"ad_81\": false,\n \"aliqua_24\": true\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "2a345f26-3435-4939-b6da-a6d91f688bd6", + "id": "a7f1b9a8-aea6-41e4-9b53-2f65c067c186", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -95140,7 +95440,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"type\": \"dateCompare\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"dolor_9da\": -67050723,\n \"eiusmod_16\": -22409216,\n \"reprehenderitc7e\": 25272270\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"type\": \"lower\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"ad_81\": false,\n \"aliqua_24\": true\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -95157,12 +95457,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3f072b5f-3633-4280-af66-6d3d5963a7c0", + "id": "9f258754-ce21-4fe0-b345-393364f85349", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -95197,7 +95497,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"type\": \"dateCompare\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"dolor_9da\": -67050723,\n \"eiusmod_16\": -22409216,\n \"reprehenderitc7e\": 25272270\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"type\": \"lower\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"ad_81\": false,\n \"aliqua_24\": true\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -95219,7 +95519,7 @@ "_postman_previewlanguage": "json" }, { - "id": "571eee63-5b08-4312-9f08-9ba7b4fd3a23", + "id": "683451e4-c69b-4f19-9787-068543638e6a", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -95254,7 +95554,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"type\": \"dateCompare\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"dolor_9da\": -67050723,\n \"eiusmod_16\": -22409216,\n \"reprehenderitc7e\": 25272270\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"type\": \"lower\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"ad_81\": false,\n \"aliqua_24\": true\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -95271,12 +95571,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0687626d-869d-4d08-b0ec-79091b733bde", + "id": "e9185517-d2ab-4a0e-9e98-d9a52315ac1c", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -95311,7 +95611,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"type\": \"dateCompare\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"dolor_9da\": -67050723,\n \"eiusmod_16\": -22409216,\n \"reprehenderitc7e\": 25272270\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"type\": \"lower\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"ad_81\": false,\n \"aliqua_24\": true\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -95328,12 +95628,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "eac07b85-09f7-4bfa-a85d-c4d88008428f", + "id": "f14fd77d-f322-483f-8a71-0cfd6bd5d194", "name": "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.", "originalRequest": { "url": { @@ -95368,7 +95668,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"type\": \"dateCompare\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"dolor_9da\": -67050723,\n \"eiusmod_16\": -22409216,\n \"reprehenderitc7e\": 25272270\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"type\": \"lower\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"ad_81\": false,\n \"aliqua_24\": true\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -95390,7 +95690,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f6b58842-8f33-449c-8dc1-4b199f41e9da", + "id": "802a53f0-f273-40e4-84b0-4acd0485bdf8", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -95425,7 +95725,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"type\": \"dateCompare\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"dolor_9da\": -67050723,\n \"eiusmod_16\": -22409216,\n \"reprehenderitc7e\": 25272270\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"type\": \"lower\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"ad_81\": false,\n \"aliqua_24\": true\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -95442,7 +95742,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -95453,7 +95753,7 @@ } }, { - "id": "e73bdbb2-3bcf-4b8e-b28c-061d87942130", + "id": "9c9fe0eb-5090-40d4-9c51-7f83ef0bd8bb", "name": "Delete a transform", "request": { "name": "Delete a transform", @@ -95490,7 +95790,7 @@ }, "response": [ { - "id": "160cb2ae-2729-46f0-aa76-86c822205f65", + "id": "db21a42a-2ecc-48b5-aa90-1e3b29ef09a1", "name": "No content - indicates the request was successful but there is no content to be returned in the response.", "originalRequest": { "url": { @@ -95524,7 +95824,7 @@ "_postman_previewlanguage": "text" }, { - "id": "31e83e9e-701e-43f4-9354-eb826176a20c", + "id": "25f0d4a7-34dc-4a5c-b758-ea86c94e869a", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -95563,12 +95863,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "14a7b9a7-3dc5-4c36-bf84-c328d19b031d", + "id": "d749ff75-4b0c-419c-91c7-ac26976f32f9", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -95612,7 +95912,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4e81df2a-1c6e-4396-8659-91a519f7150a", + "id": "59b67c73-08ea-411e-9f3c-32e22b1a8545", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -95651,12 +95951,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "24ffbe80-8dfd-43bb-b75d-e5b3ce23457f", + "id": "5c594fa8-85a5-4e4d-807c-06866147bca2", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -95695,12 +95995,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "dc562c50-31ef-4abb-a88e-4c1de04a904c", + "id": "74faaf2a-2d3b-42c7-980e-4f9f536c4f28", "name": "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.", "originalRequest": { "url": { @@ -95744,7 +96044,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f8d4f74b-e08a-4797-9859-7d116432729a", + "id": "150e0154-9be6-418a-843c-6a807c37a713", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -95783,7 +96083,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -95800,7 +96100,7 @@ "description": "Use this API to implement work item functionality. \nWith this functionality in place, users can manage their work items (tasks). \n\nWork items refer to the tasks users see in IdentityNow's Task Manager. \nThey can see the pending work items they need to complete, as well as the work items they have already completed. \nTask Manager lists the work items along with the involved sources, identities, accounts, and the timestamp when the work item was created. \nFor example, a user may see a pending 'Create an Account' work item for the identity Fred.Astaire in GitHub for Fred's GitHub account, fred-astaire-sp. \nOnce the user completes the work item, the work item will be listed with his or her other completed work items. \n\nTo complete work items, users can use their dashboards and select the 'My Tasks' widget. \nThe widget will list any work items they need to complete, and they can select the work item from the list to review its details. \nWhen they complete the work item, they can select 'Mark Complete' to add it to their list of completed work items. \n\nRefer to [Task Manager](https://documentation.sailpoint.com/saas/user-help/task_manager.html) for more information about work items, including the different types of work items users may need to complete.\n", "item": [ { - "id": "c30980f8-5137-48ce-b5b7-66bd71751711", + "id": "55c54ef4-c0c4-4a2e-8e06-e1859d58acb2", "name": "List Work Items", "request": { "name": "List Work Items", @@ -95866,7 +96166,7 @@ }, "response": [ { - "id": "64a4fce7-339c-4738-8bea-f60330299a9f", + "id": "c5f20bb2-bfa4-45c8-8cda-8555aad56f29", "name": "List of work items", "originalRequest": { "url": { @@ -95941,12 +96241,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"PENDING\",\n \"type\": \"POLICYVIOLATION\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"EXPIRED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"CANCELED\",\n \"type\": \"POLICYVIOLATION\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"PENDING\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n }\n]", + "body": "[\n {\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"PENDING\",\n \"type\": \"EVENT\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"CANCELED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"PENDING\",\n \"type\": \"EVENT\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"REJECTED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8153871a-be3e-4aff-9ccf-f1734c3a8471", + "id": "e8e88429-e50f-45ce-9c77-4b25c43ba783", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -96026,7 +96326,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a14942af-13e3-4fdc-96f0-0e28554e6290", + "id": "257539f6-bf24-4f16-8023-ee56238c0a9d", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -96101,12 +96401,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "588a407c-47a9-4296-a8b6-5dad216374e2", + "id": "c8d2103d-05c9-42d5-846d-9a605d9540ed", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -96181,12 +96481,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c79de396-1d92-4f36-96f5-969aa8dda398", + "id": "30eb4aca-317f-4ae5-a03c-2478f8be3915", "name": "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.", "originalRequest": { "url": { @@ -96266,7 +96566,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5dfaa925-5947-40a4-8925-fc731deb3e02", + "id": "34972f21-ea58-4b0f-9857-1ecee0a05d7d", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -96341,7 +96641,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -96352,7 +96652,7 @@ } }, { - "id": "3ee7ee0c-b784-40a1-b444-4606a42e7b1f", + "id": "fb3253f9-4e5b-4d43-b186-6a519e3a323d", "name": "Completed Work Items", "request": { "name": "Completed Work Items", @@ -96419,7 +96719,7 @@ }, "response": [ { - "id": "34e5114e-0539-4626-865a-9789cdacac7a", + "id": "83065468-b377-4f1e-aad8-31c01a943695", "name": "List of completed work items.", "originalRequest": { "url": { @@ -96495,12 +96795,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"PENDING\",\n \"type\": \"POLICYVIOLATION\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"EXPIRED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"CANCELED\",\n \"type\": \"POLICYVIOLATION\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"PENDING\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n }\n]", + "body": "[\n {\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"PENDING\",\n \"type\": \"EVENT\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"CANCELED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"PENDING\",\n \"type\": \"EVENT\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"REJECTED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "89cb8de3-1219-42ae-9002-ae07c0a8daca", + "id": "152486fc-cea2-4af9-849c-c456d0dd59d2", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -96581,7 +96881,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e958d957-efe6-48aa-acd3-f1a9138bf0d9", + "id": "5ea72a20-5035-4ee9-b865-41d8b0752108", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -96657,12 +96957,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7e09c5ec-861e-4090-86fa-f19b9ae6cc6f", + "id": "d80422b2-6dd5-48b7-a2ba-49a093f6cd25", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -96738,12 +97038,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e71c2f34-9ae1-48cc-8eab-15cfdcef9bd1", + "id": "1d194124-4010-4332-878c-8633715fe461", "name": "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.", "originalRequest": { "url": { @@ -96824,7 +97124,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d3f7a797-53f1-47bd-8eaf-d7d83deb745f", + "id": "be7250d3-86e5-4d2e-bf83-5c629bdb3e4a", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -96900,7 +97200,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -96911,7 +97211,7 @@ } }, { - "id": "2b569c7f-f62a-4e74-ba3b-7b2a86bac31f", + "id": "c2722e58-3e24-48fd-b8d0-34947a6b9431", "name": "Count Work Items", "request": { "name": "Count Work Items", @@ -96951,7 +97251,7 @@ }, "response": [ { - "id": "bfa75f39-bb29-4fba-8eed-7fdda1c7359d", + "id": "23cdb49f-7672-49e1-b4ca-d2aee2186cf7", "name": "List of work items", "originalRequest": { "url": { @@ -97005,7 +97305,7 @@ "_postman_previewlanguage": "json" }, { - "id": "977c08b4-1ba1-41b4-802c-37e4211ff5d6", + "id": "ebe24e74-9677-487c-8423-bec6234e5871", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -97059,7 +97359,7 @@ "_postman_previewlanguage": "json" }, { - "id": "468dbd0d-c030-46ac-80f8-0b5066b765d8", + "id": "bb0fb8bb-8f12-4828-a3bc-8ac0113bb14b", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -97108,12 +97408,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b1fc6076-4ddf-42c7-b497-a5d9cd199c17", + "id": "63d4fafa-308c-4c97-893b-06874585d32c", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -97162,12 +97462,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3a6d387f-0497-48be-843f-93845fcd6e0c", + "id": "28ffdfdb-201a-4212-abb8-93e1dcb762d1", "name": "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.", "originalRequest": { "url": { @@ -97221,7 +97521,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a546b194-a1be-4de6-84ee-c1a901aba29b", + "id": "06d20e23-4be4-49aa-99ee-7421d8ccd819", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -97270,7 +97570,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -97281,7 +97581,7 @@ } }, { - "id": "c51118f4-bb32-42b7-a864-79aaa4f1f38e", + "id": "c0413dd0-29a5-4c65-8a76-a7c8323c0953", "name": "Count Completed Work Items", "request": { "name": "Count Completed Work Items", @@ -97322,7 +97622,7 @@ }, "response": [ { - "id": "88140e90-cc2b-41cf-875f-f7886d50d2ef", + "id": "9f3114d9-7825-41a9-8122-d5bb2a9e3c21", "name": "List of work items", "originalRequest": { "url": { @@ -97377,7 +97677,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d587002e-128e-4138-b980-3a8db2020ceb", + "id": "726459ef-66cd-4782-98c4-bbc6c1bd4cb9", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -97432,7 +97732,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3d951c86-4f46-478b-bca4-96b56ca1518a", + "id": "529fb509-a5d3-4fe7-a9cc-6e96ae9d6c34", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -97482,12 +97782,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3cd12683-d6c3-4ca7-96ac-e694abe21525", + "id": "6da1f939-69f3-4790-bd87-fd809e85aae1", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -97537,12 +97837,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "640ce0ea-9480-48d5-a0b0-d17734de370c", + "id": "f26b9221-40b8-4e1d-abbd-116832631c0f", "name": "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.", "originalRequest": { "url": { @@ -97597,7 +97897,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ec227ac6-72d1-4abe-8e5d-7bdc143db530", + "id": "63cd3730-6020-439d-811d-5d2fccb40ed6", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -97647,7 +97947,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -97658,7 +97958,7 @@ } }, { - "id": "20063ca6-91ab-490a-861b-403bf2c44b06", + "id": "d862dd11-ece8-4f08-b0b6-820c438e403f", "name": "Work Items Summary", "request": { "name": "Work Items Summary", @@ -97698,7 +97998,7 @@ }, "response": [ { - "id": "0b10d665-0500-4cb9-9efc-6539e8cca15d", + "id": "56662e44-81c5-4b9a-9493-8a8ee48b0c1a", "name": "List of work items", "originalRequest": { "url": { @@ -97752,7 +98052,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3ff00aa2-f4b1-4fb1-96d8-826b8f710d7d", + "id": "ed1913fa-ce0f-427c-ad47-3e936d0d9033", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -97806,7 +98106,7 @@ "_postman_previewlanguage": "json" }, { - "id": "41e96983-0eb4-4fc3-b0e9-9458a0fe13e4", + "id": "e06ece01-bc53-441c-9b1d-7f8c73a1ac01", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -97855,12 +98155,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1187beff-d204-4a84-a7fa-69e1fa7b7afd", + "id": "ce2e25bb-c094-47db-b95d-367c24ca9c30", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -97909,12 +98209,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6b28f8b8-9d1b-46ff-b089-16b1cc335dbe", + "id": "2829a2cd-c229-45d4-9605-1f0aad78de50", "name": "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.", "originalRequest": { "url": { @@ -97968,7 +98268,7 @@ "_postman_previewlanguage": "json" }, { - "id": "101a8885-c286-4327-83bb-3603e6609911", + "id": "09777416-d7a6-4da2-8160-95f900fe6edb", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -98017,7 +98317,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -98028,7 +98328,7 @@ } }, { - "id": "128bf072-bea7-4db5-a367-82b86686bc33", + "id": "60777d42-2f63-47a7-aee6-a8b55f7d01e1", "name": "Get a Work Item", "request": { "name": "Get a Work Item", @@ -98065,7 +98365,7 @@ }, "response": [ { - "id": "ceb2fded-03e9-4366-923c-78c15753c8f0", + "id": "5f53b144-e457-4890-87eb-0536d5495f2b", "name": "The work item with the given ID.", "originalRequest": { "url": { @@ -98104,12 +98404,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"FINISHED\",\n \"type\": \"MANUALACTION\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"CANCELED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"REJECTED\",\n \"type\": \"FORM\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"PENDING\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "36eb32be-0fdf-4bbc-aa38-40709be2287c", + "id": "eface00b-5ba6-4749-bb35-dd9234f968f6", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -98153,7 +98453,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b2ca973e-b190-406f-92f0-72b9afea8e4b", + "id": "f5b7f510-bbba-4304-9a40-976d067ad66c", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -98192,12 +98492,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d365c31d-735a-401d-9f60-97a9078a1f58", + "id": "df8a49fe-bf1a-4dfa-9073-9a80a22b7dae", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -98236,12 +98536,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "59c1eb5f-5262-430c-9ae1-37bd69abe52a", + "id": "5b5d4d01-64aa-476e-8e3d-a75f15c17671", "name": "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.", "originalRequest": { "url": { @@ -98285,7 +98585,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a572bf48-12ac-42e6-abac-e94ebb5a58d5", + "id": "3ec74c29-bb2f-4861-99b8-d6d9435b90bb", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -98324,7 +98624,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -98335,7 +98635,7 @@ } }, { - "id": "878b9006-4c6c-4ee2-afc7-db8647a2eb04", + "id": "60600516-8662-4c1d-9ae4-b0d2b51d0254", "name": "Complete a Work Item", "request": { "name": "Complete a Work Item", @@ -98372,7 +98672,7 @@ }, "response": [ { - "id": "fc3d8b43-eb41-4352-bde5-844b9ec0d992", + "id": "4a2788b9-1c52-4008-8f29-5a8785f1d805", "name": "A WorkItems object", "originalRequest": { "url": { @@ -98411,12 +98711,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"FINISHED\",\n \"type\": \"MANUALACTION\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"CANCELED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"REJECTED\",\n \"type\": \"FORM\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"PENDING\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "20ea025d-de3b-4a54-bb2d-3db30acecae1", + "id": "f4d00406-1283-4960-8bea-d97e22696c7e", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -98455,12 +98755,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "688158da-7285-422f-9f84-924419afc551", + "id": "ad8e30fe-8f2d-4785-9ba6-988e271a77e8", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -98504,7 +98804,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7e8e6456-cc05-4e4d-ac42-693a9581e1f8", + "id": "838c4094-e77f-47b1-bb11-f1768d66eb29", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -98543,12 +98843,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8ea78335-8841-458c-a01c-c6e5f99fab3e", + "id": "d2bd8f31-1dcc-4847-be0a-2e4dbdcf89b7", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -98587,12 +98887,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "48ec2008-3de3-4f37-a704-e69b48129c92", + "id": "3d4e3fb6-7c80-45ff-8268-58d8e609b87e", "name": "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.", "originalRequest": { "url": { @@ -98636,7 +98936,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9bdc5ff1-b1ae-4852-80e3-6c89bf847d61", + "id": "249baafb-16b8-45d6-bac6-2d31619803e2", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -98675,7 +98975,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -98686,7 +98986,7 @@ } }, { - "id": "876022ef-e23c-438d-99df-79293e0db01a", + "id": "4cd6c79f-578a-41fd-b6d9-e0d225d6bfd9", "name": "Approve an Approval Item", "request": { "name": "Approve an Approval Item", @@ -98731,7 +99031,7 @@ }, "response": [ { - "id": "26791342-9cef-4b5b-9fd8-65bacb29dae4", + "id": "80421668-9c31-4ef3-9aca-e0a2b72f7d2f", "name": "A work items details object.", "originalRequest": { "url": { @@ -98772,12 +99072,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"FINISHED\",\n \"type\": \"MANUALACTION\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"CANCELED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"REJECTED\",\n \"type\": \"FORM\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"PENDING\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "765f6e03-cdf4-4a7f-8011-7649b7fa31ba", + "id": "49e6eeee-8c5a-4534-bb13-dd0ee94d6905", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -98818,12 +99118,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "39f936fa-d10a-47b3-9257-463a69bcf303", + "id": "949426e9-97e4-4c25-b5cf-c213227a02fb", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -98869,7 +99169,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7efea0af-f963-405f-83fd-a6dc40bfb20e", + "id": "c4e2e36d-a9c6-498a-a2b7-f8fc363efade", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -98910,12 +99210,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e55d7f3d-0289-4796-81d7-27e22ee4b632", + "id": "9d5b3948-4f9e-4725-9556-a8dbd6fd030d", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -98956,12 +99256,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "9457c465-f3e6-4d0f-9617-6017ea357c08", + "id": "e8fb0782-b964-4953-98ce-0785a9e5a4f9", "name": "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.", "originalRequest": { "url": { @@ -99007,7 +99307,7 @@ "_postman_previewlanguage": "json" }, { - "id": "788905c4-6dad-4732-9b9b-2dfe33b3540a", + "id": "713f883d-2137-4ffc-9289-d8762d5c852d", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -99048,7 +99348,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -99059,7 +99359,7 @@ } }, { - "id": "e9a7bf95-9e16-4980-9da3-09f17bdda4cc", + "id": "ae7a2cbd-e340-4732-ae9c-e0ebaefdf216", "name": "Reject an Approval Item", "request": { "name": "Reject an Approval Item", @@ -99104,7 +99404,7 @@ }, "response": [ { - "id": "82833a4e-9a94-4c5e-9e6a-d8fe7389a686", + "id": "a1bb3185-bf33-483b-b73a-ef419c603e8d", "name": "A work items details object.", "originalRequest": { "url": { @@ -99145,12 +99445,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"FINISHED\",\n \"type\": \"MANUALACTION\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"CANCELED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"REJECTED\",\n \"type\": \"FORM\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"PENDING\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "17e9613a-25c0-42ea-85e7-407a266b64d7", + "id": "fd0760f3-4bf3-41f2-a425-9168b0bed50b", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -99191,12 +99491,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "f48f59d4-608b-4656-b7e0-fd9747d17f9e", + "id": "55654c95-6cce-4225-a440-a491cf988199", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -99242,7 +99542,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3e7741c8-b943-4309-9cf1-e91ed651eaa0", + "id": "8cf8c6a6-2e49-43b3-8419-d34e09e91e77", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -99283,12 +99583,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "147d9dc2-9f2a-4a6d-b4e1-e4e4810ed77e", + "id": "f49172e6-430a-48f2-9e69-e50df3b72991", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -99329,12 +99629,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7223bc0a-ac2f-4280-9983-0282ecc2dea9", + "id": "c81694a2-0676-4819-83bc-ea5610c93903", "name": "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.", "originalRequest": { "url": { @@ -99380,7 +99680,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7d359965-4ba2-4d9c-ac4a-ed8d7fde3d1c", + "id": "db2b71a9-8834-464c-8933-144217a1058f", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -99421,7 +99721,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -99432,7 +99732,7 @@ } }, { - "id": "430988e1-c73c-4cfe-9833-9fbc5b882c57", + "id": "5047f9b4-4a77-491d-9b7d-a6ff02324e34", "name": "Bulk approve Approval Items", "request": { "name": "Bulk approve Approval Items", @@ -99470,7 +99770,7 @@ }, "response": [ { - "id": "e9041513-a449-4700-aebc-32ee78e7f2d5", + "id": "04b2d29d-ac41-4ce5-bbc1-45cc8eea652d", "name": "A work items details object.", "originalRequest": { "url": { @@ -99510,12 +99810,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"FINISHED\",\n \"type\": \"MANUALACTION\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"CANCELED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"REJECTED\",\n \"type\": \"FORM\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"PENDING\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "29009561-a97d-46b8-8682-be45befee5af", + "id": "fa45c4eb-7d98-4eba-a57e-29ea3e6b6557", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -99555,12 +99855,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8119a5f5-b682-47cd-9662-c031f89ea7d0", + "id": "858a838e-9baf-4a9a-9cdf-388511b52d93", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -99605,7 +99905,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4c0e7412-0731-42ee-8134-5ed0c701fafc", + "id": "9c025b79-8fc1-49f4-a410-8801cb334d79", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -99645,12 +99945,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "524dae0f-e880-41b6-aca4-df37005b36b3", + "id": "7b35f2b9-c6a6-430b-8f54-05850126d386", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -99690,12 +99990,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "4f7b9792-0da8-4ab3-a8bc-b61e083a5bbd", + "id": "5af7360f-2c9a-4373-b9f6-b550cae34301", "name": "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.", "originalRequest": { "url": { @@ -99740,7 +100040,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9d49b722-013c-47fe-93cb-003d64899796", + "id": "d0838bae-471a-4a6c-93e7-b79c57c0ee6d", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -99780,7 +100080,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -99791,7 +100091,7 @@ } }, { - "id": "9ae199a7-a4bd-4aa7-bfa8-f424098c2dc2", + "id": "431b60f3-1864-4ba6-be97-706a6a606018", "name": "Bulk reject Approval Items", "request": { "name": "Bulk reject Approval Items", @@ -99829,7 +100129,7 @@ }, "response": [ { - "id": "90dbc45f-7c52-4cda-a6cf-89795df55e2e", + "id": "c4cc3c80-76bf-426e-9c38-7628494ec3f3", "name": "A work items details object.", "originalRequest": { "url": { @@ -99869,12 +100169,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"FINISHED\",\n \"type\": \"MANUALACTION\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"CANCELED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"REJECTED\",\n \"type\": \"FORM\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"PENDING\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8559fd8f-0ca6-4a26-bded-51b26b79e9f2", + "id": "ea0bf2d8-3edf-4ede-8188-3bfd621ea2d9", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -99914,12 +100214,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "639e73d0-67ea-4ffc-a497-5447c0322916", + "id": "f05257c3-7ede-492a-b628-0d598b232a78", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -99964,7 +100264,7 @@ "_postman_previewlanguage": "json" }, { - "id": "12623cf0-219b-410f-a916-6fdb8060f79c", + "id": "fa950b63-bbf2-4938-9586-10eb2f39874d", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -100004,12 +100304,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "843ca396-c0e3-4ec1-9eb5-b3c3b600a1a0", + "id": "fb8ced38-6c58-4cb8-9407-23f72f88b325", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -100049,12 +100349,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7a3408cd-76d7-4442-afa7-bc54d1134de5", + "id": "35b4e810-f373-447e-9620-6cb0fbe626a1", "name": "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.", "originalRequest": { "url": { @@ -100099,7 +100399,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e4b28e07-0626-4e17-a9f0-190cf4414e26", + "id": "e9ea8567-d103-4d2d-ac83-60cf8186e942", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -100139,7 +100439,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -100150,7 +100450,7 @@ } }, { - "id": "c4097261-8e52-4344-b2bb-9b7759ce1709", + "id": "e1ecfccd-059f-4446-9914-0a2d072fc0da", "name": "Submit Account Selections", "request": { "name": "Submit Account Selections", @@ -100190,7 +100490,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"quis52\": false\n}", + "raw": "{\n \"cupidatat08c\": -48843120.43018664\n}", "options": { "raw": { "headerFamily": "json", @@ -100201,7 +100501,7 @@ }, "response": [ { - "id": "fba31f26-1dd4-4e97-a617-71737e05a62d", + "id": "0df6f639-0834-4f8f-b275-5790f87a1c42", "name": "A work items details object.", "originalRequest": { "url": { @@ -100237,7 +100537,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"quis52\": false\n}", + "raw": "{\n \"cupidatat08c\": -48843120.43018664\n}", "options": { "raw": { "headerFamily": "json", @@ -100254,12 +100554,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"FINISHED\",\n \"type\": \"MANUALACTION\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"CANCELED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"REJECTED\",\n \"type\": \"FORM\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"PENDING\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1e9fd9ff-dcf3-4ad3-947a-268b9078f676", + "id": "74632fc6-aaca-4d97-bac9-b9f4ad85f422", "name": "Client Error - Returned if the request body is invalid.", "originalRequest": { "url": { @@ -100295,7 +100595,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"quis52\": false\n}", + "raw": "{\n \"cupidatat08c\": -48843120.43018664\n}", "options": { "raw": { "headerFamily": "json", @@ -100312,12 +100612,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8c85c858-0d9f-44ed-a135-1a108282c571", + "id": "bb239a64-f1dc-4a47-8863-a65d36028d85", "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", "originalRequest": { "url": { @@ -100353,7 +100653,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"quis52\": false\n}", + "raw": "{\n \"cupidatat08c\": -48843120.43018664\n}", "options": { "raw": { "headerFamily": "json", @@ -100375,7 +100675,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4b89f3aa-cc77-43c0-8036-b6e5f6e98eb8", + "id": "0982353b-04ee-422d-b113-36e37053de98", "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", "originalRequest": { "url": { @@ -100411,7 +100711,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"quis52\": false\n}", + "raw": "{\n \"cupidatat08c\": -48843120.43018664\n}", "options": { "raw": { "headerFamily": "json", @@ -100428,12 +100728,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3c6b7e0e-2f1e-41c4-8da1-1b30512bf23e", + "id": "90452476-2e50-4070-b14d-d3b4180f1f0d", "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", "originalRequest": { "url": { @@ -100469,7 +100769,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"quis52\": false\n}", + "raw": "{\n \"cupidatat08c\": -48843120.43018664\n}", "options": { "raw": { "headerFamily": "json", @@ -100486,12 +100786,12 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "bc11f6e3-6769-47aa-992f-e93fe6e2b80c", + "id": "ca09c4b6-2338-450d-b882-f711a326b7a6", "name": "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.", "originalRequest": { "url": { @@ -100527,7 +100827,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"quis52\": false\n}", + "raw": "{\n \"cupidatat08c\": -48843120.43018664\n}", "options": { "raw": { "headerFamily": "json", @@ -100549,7 +100849,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a9be29df-9c3d-4445-aa61-de2bb2ce5edb", + "id": "3364f332-8188-43d6-873b-2ad88c74009b", "name": "Internal Server Error - Returned if there is an unexpected error.", "originalRequest": { "url": { @@ -100585,7 +100885,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"quis52\": false\n}", + "raw": "{\n \"cupidatat08c\": -48843120.43018664\n}", "options": { "raw": { "headerFamily": "json", @@ -100602,7 +100902,7 @@ "value": "application/json" } ], - "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -100693,7 +100993,7 @@ } ], "info": { - "_postman_id": "e5ff1f61-35f7-4c9b-af8b-f88fef2c4328", + "_postman_id": "bd3c7a6b-3f04-4285-80c7-b9bb07c0d645", "name": "IdentityNow V3 API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": {