Automated commit by github action: 5271259811

This commit is contained in:
GitHub Action Bot
2023-06-14 19:20:38 +00:00
parent fe6213b7f8
commit d72437ca4f
11 changed files with 74 additions and 114 deletions

View File

@@ -2,7 +2,7 @@ get:
tags: tags:
- Sources - Sources
summary: Downloads source accounts schema template summary: Downloads source accounts schema template
operationId: downloadSourceAccountsSchema operationId: getSourceAccountsSchema
parameters: parameters:
- in: path - in: path
name: id name: id
@@ -37,7 +37,7 @@ post:
summary: Uploads source accounts schema template summary: Uploads source accounts schema template
description: >- description: >-
This API uploads a source schema template file to configure a source's account attributes. This API uploads a source schema template file to configure a source's account attributes.
operationId: uploadSourceAccountsSchema operationId: importSourceAccountsSchema
parameters: parameters:
- in: path - in: path
name: id name: id

View File

@@ -1,8 +1,9 @@
#No Beta endpoint found for this operation.
get: get:
tags: tags:
- Sources - Sources
summary: Downloads source entitlements schema template summary: Downloads source entitlements schema template
operationId: downloadSourceEntitlementsSchema operationId: getSourceEntitlementsSchema
parameters: parameters:
- in: path - in: path
name: id name: id
@@ -37,13 +38,14 @@ get:
$ref: '../../v3/responses/500.yaml' $ref: '../../v3/responses/500.yaml'
security: security:
- oauth2: [idn:source-schema:read, idn:source-schema:manage] - oauth2: [idn:source-schema:read, idn:source-schema:manage]
#No Beta endpoint found for this operation.
post: post:
tags: tags:
- Sources - Sources
summary: Uploads source entitlements schema template summary: Uploads source entitlements schema template
description: >- description: >-
This API uploads a source schema template file to configure a source's entitlement attributes. This API uploads a source schema template file to configure a source's entitlement attributes.
operationId: uploadSourceEntitlementsSchema operationId: importSourceEntitlementsSchema
parameters: parameters:
- in: path - in: path
name: id name: id

View File

@@ -1,5 +1,7 @@
post: post:
operationId: uploadSourceConnectorFile operationId: importSourceConnectorFile
security:
- oauth2: [ idn:sources-admin:manage ]
tags: tags:
- Sources - Sources
summary: Upload connector file to source summary: Upload connector file to source

View File

@@ -1,5 +1,7 @@
get: get:
operationId: getSource operationId: getSource
security:
- oauth2: [ idn:sources:read ]
tags: tags:
- Sources - Sources
summary: Get Source by ID summary: Get Source by ID
@@ -36,6 +38,8 @@ get:
$ref: '../../v3/responses/500.yaml' $ref: '../../v3/responses/500.yaml'
put: put:
operationId: putSource operationId: putSource
security:
- oauth2: [ idn:sources:manage ]
tags: tags:
- Sources - Sources
summary: Update Source (Full) summary: Update Source (Full)
@@ -62,6 +66,7 @@ put:
type: string type: string
required: true required: true
description: The Source id description: The Source id
example: 2c9180835d191a86015d28455b4a2329
requestBody: requestBody:
required: true required: true
content: content:
@@ -91,6 +96,8 @@ put:
$ref: '../../v3/responses/500.yaml' $ref: '../../v3/responses/500.yaml'
patch: patch:
operationId: updateSource operationId: updateSource
security:
- oauth2: [ idn:sources:manage ]
tags: tags:
- Sources - Sources
summary: Update Source (Partial) summary: Update Source (Partial)
@@ -99,7 +106,6 @@ patch:
[JSON Patch](https://tools.ietf.org/html/rfc6902) standard. [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
Some fields are immutable and cannot be changed, such as: Some fields are immutable and cannot be changed, such as:
* id * id
* type * type
* authoritative * authoritative
@@ -225,7 +231,9 @@ patch:
'500': '500':
$ref: '../../v3/responses/500.yaml' $ref: '../../v3/responses/500.yaml'
delete: delete:
operationId: deleteSource security:
- oauth2: [ idn:sources:manage ]
operationId: delete
tags: tags:
- Sources - Sources
summary: Delete Source by ID summary: Delete Source by ID
@@ -270,13 +278,6 @@ delete:
deleteSource: deleteSource:
summary: Response returned when deleting a source summary: Response returned when deleting a source
value: {"type": "TASK_RESULT", "id": "2c91808779ecf55b0179f720942f181a", "name": null} value: {"type": "TASK_RESULT", "id": "2c91808779ecf55b0179f720942f181a", "name": null}
links:
GetTaskStatusById:
operationId: getTaskStatus
parameters:
id: '$response.body#/id'
description: >
The `id` value returned in the response can be used as the `id` parameter in `GET /task-status/{id}`.
'400': '400':
$ref: '../../v3/responses/400.yaml' $ref: '../../v3/responses/400.yaml'
'401': '401':

View File

@@ -1,5 +1,7 @@
get: get:
operationId: listSources operationId: listSources
security:
- oauth2: [ idn:sources:read ]
tags: tags:
- Sources - Sources
summary: Lists all sources in IdentityNow. summary: Lists all sources in IdentityNow.
@@ -19,50 +21,21 @@ get:
description: >- 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) 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: Filtering is supported for the following fields and operators:
**id**: *eq, in*
**name**: *co, eq, in, sw*
**id**: *eq, in* **type**: *eq, in*
**owner.id**: *eq, in*
**features**: *ca, co*
**name**: *co, eq, in, sw* **created**: *eq*
**modified**: *eq*
**managementWorkgroup.id**: *eq*
**type**: *eq, in* **description**: *eq*
**authoritative**: *eq*
**healthy**: *eq*
**owner.id**: *eq, in* **status**: *eq, in*
**connectionType**: *eq*
**connectorName**: *eq*
**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 - in: query
name: sorters name: sorters
schema: schema:
@@ -72,7 +45,6 @@ get:
description: >- 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) 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** Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status**
- in: query - in: query
name: for-subadmin name: for-subadmin
@@ -109,6 +81,8 @@ get:
$ref: '../../v3/responses/500.yaml' $ref: '../../v3/responses/500.yaml'
post: post:
operationId: createSource operationId: createSource
security:
- oauth2: [ idn:sources:manage ]
tags: tags:
- Sources - Sources
summary: Creates a source in IdentityNow. summary: Creates a source in IdentityNow.

View File

@@ -6,7 +6,7 @@ get:
This API downloads the CSV schema that defines the account attributes on a source. This API downloads the CSV schema that defines the account attributes on a source.
>**NOTE: This API is designated only for Delimited File sources.** >**NOTE: This API is designated only for Delimited File sources.**
operationId: downloadSourceAccountsSchema operationId: getAccountsSchema
parameters: parameters:
- in: path - in: path
name: id name: id
@@ -50,7 +50,7 @@ post:
>**NOTE: This API is designated only for Delimited File sources.** >**NOTE: This API is designated only for Delimited File sources.**
operationId: uploadSourceAccountsSchema operationId: importAccountsSchema
parameters: parameters:
- in: path - in: path
name: id name: id

View File

@@ -7,7 +7,7 @@ get:
>**NOTE: This API is designated only for Delimited File sources.** >**NOTE: This API is designated only for Delimited File sources.**
operationId: downloadSourceEntitlementsSchema operationId: getEntitlementsSchema
parameters: parameters:
- in: path - in: path
name: id name: id
@@ -57,7 +57,7 @@ post:
>**NOTE: This API is designated only for Delimited File sources.** >**NOTE: This API is designated only for Delimited File sources.**
operationId: uploadSourceEntitlementsSchema operationId: importEntitlementsSchema
parameters: parameters:
- in: path - in: path
name: id name: id

View File

@@ -1,8 +1,10 @@
get: get:
operationId: getSourceHealth operationId: getSourceHealth
security:
- oauth2: [ idn:sources:read ]
tags: tags:
- Sources - Sources
summary: This API fetches source health by source's id summary: Fetches source health by id
description: >- description: >-
This endpoint fetches source health by source's id This endpoint fetches source health by source's id

View File

@@ -1,5 +1,7 @@
post: post:
operationId: uploadSourceConnectorFile operationId: importConnectorFile
security:
- oauth2: [ idn:sources-admin:manage ]
tags: tags:
- Sources - Sources
summary: Upload connector file to source summary: Upload connector file to source

View File

@@ -1,5 +1,7 @@
get: get:
operationId: getSource operationId: getSource
security:
- oauth2: [ idn:sources:read ]
tags: tags:
- Sources - Sources
summary: Get Source by ID summary: Get Source by ID
@@ -36,6 +38,8 @@ get:
$ref: '../../v3/responses/500.yaml' $ref: '../../v3/responses/500.yaml'
put: put:
operationId: putSource operationId: putSource
security:
- oauth2: [ idn:sources:manage ]
tags: tags:
- Sources - Sources
summary: Update Source (Full) summary: Update Source (Full)
@@ -92,6 +96,8 @@ put:
$ref: '../../v3/responses/500.yaml' $ref: '../../v3/responses/500.yaml'
patch: patch:
operationId: updateSource operationId: updateSource
security:
- oauth2: [ idn:sources:manage ]
tags: tags:
- Sources - Sources
summary: Update Source (Partial) summary: Update Source (Partial)
@@ -227,6 +233,8 @@ patch:
$ref: '../../v3/responses/500.yaml' $ref: '../../v3/responses/500.yaml'
delete: delete:
operationId: deleteSource operationId: deleteSource
security:
- oauth2: [ idn:sources:manage ]
tags: tags:
- Sources - Sources
summary: Delete Source by ID summary: Delete Source by ID
@@ -271,12 +279,6 @@ delete:
deleteSource: deleteSource:
summary: Response returned when deleting a source summary: Response returned when deleting a source
value: {"type": "TASK_RESULT", "id": "2c91808779ecf55b0179f720942f181a", "name": null} value: {"type": "TASK_RESULT", "id": "2c91808779ecf55b0179f720942f181a", "name": null}
links:
GetTaskStatusById:
parameters:
id: '$response.body#/id'
description: >
The `id` value returned in the response can be used as the `id` parameter in `GET /task-status/{id}`.
'400': '400':
$ref: '../../v3/responses/400.yaml' $ref: '../../v3/responses/400.yaml'
'401': '401':

View File

@@ -1,5 +1,7 @@
get: get:
operationId: listSources operationId: listSources
security:
- oauth2: [ idn:sources:read ]
tags: tags:
- Sources - Sources
summary: Lists all sources in IdentityNow. summary: Lists all sources in IdentityNow.
@@ -19,50 +21,21 @@ get:
description: >- 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) 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: Filtering is supported for the following fields and operators:
**id**: *eq, in*
**name**: *co, eq, in, sw*
**id**: *eq, in* **type**: *eq, in*
**owner.id**: *eq, in*
**features**: *ca, co*
**name**: *co, eq, in, sw* **created**: *eq*
**modified**: *eq*
**managementWorkgroup.id**: *eq*
**type**: *eq, in* **description**: *eq*
**authoritative**: *eq*
**healthy**: *eq*
**owner.id**: *eq, in* **status**: *eq, in*
**connectionType**: *eq*
**connectorName**: *eq*
**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 - in: query
name: sorters name: sorters
schema: schema:
@@ -109,6 +82,8 @@ get:
$ref: '../../v3/responses/500.yaml' $ref: '../../v3/responses/500.yaml'
post: post:
operationId: createSource operationId: createSource
security:
- oauth2: [ idn:sources:manage ]
tags: tags:
- Sources - Sources
summary: Creates a source in IdentityNow. summary: Creates a source in IdentityNow.