LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-09 20:37:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Automated commit by github action: 13687233456

Browse Source
This commit is contained in:
GitHub Action Bot
2025-03-05 23:00:36 +00:00
parent 4d3af5d682
commit 0416b2638d
20 changed files with 481 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
static/api-specs/idn/v2024/schemas/reports/ReportDetails.yaml Normal file
View File

@@ -0,0 +1,32 @@
type: object
description: >-
Details about report to be processed.
properties:
reportType:
type: string
enum:
- ACCOUNTS
- IDENTITIES_DETAILS
- IDENTITIES
- IDENTITY_PROFILE_IDENTITY_ERROR
- ORPHAN_IDENTITIES
- SEARCH_EXPORT
- UNCORRELATED_ACCOUNTS
description: >-
Use this property to define what report should be processed in the RDE service.
example: ACCOUNTS
arguments:
oneOf:
- $ref: '../reports/arguments/accounts-export-report-arguments.yaml'
- $ref: '../reports/arguments/identities-details-report-arguments.yaml'
- $ref: '../reports/arguments/identities-report-arguments.yaml'
- $ref: '../reports/arguments/identity-profile-identity-error-report-arguments.yaml'
- $ref: '../reports/arguments/orphan-identities-report-arguments.yaml'
- $ref: '../reports/arguments/search-export-report-arguments.yaml'
- $ref: '../reports/arguments/uncorrelated-accounts-report-arguments.yaml'
example: {
"application": "2c9180897e7742b2017e781782f705b9",
"sourceName": Active Directory
}
description: >-
The string-object map(dictionary) with the arguments needed for report processing.

67
static/api-specs/idn/v2024/schemas/reports/ReportResults.yaml Normal file
View File

@@ -0,0 +1,67 @@
type : object
description: >-
Details about report result or current state.
properties:
reportType:
type: string
enum:
- ACCOUNTS
- IDENTITIES_DETAILS
- IDENTITIES
- IDENTITY_PROFILE_IDENTITY_ERROR
- ORPHAN_IDENTITIES
- SEARCH_EXPORT
- UNCORRELATED_ACCOUNTS
description: >-
Use this property to define what report should be processed in the RDE service.
example: IDENTITIES_DETAILS
taskDefName:
type: string
description: >-
Name of the task definition which is started to process requesting report. Usually the same as report name
example: Identities Details Report
id:
type: string
description: >-
Unique task definition identifier.
example: a248c16fe22222b2bd49615481311111
created:
type: string
description: >-
Report processing start date
format: date-time
example: '2020-09-07T42:14:00.364Z'
status:
type: string
enum:
- SUCCESS
- FAILURE
- WARNING
- TERMINATED
description: >-
Report current state or result status.
example: SUCCESS
duration:
type: integer
format: int64
description: >-
Report processing time in ms.
example: 342
rows:
type: integer
format: int64
description: >-
Report size in rows.
example: 37
availableFormats:
type: array
items:
type: string
enum:
- CSV
- PDF
description: >-
Output report file formats. This are formats for calling get endpoint as a query parameter 'fileFormat'.
In case report won't have this argument there will be ['CSV', 'PDF'] as default.
example:
- CSV

151
static/api-specs/idn/v2024/schemas/reports/TaskResultDetails.yaml Normal file
View File

@@ -0,0 +1,151 @@
type: object
description: >-
Details about job or task type, state and lifecycle.
properties:
type:
type: string
enum:
- QUARTZ
- QPOC
- MENTOS
- QUEUED_TASK
description: >-
Type of the job or task underlying in the report processing. It could be a quartz task, QPOC or MENTOS jobs or a
refresh/sync task.
example: MENTOS
id:
type: string
description: >-
Unique task definition identifier.
example: a248c16fe22222b2bd49615481311111
reportType:
enum:
- ACCOUNTS
- IDENTITIES_DETAILS
- IDENTITIES
- IDENTITY_PROFILE_IDENTITY_ERROR
- ORPHAN_IDENTITIES
- SEARCH_EXPORT
- UNCORRELATED_ACCOUNTS
description: >-
Use this property to define what report should be processed in the RDE service.
example: IDENTITIES_DETAILS
description:
type: string
description: >-
Description of the report purpose and/or contents.
example: A detailed view of the identities in the system.
parentName:
type: string
nullable: true
description: >-
Name of the parent task/report if exists.
example: Audit Report
launcher:
type: string
description: >-
Name of the report processing initiator.
example: cloudadmin
created:
type: string
description: >-
Report creation date
format: date-time
example: '2020-09-07T42:14:00.364Z'
launched:
type: string
nullable: true
format: date-time
description: >-
Report start date
example: '2020-09-07T42:14:00.521Z'
completed:
type: string
nullable: true
format: date-time
description: >-
Report completion date
example: '2020-09-07T42:14:01.137Z'
completionStatus:
type: string
nullable: true
enum:
- SUCCESS
- WARNING
- ERROR
- TERMINATED
- TEMP_ERROR
description: >-
Report completion status.
example: Success
messages:
type: array
description: >-
List of the messages dedicated to the report.
From task definition perspective here usually should be warnings or errors.
example: []
items:
type: object
properties:
type:
type: string
description: >-
Type of the message.
enum:
- INFO
- WARN
- ERROR
example: WARN
error:
type: boolean
default: false
description: >-
Flag whether message is an error.
example: false
warning:
type: boolean
default: false
description: >-
Flag whether message is a warning.
example: true
key:
type: string
description: >-
Message string identifier.
example: "The following account(s) failed to correlate: A,B,C"
localizedText:
type: string
description: >-
Message context with the locale based language.
example: "The following account(s) failed to correlate: A,B,C"
returns:
type: array
description: >-
Task definition results, if necessary.
example: []
items:
type: object
properties:
displayLabel:
type: string
description: >-
Attribute description.
example: ' '
attributeName:
type: string
description: >-
System or database attribute name.
example: ' '
attributes:
type: object
description: >-
Extra attributes map(dictionary) needed for the report.
additionalProperties:
type: object
example: {"org": "an-org"}
progress:
type: string
nullable: true
description: >-
Current report state.
example: Initializing...

18
static/api-specs/idn/v2024/schemas/reports/arguments/accounts-export-report-arguments.yaml Normal file
View File

@@ -0,0 +1,18 @@
title: ACCOUNTS
type: object
description: >-
Arguments for Account Export report (ACCOUNTS)
required:
- application
- sourceName
properties:
application:
type: string
description: >-
Source ID.
example: 2c9180897eSourceIde781782f705b9
sourceName:
type: string
description: >-
Source name.
example: Active Directory

13
static/api-specs/idn/v2024/schemas/reports/arguments/identities-details-report-arguments.yaml Normal file
View File

@@ -0,0 +1,13 @@
title: IDENTITIES_DETAILS
type: object
description: >-
Arguments for Identities Details report (IDENTITIES_DETAILS)
required:
- correlatedOnly
properties:
correlatedOnly:
type: boolean
description: >-
Flag to specify if only correlated identities are included in report.
default: false
example: true

11
static/api-specs/idn/v2024/schemas/reports/arguments/identities-report-arguments.yaml Normal file
View File

@@ -0,0 +1,11 @@
title: IDENTITIES
type: object
description: >-
Arguments for Identities report (IDENTITIES)
properties:
correlatedOnly:
type: boolean
description: >-
Flag to specify if only correlated identities are included in report.
default: false
example: true

12
static/api-specs/idn/v2024/schemas/reports/arguments/identity-profile-identity-error-report-arguments.yaml Normal file
View File

@@ -0,0 +1,12 @@
title: IDENTITY_PROFILE_IDENTITY_ERROR
type: object
description: >-
Arguments for Identity Profile Identity Error report (IDENTITY_PROFILE_IDENTITY_ERROR)
required:
- authoritativeSource
properties:
authoritativeSource:
type: string
description: >-
Source ID.
example: 1234sourceId5678902

17
static/api-specs/idn/v2024/schemas/reports/arguments/orphan-identities-report-arguments.yaml Normal file
View File

@@ -0,0 +1,17 @@
title: ORPHAN_IDENTITIES
type: object
description: >-
Arguments for Orphan Identities report (ORPHAN_IDENTITIES)
properties:
selectedFormats:
type: array
items:
type: string
enum:
- CSV
- PDF
description: >-
Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'.
In case report won't have this argument there will be ['CSV', 'PDF'] as default.
example:
- CSV

46
static/api-specs/idn/v2024/schemas/reports/arguments/search-export-report-arguments.yaml Normal file
View File

@@ -0,0 +1,46 @@
title: SEARCH_EXPORT
type: object
description: |
Arguments for Search Export report (SEARCH_EXPORT)
The report file generated will be a zip file containing csv files of the search results.
required:
- query
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:
$ref: '../../search/Index.yaml'
example:
- entitlements
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*'
columns:
description: |
Comma separated string consisting of technical attribute names of fields to include in report.
Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details.
Use `accessProfiles.spread` to unclude access profile details.
Use `entitlements.spread` to include entitlement details.
type: string
example: displayName,firstName,lastName,email,created,attributes.cloudLifecycleState
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'

17
static/api-specs/idn/v2024/schemas/reports/arguments/uncorrelated-accounts-report-arguments.yaml Normal file
View File

@@ -0,0 +1,17 @@
title: UNCORRELATED_ACCOUNTS
type: object
description: >-
Arguments for Uncorrelated Accounts report (UNCORRELATED_ACCOUNTS)
properties:
selectedFormats:
type: array
items:
type: string
enum:
- CSV
- PDF
description: >-
Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'.
In case report won't have this argument there will be ['CSV', 'PDF'] as default.
example:
- CSV

6
static/api-specs/idn/v2024/schemas/reports/examples/account-export-report-details.yaml Normal file
View File

@@ -0,0 +1,6 @@
summary: Account Export report
value:
reportType: ACCOUNTS
arguments:
application: 2c9180897eSourceIde781782f705b9
sourceName: Active Directory

5
static/api-specs/idn/v2024/schemas/reports/examples/identities-details-report-details.yaml Normal file
View File

@@ -0,0 +1,5 @@
summary: Identities Details report
value:
reportType: IDENTITIES_DETAILS
arguments:
correlatedOnly: true

11
static/api-specs/idn/v2024/schemas/reports/examples/identities-details-report-results.yaml Normal file
View File

@@ -0,0 +1,11 @@
summary: Identities Details Report result.
value:
reportType: IDENTITIES_DETAILS
taskDefName: Identities Details Report
id: 1e01d272b8084c4fa12fcf8fa898102d
created: '2023-09-07T42:14:05.122Z'
status: SUCCESS
duration: 3681
rows: 193
availableFormats:
- CSV

17
static/api-specs/idn/v2024/schemas/reports/examples/identities-details-report-task-result.yaml Normal file
View File

@@ -0,0 +1,17 @@
summary: Identities Details Report task result.
value:
reportType: IDENTITIES_DETAILS
taskDefName: Identities Details Report
type: QUARTZ
id: a248c16fe22222b2bd49615481311111
created: '2023-09-07T42:14:00.364Z'
description: A detailed view of the identities in the system.
parentName: Audit Report
launcher: '9832285'
launched: '2023-09-07T42:14:00.521Z'
completed: '2023-09-07T42:14:01.137Z'
messages: []
returns: []
attributes:
org: an-org
progress: 'Initializing...'

5
static/api-specs/idn/v2024/schemas/reports/examples/identities-report-details.yaml Normal file
View File

@@ -0,0 +1,5 @@
summary: Identities report
value:
reportType: IDENTITIES
arguments:
correlatedOnly: true

5
static/api-specs/idn/v2024/schemas/reports/examples/identity-profile-identity-error-report-details.yaml Normal file
View File

@@ -0,0 +1,5 @@
summary: Identity Profile Identity Error report
value:
reportType: IDENTITY_PROFILE_IDENTITY_ERROR
arguments:
authoritativeSource: 2c9180847de347aa017de8ef09167792

7
static/api-specs/idn/v2024/schemas/reports/examples/orphan-identities-report-details.yaml Normal file
View File

@@ -0,0 +1,7 @@
summary: Orphan Identities report
value:
reportType: ORPHAN_IDENTITIES
arguments:
selectedFormats:
- 'CSV'
- 'PDF'

10
static/api-specs/idn/v2024/schemas/reports/examples/search-export-report-details.yaml Normal file
View File

@@ -0,0 +1,10 @@
summary: Search Export report
value:
reportType: SEARCH_EXPORT
arguments:
indices:
- 'identities'
query: 'attributes.city:London'
columns: 'displayName,firstName,lastName,email,attributes.city,created,attributes.cloudLifecycleState,access.spread'
sort:
- '+displayName'

24
static/api-specs/idn/v2024/schemas/reports/examples/search-export-report-task-result.yaml Normal file
View File

@@ -0,0 +1,24 @@
summary: Identities Details Report task result.
value:
reportType: SEARCH_EXPORT
taskDefName: Search Export
type: QUARTZ
id: a248c16fe22222b2bd49615481311111
created: '2023-09-07T42:14:11.137Z'
description: Extract query data from ElasticSearch to CSV
parentName: null
launcher: T05293
launched: '2020-09-07T42:14:11.137Z'
completed: '2020-09-07T42:14:13.451Z'
messages: []
returns: []
attributes:
queryHash: 5e12cf79c67d92e23d4d8cb3e974f87d164e86d4a48d32ecf89645cacfd3f2
org: an-org
queryParams:
columns: displayName,firstName,lastName,email,created,attributes.cloudLifecycleState,tags,access.spread,apps.pread,accounts.spread
indices: identities
ownerId: 95ecba5c5444439c999aec638ce2a777
query: 700007
sort: displayName
progress: Initializing...

7
static/api-specs/idn/v2024/schemas/reports/examples/uncorrelated-accounts-report-details.yaml Normal file
View File

@@ -0,0 +1,7 @@
summary: Uncorrelated Accounts report
value:
reportType: UNCORRELATED_ACCOUNTS
arguments:
selectedFormats:
- 'CSV'
- 'PDF'