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

Automated commit by github action: 5592156004

Browse Source
This commit is contained in:
GitHub Action Bot
2023-07-18 20:37:15 +00:00
parent 8455196bac
commit 361a4485cc
43 changed files with 3689 additions and 338 deletions
Download Patch File Download Diff File Expand all files Collapse all files

194
static/api-specs/idn/beta/paths/form-definition-data-source.yaml Normal file
View File

@@ -0,0 +1,194 @@
post:
tags:
- Custom Forms
summary: Preview form definition data source.
operationId: showPreviewDataSource
parameters:
- name: formDefinitionID
in: path
description: Form definition ID
required: true
schema:
type: string
x-go-name: FormDefinitionID
example: 00000000-0000-0000-0000-000000000000
x-go-name: FormDefinitionID
- name: limit
in: query
description: |-
Limit
Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).
If it is not specified, a default limit is used.
schema:
type: integer
format: int64
maxLength: 250
minLength: 0
default: 10
x-go-name: Limit
example: 10
required: false
x-go-name: Limit
- name: filters
in: query
description: |-
Filters
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:
<b>value</b>: <i>eq, gt, sw, in</i>
<b>label</b>: <i>eq, gt, sw, in</i>
<b>subLabel</b>: <i>eq, gt, sw, in</i>
schema:
type: string
x-go-name: Filters
example: label sw "my label"
required: false
x-go-name: Filters
- name: query
in: query
description: |-
Query
String specifying to query against
schema:
type: string
x-go-name: Query
example: support
required: false
x-go-name: Query
requestBody:
description: Body is the request payload to create a form definition dynamic
schema
content:
application/json:
schema:
$ref: '../schemas/forms/FormElementPreviewRequest.yaml'
required: false
responses:
"200":
description: Returns a preview of a form definition data source
content:
application/json:
schema:
$ref: '../schemas/forms/PreviewDataSourceResponse.yaml'
"400":
description: An error with the request occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"401":
description: An error with the authorization occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"403":
description: An error with the user permissions occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"404":
description: An error with the item not found
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"429":
description: Too many requests
content:
application/json:
schema:
$ref: '../schemas/forms/Error.yaml'
"500":
description: An internal server error occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
security:
- oauth2:
- sp:forms:manage

149
static/api-specs/idn/beta/paths/form-definition-forms-action-dynamic-schema.yaml Normal file
View File

@@ -0,0 +1,149 @@
post:
tags:
- Custom Forms
summary: Generate JSON Schema dynamically.
operationId: createFormDefinitionDynamicSchema
requestBody:
description: Body is the request payload to create a form definition dynamic
schema
content:
application/json:
schema:
$ref: '../schemas/forms/FormDefinitionDynamicSchemaRequest.yaml'
example: {
"id": "sp:forms",
"attributes": {
"formDefinitionId": "00000000-0000-0000-0000-000000000000"
},
"description": "AnotherDescription",
"type": "action",
"versionNumber": 1
}
required: false
responses:
"200":
description: Returns a form elements dynamic schema
content:
application/json:
schema:
$ref: '../schemas/forms/FormDefinitionDynamicSchemaResponse.yaml'
"400":
description: An error with the request occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"401":
description: An error with the authorization occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"403":
description: An error with the user permissions occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"404":
description: An error with the item not found
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"429":
description: Too many requests
content:
application/json:
schema:
$ref: '../schemas/forms/Error.yaml'
"500":
description: An internal server error occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
security:
- oauth2:
- sp:forms:manage
x-codegen-request-body-name: Body

438
static/api-specs/idn/beta/paths/form-definition.yaml Normal file
View File

@@ -0,0 +1,438 @@
get:
tags:
- Custom Forms
summary: Return a form definition.
description: Parameter `{formDefinitionID}` should match a form definition ID.
operationId: getFormDefinitionByKey
parameters:
- name: formDefinitionID
in: path
description: Form definition ID
required: true
schema:
type: string
x-go-name: FormDefinitionID
example: 00000000-0000-0000-0000-000000000000
x-go-name: FormDefinitionID
responses:
"200":
description: Returns a form definition
content:
application/json:
schema:
$ref: '../schemas/forms/FormDefinitionResponse.yaml'
"400":
description: An error with the request occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"401":
description: An error with the authorization occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"403":
description: An error with the user permissions occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"404":
description: An error with the item not found
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"429":
description: Too many requests
content:
application/json:
schema:
$ref: '../schemas/forms/Error.yaml'
"500":
description: An internal server error occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
security:
- oauth2:
- sp:forms:manage
delete:
tags:
- Custom Forms
summary: Deletes a form definition.
description: Parameter `{formDefinitionID}` should match a form definition ID.
operationId: deleteFormDefinition
parameters:
- name: formDefinitionID
in: path
description: Form definition ID
required: true
schema:
type: string
x-go-name: FormDefinitionID
example: 00000000-0000-0000-0000-000000000000
x-go-name: FormDefinitionID
responses:
"204":
description: Returns an empty body
content:
application/json:
schema:
$ref: '../schemas/forms/Nil.yaml'
"400":
description: An error with the request occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"401":
description: An error with the authorization occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"403":
description: An error with the user permissions occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"404":
description: An error with the item not found
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"429":
description: Too many requests
content:
application/json:
schema:
$ref: '../schemas/forms/Error.yaml'
"500":
description: An internal server error occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
security:
- oauth2:
- sp:forms:manage
patch:
tags:
- Custom Forms
summary: Patch a form definition.
description: Parameter `{formDefinitionID}` should match a form definition ID.
operationId: patchFormDefinition
parameters:
- name: formDefinitionID
in: path
description: Form definition ID
required: true
schema:
type: string
x-go-name: FormDefinitionID
example: 00000000-0000-0000-0000-000000000000
x-go-name: FormDefinitionID
requestBody:
description: 'Body is the request payload to patch a form definition, check:
https://jsonpatch.com'
content:
application/json:
schema:
$ref: '../schemas/forms/Patch.yaml'
example: [
{ "op": "replace", "path": "/description", "value": "test-description" },
]
required: false
responses:
"200":
description: Returns the form definition updated
content:
application/json:
schema:
$ref: '../schemas/forms/FormDefinitionResponse.yaml'
"400":
description: An error with the request occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"401":
description: An error with the authorization occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"403":
description: An error with the user permissions occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"404":
description: An error with the user permissions occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"429":
description: Too many requests
content:
application/json:
schema:
$ref: '../schemas/forms/Error.yaml'
"500":
description: An internal server error occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
security:
- oauth2:
- sp:forms:manage
x-codegen-request-body-name: Body

191
static/api-specs/idn/beta/paths/form-definitions-export.yaml Normal file
View File

@@ -0,0 +1,191 @@
get:
tags:
- Custom Forms
summary: List form definitions by tenant.
description: No parameters required.
operationId: exportFormDefinitionsByTenant
parameters:
- name: offset
in: query
description: |-
Offset
Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).
The offset value is record-based, not page-based, and the index starts at 0.
schema:
type: integer
format: int64
default: 0
x-go-name: Offset
example: 0
required: false
x-go-name: Offset
- name: limit
in: query
description: |-
Limit
Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).
If it is not specified, a default limit is used.
schema:
type: integer
format: int64
maxLength: 250
minLength: 0
default: 250
x-go-name: Limit
example: 250
required: false
x-go-name: Limit
- name: filters
in: query
description: |-
Filters
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:
<b>name</b>: <i>eq, gt, sw, in</i>
<b>description</b>: <i>eq, gt, sw, in</i>
<b>created</b>: <i>eq, gt, sw, in</i>
<b>modified</b>: <i>eq, gt, sw, in</i>
schema:
type: string
x-go-name: Filters
example: name sw "my form"
required: false
x-go-name: Filters
- name: sorters
in: query
description: |-
Sorters
Item will be sorted in the returned array if the sorters expression evaluates to true for that item. 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:
<b>name</b>
<b>description</b>
<b>created</b>
<b>modified</b>
schema:
type: string
default: name
x-go-name: Sorters
example: name
required: false
x-go-name: Sorters
responses:
"200":
description: Returns a list of form definition objects by tenant used by
SP-Config
content:
application/json:
schema:
type: array
items:
type: object
properties:
object:
$ref: '../schemas/forms/FormDefinitionResponse.yaml'
self:
type: string
x-go-name: Self
version:
type: integer
format: int8
x-go-name: Version
"400":
description: An error with the request occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"401":
description: An error with the authorization occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"403":
description: An error with the user permissions occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"429":
description: Too many requests
content:
application/json:
schema:
$ref: '../schemas/forms/Error.yaml'
"500":
description: An internal server error occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
security:
- oauth2:
- sp:forms:manage

283
static/api-specs/idn/beta/paths/form-definitions-import.yaml Normal file
View File

@@ -0,0 +1,283 @@
post:
tags:
- Custom Forms
summary: Import form definitions from export.
operationId: importFormDefinitions
requestBody:
description: Body is the request payload to import form definitions
content:
application/json:
schema:
type: array
items:
type: object
properties:
object:
$ref: '../schemas/forms/FormDefinitionResponse.yaml'
self:
type: string
x-go-name: Self
version:
type: integer
format: int8
x-go-name: Version
example: [
{
"version": 1,
"self": {
"name": "All fields not required",
"id": "05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa",
"type": "FORM_DEFINITION"
},
"object": {
"id": "05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa",
"name": "All fields not required",
"description": "description",
"owner": {
"type": "IDENTITY",
"id": "3447d8ec2602455ab6f1e8408a0f0150"
},
"usedBy": [
{
"type": "WORKFLOW",
"id": "5008594c-dacc-4295-8fee-41df60477304"
},
{
"type": "WORKFLOW",
"id": "97e75a75-c179-4fbc-a2da-b5fa4aaa8743"
}
],
"formInput": [
{
"type": "STRING",
"label": "input1",
"description": "A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic"
}
],
"formElements": [
{
"id": "3069272797630701",
"elementType": "SECTION",
"config": {
"label": "First Section",
"formElements": [
{
"id": "3069272797630700",
"elementType": "TEXT",
"key": "firstName",
"config": {
"label": "First Name"
}
},
{
"id": "3498415402897539",
"elementType": "TEXT",
"key": "lastName",
"config": {
"label": "Last Name"
}
}
]
}
}
],
"formConditions": [
{
"ruleOperator": "AND",
"rules": [
{
"sourceType": "INPUT",
"source": "Department",
"operator": "EQ",
"valueType": "STRING",
"value": "Sales"
}
],
"effects": [
{
"effectType": "HIDE",
"config": {
"element": "2614088730489570"
}
}
]
}
],
"created": "2022-10-04T19:27:04.456Z",
"modified": "2022-11-16T20:45:02.172Z"
}
}
]
required: false
responses:
"202":
description: Returns statuses of those form definition objects imported
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
detail:
type: object
additionalProperties:
type: object
x-go-name: Detail
key:
type: string
x-go-name: Key
text:
type: string
x-go-name: Text
x-go-name: Errors
importedObjects:
type: array
items:
type: object
properties:
object:
$ref: '../schemas/forms/FormDefinitionResponse.yaml'
self:
type: string
x-go-name: Self
version:
type: integer
format: int8
x-go-name: Version
x-go-name: ImportedObjects
infos:
type: array
items:
type: object
properties:
detail:
type: object
additionalProperties:
type: object
x-go-name: Detail
key:
type: string
x-go-name: Key
text:
type: string
x-go-name: Text
x-go-name: Infos
warnings:
type: array
items:
type: object
properties:
detail:
type: object
additionalProperties:
type: object
x-go-name: Detail
key:
type: string
x-go-name: Key
text:
type: string
x-go-name: Text
x-go-name: Warnings
"400":
description: An error with the request occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"401":
description: An error with the authorization occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"403":
description: An error with the user permissions occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"429":
description: Too many requests
content:
application/json:
schema:
$ref: '../schemas/forms/Error.yaml'
"500":
description: An internal server error occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
security:
- oauth2:
- sp:forms:manage
x-codegen-request-body-name: Body

303
static/api-specs/idn/beta/paths/form-definitions.yaml Normal file
View File

@@ -0,0 +1,303 @@
get:
tags:
- Custom Forms
summary: Export form definitions by tenant.
description: No parameters required.
operationId: searchFormDefinitionsByTenant
parameters:
- name: offset
in: query
description: |-
Offset
Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).
The offset value is record-based, not page-based, and the index starts at 0.
schema:
type: integer
format: int64
default: 0
x-go-name: Offset
example: 250
required: false
x-go-name: Offset
- name: limit
in: query
description: |-
Limit
Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).
If it is not specified, a default limit is used.
schema:
type: integer
format: int64
maxLength: 250
minLength: 0
default: 250
x-go-name: Limit
example: 250
required: false
x-go-name: Limit
- name: filters
in: query
description: |-
Filters
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:
<b>name</b>: <i>eq, gt, sw, in</i>
<b>description</b>: <i>eq, gt, sw, in</i>
<b>created</b>: <i>eq, gt, sw, in</i>
<b>modified</b>: <i>eq, gt, sw, in</i>
schema:
type: string
x-go-name: Filters
example: name sw "my form"
required: false
x-go-name: Filters
- name: sorters
in: query
description: |-
Sorters
Item will be sorted in the returned array if the sorters expression evaluates to true for that item. 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:
<b>name</b>
<b>description</b>
<b>created</b>
<b>modified</b>
schema:
type: string
default: name
x-go-name: Sorters
example: name
required: false
x-go-name: Sorters
responses:
"200":
description: Returns a list of form definitions by tenant
content:
application/json:
schema:
$ref: '../schemas/forms/ListFormDefinitionsByTenantResponse.yaml'
"400":
description: An error with the request occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"401":
description: An error with the authorization occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"403":
description: An error with the user permissions occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"429":
description: Too many requests
content:
application/json:
schema:
$ref: '../schemas/forms/Error.yaml'
"500":
description: An internal server error occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
security:
- oauth2:
- sp:forms:manage
post:
tags:
- Custom Forms
summary: Creates a form definition.
operationId: createFormDefinition
requestBody:
description: Body is the request payload to create form definition request
content:
application/json:
schema:
$ref: '../schemas/forms/CreateFormDefinitionRequest.yaml'
example: {
"name": "my form",
"description": "my form description",
"owner": {
"type": "IDENTITY",
"id": "00000000-0000-0000-0000-000000000000"
}
}
required: false
responses:
"201":
description: Returns a new form definition
content:
application/json:
schema:
$ref: '../schemas/forms/FormDefinitionResponse.yaml'
"400":
description: An error with the request occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"401":
description: An error with the authorization occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"403":
description: An error with the user permissions occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"429":
description: Too many requests
content:
application/json:
schema:
$ref: '../schemas/forms/Error.yaml'
"500":
description: An internal server error occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
security:
- oauth2:
- sp:forms:manage
x-codegen-request-body-name: Body

186
static/api-specs/idn/beta/paths/form-instance-data-source.yaml Normal file
View File

@@ -0,0 +1,186 @@
get:
tags:
- Custom Forms
summary: Retrieves dynamic data by element.
description: |-
Parameter `{formInstanceID}` should match a form instance ID.
Parameter `{formElementID}` should match a form element ID at the data source configuration.
operationId: searchFormElementDataByElementID
parameters:
- name: formInstanceID
in: path
description: Form instance ID
required: true
schema:
type: string
x-go-name: FormInstanceID
example: 00000000-0000-0000-0000-000000000000
x-go-name: FormInstanceID
- name: formElementID
in: path
description: Form element ID
required: true
schema:
type: string
x-go-name: FormElementID
example: 1
x-go-name: FormElementID
- name: limit
in: query
description: |-
Limit
Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).
If it is not specified, a default limit is used.
schema:
type: integer
format: int64
maxLength: 250
minLength: 0
default: 250
x-go-name: Limit
example: 250
required: false
x-go-name: Limit
- name: filters
in: query
description: |-
Filters
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:
<b>value</b>: <i>eq, ne, in</i>
<b>label</b>: <i>eq, ne, in</i>
<b>subLabel</b>: <i>eq, ne, in</i>
schema:
type: string
x-go-name: Filters
example: label sw "my label"
required: false
x-go-name: Filters
responses:
"200":
description: Retrieves dynamic data to aid in correctly completing a valid
form by form element ID from data source configuration
content:
application/json:
schema:
$ref: '../schemas/forms/ListFormElementDataByElementIDResponse.yaml'
"400":
description: An error with the request occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"401":
description: An error with the authorization occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"403":
description: An error with the user permissions occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"404":
description: An error with the item not found
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"429":
description: Too many requests
content:
application/json:
schema:
$ref: '../schemas/forms/Error.yaml'
"500":
description: An internal server error occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
security:
- oauth2: [ ]

317
static/api-specs/idn/beta/paths/form-instance.yaml Normal file
View File

@@ -0,0 +1,317 @@
get:
tags:
- Custom Forms
summary: Returns a form instance.
description: Parameter `{formInstanceID}` should match a form instance ID.
operationId: getFormInstanceByKey
parameters:
- name: formInstanceID
in: path
description: Form instance ID
required: true
schema:
type: string
x-go-name: FormInstanceID
example: 00000000-0000-0000-0000-000000000000
x-go-name: FormInstanceID
responses:
"200":
description: Returns a form instance by its key
content:
application/json:
schema:
$ref: '../schemas/forms/FormInstanceResponse.yaml'
"400":
description: An error with the request occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"401":
description: An error with the authorization occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"403":
description: An error with the user permissions occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"404":
description: An error with the item not found
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"429":
description: Too many requests
content:
application/json:
schema:
$ref: '../schemas/forms/Error.yaml'
"500":
description: An internal server error occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
security:
- oauth2: [ ]
patch:
tags:
- Custom Forms
summary: Patch a form instance.
description: Parameter `{formInstanceID}` should match a form instance ID.
operationId: patchFormInstance
parameters:
- name: formInstanceID
in: path
description: Form instance ID
required: true
schema:
type: string
x-go-name: FormInstanceID
example: 00000000-0000-0000-0000-000000000000
x-go-name: FormInstanceID
requestBody:
description: 'Body is the request payload to patch a form instance, check:
https://jsonpatch.com'
content:
application/json:
schema:
$ref: '../schemas/forms/Patch.yaml'
example: [
{ "op": "replace", "path": "/state", "value": "SUBMITTED" },
{ "op": "replace", "path": "/formData", "value": { "a-key-1": "a-value-1", "a-key-2": true, "a-key-3": 1 } }
]
required: false
responses:
"200":
description: Returns the form instance updated
content:
application/json:
schema:
$ref: '../schemas/forms/FormInstanceResponse.yaml'
"400":
description: An error with the request occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"401":
description: An error with the authorization occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"403":
description: An error with the user permissions occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"404":
description: An error with the item not found
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"409":
description: An error with the request property conflicts with stored
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"429":
description: Too many requests
content:
application/json:
schema:
$ref: '../schemas/forms/Error.yaml'
"500":
description: An internal server error occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
security:
- oauth2: [ ]
x-codegen-request-body-name: Body

239
static/api-specs/idn/beta/paths/form-instances.yaml Normal file
View File

@@ -0,0 +1,239 @@
get:
tags:
- Custom Forms
summary: List form instances by tenant.
description: No parameters required.
operationId: searchFormInstancesByTenant
responses:
"200":
description: Returns a list of form instances by tenant
content:
application/json:
schema:
$ref: '../schemas/forms/ListFormInstancesByTenantResponse.yaml'
"400":
description: An error with the request occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"401":
description: An error with the authorization occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"403":
description: An error with the user permissions occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"429":
description: Too many requests
content:
application/json:
schema:
$ref: '../schemas/forms/Error.yaml'
"500":
description: An internal server error occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
security:
- oauth2:
- sp:forms:manage
post:
tags:
- Custom Forms
summary: Creates a form instance.
operationId: createFormInstance
requestBody:
description: Body is the request payload to create a form instance
content:
application/json:
schema:
$ref: '../schemas/forms/CreateFormInstanceRequest.yaml'
example: {
"expire": "2023-06-20T15:57:55.332882Z",
"formDefinitionId": "00000000-0000-0000-0000-000000000000",
"recipients": [ {
type: "IDENTITY",
id: "an-identity-id"
} ],
"createdBy": {
"type": "WORKFLOW_EXECUTION",
"id": "a-workflow-execution-id"
},
}
required: false
responses:
"201":
description: Returns a new form instance
content:
application/json:
schema:
$ref: '../schemas/forms/FormInstanceResponse.yaml'
"400":
description: An error with the request occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"401":
description: An error with the authorization occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"403":
description: An error with the user permissions occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"429":
description: Too many requests
content:
application/json:
schema:
$ref: '../schemas/forms/Error.yaml'
"500":
description: An internal server error occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
security:
- oauth2:
- sp:forms:manage
x-codegen-request-body-name: Body

110
static/api-specs/idn/beta/paths/forms-predefined-select-options.yaml Normal file
View File

@@ -0,0 +1,110 @@
get:
tags:
- Custom Forms
summary: List predefined select options.
description: No parameters required.
operationId: searchPreDefinedSelectOptions
responses:
"200":
description: Returns a list of available predefined select options
content:
application/json:
schema:
$ref: '../schemas/forms/ListPredefinedSelectOptionsResponse.yaml'
"400":
description: An error with the request occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"401":
description: An error with the authorization occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"403":
description: An error with the user permissions occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
"429":
description: Too many requests
content:
application/json:
schema:
$ref: '../schemas/forms/Error.yaml'
"500":
description: An internal server error occurred
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: '../schemas/forms/ErrorMessage.yaml'
x-go-name: Messages
statusCode:
type: integer
format: int64
x-go-name: StatusCode
trackingId:
type: string
x-go-name: TrackingID
security:
- oauth2:
- sp:forms:manage

45
static/api-specs/idn/beta/schemas/forms/ConditionEffect.yaml Normal file
View File

@@ -0,0 +1,45 @@
description: ConditionEffect is the effect produced by a condition
properties:
config:
additionalProperties: { }
description: Config is a arbitrary map that holds a configuration based on EffectType
example: {}
type: object
x-go-name: Config
effectType:
description: |-
EffectType is the type of effect to perform when the conditions are evaluated for this logic block
HIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations
SHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations
DISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations
ENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations
REQUIRE ConditionEffectTypeRequire
OPTIONAL ConditionEffectTypeOptional
SUBMIT_MESSAGE ConditionEffectTypeSubmitMessage
SUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification
SET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose
enum:
- HIDE
- SHOW
- DISABLE
- ENABLE
- REQUIRE
- OPTIONAL
- SUBMIT_MESSAGE
- SUBMIT_NOTIFICATION
- SET_DEFAULT_VALUE
example: HIDE
type: string
x-go-enum-desc: |-
HIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations
SHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations
DISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations
ENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations
REQUIRE ConditionEffectTypeRequire
OPTIONAL ConditionEffectTypeOptional
SUBMIT_MESSAGE ConditionEffectTypeSubmitMessage
SUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification
SET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose
x-go-name: EffectType
type: object
x-go-package: github.com/sailpoint/sp-forms/domain

98
static/api-specs/idn/beta/schemas/forms/ConditionRule.yaml Normal file
View File

@@ -0,0 +1,98 @@
properties:
operator:
description: |-
Operator is a ConditionRuleComparisonOperatorType value
EQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality
NE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality
CO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value
NOT_CO ConditionRuleComparisonOperatorTypeNotContains
IN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values
NOT_IN ConditionRuleComparisonOperatorTypeNotIncludes
EM ConditionRuleComparisonOperatorTypeEmpty
NOT_EM ConditionRuleComparisonOperatorTypeNotEmpty
SW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive
NOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith
EW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive
NOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith
enum:
- EQ
- NE
- CO
- NOT_CO
- IN
- NOT_IN
- EM
- NOT_EM
- SW
- NOT_SW
- EW
- NOT_EW
example: EQ
type: string
x-go-enum-desc: |-
EQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality
NE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality
CO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value
NOT_CO ConditionRuleComparisonOperatorTypeNotContains
IN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values
NOT_IN ConditionRuleComparisonOperatorTypeNotIncludes
EM ConditionRuleComparisonOperatorTypeEmpty
NOT_EM ConditionRuleComparisonOperatorTypeNotEmpty
SW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive
NOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith
EW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive
NOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith
x-go-name: Operator
source:
description: |-
Source, if the sourceType is ConditionRuleSourceTypeInput then the source type is the name of the form input to accept. While if the sourceType is ConditionRuleSourceTypeElement
then source is the name of a technical key of an element to retrieve its value
example: department
type: string
x-go-name: Source
sourceType:
description: |-
SourceType defines what type of object is being selected. Either a reference to a form input (by input name), or a form element (by technical key)
INPUT ConditionRuleSourceTypeInput
ELEMENT ConditionRuleSourceTypeElement
enum:
- INPUT
- ELEMENT
example: ELEMENT
type: string
x-go-enum-desc: |-
INPUT ConditionRuleSourceTypeInput
ELEMENT ConditionRuleSourceTypeElement
x-go-name: SourceType
value:
description: Value is the value based on the ValueType
example: Engineering
x-go-name: Value
valueType:
description: |-
ValueType is a ConditionRuleValueType type
STRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string
STRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values
INPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by
ELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)
LIST ConditionRuleValueTypeList
BOOLEAN ConditionRuleValueTypeBoolean
enum:
- STRING
- STRING_LIST
- INPUT
- ELEMENT
- LIST
- BOOLEAN
example: STRING
type: string
x-go-enum-desc: |-
STRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string
STRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values
INPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by
ELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)
LIST ConditionRuleValueTypeList
BOOLEAN ConditionRuleValueTypeBoolean
x-go-name: ValueType
type: object
x-go-package: github.com/sailpoint/sp-forms/domain

45
static/api-specs/idn/beta/schemas/forms/CreateFormDefinitionRequest.yaml Normal file
View File

@@ -0,0 +1,45 @@
properties:
description:
description: Description is the form definition description
example: My form description
maxLength: 2000
minLength: 0
type: string
x-go-name: Description
formConditions:
description: FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form
items:
$ref: './FormCondition.yaml'
type: array
x-go-name: FormConditions
formElements:
description: FormElements is a list of nested form elements
items:
$ref: './FormElement.yaml'
type: array
x-go-name: FormElements
formInput:
description: FormInput is a list of form inputs that are required when creating a form-instance object
items:
$ref: './FormDefinitionInput.yaml'
type: array
x-go-name: FormInput
name:
description: Name is the form definition name
example: My form
maxLength: 255
type: string
x-go-name: Name
owner:
$ref: './FormOwner.yaml'
usedBy:
description: UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used
items:
$ref: './FormUsedBy.yaml'
type: array
x-go-name: UsedBy
required:
- name
- owner
type: object
x-go-package: github.com/sailpoint/sp-forms/domain

70
static/api-specs/idn/beta/schemas/forms/CreateFormInstanceRequest.yaml Normal file
View File

@@ -0,0 +1,70 @@
properties:
createdBy:
$ref: './FormInstanceCreatedBy.yaml'
expire:
description: Expire is required
example: "2023-08-12T20:14:57.74486Z"
type: string
x-go-name: Expire
formDefinitionId:
description: FormDefinitionID is the id of the form definition that created this form
example: 00000000-0000-0000-0000-000000000000
type: string
x-go-name: FormDefinitionID
formInput:
additionalProperties: { }
description: FormInput is an object of form input labels to value
example:
input1: Sales
type: object
x-go-name: FormInput
recipients:
description: Recipients is required
items:
$ref: './FormInstanceRecipient.yaml'
type: array
x-go-name: Recipients
standAloneForm:
default: false
description: StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form
example: false
type: boolean
x-go-name: StandAloneForm
state:
description: |-
State is required, if not present initial state is FormInstanceStateAssigned
ASSIGNED FormInstanceStateAssigned
IN_PROGRESS FormInstanceStateInProgress
SUBMITTED FormInstanceStateSubmitted
COMPLETED FormInstanceStateCompleted
CANCELLED FormInstanceStateCancelled
enum:
- ASSIGNED
- IN_PROGRESS
- SUBMITTED
- COMPLETED
- CANCELLED
example: ASSIGNED
type: string
x-go-enum-desc: |-
ASSIGNED FormInstanceStateAssigned
IN_PROGRESS FormInstanceStateInProgress
SUBMITTED FormInstanceStateSubmitted
COMPLETED FormInstanceStateCompleted
CANCELLED FormInstanceStateCancelled
x-go-name: State
ttl:
description: |-
TTL an epoch timestamp in seconds, it most be in seconds or dynamodb will ignore it
SEE: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/time-to-live-ttl-before-you-start.html
example: 1571827560
format: int64
type: integer
x-go-name: TTL
required:
- expire
- recipients
- createdBy
- formDefinitionId
type: object
x-go-package: github.com/sailpoint/sp-forms/domain

19
static/api-specs/idn/beta/schemas/forms/Error.yaml Normal file
View File

@@ -0,0 +1,19 @@
title: Error is the standard API error response type.
type: object
properties:
detailCode:
description: DetailCode is the text of the status code returned
example: Internal Server Error
type: string
x-go-name: DetailCode
messages:
type: array
items:
$ref: './ErrorMessage.yaml'
x-go-name: Messages
trackingId:
description: TrackingID is the request tracking unique identifier
example: 9cd03ef80e6a425eb6b11bdbb057cdb4
type: string
x-go-name: TrackingID
x-go-package: github.com/sailpoint/atlas-go/atlas/web

19
static/api-specs/idn/beta/schemas/forms/ErrorMessage.yaml Normal file
View File

@@ -0,0 +1,19 @@
title: ErrorMessage is the standard API error response message type.
type: object
properties:
locale:
description: Locale is the current Locale
example: en-US
type: string
x-go-name: Locale
localeOrigin:
description: LocaleOrigin holds possible values of how the locale was selected
example: DEFAULT
type: string
x-go-name: LocaleOrigin
text:
description: Text is the actual text of the error message
example: This is an error
type: string
x-go-name: Text
x-go-package: github.com/sailpoint/atlas-go/atlas/web

30
static/api-specs/idn/beta/schemas/forms/FormCondition.yaml Normal file
View File

@@ -0,0 +1,30 @@
description: FormCondition represent a form conditional
properties:
effects:
description: Effects is a list of effects
items:
$ref: './ConditionEffect.yaml'
type: array
x-go-name: Effects
ruleOperator:
description: |-
RuleOperator is a ConditionRuleLogicalOperatorType value
AND ConditionRuleLogicalOperatorTypeAnd
OR ConditionRuleLogicalOperatorTypeOr
enum:
- AND
- OR
example: AND
type: string
x-go-enum-desc: |-
AND ConditionRuleLogicalOperatorTypeAnd
OR ConditionRuleLogicalOperatorTypeOr
x-go-name: RuleOperator
rules:
description: Rules is a list of rules
items:
$ref: './ConditionRule.yaml'
type: array
x-go-name: Rules
type: object
x-go-package: github.com/sailpoint/sp-forms/domain

33
static/api-specs/idn/beta/schemas/forms/FormDefinitionDynamicSchemaRequest.yaml Normal file
View File

@@ -0,0 +1,33 @@
properties:
attributes:
properties:
formDefinitionId:
description: FormDefinitionID is a unique guid identifying this form definition
example: 00000000-0000-0000-0000-000000000000
type: string
x-go-name: FormDefinitionID
type: object
x-go-name: Attributes
description:
description: Description is the form definition dynamic schema description text
example: A description
type: string
x-go-name: Description
id:
description: ID is a unique identifier
example: 00000000-0000-0000-0000-000000000000
type: string
x-go-name: ID
type:
description: Type is the form definition dynamic schema type
example: action
type: string
x-go-name: Type
versionNumber:
description: VersionNumber is the form definition dynamic schema version number
example: 1
format: int64
type: integer
x-go-name: VersionNumber
type: object
x-go-package: github.com/sailpoint/sp-forms/domain

27
static/api-specs/idn/beta/schemas/forms/FormDefinitionDynamicSchemaResponse.yaml Normal file
View File

@@ -0,0 +1,27 @@
properties:
outputSchema:
additionalProperties: { }
description: OutputSchema holds a JSON schema generated dynamically
example:
outputSchema:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
properties:
firstName:
title: First Name
type: string
fullName:
title: Full Name
type: string
lastName:
title: Last Name
type: string
startDate:
format: date-time
title: Start Date
type: string
type: object
type: object
x-go-name: OutputSchema
type: object
x-go-package: github.com/sailpoint/sp-forms/domain

28
static/api-specs/idn/beta/schemas/forms/FormDefinitionInput.yaml Normal file
View File

@@ -0,0 +1,28 @@
properties:
description:
description: Description is the description for this form input value
example: A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic
type: string
x-go-name: Description
id:
description: ID is a unique identifier
example: 00000000-0000-0000-0000-000000000000
type: string
x-go-name: ID
label:
description: Label is the name for this form input value
example: input1
type: string
x-go-name: Label
type:
description: |-
Type is a FormDefinitionInputType value
STRING FormDefinitionInputTypeString
enum:
- STRING
example: STRING
type: string
x-go-enum-desc: STRING FormDefinitionInputTypeString
x-go-name: Type
type: object
x-go-package: github.com/sailpoint/sp-forms/domain

56
static/api-specs/idn/beta/schemas/forms/FormDefinitionResponse.yaml Normal file
View File

@@ -0,0 +1,56 @@
properties:
created:
description: Created is the date the form definition was created
example: "2023-07-12T20:14:57.74486Z"
format: date-time
type: string
x-go-name: Created
description:
description: Description is the form definition description
example: My form description
type: string
x-go-name: Description
formConditions:
description: FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form
items:
$ref: './FormCondition.yaml'
type: array
x-go-name: FormConditions
formElements:
description: FormElements is a list of nested form elements
items:
$ref: './FormElement.yaml'
type: array
x-go-name: FormElements
formInput:
description: FormInput is a list of form inputs that are required when creating a form-instance object
items:
$ref: './FormDefinitionInput.yaml'
type: array
x-go-name: FormInput
id:
description: FormDefinitionID is a unique guid identifying this form definition
example: 00000000-0000-0000-0000-000000000000
type: string
x-go-name: FormDefinitionID
modified:
description: Modified is the last date the form definition was modified
example: "2023-07-12T20:14:57.74486Z"
format: date-time
type: string
x-go-name: Modified
name:
description: Name is the form definition name
example: My form
type: string
x-go-name: Name
owner:
$ref: './FormOwner.yaml'
usedBy:
description: UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used
items:
$ref: './FormUsedBy.yaml'
type: array
x-go-name: UsedBy
type: object
x-go-package: github.com/sailpoint/sp-forms/domain

60
static/api-specs/idn/beta/schemas/forms/FormElement.yaml Normal file
View File

@@ -0,0 +1,60 @@
properties:
config:
additionalProperties: { }
description: Config is a config object
example:
label: Department
type: object
x-go-name: Config
elementType:
description: |-
ElementType is a FormElementType value
TEXT FormElementTypeText
TOGGLE FormElementTypeToggle
TEXTAREA FormElementTypeTextArea
HIDDEN FormElementTypeHidden
PHONE FormElementTypePhone
EMAIL FormElementTypeEmail
SELECT FormElementTypeSelect
DATE FormElementTypeDate
SECTION FormElementTypeSection
COLUMNS FormElementTypeColumns
enum:
- TEXT
- TOGGLE
- TEXTAREA
- HIDDEN
- PHONE
- EMAIL
- SELECT
- DATE
- SECTION
- COLUMNS
example: TEXT
type: string
x-go-enum-desc: |-
TEXT FormElementTypeText
TOGGLE FormElementTypeToggle
TEXTAREA FormElementTypeTextArea
HIDDEN FormElementTypeHidden
PHONE FormElementTypePhone
EMAIL FormElementTypeEmail
SELECT FormElementTypeSelect
DATE FormElementTypeDate
SECTION FormElementTypeSection
COLUMNS FormElementTypeColumns
x-go-name: ElementType
id:
description: ID is a form element identifier
example: 00000000-0000-0000-0000-000000000000
type: string
x-go-name: ID
key:
description: Key is the technical key
example: department
type: string
x-go-name: Key
validations:
$ref: './FormElementValidationsSet.yaml'
type: object
x-go-package: github.com/sailpoint/sp-forms/domain

18
static/api-specs/idn/beta/schemas/forms/FormElementDataSourceConfigOptions.yaml Normal file
View File

@@ -0,0 +1,18 @@
type: object
properties:
label:
description: Label is the main label to display to the user when selecting this option
type: string
example: 'regression-test-access-request-07c55dd6-3056-430a-86b5-fccc395bb6c5'
x-go-name: Label
subLabel:
description: SubLabel is the sub label to display below the label in diminutive styling to help describe or identify this option
type: string
example: ''
x-go-name: SubLabel
value:
description: Value is the value to save as an entry when the user selects this option
type: string
example: 'e96674448eba4ca1ba04eee999a8f3cd'
x-go-name: Value
x-go-package: github.com/sailpoint/sp-forms/domain

22
static/api-specs/idn/beta/schemas/forms/FormElementDynamicDataSource.yaml Normal file
View File

@@ -0,0 +1,22 @@
properties:
config:
$ref: './FormElementDynamicDataSourceConfig.yaml'
dataSourceType:
description: |-
DataSourceType is a FormElementDataSourceType value
STATIC FormElementDataSourceTypeStatic
INTERNAL FormElementDataSourceTypeInternal
SEARCH FormElementDataSourceTypeSearch
enum:
- STATIC
- INTERNAL
- SEARCH
example: STATIC
type: string
x-go-enum-desc: |-
STATIC FormElementDataSourceTypeStatic
INTERNAL FormElementDataSourceTypeInternal
SEARCH FormElementDataSourceTypeSearch
x-go-name: DataSourceType
type: object
x-go-package: github.com/sailpoint/sp-forms/domain

60
static/api-specs/idn/beta/schemas/forms/FormElementDynamicDataSourceConfig.yaml Normal file
View File

@@ -0,0 +1,60 @@
properties:
aggregationBucketField:
description: AggregationBucketField is the aggregation bucket field name
example: attributes.cloudStatus.exact
type: string
x-go-name: AggregationBucketField
indices:
description: Indices is a list of indices to use
example:
- identities
items:
enum:
- accessprofiles
- accountactivities
- entitlements
- identities
- events
- roles
- '*'
type: string
x-go-enum-desc: |-
accessprofiles SearchIndexAccessProfiles
accountactivities SearchIndexAccountActivities
entitlements SearchIndexEntitlements
identities SearchIndexIdentities
events SearchIndexEvents
roles SearchIndexRoles
* SearchIndexWildcard
type: array
x-go-name: Indices
objectType:
description: |-
ObjectType is a PreDefinedSelectOption value
IDENTITY PreDefinedSelectOptionIdentity
ACCESS_PROFILE PreDefinedSelectOptionAccessProfile
SOURCES PreDefinedSelectOptionSources
ROLE PreDefinedSelectOptionRole
ENTITLEMENT PreDefinedSelectOptionEntitlement
enum:
- IDENTITY
- ACCESS_PROFILE
- SOURCES
- ROLE
- ENTITLEMENT
example: IDENTITY
type: string
x-go-enum-desc: |-
IDENTITY PreDefinedSelectOptionIdentity
ACCESS_PROFILE PreDefinedSelectOptionAccessProfile
SOURCES PreDefinedSelectOptionSources
ROLE PreDefinedSelectOptionRole
ENTITLEMENT PreDefinedSelectOptionEntitlement
x-go-name: ObjectType
query:
description: Query is a text
example: '*'
type: string
x-go-name: Query
type: object
x-go-package: github.com/sailpoint/sp-forms/domain

5
static/api-specs/idn/beta/schemas/forms/FormElementPreviewRequest.yaml Normal file
View File

@@ -0,0 +1,5 @@
properties:
dataSource:
$ref: './FormElementDynamicDataSource.yaml'
type: object
x-go-package: github.com/sailpoint/sp-forms/domain

4
static/api-specs/idn/beta/schemas/forms/FormElementValidationsSet.yaml Normal file
View File

@@ -0,0 +1,4 @@
description: FormElementValidationsSet is a set of FormElementValidation items
example: [ { "validationType": "REQUIRED" } ]
type: object
x-go-package: github.com/sailpoint/sp-forms/domain

18
static/api-specs/idn/beta/schemas/forms/FormError.yaml Normal file
View File

@@ -0,0 +1,18 @@
properties:
key:
description: Key is the technical key
example: department
type: string
x-go-name: Key
messages:
description: Messages is a list of web.ErrorMessage items
items:
$ref: './ErrorMessage.yaml'
type: array
x-go-name: Messages
value:
description: Value is the value associated with a Key
example: Engineering
x-go-name: Value
type: object
x-go-package: github.com/sailpoint/sp-forms/domain

22
static/api-specs/idn/beta/schemas/forms/FormInstanceCreatedBy.yaml Normal file
View File

@@ -0,0 +1,22 @@
properties:
id:
description: ID is a unique identifier
example: 00000000-0000-0000-0000-000000000000
type: string
x-go-name: ID
type:
description: |-
Type is a form instance created by type enum value
WORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution
SOURCE FormInstanceCreatedByTypeSource
enum:
- WORKFLOW_EXECUTION
- SOURCE
example: WORKFLOW_EXECUTION
type: string
x-go-enum-desc: |-
WORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution
SOURCE FormInstanceCreatedByTypeSource
x-go-name: Type
type: object
x-go-package: github.com/sailpoint/sp-forms/domain

18
static/api-specs/idn/beta/schemas/forms/FormInstanceRecipient.yaml Normal file
View File

@@ -0,0 +1,18 @@
properties:
id:
description: ID is a unique identifier
example: 00000000-0000-0000-0000-000000000000
type: string
x-go-name: ID
type:
description: |-
Type is a FormInstanceRecipientType value
IDENTITY FormInstanceRecipientIdentity
enum:
- IDENTITY
example: IDENTITY
type: string
x-go-enum-desc: IDENTITY FormInstanceRecipientIdentity
x-go-name: Type
type: object
x-go-package: github.com/sailpoint/sp-forms/domain

104
static/api-specs/idn/beta/schemas/forms/FormInstanceResponse.yaml Normal file
View File

@@ -0,0 +1,104 @@
properties:
created:
description: Created is the date the form instance was assigned
example: "2023-07-12T20:14:57.74486Z"
format: date-time
type: string
x-go-name: Created
createdBy:
$ref: './FormInstanceCreatedBy.yaml'
expire:
description: Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record
example: "2023-08-12T20:14:57.74486Z"
type: string
x-go-name: Expire
formConditions:
description: FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form
items:
$ref: './FormCondition.yaml'
type: array
x-go-name: FormConditions
formData:
additionalProperties: { }
description: FormData is the data provided by the form on submit. The data is in a key -> value map
example:
department: Engineering
type: object
x-go-name: FormData
formDefinitionId:
description: FormDefinitionID is the id of the form definition that created this form
example: 00000000-0000-0000-0000-000000000000
type: string
x-go-name: FormDefinitionID
formElements:
description: FormElements is the configuration of the form, this would be a repeat of the fields from the form-config
items:
$ref: './FormElement.yaml'
type: array
x-go-name: FormElements
formErrors:
description: FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors
items:
$ref: './FormError.yaml'
type: array
x-go-name: FormErrors
formInput:
additionalProperties: { }
description: FormInput is an object of form input labels to value
example:
input1: Sales
type: object
x-go-name: FormInput
id:
description: FormInstanceID is a unique guid identifying this form instance
example: 00000000-0000-0000-0000-000000000000
type: string
x-go-name: FormInstanceID
modified:
description: Modified is the last date the form instance was modified
example: "2023-07-12T20:14:57.74486Z"
format: date-time
type: string
x-go-name: Modified
recipients:
description: Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it
items:
$ref: './FormInstanceRecipient.yaml'
type: array
x-go-name: Recipients
standAloneForm:
default: false
description: StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form
example: false
type: boolean
x-go-name: StandAloneForm
standAloneFormUrl:
description: StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI
example: https://my-org.identitynow.com/ui/d/forms/00000000-0000-0000-0000-000000000000
type: string
x-go-name: StandAloneFormURL
state:
description: |-
State the state of the form instance
ASSIGNED FormInstanceStateAssigned
IN_PROGRESS FormInstanceStateInProgress
SUBMITTED FormInstanceStateSubmitted
COMPLETED FormInstanceStateCompleted
CANCELLED FormInstanceStateCancelled
enum:
- ASSIGNED
- IN_PROGRESS
- SUBMITTED
- COMPLETED
- CANCELLED
example: ASSIGNED
type: string
x-go-enum-desc: |-
ASSIGNED FormInstanceStateAssigned
IN_PROGRESS FormInstanceStateInProgress
SUBMITTED FormInstanceStateSubmitted
COMPLETED FormInstanceStateCompleted
CANCELLED FormInstanceStateCancelled
x-go-name: State
type: object
x-go-package: github.com/sailpoint/sp-forms/domain

18
static/api-specs/idn/beta/schemas/forms/FormOwner.yaml Normal file
View File

@@ -0,0 +1,18 @@
properties:
id:
description: ID is a unique identifier
example: 00000000-0000-0000-0000-000000000000
type: string
x-go-name: ID
type:
description: |-
Type is a FormOwnerType value
IDENTITY FormOwnerTypeIdentity
enum:
- IDENTITY
example: IDENTITY
type: string
x-go-enum-desc: IDENTITY FormOwnerTypeIdentity
x-go-name: Type
type: object
x-go-package: github.com/sailpoint/sp-forms/domain

22
static/api-specs/idn/beta/schemas/forms/FormUsedBy.yaml Normal file
View File

@@ -0,0 +1,22 @@
properties:
id:
description: ID is a unique identifier
example: 00000000-0000-0000-0000-000000000000
type: string
x-go-name: ID
type:
description: |-
Type is a FormUsedByType value
WORKFLOW FormUsedByTypeWorkflow
SOURCE FormUsedByTypeSource
enum:
- WORKFLOW
- SOURCE
example: WORKFLOW
type: string
x-go-enum-desc: |-
WORKFLOW FormUsedByTypeWorkflow
SOURCE FormUsedByTypeSource
x-go-name: Type
type: object
x-go-package: github.com/sailpoint/sp-forms/domain

15
static/api-specs/idn/beta/schemas/forms/ListFormDefinitionsByTenantResponse.yaml Normal file
View File

@@ -0,0 +1,15 @@
properties:
count:
description: Count number of Results
example: 1
format: int64
type: integer
x-go-name: Count
results:
description: Results holds a list of FormDefinitionResponse items
items:
$ref: './FormDefinitionResponse.yaml'
type: array
x-go-name: Results
type: object
x-go-package: github.com/sailpoint/sp-forms/domain

10
static/api-specs/idn/beta/schemas/forms/ListFormElementDataByElementIDResponse.yaml Normal file
View File

@@ -0,0 +1,10 @@
properties:
results:
description: Results holds a list of FormElementDataSourceConfigOptions items
example: '{"results":[{"label":"Alfred 255e71dfc6e","subLabel":"Alfred.255e71dfc6e@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16676"},{"label":"Alize eba9d4cd27da","subLabel":"Alize.eba9d4cd27da@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f1667c"},{"label":"Antonina 01f69c3ea","subLabel":"Antonina.01f69c3ea@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f9667e"},{"label":"Ardella 21e78ce155","subLabel":"Ardella.21e78ce155@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e6667a"},{"label":"Arnaldo d8582b6e17","subLabel":"Arnaldo.d8582b6e17@testmail.identitysoon.com","value":"2c918084821847c5018227ced3426686"},{"label":"Aurelia admin24828","subLabel":"Aurelia.admin24828@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16674"},{"label":"Barbara 72ca418fdd","subLabel":"Barbara.72ca418fdd@testmail.identitysoon.com","value":"2c918084821847c5018227ced2fb6680"},{"label":"Barbara ee1a2436ee","subLabel":"Barbara.ee1a2436ee@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e56678"},{"label":"Baylee 652d72432f3","subLabel":"Baylee.652d72432f3@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aee"},{"label":"Brock e76b56ae4d49","subLabel":"Brock.e76b56ae4d49@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aef"}]}'
items:
$ref: './FormElementDataSourceConfigOptions.yaml'
type: array
x-go-name: Results
type: object
x-go-package: github.com/sailpoint/sp-forms/domain

15
static/api-specs/idn/beta/schemas/forms/ListFormInstancesByTenantResponse.yaml Normal file
View File

@@ -0,0 +1,15 @@
type: object
properties:
count:
description: Count number of Results
type: integer
format: int64
example: 1
x-go-name: Count
results:
description: Results holds a list of FormInstanceResponse items
type: array
items:
$ref: './FormInstanceResponse.yaml'
x-go-name: Results
x-go-package: github.com/sailpoint/sp-forms/domain

9
static/api-specs/idn/beta/schemas/forms/ListPredefinedSelectOptionsResponse.yaml Normal file
View File

@@ -0,0 +1,9 @@
type: object
properties:
results:
description: Results holds a list of PreDefinedSelectOption items
type: array
items:
$ref: './PreDefinedSelectOption.yaml'
x-go-name: Results
x-go-package: github.com/sailpoint/sp-forms/domain

3
static/api-specs/idn/beta/schemas/forms/Nil.yaml Normal file
View File

@@ -0,0 +1,3 @@
title: Nil represents the predeclared value nil.
type: object
x-go-package: go/types

6
static/api-specs/idn/beta/schemas/forms/Operation.yaml Normal file
View File

@@ -0,0 +1,6 @@
title: Operation is a single JSON-Patch step, such as a single 'add' operation.
type: object
additionalProperties:
type: object
properties: { }
x-go-package: github.com/evanphx/json-patch

7
static/api-specs/idn/beta/schemas/forms/Patch.yaml Normal file
View File

@@ -0,0 +1,7 @@
title: Patch is an ordered collection of Operations.
description: Patch is an ordered collection of Operations.
type: array
example: [ { "op": "replace","path": "/description","value": "a new description" } ]
items:
$ref: './Operation.yaml'
x-go-package: github.com/evanphx/json-patch

4
static/api-specs/idn/beta/schemas/forms/PreDefinedSelectOption.yaml Normal file
View File

@@ -0,0 +1,4 @@
type: string
description: PreDefinedSelectOption pre-defined select options
example: IDENTITY
x-go-package: github.com/sailpoint/sp-forms/domain

11
static/api-specs/idn/beta/schemas/forms/PreviewDataSourceResponse.yaml Normal file
View File

@@ -0,0 +1,11 @@
description: PreviewDataSourceResponse is the response sent by /form-definitions/{formDefinitionID}/data-source endpoint
properties:
results:
description: Results holds a list of FormElementDataSourceConfigOptions items
example: '{"results":[{"label":"Alfred 255e71dfc6e","subLabel":"Alfred.255e71dfc6e@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16676"},{"label":"Alize eba9d4cd27da","subLabel":"Alize.eba9d4cd27da@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f1667c"},{"label":"Antonina 01f69c3ea","subLabel":"Antonina.01f69c3ea@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f9667e"},{"label":"Ardella 21e78ce155","subLabel":"Ardella.21e78ce155@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e6667a"},{"label":"Arnaldo d8582b6e17","subLabel":"Arnaldo.d8582b6e17@testmail.identitysoon.com","value":"2c918084821847c5018227ced3426686"},{"label":"Aurelia admin24828","subLabel":"Aurelia.admin24828@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16674"},{"label":"Barbara 72ca418fdd","subLabel":"Barbara.72ca418fdd@testmail.identitysoon.com","value":"2c918084821847c5018227ced2fb6680"},{"label":"Barbara ee1a2436ee","subLabel":"Barbara.ee1a2436ee@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e56678"},{"label":"Baylee 652d72432f3","subLabel":"Baylee.652d72432f3@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aee"},{"label":"Brock e76b56ae4d49","subLabel":"Brock.e76b56ae4d49@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aef"}]}'
items:
$ref: './FormElementDataSourceConfigOptions.yaml'
type: array
x-go-name: Results
type: object
x-go-package: github.com/sailpoint/sp-forms/domain

696
static/api-specs/idn/sailpoint-api.beta.yaml
View File

File diff suppressed because it is too large Load Diff