LukeParke/api-specs
1
0
Fork 0
mirror of https://github.com/LukeHagar/api-specs.git synced 2025-12-10 04:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Automated commit by github action: 3245408893

Browse Source
This commit is contained in:
GitHub Action Bot
2022-10-13 20:18:12 +00:00
parent 981b544dfb
commit 3e3ff15c97
154 changed files with 1742 additions and 1081 deletions
Download Patch File Download Diff File Expand all files Collapse all files

123
idn/beta/paths/account.yaml
View File

@@ -5,7 +5,7 @@ get:
summary: Account Details
description: >-
This API returns the details for a single account based on the ID.
A token with ORG_ADMIN authority is required to call this API.
security:
- oauth2: [idn:account:read]
@@ -18,22 +18,22 @@ get:
description: The account ID
example: ef38f94347e94562b5bb8424a56397d8
responses:
'200':
"200":
description: An account object
content:
application/json:
schema:
$ref: '../schemas/Account.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
$ref: '../../v3/responses/403.yaml'
'404':
$ref: '../../v3/responses/404.yaml'
'429':
$ref: '../../v3/responses/429.yaml'
'500':
$ref: '../../v3/responses/500.yaml'
$ref: "../schemas/Account.yaml"
"401":
$ref: "../../v3/responses/401.yaml"
"403":
$ref: "../../v3/responses/403.yaml"
"404":
$ref: "../../v3/responses/404.yaml"
"429":
$ref: "../../v3/responses/429.yaml"
"500":
$ref: "../../v3/responses/500.yaml"
patch:
operationId: updateAccount
tags:
@@ -41,7 +41,7 @@ patch:
summary: Update Account
description: >-
This updates account details.
A token with ORG_ADMIN authority is required to call this API.
security:
- oauth2: [idn:account:update]
@@ -56,33 +56,34 @@ patch:
requestBody:
required: true
description: >-
A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
A list of account update operations according to the [JSON
Patch](https://tools.ietf.org/html/rfc6902) standard.
content:
application/json-patch+json:
schema:
type: array
items:
type: object
type: array
items:
type: object
example:
- op: "replace"
path: "/identityId"
value: "2c9180845d1edece015d27a975983e21"
responses:
'202':
"202":
description: Accepted. Update request accepted and is in progress.
$ref: '../../v3/responses/202.yaml'
'400':
$ref: '../../v3/responses/400.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
$ref: '../../v3/responses/403.yaml'
'404':
$ref: '../../v3/responses/404.yaml'
'429':
$ref: '../../v3/responses/429.yaml'
'500':
$ref: '../../v3/responses/500.yaml'
$ref: "../../v3/responses/202.yaml"
"400":
$ref: "../../v3/responses/400.yaml"
"401":
$ref: "../../v3/responses/401.yaml"
"403":
$ref: "../../v3/responses/403.yaml"
"404":
$ref: "../../v3/responses/404.yaml"
"429":
$ref: "../../v3/responses/429.yaml"
"500":
$ref: "../../v3/responses/500.yaml"
put:
operationId: putAccount
tags:
@@ -107,26 +108,26 @@ put:
content:
application/json:
schema:
$ref: '../schemas/AccountAttributes.yaml'
$ref: "../schemas/AccountAttributes.yaml"
responses:
'202':
"202":
description: Async task details
content:
application/json:
schema:
$ref: '../schemas/AccountsAsyncResult.yaml'
'400':
$ref: '../../v3/responses/400.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
$ref: '../../v3/responses/403.yaml'
'404':
$ref: '../../v3/responses/404.yaml'
'429':
$ref: '../../v3/responses/429.yaml'
'500':
$ref: '../../v3/responses/500.yaml'
$ref: "../schemas/AccountsAsyncResult.yaml"
"400":
$ref: "../../v3/responses/400.yaml"
"401":
$ref: "../../v3/responses/401.yaml"
"403":
$ref: "../../v3/responses/403.yaml"
"404":
$ref: "../../v3/responses/404.yaml"
"429":
$ref: "../../v3/responses/429.yaml"
"500":
$ref: "../../v3/responses/500.yaml"
delete:
operationId: deleteAccount
tags:
@@ -147,21 +148,21 @@ delete:
description: The account ID
example: ef38f94347e94562b5bb8424a56397d8
responses:
'202':
"202":
description: Async task details
content:
application/json:
schema:
$ref: '../schemas/AccountsAsyncResult.yaml'
'400':
$ref: '../../v3/responses/400.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
$ref: '../../v3/responses/403.yaml'
'404':
$ref: '../../v3/responses/404.yaml'
'429':
$ref: '../../v3/responses/429.yaml'
'500':
$ref: '../../v3/responses/500.yaml'
$ref: "../schemas/AccountsAsyncResult.yaml"
"400":
$ref: "../../v3/responses/400.yaml"
"401":
$ref: "../../v3/responses/401.yaml"
"403":
$ref: "../../v3/responses/403.yaml"
"404":
$ref: "../../v3/responses/404.yaml"
"429":
$ref: "../../v3/responses/429.yaml"
"500":
$ref: "../../v3/responses/500.yaml"

1
idn/v3/parameters/path/search/id.yaml
View File

@@ -4,3 +4,4 @@ description: ID of the requested document.
schema:
type: string
required: true
example: 2c91808568c529c60168cca6f90c1313

1
idn/v3/parameters/path/search/index.yaml
View File

@@ -7,3 +7,4 @@ description: |
schema:
type: string
required: true
example: accounts

47
idn/v3/paths/access-request-approval-summary.yaml
View File

@@ -4,45 +4,52 @@ get:
tags:
- Access Request Approvals
description: >-
This endpoint returns the number of pending, approved and rejected access requests approvals.
See "owner-id" query parameter below for authorization info.
This endpoint returns the number of pending, approved and rejected access
requests approvals. See "owner-id" query parameter below for authorization
info.
parameters:
- in: query
name: owner-id
schema:
type: string
description: >-
The id of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity.
The id of the owner or approver identity of the approvals. If present,
the value returns approval summary for the specified identity.
* ORG_ADMIN users can call this with any identity ID value.
* ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used.
* Non ORG_ADMIN users can only specify *me* or pass their own identity ID value.
* ORG_ADMIN user can also fetch all the approvals in the org, when
owner-id is not used.
* Non ORG_ADMIN users can only specify *me* or pass their own
identity ID value.
example: 2c91808568c529c60168cca6f90c1313
required: false
- in: query
name: from-date
schema:
type: string
description: >-
From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format
From date is the date and time from which the results will be shown. It
should be in a valid ISO-8601 format
example: from-date=2020-03-19T19:59:11Z
required: false
responses:
'200':
description: Number of pending, approved, rejected access request approvals.
"200":
description:
Number of pending, approved, rejected access request approvals.
content:
application/json:
schema:
$ref: '../schemas/ApprovalSummary.yaml'
'400':
$ref: "../schemas/ApprovalSummary.yaml"
"400":
description: Client Error - Returned if the query parameter is invalid.
content:
application/json:
schema:
$ref: '../schemas/ErrorResponseDto.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/ErrorResponseDto.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"

66
idn/v3/paths/access-request-status.yaml
View File

@@ -4,9 +4,12 @@ get:
- Access Requests
summary: Access Request Status
description: >-
The Access Request Status API returns a list of access request statuses based on the specified query parameters.
The Access Request Status API returns a list of access request statuses
based on the specified query parameters.
Any token with any authority can request their own status. A token with ORG_ADMIN authority is required to call this API to get a list of statuses for other users.
Any token with any authority can request their own status. A token with
ORG_ADMIN authority is required to call this API to get a list of statuses
for other users.
parameters:
- in: query
name: requested-for
@@ -14,7 +17,8 @@ get:
type: string
example: 2c9180877b2b6ea4017b2c545f971429
description: >-
Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with
Filter the results by the identity for which the requests were made.
*me* indicates the current user. Mutually exclusive with
*regarding-identity*.
required: false
- in: query
@@ -23,7 +27,8 @@ get:
type: string
example: 2c9180877b2b6ea4017b2c545f971429
description: >-
Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with
Filter the results by the identity that made the requests. *me*
indicates the current user. Mutually exclusive with
*regarding-identity*.
required: false
- in: query
@@ -32,14 +37,16 @@ get:
type: string
example: 2c9180877b2b6ea4017b2c545f971429
description: >-
Filter the results by the specified identity which is either the requester or target of the requests. *me* indicates the
current user. Mutually exclusive with *requested-for* and *requested-by*.
Filter the results by the specified identity which is either the
requester or target of the requests. *me* indicates the current user.
Mutually exclusive with *requested-for* and *requested-by*.
required: false
- 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.
required: false
schema:
type: boolean
@@ -59,8 +66,8 @@ get:
- in: query
name: offset
description: >-
Offset into the full result set. Usually specified with *limit* to paginate through the results.
Defaults to 0 if not specified.
Offset into the full result set. Usually specified with *limit* to
paginate through the results. Defaults to 0 if not specified.
required: false
schema:
type: integer
@@ -73,42 +80,47 @@ get:
type: string
example: accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"
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:
**accountActivityItemId**: *eq, in*
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)
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, accountActivityItemId**
Sorting is supported for the following fields: **created, modified,
accountActivityItemId**
example: created
required: false
responses:
'200':
"200":
description: List of requested item status.
content:
application/json:
schema:
type: array
items:
$ref: '../schemas/RequestedItemStatus.yaml'
'400':
$ref: '../../v3/responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/RequestedItemStatus.yaml"
"400":
$ref: "../../v3/responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"

67
idn/v3/paths/account-activities.yaml
View File

@@ -4,47 +4,55 @@ get:
- Account Activities
summary: List Account Activities
description: >-
This gets a collection of account activities that satisfy the given query parameters.
This gets a collection of account activities that satisfy the given query
parameters.
parameters:
- in: query
name: requested-for
schema:
type: string
description: >-
The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with
*regarding-identity*.
The identity that the activity was requested for. *me* indicates the
current user. Mutually exclusive with *regarding-identity*.
required: false
example: 2c91808568c529c60168cca6f90c1313
- in: query
name: requested-by
schema:
type: string
description: >-
The identity that requested the activity. *me* indicates the current user. Mutually exclusive with
*regarding-identity*.
The identity that requested the activity. *me* indicates the current
user. Mutually exclusive with *regarding-identity*.
required: false
example: 2c91808568c529c60168cca6f90c1313
- in: query
name: regarding-identity
schema:
type: string
description: >-
The specified identity will be either the requester or target of the account activity. *me* indicates the
current user. Mutually exclusive with *requested-for* and *requested-by*.
The specified identity will be either the requester or target of the
account activity. *me* indicates the current user. Mutually exclusive
with *requested-for* and *requested-by*.
required: false
example: 2c91808568c529c60168cca6f90c1313
- in: query
name: type
schema:
type: string
description: The type of account activity.
required: false
- $ref: '../../parameters/v3/limit.yaml'
- $ref: '../../parameters/v3/offset.yaml'
- $ref: '../../parameters/v3/count.yaml'
example: Identity Refresh
- $ref: "../../parameters/v3/limit.yaml"
- $ref: "../../parameters/v3/offset.yaml"
- $ref: "../../parameters/v3/count.yaml"
- 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)
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:
@@ -57,34 +65,39 @@ get:
**modified**: *gt, lt, ge, le*
example: type eq "Identity Refresh"
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)
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**
Sorting is supported for the following fields: **type, created,
modified**
example: created
required: false
responses:
'200':
"200":
description: List of account activities
content:
application/json:
schema:
type: array
items:
$ref: '../../schemas/v3/AccountActivity.yaml'
'400':
$ref: '../../responses/v3/400.yaml'
'401':
$ref: '../../responses/v3/401.yaml'
'403':
$ref: '../../responses/v3/403.yaml'
'429':
$ref: '../../responses/v3/429.yaml'
'500':
$ref: '../../responses/v3/500.yaml'
$ref: "../../schemas/v3/AccountActivity.yaml"
"400":
$ref: "../../responses/v3/400.yaml"
"401":
$ref: "../../responses/v3/401.yaml"
"403":
$ref: "../../responses/v3/403.yaml"
"429":
$ref: "../../responses/v3/429.yaml"
"500":
$ref: "../../responses/v3/500.yaml"

67
idn/v3/paths/account-activity-list.yaml
View File

@@ -4,47 +4,55 @@ get:
- Account Activities
summary: Get a list of Account Activities
description: >-
This gets a collection of account activities that satisfy the given query parameters.
This gets a collection of account activities that satisfy the given query
parameters.
parameters:
- in: query
name: requested-for
schema:
type: string
description: >-
The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with
*regarding-identity*.
The identity that the activity was requested for. *me* indicates the
current user. Mutually exclusive with *regarding-identity*.
required: false
example: 2c91808568c529c60168cca6f90c1313
- in: query
name: requested-by
schema:
type: string
description: >-
The identity that requested the activity. *me* indicates the current user. Mutually exclusive with
*regarding-identity*.
The identity that requested the activity. *me* indicates the current
user. Mutually exclusive with *regarding-identity*.
required: false
example: 2c91808568c529c60168cca6f90c1313
- in: query
name: regarding-identity
schema:
type: string
description: >-
The specified identity will be either the requester or target of the account activity. *me* indicates the
current user. Mutually exclusive with *requested-for* and *requested-by*.
The specified identity will be either the requester or target of the
account activity. *me* indicates the current user. Mutually exclusive
with *requested-for* and *requested-by*.
required: false
example: 2c91808568c529c60168cca6f90c1313
- in: query
name: type
schema:
type: string
description: The type of account activity.
required: false
- $ref: '../parameters/limit.yaml'
- $ref: '../parameters/offset.yaml'
- $ref: '../parameters/count.yaml'
example: Identity Refresh
- $ref: "../parameters/limit.yaml"
- $ref: "../parameters/offset.yaml"
- $ref: "../parameters/count.yaml"
- 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)
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:
@@ -53,33 +61,38 @@ get:
**created**: *gt, lt, ge, le*
**modified**: *gt, lt, ge, le*
example: type eq "Identity Refresh"
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)
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**
Sorting is supported for the following fields: **type, created,
modified**
example: created
required: false
responses:
'200':
"200":
description: List of account activities
content:
application/json:
schema:
type: array
items:
$ref: '../schemas/AccountActivity.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/AccountActivity.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"

134
idn/v3/paths/account.yaml
View File

@@ -5,7 +5,7 @@ get:
summary: Account Details
description: >-
This API returns the details for a single account based on the ID.
A token with ORG_ADMIN authority is required to call this API.
security:
- oauth2: [idn:account:read]
@@ -18,24 +18,24 @@ get:
description: The account ID
example: ef38f94347e94562b5bb8424a56397d8
responses:
'200':
"200":
description: An account object
content:
application/json:
schema:
$ref: '../schemas/Account.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'404':
$ref: '../responses/404.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/Account.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"404":
$ref: "../responses/404.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"
patch:
operationId: updateAccount
tags:
@@ -70,33 +70,34 @@ patch:
requestBody:
required: true
description: >-
A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
A list of account update operations according to the [JSON
Patch](https://tools.ietf.org/html/rfc6902) standard.
content:
application/json-patch+json:
schema:
type: array
items:
type: object
type: array
items:
$ref: "../schemas/JsonPatchOperation.yaml"
example:
- op: "replace"
path: "/identityId"
value: "2c9180845d1edece015d27a975983e21"
responses:
'202':
"202":
description: Accepted. Update request accepted and is in progress.
$ref: '../responses/202.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'404':
$ref: '../responses/404.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../responses/202.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"404":
$ref: "../responses/404.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"
put:
operationId: putAccount
tags:
@@ -107,7 +108,8 @@ put:
A token with ORG_ADMIN authority is required to call this API.
>**NOTE: The PUT Account API is designated only for Delimited File sources.**
>**NOTE: The PUT Account API is designated only for Delimited File
sources.**
security:
- oauth2: [idn:account:update]
parameters:
@@ -123,34 +125,36 @@ put:
content:
application/json:
schema:
$ref: '../schemas/AccountAttributes.yaml'
$ref: "../schemas/AccountAttributes.yaml"
responses:
'202':
"202":
description: Async task details
content:
application/json:
schema:
$ref: '../schemas/AccountsAsyncResult.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'404':
$ref: '../responses/404.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/AccountsAsyncResult.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"404":
$ref: "../responses/404.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"
delete:
operationId: deleteAccount
tags:
- Accounts
summary: Delete Account
description: >-
This API submits an account delete task and returns the task ID. This operation can only be used on Flat File Sources.
Any attempt to execute this request on the source of other type will result in an error response with a status code of 400.
This API submits an account delete task and returns the task ID. This
operation can only be used on Flat File Sources. Any attempt to execute this
request on the source of other type will result in an error response with a
status code of 400.
A token with ORG_ADMIN authority is required to call this API.
security:
@@ -164,21 +168,21 @@ delete:
description: The account ID
example: ef38f94347e94562b5bb8424a56397d8
responses:
'202':
"202":
description: Async task details
content:
application/json:
schema:
$ref: '../schemas/AccountsAsyncResult.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'404':
$ref: '../responses/404.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/AccountsAsyncResult.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"404":
$ref: "../responses/404.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"

63
idn/v3/paths/accounts.yaml
View File

@@ -5,21 +5,23 @@ get:
summary: Accounts List
description: >-
This returns a list of accounts.
A token with ORG_ADMIN authority is required to call this API.
security:
- oauth2: [idn:account-list:read]
parameters:
- $ref: '../parameters/limit.yaml'
- $ref: '../parameters/offset.yaml'
- $ref: '../parameters/count.yaml'
- $ref: "../parameters/limit.yaml"
- $ref: "../parameters/offset.yaml"
- $ref: "../parameters/count.yaml"
- in: query
name: filters
schema:
type: string
example: identityId eq "2c9180858082150f0180893dbaf44201"
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:
@@ -41,25 +43,26 @@ get:
**uncorrelated**: *eq*
required: false
responses:
'200':
"200":
description: List of account objects
content:
application/json:
schema:
type: array
items:
$ref: '../schemas/Account.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/Account.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"
post:
operationId: createAccount
tags:
@@ -76,21 +79,21 @@ post:
content:
application/json:
schema:
$ref: '../schemas/AccountAttributesCreate.yaml'
$ref: "../schemas/AccountAttributesCreate.yaml"
responses:
'202':
"202":
description: Async task details
content:
application/json:
schema:
$ref: '../schemas/AccountsAsyncResult.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/AccountsAsyncResult.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"

53
idn/v3/paths/completed-access-request-approvals.yaml
View File

@@ -4,8 +4,8 @@ get:
tags:
- Access Request Approvals
description: >-
This endpoint returns list of completed approvals.
See *owner-id* query parameter below for authorization info.
This endpoint returns list of completed approvals. See *owner-id* query
parameter below for authorization info.
parameters:
- in: query
name: owner-id
@@ -13,22 +13,26 @@ get:
schema:
type: string
description: >-
If present, the value returns only completed approvals for the specified identity.
If present, the value returns only completed approvals for the specified
identity.
* ORG_ADMIN users can call this with any identity ID value.
* ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used.
* Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value.
* ORG_ADMIN users can also fetch all the approvals in the org, when
owner-id is not used.
* Non-ORG_ADMIN users can only specify *me* or pass their own
identity ID value.
example: 2c91808568c529c60168cca6f90c1313
- $ref: '../parameters/limit.yaml'
- $ref: '../parameters/offset.yaml'
- $ref: '../parameters/count.yaml'
- $ref: "../parameters/limit.yaml"
- $ref: "../parameters/offset.yaml"
- $ref: "../parameters/count.yaml"
- 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)
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:
@@ -42,7 +46,6 @@ get:
**modified**: *gt, lt, ge, le*
example: id eq "2c91808568c529c60168cca6f90c1313"
- in: query
name: sorters
required: false
@@ -50,27 +53,29 @@ get:
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)
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**
example: modified
responses:
'200':
"200":
description: List of Completed Approvals.
content:
application/json:
schema:
type: array
items:
$ref: '../schemas/CompletedApproval.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/CompletedApproval.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"

12
idn/v3/paths/identity-certifications-access-review-items.yaml
View File

@@ -19,6 +19,7 @@ get:
- $ref: '../parameters/offset.yaml'
- $ref: '../parameters/count.yaml'
- in: query
required: false
name: filters
schema:
type: string
@@ -54,11 +55,14 @@ get:
**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)
@@ -66,8 +70,10 @@ get:
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.
@@ -75,8 +81,10 @@ get:
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.
@@ -84,8 +92,10 @@ get:
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.
@@ -100,6 +110,8 @@ get:
type: array
items:
$ref: '../schemas/AccessReviewItem.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':

4
idn/v3/paths/identity-certifications-access-summaries.yaml
View File

@@ -31,8 +31,10 @@ get:
- $ref: '../parameters/count.yaml'
- 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://community.sailpoint.com/t5/IdentityNow-Wiki-API-Standard-Collection-Parameters/ta-p/156407)
@@ -55,9 +57,11 @@ get:
**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)

2
idn/v3/paths/identity-certifications-decision-summary.yaml
View File

@@ -17,8 +17,10 @@ get:
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://community.sailpoint.com/t5/IdentityNow-Wiki-API-Standard-Collection-Parameters/ta-p/156407)

6
idn/v3/paths/identity-certifications-identity-summaries.yaml
View File

@@ -2,7 +2,7 @@ get:
operationId: getIdentitySummaries
tags:
- Certification Summaries
summary: Identity Summaries for Identity Campaign Certification
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
@@ -20,8 +20,10 @@ get:
- $ref: '../parameters/count.yaml'
- 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)
@@ -38,9 +40,11 @@ get:
**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)

2
idn/v3/paths/identity-certifications-identity-summary.yaml
View File

@@ -28,6 +28,8 @@ get:
application/json:
schema:
$ref: '../schemas/CertificationIdentitySummary.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':

5
idn/v3/paths/identity-certifications.yaml
View File

@@ -12,6 +12,7 @@ get:
name: reviewer-identity
schema:
type: string
example: me
description: >-
The ID of reviewer identity. *me* indicates the current user.
required: false
@@ -20,8 +21,10 @@ get:
- $ref: '../parameters/count.yaml'
- 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)
@@ -36,9 +39,11 @@ get:
**completed**: *eq, ne*
- in: query
name: sorters
required: false
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)

2
idn/v3/paths/identity-profile-default-config.yaml
View File

@@ -23,6 +23,8 @@ get:
application/json:
schema:
$ref: '../schemas/IdentityAttributeConfig.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':

2
idn/v3/paths/identity-profile-lifecycle-state.yaml
View File

@@ -16,12 +16,14 @@ get:
required: true
schema:
type: string
example: ef38f94347e94562b5bb8424a56397d8
- 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.

3
idn/v3/paths/identity-profile-lifecycle-states.yaml
View File

@@ -16,14 +16,17 @@ get:
required: true
schema:
type: string
example: ef38f94347e94562b5bb8424a56397d8
- $ref: '../parameters/limit.yaml'
- $ref: '../parameters/offset.yaml'
- $ref: '../parameters/count.yaml'
- 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)

2
idn/v3/paths/identity-profile.yaml
View File

@@ -23,6 +23,8 @@ get:
application/json:
schema:
$ref: '../schemas/IdentityProfile.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':

4
idn/v3/paths/identity-profiles-export.yaml
View File

@@ -11,8 +11,10 @@ get:
- $ref: '../parameters/count.yaml'
- 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)
@@ -29,9 +31,11 @@ get:
**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)

4
idn/v3/paths/identity-profiles.yaml
View File

@@ -13,8 +13,10 @@ get:
- $ref: '../parameters/count.yaml'
- 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)
@@ -31,9 +33,11 @@ get:
**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)

2
idn/v3/paths/identity-set-lifecycle-state.yaml
View File

@@ -41,6 +41,8 @@ post:
type: string
example: 2c9180837ab5b716017ab7c6c9ef1e20
description: The ID of the IdentityRequest object that was generated when the workflow launches
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':

58
idn/v3/paths/non-employee-approval-list.yaml
View File

@@ -7,55 +7,65 @@ get:
summary: Get List of Non-Employee Approval Requests
description: >-
This gets a list of non-employee approval requests.<br><br>
There are two contextual uses for this endpoint:<br>
1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver.<br>
2. The user owns the requested approval.
1. The user has the role context of `idn:nesr:read`, in which case they
can list the approvals for any approver.<br>
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.
The identity for whom the request was made. *me* indicates the current
user.
required: false
- $ref: '../parameters/limit.yaml'
- $ref: '../parameters/offset.yaml'
- $ref: '../parameters/count.yaml'
example: 2c91808280430dfb0180431a59440460
- $ref: "../parameters/limit.yaml"
- $ref: "../parameters/offset.yaml"
- $ref: "../parameters/count.yaml"
- 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)<br/><br/>
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)<br/><br/>
Filtering is supported for the following fields and operators:<br/><br/>
**approvalStatus**: *eq* <br/><br/>
*Example:* approvalStatus eq "PENDING"
**approvalStatus**: *eq* <br/><br/> *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)<br/><br/>
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)<br/><br/>
Sorting is supported for the following fields: **created, modified**
required: false
example: created
responses:
'200':
"200":
description: List of approval items.
content:
application/json:
schema:
type: array
items:
$ref: '../schemas/non-employee/NonEmployeeApprovalItem.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/non-employee/NonEmployeeApprovalItem.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"

41
idn/v3/paths/non-employee-approval-summary.yaml
View File

@@ -6,32 +6,39 @@ get:
- Non-Employee Lifecycle Management
summary: Get Summary of Non-Employee Approval Requests
description: >-
This request will retrieve a summary of non-employee approval requests.<br><br>
There are two contextual uses for the `requested-for` path parameter:<br>
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.<br>
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.
This request will retrieve a summary of non-employee approval
requests.<br><br> There are two contextual uses for the `requested-for` path
parameter:<br>
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.<br>
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.
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':
"200":
description: summary of non-employee approval requests
content:
application/json:
schema:
$ref: '../schemas/non-employee/NonEmployeeApprovalSummary.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/non-employee/NonEmployeeApprovalSummary.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"

40
idn/v3/paths/non-employee-approve-get.yaml
View File

@@ -6,10 +6,11 @@ get:
- Non-Employee Lifecycle Management
summary: Get a non-employee approval item detail
description: >-
Gets a non-employee approval item detail.<br><br>
There are two contextual uses for this endpoint:<br>
1. The user has the role context of `idn:nesr:read`, in which case they can get any approval.<br>
2. The user owns the requested approval.
Gets a non-employee approval item detail.<br><br> There are two contextual
uses for this endpoint:<br>
1. The user has the role context of `idn:nesr:read`, in which case they
can get any approval.<br>
2. The user owns the requested approval.
parameters:
- in: path
name: id
@@ -18,27 +19,30 @@ get:
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*
The object nonEmployeeRequest will not be included detail when set to
false. *Default value is true*
required: false
schema:
type: string
type: boolean
example: true
responses:
'200':
"200":
description: Non-Employee approval item object.
content:
application/json:
schema:
$ref: '../schemas/non-employee/NonEmployeeApprovalItemDetail.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/non-employee/NonEmployeeApprovalItemDetail.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"

31
idn/v3/paths/non-employee-approve-request.yaml
View File

@@ -6,8 +6,8 @@ post:
- Non-Employee Lifecycle Management
summary: Approve a Non-Employee Request
description: >-
Approves a non-employee approval request and notifies the next approver.<br><br>
The current user must be the requested approver.
Approves a non-employee approval request and notifies the next
approver.<br><br> The current user must be the requested approver.
parameters:
- in: path
name: id
@@ -16,26 +16,27 @@ post:
required: true
schema:
type: string
example: e136567de87e4d029e60b3c3c55db56d
requestBody:
required: true
content:
application/json:
schema:
$ref: '../schemas/non-employee/NonEmployeeApprovalDecision.yaml'
$ref: "../schemas/non-employee/NonEmployeeApprovalDecision.yaml"
responses:
'200':
"200":
description: Non-Employee approval item object.
content:
application/json:
schema:
$ref: '../schemas/non-employee/NonEmployeeApprovalItem.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/non-employee/NonEmployeeApprovalItem.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"

25
idn/v3/paths/non-employee-bulk-upload-jobs-fail.yaml
View File

@@ -27,21 +27,22 @@ post:
required: true
schema:
type: string
example: e136567de87e4d029e60b3c3c55db56d
responses:
'200':
"200":
description: >-
The bulk upload job was marked as failed.
content:
application/json:
schema:
$ref: '../schemas/non-employee/NonEmployeeBulkUploadJob.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/non-employee/NonEmployeeBulkUploadJob.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"

145
idn/v3/paths/non-employee-record.yaml
View File

@@ -19,22 +19,22 @@ get:
schema:
type: string
responses:
'200':
"200":
description: Non-Employee record object
content:
application/json:
schema:
$ref: '../schemas/non-employee/NonEmployeeRecord.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/non-employee/NonEmployeeRecord.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"
put:
operationId: nonEmployeeRecordUpdate
security:
@@ -43,10 +43,12 @@ put:
- Non-Employee Lifecycle Management
summary: Update Non-Employee Record
description: >-
This request will update a non-employee record.<br><br>
There are two contextual uses for this endpoint:<br>
1. The user has the role context of `idn:nesr:update`, in which case they update all available fields.<br>
2. The user is owner of the source, in this case they can only update the end date.
This request will update a non-employee record.<br><br> There are two
contextual uses for this endpoint:<br>
1. The user has the role context of `idn:nesr:update`, in which case they
update all available fields.<br>
2. The user is owner of the source, in this case they can only update the
end date.
parameters:
- in: path
name: id
@@ -57,31 +59,34 @@ put:
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.
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:
$ref: '../schemas/non-employee/NonEmployeeRequestBody.yaml'
$ref: "../schemas/non-employee/NonEmployeeRequestBody.yaml"
responses:
'200':
"200":
description: An updated non-employee record.
content:
application/json:
schema:
$ref: '../schemas/non-employee/NonEmployeeRecord.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'404':
$ref: '../responses/404.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/non-employee/NonEmployeeRecord.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"404":
$ref: "../responses/404.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"
patch:
operationId: nonEmployeeRecordPatch
security:
@@ -90,10 +95,12 @@ patch:
- Non-Employee Lifecycle Management
summary: Patch Non-Employee Record
description: >-
This request will patch a non-employee record.<br><br>
There are two contextual uses for this endpoint:<br>
1. The user has the role context of `idn:nesr:update`, in which case they update all available fields.<br>
2. The user is owner of the source, in this case they can only update the end date.
This request will patch a non-employee record.<br><br> There are two
contextual uses for this endpoint:<br>
1. The user has the role context of `idn:nesr:update`, in which case they
update all available fields.<br>
2. The user is owner of the source, in this case they can only update the
end date.
parameters:
- in: path
name: id
@@ -104,37 +111,41 @@ patch:
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.
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:
$ref: '../schemas/JsonPatchOperation.yaml'
$ref: "../schemas/JsonPatchOperation.yaml"
example:
- op: "replace"
path: "/endDate"
value: "2019-08-23T18:40:35.772Z"
- op: "replace"
path: "/endDate"
value: "2019-08-23T18:40:35.772Z"
responses:
'200':
"200":
description: A patched non-employee record.
content:
application/json:
schema:
$ref: '../schemas/non-employee/NonEmployeeRecord.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'404':
$ref: '../responses/404.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/non-employee/NonEmployeeRecord.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"404":
$ref: "../responses/404.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"
delete:
operationId: nonEmployeeRecordDelete
# security:
@@ -156,15 +167,15 @@ delete:
schema:
type: string
responses:
'204':
$ref: '../responses/204.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
"204":
$ref: "../responses/204.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"

30
idn/v3/paths/non-employee-records-bulk-delete.yaml
View File

@@ -6,8 +6,9 @@ post:
- 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.<br><br>
Requires role context of `idn:nesr:delete`
This request will delete multiple non-employee records based on the
non-employee ids provided.<br><br> Requires role context of
`idn:nesr:delete`
requestBody:
description: Non-Employee bulk delete request body.
required: true
@@ -22,18 +23,19 @@ post:
items:
type: string
format: uuid
example: e136567de87e4d029e60b3c3c55db56d
required:
- ids
responses:
'204':
$ref: '../responses/204.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
"204":
$ref: "../responses/204.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"

27
idn/v3/paths/non-employee-reject-request.yaml
View File

@@ -16,26 +16,27 @@ post:
required: true
schema:
type: string
example: e136567de87e4d029e60b3c3c55db56d
requestBody:
required: true
content:
application/json:
schema:
$ref: '../schemas/non-employee/NonEmployeeRejectApprovalDecision.yaml'
$ref: "../schemas/non-employee/NonEmployeeRejectApprovalDecision.yaml"
responses:
'200':
"200":
description: Non-Employee approval item object.
content:
application/json:
schema:
$ref: '../schemas/non-employee/NonEmployeeApprovalItem.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/non-employee/NonEmployeeApprovalItem.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"

41
idn/v3/paths/non-employee-request-summary-get.yaml
View File

@@ -6,33 +6,40 @@ get:
- Non-Employee Lifecycle Management
summary: Get Summary of Non-Employee Requests
description: >-
This request will retrieve a summary of non-employee requests.<br><br>
There are two contextual uses for the `requested-for` path parameter:<br>
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.<br>
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.
This request will retrieve a summary of non-employee requests.<br><br> There
are two contextual uses for the `requested-for` path parameter:<br>
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.<br>
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.
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':
"200":
description: Non-Employee request summary object.
content:
application/json:
schema:
$ref: '../schemas/non-employee/NonEmployeeRequestSummary.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/non-employee/NonEmployeeRequestSummary.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"

64
idn/v3/paths/non-employee-request.yaml
View File

@@ -7,9 +7,10 @@ get:
summary: Get a Non-Employee Request
description: >-
This gets a non-employee request.<br><br>
There are two contextual uses for this endpoint:<br>
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.<br>
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.<br>
2. The user must be the owner of the non-employee request.
parameters:
- in: path
@@ -21,24 +22,24 @@ get:
schema:
type: string
responses:
'200':
"200":
description: Non-Employee request object.
content:
application/json:
schema:
$ref: '../schemas/non-employee/NonEmployeeRequest.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'404':
$ref: '../responses/404.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/non-employee/NonEmployeeRequest.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"404":
$ref: "../responses/404.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"
delete:
operationId: nonEmployeeRequestDeletion
# security:
@@ -48,7 +49,7 @@ delete:
summary: Delete Non-Employee Request
description: >-
This request will delete a non-employee request.<br><br>
Requires role context of `idn:nesr:delete`
parameters:
- in: path
@@ -59,18 +60,19 @@ delete:
schema:
type: string
format: uuid
example: e136567de87e4d029e60b3c3c55db56d
responses:
'204':
$ref: '../responses/204.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'404':
$ref: '../responses/404.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
"204":
$ref: "../responses/204.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"404":
$ref: "../responses/404.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"

102
idn/v3/paths/non-employee-requests.yaml
View File

@@ -6,28 +6,29 @@ post:
- Non-Employee Lifecycle Management
summary: Create Non-Employee Request
description: >-
This request will create a non-employee request and notify the approver.<br><br>
Requires role context of `idn:nesr:create` or the user must own the source.
This request will create a non-employee request and notify the
approver.<br><br> 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:
$ref: '../schemas/non-employee/NonEmployeeRequestBody.yaml'
$ref: "../schemas/non-employee/NonEmployeeRequestBody.yaml"
responses:
'200':
"200":
description: Non-Employee request creation object
content:
application/json:
schema:
$ref: '../schemas/non-employee/NonEmployeeRequest.yaml'
'400':
$ref: "../schemas/non-employee/NonEmployeeRequest.yaml"
"400":
description: Client Error - Returned if the request body is invalid.
content:
application/json:
schema:
$ref: '../schemas/ErrorResponseDto.yaml'
$ref: "../schemas/ErrorResponseDto.yaml"
examples:
400.1 Bad Request Content:
description: Response for bad request content
@@ -46,15 +47,17 @@ post:
messages:
- locale: en
localeOrigin: REQUEST
text: Unable to create Non-Employee because the accountName "existed" is already being used.
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
text:
Unable to create Non-Employee because the accountName
"existed" is already being used.
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"
get:
operationId: nonEmployeeRequestList
security:
@@ -63,59 +66,70 @@ get:
- Non-Employee Lifecycle Management
summary: List Non-Employee Requests
description: >-
This gets a list of non-employee requests.<br><br>
There are two contextual uses for the `requested-for` path parameter:<br>
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.<br>
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.
This gets a list of non-employee requests.<br><br> There are two contextual
uses for the `requested-for` path parameter:<br>
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.<br>
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:
- $ref: '../parameters/limit.yaml'
- $ref: '../parameters/offset.yaml'
- $ref: '../parameters/count.yaml'
- $ref: "../parameters/limit.yaml"
- $ref: "../parameters/offset.yaml"
- $ref: "../parameters/count.yaml"
- in: query
name: requested-for
required: true
schema:
type: string
example: "me"
example: e136567de87e4d029e60b3c3c55db56d
description: >-
The identity for whom the request was made. *me* indicates the current user.
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"
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)<br/><br/>
Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate**
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)<br/><br/>
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\""
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)<br/><br/>
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)<br/><br/>
Filtering is supported for the following fields and operators:<br/><br/>
**sourceId**: *eq* <br/><br/>
*Example:* sourceId eq "2c91808568c529c60168cca6f90c1313"
**sourceId**: *eq* <br/><br/> *Example:* sourceId eq
"2c91808568c529c60168cca6f90c1313"
responses:
'200':
"200":
description: List of non-employee request objects.
content:
application/json:
schema:
type: array
items:
$ref: '../schemas/non-employee/NonEmployeeRequest.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/non-employee/NonEmployeeRequest.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"

32
idn/v3/paths/non-employee-source-aggregate.yaml
View File

@@ -6,7 +6,8 @@ post:
- Non-Employee Lifecycle Management
summary: Aggregate all accounts for a Non-Employee Source
description: >-
This fetches all the non-employee records related to a non-employee source and publishes an aggregation event for each one.<br><br>
This fetches all the non-employee records related to a non-employee source
and publishes an aggregation event for each one.<br><br>
Requires auth scope of 'idn:nesr:create'
parameters:
@@ -17,18 +18,19 @@ post:
required: true
schema:
type: string
example: e136567de87e4d029e60b3c3c55db56d
responses:
'202':
$ref: '../responses/202.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'404':
$ref: '../responses/404.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
"202":
$ref: "../responses/202.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"404":
$ref: "../responses/404.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"

106
idn/v3/paths/non-employee-source.yaml
View File

@@ -6,10 +6,12 @@ get:
- Non-Employee Lifecycle Management
summary: Get a Non-Employee Source
description: >-
This gets a non-employee source.<br><br>
There are two contextual uses for the requested-for path parameter: <br>
1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source.<br>
2. The current user is an account manager, in which case the user can only request sources that they own.
This gets a non-employee source.<br><br> There are two contextual uses for
the requested-for path parameter: <br>
1. The user has the role context of `idn:nesr:read`, in which case he or
she may request any source.<br>
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
@@ -20,22 +22,22 @@ get:
schema:
type: string
responses:
'200':
"200":
description: Non-Employee source object.
content:
application/json:
schema:
$ref: '../schemas/non-employee/NonEmployeeSource.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/non-employee/NonEmployeeSource.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"
patch:
operationId: nonEmployeeSourcePatch
# security:
@@ -44,9 +46,9 @@ patch:
- Non-Employee Lifecycle Management
summary: Patch a Non-Employee Source
description: >-
patch a non-employee source. (partial update) <br/>
Patchable field: **name, description, approvers, accountManagers**<br><br>
Requires role context of `idn:nesr:update`.
patch a non-employee source. (partial update) <br/> Patchable field: **name,
description, approvers, accountManagers**<br><br> Requires role context of
`idn:nesr:update`.
parameters:
- in: path
name: sourceId
@@ -55,39 +57,46 @@ patch:
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.
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:
$ref: '../schemas/JsonPatchOperation.yaml'
$ref: "../schemas/JsonPatchOperation.yaml"
example:
- op: "replace"
path: "/name"
value: { "new name" }
- op: "replace"
path: "/approvers"
value: [ "2c91809f703bb37a017040a2fe8748c7", "48b1f463c9e8427db5a5071bd81914b8" ]
value:
[
"2c91809f703bb37a017040a2fe8748c7",
"48b1f463c9e8427db5a5071bd81914b8",
]
responses:
'200':
"200":
description: A patched non-employee source object.
content:
application/json:
schema:
$ref: '../schemas/non-employee/NonEmployeeSource.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/non-employee/NonEmployeeSource.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"
delete:
operationId: nonEmployeeSourceDelete
# security:
@@ -96,8 +105,8 @@ delete:
- Non-Employee Lifecycle Management
summary: Delete Non-Employee Source
description: >-
This request will delete a non-employee source.<br><br>
Requires role context of `idn:nesr:delete`.
This request will delete a non-employee source.<br><br> Requires role
context of `idn:nesr:delete`.
parameters:
- in: path
name: sourceId
@@ -106,16 +115,17 @@ delete:
required: true
schema:
type: string
example: e136567de87e4d029e60b3c3c55db56d
responses:
'204':
$ref: '../responses/204.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
"204":
$ref: "../responses/204.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"

25
idn/v3/paths/non-employee-sources-bulk-upload-details.yaml
View File

@@ -19,21 +19,22 @@ get:
required: true
schema:
type: string
example: e136567de87e4d029e60b3c3c55db56d
responses:
'200':
"200":
description: >-
Details of the newest bulk-upload job, if any.
content:
application/json:
schema:
$ref: '../schemas/non-employee/NonEmployeeBulkUploadJob.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/non-employee/NonEmployeeBulkUploadJob.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"

51
idn/v3/paths/non-employee-sources-bulk-upload-non-employees.yaml
View File

@@ -6,8 +6,8 @@ post:
- 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.<br><br>
Requires role context of `idn:nesr:create`
This post will import, or update, Non-Employee records found in the
CSV.<br><br> Requires role context of `idn:nesr:create`
parameters:
- in: path
name: id
@@ -16,8 +16,11 @@ post:
required: true
schema:
type: string
example: e136567de87e4d029e60b3c3c55db56d
requestBody:
description: The form-data "name" attribute for the file content must be "data". See the schema specification.
description:
The form-data "name" attribute for the file content must be "data". See
the schema specification.
content:
multipart/form-data:
schema:
@@ -28,35 +31,39 @@ post:
format: base64
required:
- data
example:
{ data:
example:
{
data:
"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"
}
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",
}
responses:
'202':
"202":
description: >-
The CSV was accepted to be bulk inserted now or at a later time.
content:
application/json:
schema:
$ref: '../schemas/non-employee/NonEmployeeBulkUploadJob.yaml'
'400':
$ref: "../schemas/non-employee/NonEmployeeBulkUploadJob.yaml"
"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:
$ref: '../schemas/ErrorResponseDto.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'404':
$ref: '../responses/404.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/ErrorResponseDto.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"404":
$ref: "../responses/404.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"

25
idn/v3/paths/non-employee-sources-bulk-upload-status.yaml
View File

@@ -16,21 +16,22 @@ get:
required: true
schema:
type: string
example: e136567de87e4d029e60b3c3c55db56d
responses:
'200':
"200":
description: >-
Status of the newest bulk-upload job, if any.
content:
application/json:
schema:
$ref: '../schemas/non-employee/NonEmployeeBulkUploadStatus.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
$ref: "../schemas/non-employee/NonEmployeeBulkUploadStatus.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"

31
idn/v3/paths/non-employee-sources-export-non-employees.yaml
View File

@@ -6,8 +6,8 @@ get:
- 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.<br><br>
Requires role context of `idn:nesr:read`
This requests a CSV download for all non-employees from a provided
source.<br><br> Requires role context of `idn:nesr:read`
parameters:
- in: path
name: id
@@ -16,8 +16,9 @@ get:
required: true
schema:
type: string
example: e136567de87e4d029e60b3c3c55db56d
responses:
'200':
"200":
description: Exported CSV
content:
text/csv:
@@ -25,15 +26,15 @@ get:
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':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'404':
$ref: '../responses/404.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"404":
$ref: "../responses/404.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"

1
idn/v3/paths/non-employee-sources-export-schema-attributes-template.yaml
View File

@@ -14,6 +14,7 @@ get:
description: >-
Source Id (UUID)
required: true
example: ef38f94347e94562b5bb8424a56397d8
schema:
type: string
responses:

4
idn/v3/paths/non-employee-sources-schema-attribute.yaml
View File

@@ -14,12 +14,14 @@ get:
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':
@@ -28,6 +30,8 @@ get:
application/json:
schema:
$ref: '../schemas/non-employee/NonEmployeeSchemaAttribute.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':

3
idn/v3/paths/non-employee-sources-schema-attributes.yaml
View File

@@ -17,6 +17,7 @@ get:
schema:
type: string
required: true
example: ef38f94347e94562b5bb8424a56397d8
description: The Source id
responses:
'200':
@@ -28,6 +29,8 @@ get:
items:
$ref: '../schemas/non-employee/NonEmployeeSchemaAttribute.yaml'
maxItems: 18
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':

2
idn/v3/paths/public-identities-config.yaml
View File

@@ -15,6 +15,8 @@ get:
application/json:
schema:
$ref: '../schemas/PublicIdentityConfig.yaml'
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':

7
idn/v3/paths/public-identities.yaml
View File

@@ -11,6 +11,7 @@ get:
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)
@@ -31,6 +32,7 @@ get:
**lastname**: *eq, sw*
example: firstname eq "John"
- in: query
name: add-core-filters
description: >-
@@ -41,6 +43,7 @@ get:
- lastname should not be null.
- email should not be null.
required: false
example: false
schema:
type: boolean
default: false
@@ -49,11 +52,13 @@ get:
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.
@@ -100,6 +105,8 @@ get:
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'429':
$ref: '../responses/429.yaml'
'500':

2
idn/v3/paths/requestable-object-list.yaml
View File

@@ -71,11 +71,13 @@ get:
**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)

1
idn/v3/paths/saved-searches.yaml
View File

@@ -54,6 +54,7 @@ get:
```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.

1
idn/v3/paths/scheduled-searches.yaml
View File

@@ -54,6 +54,7 @@ get:
```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.

2
idn/v3/paths/service-desk-integrations.yaml
View File

@@ -19,6 +19,7 @@ get:
Sorting is supported for the following fields: **name**
example: name
- name: filters
in: query
required: false
@@ -44,6 +45,7 @@ get:
**cluster**: *eq, in*
example: name eq "John Doe"
- $ref: '../../v3/parameters/count.yaml'
responses:
"200":

1
idn/v3/paths/work-item.yaml
View File

@@ -12,6 +12,7 @@ get:
type: string
required: true
description: ID of the work item.
example: 2c9180835d191a86015d28455b4a2329
responses:
'200':
description: The work item with the given ID.

1
idn/v3/paths/work-items-completed-count.yaml
View File

@@ -12,6 +12,7 @@ get:
type: string
description: ID of the work item owner.
required: false
example: 1211bcaa32112bcef6122adb21cef1ac
responses:
'200':
description: List of work items

1
idn/v3/paths/work-items-completed.yaml
View File

@@ -13,6 +13,7 @@ get:
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
- $ref: '../../v3/parameters/limit.yaml'
- $ref: '../../v3/parameters/offset.yaml'
- $ref: '../../v3/parameters/count.yaml'

1
idn/v3/paths/work-items-count.yaml
View File

@@ -12,6 +12,7 @@ get:
type: string
description: ID of the work item owner.
required: false
example: ef38f94347e94562b5bb8424a56397d8
responses:
'200':
description: List of work items

1
idn/v3/paths/work-items-summary.yaml
View File

@@ -12,6 +12,7 @@ get:
type: string
description: ID of the work item owner.
required: false
example: 1211bcaa32112bcef6122adb21cef1ac
responses:
'200':
description: List of work items

1
idn/v3/paths/work-items.yaml
View File

@@ -15,6 +15,7 @@ get:
type: string
description: ID of the work item owner.
required: false
example: 1211bcaa32112bcef6122adb21cef1ac
responses:
'200':
description: List of work items

9
idn/v3/schemas/AccessReviewItem.yaml
View File

@@ -1,11 +1,11 @@
# Replaced by ReviewItem.yaml
# Cannot represent information from a Role Composition Certification Item
type : object
type: object
properties:
accessSummary:
$ref: './AccessSummary.yaml'
$ref: "./AccessSummary.yaml"
identitySummary:
$ref: './CertificationIdentitySummary.yaml'
$ref: "./CertificationIdentitySummary.yaml"
id:
type: string
description: The review item's id
@@ -17,8 +17,9 @@ properties:
newAccess:
type: boolean
description: Indicates whether the review item is for new access to a source
example: false
decision:
$ref: './CertificationDecision.yaml'
$ref: "./CertificationDecision.yaml"
comments:
nullable: true
type: string

28
idn/v3/schemas/Account.yaml
View File

@@ -1,5 +1,5 @@
allOf:
- $ref: './BaseCommonDto.yaml'
- $ref: "./BaseCommonDto.yaml"
- type: object
properties:
sourceId:
@@ -10,23 +10,49 @@ allOf:
example: 2c9180835d2e5168015d32f890ca1581
attributes:
type: object
additionalProperties: true
example:
firstName: "SailPoint"
lastName: "Support"
displayName: "SailPoint Support"
authoritative:
type: boolean
description: Indicates if this account is from an authoritative source
example: false
description:
type: string
description: A description of the account
nullable: true
example: null
disabled:
type: boolean
description: Indicates if the account is currently disabled
example: false
locked:
type: boolean
description: Indicates if the account is currently locked
example: false
nativeIdentity:
type: string
example: "552775"
systemAccount:
type: boolean
example: false
uncorrelated:
type: boolean
description: Indicates if this account is not correlated to an identity
example: false
uuid:
type: string
description:
The unique ID of the account as determined by the account schema
example: "slpt.support"
manuallyCorrelated:
type: boolean
description:
Indicates if the account has been manually correlated to an identity
example: false
hasEntitlements:
type: boolean
description: Indicates if the account has entitlements
example: true

41
idn/v3/schemas/AccountActivity.yaml
View File

@@ -9,50 +9,57 @@ properties:
example: 2c9180835d2e5168015d32f890ca1581
created:
type: string
format: 'date-time'
example: '2017-07-11T18:45:37.098Z'
format: "date-time"
example: "2017-07-11T18:45:37.098Z"
modified:
type: string
format: 'date-time'
example: '2018-06-25T20:22:28.104Z'
format: "date-time"
example: "2018-06-25T20:22:28.104Z"
completed:
type: string
format: 'date-time'
format: "date-time"
nullable: true
example: '2018-10-19T13:49:37.385Z'
example: "2018-10-19T13:49:37.385Z"
completionStatus:
$ref: './CompletionStatus.yaml'
$ref: "./CompletionStatus.yaml"
type:
type: string
example: appRequest
requesterIdentitySummary:
$ref: './IdentitySummary.yaml'
$ref: "./IdentitySummary.yaml"
targetIdentitySummary:
$ref: './IdentitySummary.yaml'
$ref: "./IdentitySummary.yaml"
errors:
nullable: true
type: array
items:
items:
type: string
example: ["sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds."]
example:
[
"sailpoint.connector.ConnectorException: java.lang.InterruptedException:
Timeout waiting for response to message 0 from client
57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds.",
]
warnings:
nullable: true
type: array
items:
items:
type: string
example: ["Some warning, another warning"]
items:
type: array
items:
$ref: './AccountActivityItem.yaml'
$ref: "./AccountActivityItem.yaml"
executionStatus:
$ref: './ExecutionStatus.yaml'
$ref: "./ExecutionStatus.yaml"
clientMetadata:
nullable: true
type: object
additionalProperties:
type: string
description: >-
Arbitrary key-value pairs, if any were included in the corresponding access request
Arbitrary key-value pairs, if any were included in the corresponding
access request
example:
customKey1: custom value 1
customKey2: custom value 2

38
idn/v3/schemas/AccountActivityItem.yaml
View File

@@ -3,27 +3,28 @@ properties:
id:
type: string
description: Item id
example: 2725138ee34949beb0d6cc982d2d4625
example: 48c545831b264409a81befcabb0e3c5a
name:
type: string
description: Human-readable display name of item
example: 48c545831b264409a81befcabb0e3c5a
requested:
type: string
format: 'date-time'
format: "date-time"
description: Date and time item was requested
example: '2017-07-11T18:45:37.098Z'
example: "2017-07-11T18:45:37.098Z"
approvalStatus:
$ref: './WorkItemState.yaml'
$ref: "./WorkItemState.yaml"
provisioningStatus:
$ref: './ProvisioningState.yaml'
$ref: "./ProvisioningState.yaml"
requesterComment:
$ref: './Comment.yaml'
$ref: "./Comment.yaml"
reviewerIdentitySummary:
$ref: './IdentitySummary.yaml'
$ref: "./IdentitySummary.yaml"
reviewerComment:
$ref: './Comment.yaml'
$ref: "./Comment.yaml"
operation:
$ref: './AccountActivityItemOperation.yaml'
$ref: "./AccountActivityItemOperation.yaml"
attribute:
type: string
description: Attribute to which account activity applies
@@ -37,24 +38,31 @@ properties:
nativeIdentity:
nullable: true
type: string
description: Native identity in the target system to which the account activity applies
description:
Native identity in the target system to which the account activity applies
example: Sandie.Camero
sourceId:
type: string
description: Id of Source to which account activity applies
example: 2c91808363ef85290164000587130c0c
accountRequestInfo:
$ref: './AccountRequestInfo.yaml'
$ref: "./AccountRequestInfo.yaml"
clientMetadata:
nullable: true
type: object
additionalProperties:
type: string
description: >-
Arbitrary key-value pairs, if any were included in the corresponding access request item
Arbitrary key-value pairs, if any were included in the corresponding
access request item
example:
customKey1: custom value 1
customKey2: custom value 2
removeDate:
nullable: true
type: string
description: The date the role or access profile is no longer assigned to the specified identity.
format: 'date-time'
example: '2020-07-11T00:00:00Z'
description:
The date the role or access profile is no longer assigned to the specified
identity.
format: "date-time"
example: "2020-07-11T00:00:00Z"

1
idn/v3/schemas/AccountActivityItemOperation.yaml
View File

@@ -10,3 +10,4 @@ enum:
- LOCK
- REMOVE
description: Represents an operation in an account activity item
example: ADD

3
idn/v3/schemas/AccountAttributes.yaml
View File

@@ -1,10 +1,11 @@
type : object
type: object
required:
- attributes
properties:
attributes:
description: The schema attribute values for the account
type: object
additionalProperties: true
example:
city: Austin
displayName: John Doe

5
idn/v3/schemas/AccountAttributesCreate.yaml
View File

@@ -1,4 +1,4 @@
type : object
type: object
required:
- attributes
properties:
@@ -11,8 +11,7 @@ properties:
sourceId:
type: string
description: Target source to create an account
example:
34bfcbe116c9407464af37acbaf7a4dc
example: 34bfcbe116c9407464af37acbaf7a4dc
additionalProperties:
type: string
example:

4
idn/v3/schemas/ApprovalScheme.yaml
View File

@@ -6,4 +6,6 @@ enum:
- ROLE_OWNER
- ACCESS_PROFILE_OWNER
- GOVERNANCE_GROUP
description: Describes the individual or group that is responsible for an approval step.
description:
Describes the individual or group that is responsible for an approval step.
example: MANAGER

30
idn/v3/schemas/ApprovalStatusDto.yaml
View File

@@ -1,18 +1,21 @@
type : object
type: object
properties:
forwarded:
type: boolean
description: True if the request for this item was forwarded from one owner to another.
description:
True if the request for this item was forwarded from one owner to another.
example: false
originalOwner:
$ref: './BaseReferenceDto.yaml'
$ref: "./BaseReferenceDto.yaml"
description: >-
Base identity/workgroup reference object representing the original owner, if forwarded.
Base identity/workgroup reference object representing the original owner,
if forwarded.
currentOwner:
$ref: './BaseReferenceDto.yaml'
$ref: "./BaseReferenceDto.yaml"
description: >-
Base reference of approver that will make decision.
reviewedBy:
$ref: './BaseReferenceDto.yaml'
$ref: "./BaseReferenceDto.yaml"
description: The identity who has reviewed the approval.
modified:
type: string
@@ -20,20 +23,23 @@ properties:
description: Time at which item was modified.
example: "2019-08-23T18:52:57.398Z"
status:
$ref: './ManualWorkItemState.yaml'
$ref: "./ManualWorkItemState.yaml"
scheme:
$ref: './ApprovalScheme.yaml'
$ref: "./ApprovalScheme.yaml"
errorMessages:
type: array
items:
$ref: './ErrorMessageDto.yaml'
$ref: "./ErrorMessageDto.yaml"
description: >-
If the request failed, includes any error messages that were generated.
comment:
type: string
description: Comment, if any, provided by the approver.
example: I approve this request
removeDate:
type: string
description: The date the role or access profile is no longer assigned to the specified identity.
format: 'date-time'
example: '2020-07-11T00:00:00Z'
description:
The date the role or access profile is no longer assigned to the specified
identity.
format: "date-time"
example: "2020-07-11T00:00:00Z"

4
idn/v3/schemas/ApprovalSummary.yaml
View File

@@ -5,15 +5,13 @@ properties:
description: The number of pending access requests approvals.
format: int32
example: 0
approved:
type: integer
description: The number of approved access requests approvals.
format: int32
example: 0
rejected:
type: integer
description: The number of rejected access requests approvals.
format: int32
example: 0
example: 0

23
idn/v3/schemas/AttributeDefinition.yaml
View File

@@ -5,20 +5,24 @@ properties:
description: The name of the attribute.
example: sAMAccountName
type:
$ref: './AttributeDefinitionType.yaml'
$ref: "./AttributeDefinitionType.yaml"
description: The type of the attribute.
example: string
schema:
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
description: A reference to the schema on the source to which the values of the attribute map.
example: {
type: "CONNECTOR_SCHEMA",
id: "2c9180866166b5b0016167c32ef31a66",
name: "group"
}
$ref: "../../v3/schemas/BaseReferenceDto.yaml"
description:
A reference to the schema on the source to which the values of the
attribute map.
example:
{
type: "CONNECTOR_SCHEMA",
id: "2c9180866166b5b0016167c32ef31a66",
name: "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.
@@ -29,6 +33,7 @@ properties:
example: false
isGroup:
type: boolean
description: Flag indicating whether or not the attribute represents a group.
description:
Flag indicating whether or not the attribute represents a group.
example: false
readOnly: true

5
idn/v3/schemas/AttributeDefinitionType.yaml
View File

@@ -1,8 +1,9 @@
type: string
enum:
- STRING
- LONG
- INT
- BOOLEAN
description: The underlying type of the value which an AttributeDefinition represents.
description:
The underlying type of the value which an AttributeDefinition represents.
example: STRING

4
idn/v3/schemas/BaseCommonDto.yaml
View File

@@ -14,12 +14,12 @@ properties:
created:
description: Creation date of the Object
type: string
example: 2015-05-28T14:07:17Z
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
example: "2015-05-28T14:07:17Z"
format: date-time
readOnly: true

7
idn/v3/schemas/CertificationIdentitySummary.yaml
View File

@@ -1,4 +1,4 @@
type : object
type: object
properties:
id:
type: string
@@ -14,4 +14,7 @@ properties:
example: 2c9180857182306001719937377a33de
completed:
type: boolean
description: Indicates whether the review items for the linked identity's certification have been completed
description:
Indicates whether the review items for the linked identity's certification
have been completed
example: true

5
idn/v3/schemas/CertificationReference.yaml
View File

@@ -7,10 +7,11 @@ properties:
name:
type: string
description: The name of the certification.
example: 'Certification Name'
example: "Certification Name"
type:
type: string
enum:
- CERTIFICATION
example: CERTIFICATION
reviewer:
$ref: './Reviewer.yaml'
$ref: "./Reviewer.yaml"

1
idn/v3/schemas/CompletionStatus.yaml
View File

@@ -5,3 +5,4 @@ enum:
- FAILURE
- INCOMPLETE
- PENDING
example: SUCCESS

42
idn/v3/schemas/CreateOAuthClientRequest.yaml
View File

@@ -15,38 +15,51 @@ properties:
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
example:
An API client used for the authorization_code, refresh_token, and
client_credentials flows
accessTokenValiditySeconds:
type: string
description: The number of seconds an access token generated for this API Client is valid for
description:
The number of seconds an access token generated for this API Client is
valid for
type: integer
format: int32
example: 750
refreshTokenValiditySeconds:
type: string
description: The number of seconds a refresh token generated for this API Client is valid for
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. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client.
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
items:
$ref: '../schemas/GrantType.yaml'
description: A list of OAuth 2.0 grant types this API Client can be used with
$ref: "../schemas/GrantType.yaml"
description:
A list of OAuth 2.0 grant types this API Client can be used with
example: ["AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN"]
accessType:
$ref: '../schemas/AccessType.yaml'
$ref: "../schemas/AccessType.yaml"
description: The access type (online or offline) of this API Client
example: "OFFLINE"
type:
$ref: '../schemas/ClientType.yaml'
$ref: "../schemas/ClientType.yaml"
description: The type of the API Client (public or confidential)
example: "CONFIDENTIAL"
internal:
type: boolean
description: An indicator of whether the API Client can be used for requests internal within the product.
description:
An indicator of whether the API Client can be used for requests internal
within the product.
example: false
enabled:
type: boolean
@@ -54,11 +67,14 @@ properties:
example: true
strongAuthSupported:
type: boolean
description: An indicator of whether the API Client supports strong authentication
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
description:
An indicator of whether the API Client supports the serialization of SAML
claims when used with the authorization_code flow
example: false
required:
- name

61
idn/v3/schemas/CreateOAuthClientResponse.yaml
View File

@@ -6,7 +6,9 @@ properties:
example: 2c9180835d2e5168015d32f890ca1581
secret:
type: string
description: Secret of the OAuth client (This field is only returned on the intial create call.)
description:
Secret of the OAuth client (This field is only returned on the intial
create call.)
example: 5c32dd9b21adb51c77794d46e71de117a1d0ddb36a7ff941fa28014ab7de2cf3
businessName:
type: string
@@ -23,38 +25,50 @@ properties:
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
example:
An API client used for the authorization_code, refresh_token, and
client_credentials flows
accessTokenValiditySeconds:
type: string
description: The number of seconds an access token generated for this API Client is valid for
description:
The number of seconds an access token generated for this API Client is
valid for
example: 750
type: integer
format: int32
refreshTokenValiditySeconds:
type: string
description: The number of seconds a refresh token generated for this API Client is valid for
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
description:
A list of the approved redirect URIs used with the authorization_code flow
example: ["http://localhost:12345"]
grantTypes:
type: array
items:
$ref: '../schemas/GrantType.yaml'
description: A list of OAuth 2.0 grant types this API Client can be used with
$ref: "../schemas/GrantType.yaml"
description:
A list of OAuth 2.0 grant types this API Client can be used with
example: ["AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN"]
accessType:
$ref: '../schemas/AccessType.yaml'
$ref: "../schemas/AccessType.yaml"
description: The access type (online or offline) of this API Client
example: "OFFLINE"
type:
$ref: '../schemas/ClientType.yaml'
$ref: "../schemas/ClientType.yaml"
description: The type of the API Client (public or confidential)
example: "CONFIDENTIAL"
internal:
type: boolean
description: An indicator of whether the API Client can be used for requests internal to IDN
description:
An indicator of whether the API Client can be used for requests internal
to IDN
example: false
enabled:
type: boolean
@@ -62,22 +76,29 @@ properties:
example: true
strongAuthSupported:
type: boolean
description: An indicator of whether the API Client supports strong authentication
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
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'
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'
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"
required:
- id
- secret

21
idn/v3/schemas/EntitlementDto.yaml
View File

@@ -1,5 +1,5 @@
allOf:
- $ref: './BaseCommonDto.yaml'
- $ref: "./BaseCommonDto.yaml"
- type: object
description: Entitlement object that represents entitlement
properties:
@@ -14,23 +14,32 @@ allOf:
description:
description: Entitlment description
type: string
example: Active Directory DC
attributes:
description: Entitlement attributes
type: object
additionalProperties: true
example:
GroupType: Security
sAMAccountName: Buyer
sourceSchemaObjectType:
description: Schema objectType on the given application that maps to an Account Group
description:
Schema objectType on the given application that maps to an Account
Group
type: string
example: group
privileged:
description: Determines if this Entitlement is privileged.
type: boolean
example: false
cloudGoverned:
description: Determines if this Entitlement is goverened in the cloud.
type: boolean
example: false
source:
$ref: './BaseReferenceDto.yaml'
$ref: "./BaseReferenceDto.yaml"
description: Reference to the source this entitlment belongs to.
example:
- type: 'SOURCE'
id: '2c9180835d191a86015d28455b4b232a'
name: 'HR Active Directory'
- type: "SOURCE"
id: "2c9180835d191a86015d28455b4b232a"
name: "HR Active Directory"

9
idn/v3/schemas/ErrorMessageDto.yaml
View File

@@ -1,13 +1,14 @@
type : object
type: object
properties:
locale:
type: string
description: The locale for the message text, a BCP 47 language tag.
example: en-US
localeOrigin:
$ref: "../../v3/schemas/LocaleOrigin.yaml"
$ref: "./LocaleOrigin.yaml"
text:
type: string
description: Actual text of the error message in the indicated locale.
example: The request was syntactically correct but its content is semantically invalid.
example:
The request was syntactically correct but its content is semantically
invalid.

1
idn/v3/schemas/ExecutionStatus.yaml
View File

@@ -4,3 +4,4 @@ enum:
- VERIFYING
- TERMINATED
- COMPLETED
example: COMPLETED

3
idn/v3/schemas/ForwardApprovalDto.yaml
View File

@@ -6,10 +6,9 @@ properties:
newOwnerId:
type: string
description: The Id of the new owner
example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat
example: 2c91808568c529c60168cca6f90c1314
minLength: 1
maxLength: 255
comment:
type: string
description: The comment provided by the forwarder

16
idn/v3/schemas/IdentityCertDecisionSummary.yaml
View File

@@ -5,63 +5,79 @@ properties:
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'

10
idn/v3/schemas/IdentityCertificationDto.yaml
View File

@@ -5,9 +5,11 @@ 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:
$ref: './CampaignReference.yaml'
completed:
@@ -18,26 +20,32 @@ properties:
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'
@@ -54,9 +62,11 @@ properties:
reassignment:
$ref: './Reassignment.yaml'
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'

1
idn/v3/schemas/IdentityPreviewRequest.yaml
View File

@@ -4,6 +4,7 @@ properties:
type: string
format: uuid
example: 2c9180857893f12901789445619b0366
description: The Identity id
identityAttributeConfig:
type: array
items:

1
idn/v3/schemas/IdentityProfileExportedObject.yaml
View File

@@ -5,6 +5,7 @@ properties:
type: integer
example: 1
description: Version or object from the target service.
format: 'int32'
self:
$ref: '../schemas/BaseReferenceDto.yaml'
object:

1
idn/v3/schemas/IdentitySummary.yaml
View File

@@ -17,3 +17,4 @@ properties:
completed:
type: boolean
description: Indicates if all access items for this summary have been decided on
example: true

10
idn/v3/schemas/JsonPatch.yaml
View File

@@ -5,12 +5,4 @@ properties:
description: Operations to be applied
type: array
items:
$ref: './JsonPatchOperation.yaml'
example: >-
[
{
"op": "replace",
"path": "/description",
"value": "A new description"
}
]
$ref: './JsonPatchOperation.yaml'

2
idn/v3/schemas/ProvisioningConfig.yaml
View File

@@ -5,6 +5,7 @@ properties:
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
@@ -19,3 +20,4 @@ properties:
source:
description: This is a Rule that allows provisioning instruction changes.
type: string
example: <rule code>

4
idn/v3/schemas/ProvisioningPolicyDto.yaml
View File

@@ -4,8 +4,12 @@ required:
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:
$ref: '../schemas/UsageType.yaml'
fields:

1
idn/v3/schemas/ProvisioningState.yaml
View File

@@ -7,3 +7,4 @@ enum:
- FAILED
- RETRY
description: Provisioning state of an account activity item
example: PENDING

2
idn/v3/schemas/ReassignReference.yaml
View File

@@ -6,10 +6,12 @@ properties:
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

3
idn/v3/schemas/RequestableObject.yaml
View File

@@ -12,11 +12,13 @@ properties:
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.
@@ -35,6 +37,7 @@ properties:
requestCommentsRequired:
type: boolean
description: Whether the requester must provide comments when requesting the object.
example: false

1
idn/v3/schemas/RequestableObjectRequestStatus.yaml
View File

@@ -9,3 +9,4 @@ description: >-
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

2
idn/v3/schemas/ReviewDecision.yaml
View File

@@ -2,12 +2,14 @@ type : object
properties:
id:
type: string
description: The id of the review decision
example: ef38f94347e94562b5bb8424a56397d8
decision:
$ref: './CertificationDecision.yaml'
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

5
idn/v3/schemas/ReviewRecommendation.yaml
View File

@@ -4,11 +4,16 @@ properties:
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

4
idn/v3/schemas/Reviewer.yaml
View File

@@ -16,13 +16,17 @@ properties:
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.

8
idn/v3/schemas/ServiceDeskIntegrationDto.yaml
View File

@@ -15,6 +15,7 @@ allOf:
description: Type of the Service Desk integration
type: string
default: ServiceNowSDIM
example: ServiceNowSDIM
ownerRef:
description: Reference to the identity that is the owner of this Service Desk integration
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
@@ -36,6 +37,9 @@ allOf:
items:
type: string
deprecated: true
example:
- 2c9180835d191a86015d28455b4a2329
- 2c5680835d191a85765d28455b4a9823
provisioningConfig:
description: The 'provisioningConfig' property specifies the configuration used to provision integrations.
$ref: './ProvisioningConfig.yaml'
@@ -43,6 +47,10 @@ allOf:
description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation.
type: object
additionalProperties: true
example: {
property: "value",
key: "value"
}
beforeProvisioningRule:
description: Reference to beforeProvisioningRule for this Service Desk integration
$ref: '../../v3/schemas/BaseReferenceDto.yaml'

4
idn/v3/schemas/ServiceDeskIntegrationTemplateDto.yaml
View File

@@ -16,6 +16,10 @@ allOf:
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.
$ref: './ProvisioningConfig.yaml'

1
idn/v3/schemas/SourceFeature.yaml
View File

@@ -80,3 +80,4 @@ description: >-
* 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

6
idn/v3/schemas/SourceHealthDto.yaml
View File

@@ -21,17 +21,23 @@ properties:
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

2
idn/v3/schemas/UsageType.yaml
View File

@@ -17,3 +17,5 @@ enum:
- DISABLE
- UNLOCK
- CHANGE_PASSWORD
example: CREATE
description: The type of ProvisioningPolicy usage.

4
idn/v3/schemas/WorkItemState.yaml
View File

@@ -5,4 +5,6 @@ enum:
- RETURNED
- EXPIRED
- PENDING
- CANCELED
- CANCELED
example: FINISHED
description: The state of a work item

4
idn/v3/schemas/WorkItemType.yaml
View File

@@ -14,4 +14,6 @@ enum:
- SIGNOFF
- EVENT
- MANUALACTION
- TEST
- TEST
example: GENERIC
description: The type of the work item

5
idn/v3/schemas/WorkItems.yaml
View File

@@ -24,10 +24,12 @@ properties:
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
@@ -48,8 +50,10 @@ properties:
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:
@@ -59,5 +63,6 @@ properties:
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

Some files were not shown because too many files have changed in this diff Show More