mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
Automated commit by github action: 5755333661
This commit is contained in:
GitHub Action Bot
@@ -1,7 +1,7 @@
|
||||
openapi: "3.0.0"
|
||||
info:
|
||||
version: 1.0.0
|
||||
title: NERM Lifecycle API
|
||||
title: SecZetta Lifecycle API
|
||||
description: The Lifecycle API can be used to access and modify various resources in your environment.
|
||||
license:
|
||||
name: MIT
|
||||
|
||||
@@ -4,5 +4,4 @@ description: The id of the attachment attribute
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
format: uuid
|
||||
@@ -1,8 +1,8 @@
|
||||
name: id
|
||||
in: path
|
||||
description: ID of the object to retrieve or update
|
||||
description: ID of the object to retrieve, update, or delete
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
example: 1246d8b3-ac29-4015-8154-dea4434a73fa
|
||||
@@ -4,5 +4,4 @@ description: Filter by archive status
|
||||
required: false
|
||||
schema:
|
||||
type: boolean
|
||||
default: false
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
default: false
|
||||
@@ -4,5 +4,4 @@ description: The attribute data type to filter by
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
enum: [text field, text area, drop-down, radio buttons, check boxes, date, tags, attachment, profile select, profile search, owner select, owner search, contributor select, contributor search]
|
||||
example: radio buttons
|
||||
enum: [text field, text area, drop-down, radio buttons, check boxes, date, tags, attachment, profile select, profile search, owner select, owner search, contributor select, contributor search]
|
||||
@@ -4,5 +4,4 @@ description: The user email to search by
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
format: email
|
||||
example: test@sailpoint.com
|
||||
format: email
|
||||
@@ -4,5 +4,4 @@ description: Allows for optimization by not returning the associated attribute d
|
||||
required: false
|
||||
schema:
|
||||
type: boolean
|
||||
default: false
|
||||
example: true
|
||||
default: false
|
||||
@@ -4,6 +4,4 @@ description: Impact risk level to filter by
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
|
||||
format: uuid
|
||||
@@ -3,5 +3,4 @@ in: query
|
||||
description: The id of the job returned from a POST or PATCH endpoint that resulted in a job being created
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
type: string
|
||||
@@ -2,6 +2,5 @@ name: label
|
||||
in: query
|
||||
description: The attribute label to filter by
|
||||
required: false
|
||||
example: mylabel
|
||||
schema:
|
||||
type: string
|
||||
@@ -3,5 +3,4 @@ in: query
|
||||
description: The user login to search by
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: myuser
|
||||
type: string
|
||||
@@ -4,5 +4,4 @@ description: The ID of a user for filtering
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
format: uuid
|
||||
@@ -2,7 +2,7 @@ name: metadata
|
||||
in: query
|
||||
description: Returns batching metadata in the response
|
||||
required: false
|
||||
example: true
|
||||
schema:
|
||||
type: boolean
|
||||
default: false
|
||||
default: false
|
||||
example: true
|
||||
@@ -3,5 +3,4 @@ in: query
|
||||
description: object name for filtering
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: objectname
|
||||
type: string
|
||||
@@ -5,4 +5,4 @@ required: false
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
|
||||
@@ -4,6 +4,4 @@ description: ID of an object for filtering. Used along with object_type
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
|
||||
format: uuid
|
||||
@@ -4,5 +4,4 @@ description: Type of object that object_id represents
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
enum: [Profile, WorkflowSession]
|
||||
example: Profile
|
||||
enum: [Profile, WorkflowSession]
|
||||
@@ -3,5 +3,4 @@ in: query
|
||||
description: attribute option label for filtering
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: my_option_label
|
||||
type: string
|
||||
@@ -4,5 +4,4 @@ description: Overall risk level to filter by
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example:
|
||||
format: uuid
|
||||
@@ -4,6 +4,4 @@ description: Probability risk level to filter by
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
|
||||
format: uuid
|
||||
@@ -5,4 +5,4 @@ required: false
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
example: 4e480441-451d-47d9-87c2-9a0f0fe135eb
|
||||
@@ -4,5 +4,4 @@ description: Profile Type ID for filtering
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
format: uuid
|
||||
@@ -1,53 +1,22 @@
|
||||
name: query
|
||||
in: query
|
||||
description: |
|
||||
Allows for pagination and sorting using the deepObject notation.
|
||||
|
||||
</br>
|
||||
|
||||
`resource?query[limit]=50&query[offset]=0&query[order]=label`
|
||||
|
||||
</br>
|
||||
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Description</th>
|
||||
<th>Default</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>limit</td>
|
||||
<td>Limits the number of results returned</td>
|
||||
<td>100</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>offset</td>
|
||||
<td>Returns the results starting at the value provided</td>
|
||||
<td>0</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>order</td>
|
||||
<td>Allows you to determine the order in which the data is returned (not available on profile attributes)</td>
|
||||
<td>id</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
description: Allows for pagination and sorting.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
limit:
|
||||
type: integer
|
||||
description: The limit of results to return
|
||||
example: 100
|
||||
offset:
|
||||
type: integer
|
||||
description: The number of records to offset
|
||||
example: 50
|
||||
order:
|
||||
type: string
|
||||
description: The attribute to order by
|
||||
example: created_at
|
||||
example:
|
||||
limit: 100
|
||||
offset: 50
|
||||
order: created_at
|
||||
style: deepObject
|
||||
explode: true
|
||||
example: query[limit]=100&query[offset]=50&query[order]=created_at
|
||||
|
||||
@@ -5,4 +5,4 @@ required: false
|
||||
schema:
|
||||
type: string
|
||||
enum: [owner, contributor]
|
||||
example: owner
|
||||
example: contributor
|
||||
@@ -4,5 +4,4 @@ description: Requester ID for filtering
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
format: uuid
|
||||
@@ -4,5 +4,4 @@ description: ID Proofing Result to filter by
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
enum: [pass, fail]
|
||||
example: fail
|
||||
enum: [pass, fail]
|
||||
@@ -4,5 +4,4 @@ description: The ID of a role for filtering
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
format: uuid
|
||||
@@ -4,5 +4,4 @@ description: Will run the created/updated workflow session if successful
|
||||
required: false
|
||||
schema:
|
||||
type: boolean
|
||||
default: false
|
||||
example: true
|
||||
default: false
|
||||
@@ -4,5 +4,4 @@ description: status value for filtering
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
enum: [Active, Inactive, On Leave, Terminated]
|
||||
example: Active
|
||||
enum: [Active, Inactive, On Leave, Terminated]
|
||||
@@ -3,5 +3,4 @@ in: query
|
||||
description: The user title to search by
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: usertitle
|
||||
type: string
|
||||
@@ -5,5 +5,4 @@ required: false
|
||||
schema:
|
||||
type: string
|
||||
minLength: 32
|
||||
maxLength: 32
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
maxLength: 32
|
||||
@@ -5,4 +5,4 @@ required: false
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
example: bba9cfb2-96c1-4acb-ac79-a21732527265
|
||||
@@ -4,5 +4,4 @@ description: Workflow ID for filtering
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
format: uuid
|
||||
@@ -4,5 +4,4 @@ description: Workflow Session ID to filter by
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
format: uuid
|
||||
@@ -67,5 +67,4 @@ schema:
|
||||
"pending identity proofing",
|
||||
"closed",
|
||||
"workflow changed"
|
||||
]
|
||||
example: batch completed
|
||||
]
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getAdvancedSearch
|
||||
description: Get saved advanced search queries
|
||||
tags:
|
||||
- Advanced Search
|
||||
- advanced search
|
||||
responses:
|
||||
'200':
|
||||
$ref: "../responses/AdvancedSearches.yaml"
|
||||
@@ -12,7 +12,7 @@ post:
|
||||
operationId: postAdvancedSearch
|
||||
description: Save an advanced search query for later use
|
||||
tags:
|
||||
- Advanced Search
|
||||
- advanced search
|
||||
requestBody:
|
||||
$ref: "../requestBodies/POST/AdvancedSearch.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ patch:
|
||||
operationId: patchAdvancedSearch
|
||||
description: Update a saved advanced search query
|
||||
tags:
|
||||
- Advanced Search
|
||||
- advanced search
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
requestBody:
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: runAdvancedSearchbyID
|
||||
description: Run a saved advanced search query
|
||||
tags:
|
||||
- Advanced Search
|
||||
- advanced search
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
- $ref: "../parameters/query/query.yaml"
|
||||
|
||||
@@ -3,7 +3,7 @@ post:
|
||||
operationId: runAdvancedSearch
|
||||
description: Run an advanced search for profiles, without saving the query
|
||||
tags:
|
||||
- Advanced Search
|
||||
- advanced search
|
||||
parameters:
|
||||
- $ref: "../parameters/query/query.yaml"
|
||||
requestBody:
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getIdentityProofingResults
|
||||
description: This endpoint can retrieve identity proofing result data in bulk from Lifecycle
|
||||
tags:
|
||||
- Identity Proofing Results
|
||||
- identity proofing results
|
||||
parameters:
|
||||
- $ref: "../parameters/query/query.yaml"
|
||||
- $ref: "../parameters/query/profile_id.yaml"
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getJobStatus
|
||||
description: Get the status of a bulk job
|
||||
tags:
|
||||
- Job Status
|
||||
- job status
|
||||
parameters:
|
||||
- $ref: "../parameters/query/job_id.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ post:
|
||||
operationId: postAttributeOption
|
||||
description: Add a value to an option based attribute
|
||||
tags:
|
||||
- Attribute Options
|
||||
- attribute options
|
||||
requestBody:
|
||||
$ref: "../requestBodies/POST/AttributeOption.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getAttributeOptions
|
||||
description: Get option based attribute values
|
||||
tags:
|
||||
- Attribute Options
|
||||
- attribute options
|
||||
parameters:
|
||||
- $ref: "../parameters/query/query.yaml"
|
||||
- $ref: "../parameters/query/ne_attribute_id.yaml"
|
||||
@@ -21,7 +21,7 @@ post:
|
||||
operationId: postAttributeOptions
|
||||
description: Create multiple new option based attribute values
|
||||
tags:
|
||||
- Attribute Options
|
||||
- attribute options
|
||||
requestBody:
|
||||
$ref: "../requestBodies/POST/AttributeOptions.yaml"
|
||||
responses:
|
||||
@@ -36,7 +36,7 @@ patch:
|
||||
operationId: patchAttributeOptions
|
||||
description: Update multiple option based attribute values
|
||||
tags:
|
||||
- Attribute Options
|
||||
- attribute options
|
||||
requestBody:
|
||||
$ref: "../requestBodies/PATCH/AttributeOptions.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getAttributeOption
|
||||
description: Info for a specific option based attribute value
|
||||
tags:
|
||||
- Attribute Options
|
||||
- attribute options
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
responses:
|
||||
@@ -18,7 +18,7 @@ patch:
|
||||
operationId: patchAttributeOption
|
||||
description: Update a option based attribute value by id
|
||||
tags:
|
||||
- Attribute Options
|
||||
- attribute options
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
requestBody:
|
||||
@@ -35,7 +35,7 @@ delete:
|
||||
operationId: deleteAttributeOption
|
||||
description: Delete a option based attribute value by id
|
||||
tags:
|
||||
- Attribute Options
|
||||
- attribute options
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getAttributes
|
||||
description: This endpoint can retrieve attribute data in bulk from Lifecycle or you can search for attributes using parameters
|
||||
tags:
|
||||
- Attributes
|
||||
- attributes
|
||||
parameters:
|
||||
- $ref: "../parameters/query/query.yaml"
|
||||
- $ref: "../parameters/query/label.yaml"
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getAttribute
|
||||
description: Info for a specific attribute
|
||||
tags:
|
||||
- Attributes
|
||||
- attributes
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ post:
|
||||
operationId: postProfile
|
||||
description: Create a profile
|
||||
tags:
|
||||
- Profiles
|
||||
- profiles
|
||||
requestBody:
|
||||
$ref: "../requestBodies/POST/Profile.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ post:
|
||||
operationId: postProfileType
|
||||
description: Create a profile type
|
||||
tags:
|
||||
- Profile Types
|
||||
- profile types
|
||||
requestBody:
|
||||
$ref: "../requestBodies/POST/ProfileType.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getProfileTypes
|
||||
description: Get option based attribute values
|
||||
tags:
|
||||
- Profile Types
|
||||
- profile types
|
||||
parameters:
|
||||
- $ref: "../parameters/query/query.yaml"
|
||||
- $ref: "../parameters/query/name.yaml"
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getProfileType
|
||||
description: Find profile type by id
|
||||
tags:
|
||||
- Profile Types
|
||||
- profile types
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
responses:
|
||||
@@ -18,7 +18,7 @@ patch:
|
||||
operationId: patchProfileType
|
||||
description: Update a profile type by id
|
||||
tags:
|
||||
- Profile Types
|
||||
- profile types
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
requestBody:
|
||||
@@ -36,7 +36,7 @@ delete:
|
||||
operationId: deleteProfileType
|
||||
description: Delete a profile type. All profiles of that type must first be destroyed before the profile type can be destroyed.
|
||||
tags:
|
||||
- Profile Types
|
||||
- profile types
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getProfiles
|
||||
description: Get profiles
|
||||
tags:
|
||||
- Profiles
|
||||
- profiles
|
||||
parameters:
|
||||
- $ref: "../parameters/query/query.yaml"
|
||||
- $ref: "../parameters/query/exclude_attributes.yaml"
|
||||
@@ -23,7 +23,7 @@ post:
|
||||
operationId: postProfiles
|
||||
description: Create multiple profiles
|
||||
tags:
|
||||
- Profiles
|
||||
- profiles
|
||||
requestBody:
|
||||
$ref: "../requestBodies/POST/Profiles.yaml"
|
||||
responses:
|
||||
@@ -38,7 +38,7 @@ patch:
|
||||
operationId: patchProfiles
|
||||
description: Update multiple profiles
|
||||
tags:
|
||||
- Profiles
|
||||
- profiles
|
||||
requestBody:
|
||||
$ref: "../requestBodies/PATCH/Profiles.yaml"
|
||||
responses:
|
||||
@@ -53,7 +53,7 @@ delete:
|
||||
operationId: deleteProfiles
|
||||
description: Delete multiple profiles
|
||||
tags:
|
||||
- Profiles
|
||||
- profiles
|
||||
requestBody:
|
||||
$ref: "../requestBodies/DELETE/Profiles.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getProfile
|
||||
description: Find profile by id
|
||||
tags:
|
||||
- Profiles
|
||||
- profiles
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
responses:
|
||||
@@ -18,7 +18,7 @@ patch:
|
||||
operationId: patchProfile
|
||||
description: Update a profile by id
|
||||
tags:
|
||||
- Profiles
|
||||
- profiles
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
requestBody:
|
||||
@@ -28,5 +28,28 @@ patch:
|
||||
$ref: "../responses/Profile.yaml"
|
||||
'400':
|
||||
$ref: "../responses/400.yaml"
|
||||
'500':
|
||||
$ref: "../responses/500.yaml"
|
||||
delete:
|
||||
summary: Delete a single profile
|
||||
operationId: deleteProfile
|
||||
description: Delete a single profile
|
||||
tags:
|
||||
- profiles
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
responses:
|
||||
'204':
|
||||
description: The Profile was successfully deleted.
|
||||
'400':
|
||||
description: Error deleting Profile
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
error:
|
||||
description: A message describing the error that occurred
|
||||
type: string
|
||||
'500':
|
||||
$ref: "../responses/500.yaml"
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getProfileAvatar
|
||||
description: Retrieves the URL of the profile avatar
|
||||
tags:
|
||||
- Profiles
|
||||
- profiles
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
responses:
|
||||
@@ -18,7 +18,7 @@ post:
|
||||
operationId: postProfileAvatar
|
||||
description: Uploads a new profile avatar
|
||||
tags:
|
||||
- Profiles
|
||||
- profiles
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
requestBody:
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getProfileUpload
|
||||
description: Retrieves the URL of an attachment attribute value from a profile
|
||||
tags:
|
||||
- Profiles
|
||||
- profiles
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
- $ref: "../parameters/path/attribute_id.yaml"
|
||||
@@ -19,7 +19,7 @@ post:
|
||||
operationId: postProfileUpload
|
||||
description: Uploads a new attachment attribute value to a profile
|
||||
tags:
|
||||
- Profiles
|
||||
- profiles
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
- $ref: "../parameters/path/attribute_id.yaml"
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getRiskLevels
|
||||
description: This endpoint can retrieve risk level data in bulk from Lifecycle
|
||||
tags:
|
||||
- Risk Levels
|
||||
- risk levels
|
||||
parameters:
|
||||
- $ref: "../parameters/query/query.yaml"
|
||||
- $ref: "../parameters/query/label.yaml"
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getRiskLevel
|
||||
description: Find risk level data by id
|
||||
tags:
|
||||
- Risk Levels
|
||||
- risk levels
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getRiskScores
|
||||
description: This endpoint can retrieve risk score data in bulk from Lifecycle
|
||||
tags:
|
||||
- Risk Scores
|
||||
- risk scores
|
||||
parameters:
|
||||
- $ref: "../parameters/query/query.yaml"
|
||||
- $ref: "../parameters/query/object_id.yaml"
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getRiskScore
|
||||
description: Find risk score data by id
|
||||
tags:
|
||||
- Risk Scores
|
||||
- risk scores
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ post:
|
||||
operationId: postRole
|
||||
description: Create a new role
|
||||
tags:
|
||||
- Roles
|
||||
- roles
|
||||
requestBody:
|
||||
$ref: "../requestBodies/POST/Role.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ post:
|
||||
operationId: postRoleProfile
|
||||
description: Create a role-profile contributor relationship
|
||||
tags:
|
||||
- Role Profiles
|
||||
- role profiles
|
||||
requestBody:
|
||||
$ref: "../requestBodies/POST/RoleProfile.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ delete:
|
||||
operationId: deleteRoleProfile
|
||||
description: Delete a role profile assignment
|
||||
tags:
|
||||
- Role Profiles
|
||||
- role profiles
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getRoleProfiles
|
||||
description: Get role-profile contributor relationships
|
||||
tags:
|
||||
- Role Profiles
|
||||
- role profiles
|
||||
parameters:
|
||||
- $ref: "../parameters/query/query.yaml"
|
||||
- $ref: "../parameters/query/role_id.yaml"
|
||||
@@ -21,7 +21,7 @@ post:
|
||||
operationId: postRoleProfiles
|
||||
description: Create multiple role-profile contributor relationships
|
||||
tags:
|
||||
- Role Profiles
|
||||
- role profiles
|
||||
requestBody:
|
||||
$ref: "../requestBodies/POST/RoleProfiles.yaml"
|
||||
responses:
|
||||
@@ -36,7 +36,7 @@ patch:
|
||||
operationId: patchRoleProfiles
|
||||
description: Update multiple role-profile contributor relationships
|
||||
tags:
|
||||
- Role Profiles
|
||||
- role profiles
|
||||
requestBody:
|
||||
$ref: "../requestBodies/PATCH/RoleProfiles.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getRoleProfile
|
||||
description: Find role-profile contributor relationship by id
|
||||
tags:
|
||||
- Role Profiles
|
||||
- role profiles
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
responses:
|
||||
@@ -18,7 +18,7 @@ patch:
|
||||
operationId: patchRoleProfile
|
||||
description: Update a role-profile contributor relationship by id
|
||||
tags:
|
||||
- Role Profiles
|
||||
- role profiles
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
requestBody:
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getRoles
|
||||
description: This endpoint can retrieve roles from NERM. Optionally you can provide parameters to filter results.
|
||||
tags:
|
||||
- Roles
|
||||
- roles
|
||||
parameters:
|
||||
- $ref: "../parameters/query/query.yaml"
|
||||
- $ref: "../parameters/query/metadata.yaml"
|
||||
@@ -19,7 +19,7 @@ post:
|
||||
operationId: postRoles
|
||||
description: Create multiple new users
|
||||
tags:
|
||||
- Roles
|
||||
- roles
|
||||
requestBody:
|
||||
$ref: "../requestBodies/POST/Roles.yaml"
|
||||
responses:
|
||||
@@ -34,7 +34,7 @@ patch:
|
||||
operationId: patchRoles
|
||||
description: Update multiple users
|
||||
tags:
|
||||
- Roles
|
||||
- roles
|
||||
requestBody:
|
||||
$ref: "../requestBodies/PATCH/Roles.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getRole
|
||||
description: Info for a specific user role
|
||||
tags:
|
||||
- Roles
|
||||
- roles
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
responses:
|
||||
@@ -18,7 +18,7 @@ patch:
|
||||
operationId: patchRole
|
||||
description: Update an existing role
|
||||
tags:
|
||||
- Roles
|
||||
- roles
|
||||
requestBody:
|
||||
$ref: "../requestBodies/PATCH/Role.yaml"
|
||||
parameters:
|
||||
|
||||
@@ -3,7 +3,7 @@ post:
|
||||
operationId: postUser
|
||||
description: Create a new user
|
||||
tags:
|
||||
- Users
|
||||
- users
|
||||
requestBody:
|
||||
$ref: "../requestBodies/POST/User.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ post:
|
||||
operationId: postUserManager
|
||||
description: Create a new user-manager relationship
|
||||
tags:
|
||||
- User Managers
|
||||
- user managers
|
||||
requestBody:
|
||||
$ref: "../requestBodies/POST/UserManager.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getUserManagers
|
||||
description: This endpoint can retrieve user-manager relationships from Lifecycle or you can search for user-manager relationships using parameters
|
||||
tags:
|
||||
- User Managers
|
||||
- user managers
|
||||
parameters:
|
||||
- $ref: "../parameters/query/query.yaml"
|
||||
- $ref: "../parameters/query/user_id.yaml"
|
||||
@@ -21,7 +21,7 @@ post:
|
||||
operationId: postUserManagers
|
||||
description: Create multiple new user-manager relationships
|
||||
tags:
|
||||
- User Managers
|
||||
- user managers
|
||||
requestBody:
|
||||
$ref: "../requestBodies/POST/UserManagers.yaml"
|
||||
responses:
|
||||
@@ -36,7 +36,7 @@ patch:
|
||||
operationId: patchUserManagers
|
||||
description: Update multiple user-manager relationships
|
||||
tags:
|
||||
- User Managers
|
||||
- user managers
|
||||
requestBody:
|
||||
$ref: "../requestBodies/PATCH/UserManagers.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getUserManager
|
||||
description: Info for a specific user-manager relationship
|
||||
tags:
|
||||
- User Managers
|
||||
- user managers
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
responses:
|
||||
@@ -18,7 +18,7 @@ patch:
|
||||
operationId: patchUserManager
|
||||
description: Update a user-manager relationship by id
|
||||
tags:
|
||||
- User Managers
|
||||
- user managers
|
||||
requestBody:
|
||||
$ref: "../requestBodies/PATCH/UserManager.yaml"
|
||||
parameters:
|
||||
|
||||
@@ -3,7 +3,7 @@ post:
|
||||
operationId: postUserProfile
|
||||
description: Create a user-profile contributor relationship
|
||||
tags:
|
||||
- User Profiles
|
||||
- user profiles
|
||||
requestBody:
|
||||
$ref: "../requestBodies/POST/UserProfile.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ delete:
|
||||
operationId: deleteUserProfile
|
||||
description: Delete a user profile assignment
|
||||
tags:
|
||||
- User Profiles
|
||||
- user profiles
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getUserProfiles
|
||||
description: Get user-profile contributor relationships
|
||||
tags:
|
||||
- User Profiles
|
||||
- user profiles
|
||||
parameters:
|
||||
- $ref: "../parameters/query/query.yaml"
|
||||
- $ref: "../parameters/query/user_id.yaml"
|
||||
@@ -20,10 +20,10 @@ get:
|
||||
$ref: "../responses/500.yaml"
|
||||
post:
|
||||
summary: Create multiple user-profile contributor relationships
|
||||
operationId: postUserProfiles
|
||||
operationId: createUserProfiles
|
||||
description: Create multiple user-profile contributor relationships
|
||||
tags:
|
||||
- User Profiles
|
||||
- user profiles
|
||||
requestBody:
|
||||
$ref: "../requestBodies/POST/UserProfiles.yaml"
|
||||
responses:
|
||||
@@ -38,9 +38,24 @@ patch:
|
||||
operationId: patchUserProfiles
|
||||
description: Update multiple user-profile contributor relationships
|
||||
tags:
|
||||
- User Profiles
|
||||
- user profiles
|
||||
requestBody:
|
||||
$ref: "../requestBodies/PATCH/UserProfiles.yaml"
|
||||
responses:
|
||||
'200':
|
||||
$ref: "../responses/UserProfilesJob.yaml"
|
||||
'400':
|
||||
$ref: "../responses/400.yaml"
|
||||
'500':
|
||||
$ref: "../responses/500.yaml"
|
||||
delete:
|
||||
summary: Delete multiple user-profile contributor relationships
|
||||
operationId: deleteUserProfiles
|
||||
description: Delete multiple user-profile contributor relationships
|
||||
tags:
|
||||
- user profiles
|
||||
requestBody:
|
||||
$ref: "../requestBodies/DELETE/UserProfiles.yaml"
|
||||
responses:
|
||||
'200':
|
||||
$ref: "../responses/UserProfilesJob.yaml"
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getUserProfile
|
||||
description: Find user-profile contributor relationship by id
|
||||
tags:
|
||||
- User Profiles
|
||||
- user profiles
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
responses:
|
||||
@@ -18,7 +18,7 @@ patch:
|
||||
operationId: patchUserProfile
|
||||
description: Update a user-profile contributor relationship by id
|
||||
tags:
|
||||
- User Profiles
|
||||
- user profiles
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
requestBody:
|
||||
|
||||
@@ -3,7 +3,7 @@ post:
|
||||
operationId: postUserRole
|
||||
description: Assign a new role to a user
|
||||
tags:
|
||||
- User Roles
|
||||
- user roles
|
||||
requestBody:
|
||||
$ref: "../requestBodies/POST/UserRole.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ delete:
|
||||
operationId: deleteUserRole
|
||||
description: Delete a user role assignment
|
||||
tags:
|
||||
- User Roles
|
||||
- user roles
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getUserRoles
|
||||
description: This endpoint can retrieve user role pairings from Lifecycle or you can search for user role pairings using parameters
|
||||
tags:
|
||||
- User Roles
|
||||
- user roles
|
||||
parameters:
|
||||
- $ref: "../parameters/query/query.yaml"
|
||||
- $ref: "../parameters/query/user_id.yaml"
|
||||
@@ -21,7 +21,7 @@ post:
|
||||
operationId: postUserRoles
|
||||
description: Create multiple new user role pairings
|
||||
tags:
|
||||
- User Roles
|
||||
- user roles
|
||||
requestBody:
|
||||
$ref: "../requestBodies/POST/UserRoles.yaml"
|
||||
responses:
|
||||
@@ -36,7 +36,7 @@ patch:
|
||||
operationId: patchUserRoles
|
||||
description: Update multiple user role pairings
|
||||
tags:
|
||||
- User Roles
|
||||
- user roles
|
||||
requestBody:
|
||||
$ref: "../requestBodies/PATCH/UserRoles.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getUserRole
|
||||
description: Info for a specific user role pairing
|
||||
tags:
|
||||
- User Roles
|
||||
- user roles
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
responses:
|
||||
@@ -18,7 +18,7 @@ patch:
|
||||
operationId: patchUserRole
|
||||
description: Update a user role pairing by id
|
||||
tags:
|
||||
- User Roles
|
||||
- user roles
|
||||
requestBody:
|
||||
$ref: "../requestBodies/PATCH/UserRole.yaml"
|
||||
parameters:
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getUsers
|
||||
description: This endpoint can retrieve users from Lifecycle or you can search for users using parameters
|
||||
tags:
|
||||
- Users
|
||||
- users
|
||||
parameters:
|
||||
- $ref: "../parameters/query/query.yaml"
|
||||
- $ref: "../parameters/query/name.yaml"
|
||||
@@ -24,7 +24,7 @@ post:
|
||||
operationId: postUsers
|
||||
description: Create multiple new users
|
||||
tags:
|
||||
- Users
|
||||
- users
|
||||
requestBody:
|
||||
$ref: "../requestBodies/POST/Users.yaml"
|
||||
responses:
|
||||
@@ -39,7 +39,7 @@ patch:
|
||||
operationId: patchUsers
|
||||
description: Update multiple users
|
||||
tags:
|
||||
- Users
|
||||
- users
|
||||
requestBody:
|
||||
$ref: "../requestBodies/PATCH/Users.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getUser
|
||||
description: Info for a specific user
|
||||
tags:
|
||||
- Users
|
||||
- users
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
responses:
|
||||
@@ -18,7 +18,7 @@ patch:
|
||||
operationId: patchUser
|
||||
description: Update a user by id
|
||||
tags:
|
||||
- Users
|
||||
- users
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
requestBody:
|
||||
@@ -35,7 +35,7 @@ delete:
|
||||
operationId: deleteUser
|
||||
description: Delete a user
|
||||
tags:
|
||||
- Users
|
||||
- users
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
responses:
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getUserAvatar
|
||||
description: Retrieves the URL of the user avatar
|
||||
tags:
|
||||
- Users
|
||||
- users
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
responses:
|
||||
@@ -18,7 +18,7 @@ post:
|
||||
operationId: postUserAvatar
|
||||
description: Uploads a new user avatar
|
||||
tags:
|
||||
- Users
|
||||
- users
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
requestBody:
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getWorkflowSessions
|
||||
description: Get workflow sessions
|
||||
tags:
|
||||
- Workflow Sessions
|
||||
- workflow sessions
|
||||
parameters:
|
||||
- $ref: "../parameters/query/query.yaml"
|
||||
- $ref: "../parameters/query/profile_id.yaml"
|
||||
@@ -24,7 +24,7 @@ post:
|
||||
operationId: postWorkflowSession
|
||||
description: Create a workflow session
|
||||
tags:
|
||||
- Workflow Sessions
|
||||
- workflow sessions
|
||||
parameters:
|
||||
- $ref: "../parameters/query/run.yaml"
|
||||
requestBody:
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getWorkflowSession
|
||||
description: Find workflow session by id
|
||||
tags:
|
||||
- Workflow Sessions
|
||||
- workflow sessions
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
responses:
|
||||
@@ -18,7 +18,7 @@ patch:
|
||||
operationId: patchWorkflowSession
|
||||
description: Update a workflow session by id
|
||||
tags:
|
||||
- Workflow Sessions
|
||||
- workflow sessions
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
- $ref: "../parameters/query/run.yaml"
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getWorkflowSessionUpload
|
||||
description: Retrieves the URL of an attachment attribute value from a workflow session
|
||||
tags:
|
||||
- Workflow Sessions
|
||||
- workflow sessions
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
- $ref: "../parameters/path/attribute_id.yaml"
|
||||
@@ -19,7 +19,7 @@ post:
|
||||
operationId: postWorkflowSessionUpload
|
||||
description: Uploads a new attachment attribute value to a workflow session
|
||||
tags:
|
||||
- Workflow Sessions
|
||||
- workflow sessions
|
||||
parameters:
|
||||
- $ref: "../parameters/path/id.yaml"
|
||||
- $ref: "../parameters/path/attribute_id.yaml"
|
||||
|
||||
14
static/api-specs/nerm/requestBodies/DELETE/UserProfiles.yaml
Normal file
14
static/api-specs/nerm/requestBodies/DELETE/UserProfiles.yaml
Normal file
@@ -0,0 +1,14 @@
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
profiles:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
format: uuid
|
||||
@@ -1,24 +1,17 @@
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
description: The id
|
||||
type: string
|
||||
format: uuid
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
uid:
|
||||
description: the uid
|
||||
type: string
|
||||
minLength: 32
|
||||
maxLength: 32
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
label:
|
||||
description: the label
|
||||
type: string
|
||||
example: mylabel
|
||||
condition_rules_attributes:
|
||||
description: The condition rules attributes
|
||||
type: array
|
||||
items:
|
||||
anyOf:
|
||||
@@ -28,12 +21,4 @@ properties:
|
||||
- $ref: "./ProfileAttributeRuleDate.yaml"
|
||||
- $ref: "./ProfileAttributeRuleId.yaml"
|
||||
- $ref: "./RiskRule.yaml"
|
||||
example:
|
||||
- type: ProfileTypeRule
|
||||
comparison_operator: ==
|
||||
value: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
- type: ProfileStatusRule
|
||||
id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
uid: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
comparison_operator: ==
|
||||
value: Active
|
||||
|
||||
|
||||
@@ -1,120 +1,70 @@
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
description: The id
|
||||
type: string
|
||||
format: uuid
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
uid:
|
||||
uid:
|
||||
type: string
|
||||
minLength: 32
|
||||
maxLength: 32
|
||||
readOnly: true
|
||||
readOnly: true
|
||||
label:
|
||||
|
||||
type: string
|
||||
description: The label
|
||||
description:
|
||||
example: my_attribute
|
||||
type: string
|
||||
description: The description
|
||||
tool_tip:
|
||||
example: This is my attribute
|
||||
type: string
|
||||
description: The tool tip
|
||||
crypt:
|
||||
example: my attribute
|
||||
type: boolean
|
||||
description: Should this be encrypted?
|
||||
archived:
|
||||
example: true
|
||||
type: boolean
|
||||
description: Is this attribute archived?
|
||||
archived_on:
|
||||
example: false
|
||||
type: string
|
||||
format: date-time
|
||||
readOnly: true
|
||||
format: date-time
|
||||
created_at:
|
||||
example: 2023-05-01T09:12:28Z
|
||||
type: string
|
||||
format: date-time
|
||||
readOnly: true
|
||||
format: date-time
|
||||
updated_at:
|
||||
example: 2023-05-01T09:12:28Z
|
||||
type: string
|
||||
format: date-time
|
||||
readOnly: true
|
||||
format: date-time
|
||||
date_format:
|
||||
example: 2023-05-01T09:12:28Z
|
||||
type: string
|
||||
enum: [mm/dd/yyyy, mm-dd-yyyy, dd/mm/yyyy, dd-mm-yyyy, yyyy/mm/dd, yyyy-mm-dd]
|
||||
type: string
|
||||
selectable_status:
|
||||
example: mm/dd/yyyy
|
||||
type: string
|
||||
description: The selectable_status
|
||||
type: string
|
||||
example: Active
|
||||
risk_score_setting:
|
||||
type: string
|
||||
description: The risk score setting
|
||||
risk_type:
|
||||
example: standard
|
||||
type: string
|
||||
description: The risk type
|
||||
ownership_driver:
|
||||
example: inherited
|
||||
type: boolean
|
||||
description: The ownership_driver
|
||||
allow_multiple_selections:
|
||||
example: true
|
||||
type: boolean
|
||||
description: allow multiple selections
|
||||
filtered_by_ne_attribute:
|
||||
example: false
|
||||
type: boolean
|
||||
description: Should this attribute be filtered_by_ne_attribute
|
||||
filtering_ne_attribute_id:
|
||||
example: false
|
||||
type: string
|
||||
format: uuid
|
||||
type: string
|
||||
ne_attribute_filter_id:
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
type: string
|
||||
format: uuid
|
||||
type: string
|
||||
reverse_association_attribute_id:
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
type: string
|
||||
format: uuid
|
||||
type: string
|
||||
profile_type_id:
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
type: string
|
||||
format: uuid
|
||||
type: string
|
||||
legacy_id:
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
legacy_id:
|
||||
description: The legacy ID
|
||||
type: integer
|
||||
type: integer
|
||||
tmp_created_at:
|
||||
example: 123
|
||||
type: string
|
||||
format: date-time
|
||||
readOnly: true
|
||||
format: date-time
|
||||
tmp_updated_at:
|
||||
example: 2023-05-01T09:12:28Z
|
||||
type: string
|
||||
format: date-time
|
||||
type: string
|
||||
format: date-time
|
||||
readOnly: true
|
||||
readOnly: true
|
||||
@@ -1,24 +1,16 @@
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
description: the id
|
||||
type: string
|
||||
format: uuid
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
uid:
|
||||
description: the uid
|
||||
type: string
|
||||
minLength: 32
|
||||
maxLength: 32
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
ne_attribute_id:
|
||||
description: the ne_attribute_id
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
option:
|
||||
description: the option
|
||||
type: string
|
||||
example: myoption
|
||||
type: string
|
||||
@@ -3,13 +3,4 @@ properties:
|
||||
ne_attribute_options:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../GET/AttributeOption.yaml'
|
||||
example:
|
||||
- id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
uid: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
ne_attribute_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
option: myoption1
|
||||
- id: db6f8e8b-65c2-47d5-a0db-90bcc4e9d511
|
||||
uid: db6f8e8b-65c2-47d5-a0db-90bcc4e9d511
|
||||
ne_attribute_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9d511
|
||||
option: myoption2
|
||||
$ref: '../GET/AttributeOption.yaml'
|
||||
@@ -1,50 +1,33 @@
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
description: the id
|
||||
type: string
|
||||
format: uuid
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
identity_proofing_action_id:
|
||||
description: The identity_proofing_action_id
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
workflow_session_id:
|
||||
description: the workflow_session_id
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
profile_id:
|
||||
description: the profile_id
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
proofing_workflow:
|
||||
description: the proofing workflow id
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
result:
|
||||
description: the result of the identity proofing
|
||||
type: string
|
||||
enum: [pending, pass, fail]
|
||||
example: pass
|
||||
proofing_attributes:
|
||||
description: Any additional attributes associated with the proofing
|
||||
type: object
|
||||
additionalProperties:
|
||||
type: string
|
||||
example:
|
||||
result: approve
|
||||
created_at:
|
||||
description: The created at time
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2023-05-01T09:12:28Z
|
||||
updated_at:
|
||||
description: The updated at time
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2023-05-01T09:12:28Z
|
||||
format: date-time
|
||||
@@ -1,49 +1,32 @@
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
description: the id
|
||||
type: string
|
||||
format: uuid
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
uid:
|
||||
description: the uid
|
||||
type: string
|
||||
minLength: 32
|
||||
maxLength: 32
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
name:
|
||||
description: the name
|
||||
type: string
|
||||
example: my profile
|
||||
profile_type_id:
|
||||
description: The profile type id
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
status:
|
||||
description: the status
|
||||
type: string
|
||||
enum: [Active, Inactive, On Leave, Terminated]
|
||||
example: Active
|
||||
id_proofing_status:
|
||||
description: the id profing status
|
||||
type: string
|
||||
enum: [pending, pass, fail]
|
||||
example: pending
|
||||
created_at:
|
||||
description: the created at time
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2023-05-01T09:12:28Z
|
||||
updated_at:
|
||||
description: the updated at time
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2023-05-01T09:12:28Z
|
||||
attributes:
|
||||
description: the attributes
|
||||
type: object
|
||||
additionalProperties:
|
||||
type: string
|
||||
|
||||
@@ -1,63 +1,42 @@
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
description: The id
|
||||
type: string
|
||||
format: uuid
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
uid:
|
||||
description: The uid
|
||||
type: string
|
||||
minLength: 32
|
||||
maxLength: 32
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
type:
|
||||
description: The type
|
||||
type: string
|
||||
required: true
|
||||
enum: [ProfileAttributeRule]
|
||||
example: ProfileAttributeRule
|
||||
condition_object_type:
|
||||
description: The condition object type
|
||||
type: string
|
||||
required: true
|
||||
enum: [DateAttribute]
|
||||
example: DateAttribute
|
||||
condition_object_id:
|
||||
description: The condition object id
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
secondary_attribute_type:
|
||||
description: The secondary_attribute_type
|
||||
type: string
|
||||
enum: [DateAttribute]
|
||||
example: DateAttribute
|
||||
secondary_attribute_id:
|
||||
description: The secondary_attribute_id
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
comparison_operator:
|
||||
description: The operator to use for comparison
|
||||
type: string
|
||||
enum: ['>', '<', 'after', 'before']
|
||||
example: <
|
||||
value:
|
||||
description: The value to use for comparison
|
||||
type: string
|
||||
required: true
|
||||
enum: ['Today', '<uid>']
|
||||
example: Today
|
||||
secondary_value:
|
||||
description: The secondary value
|
||||
type: string
|
||||
enum: ['after', 'before']
|
||||
example: after
|
||||
tertiary_value:
|
||||
description: the tertiary_value
|
||||
type: string
|
||||
example: 30
|
||||
|
||||
|
||||
@@ -1,45 +1,31 @@
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
description: The id
|
||||
type: string
|
||||
format: uuid
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
uid:
|
||||
description: The uid
|
||||
type: string
|
||||
minLength: 32
|
||||
maxLength: 32
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
type:
|
||||
description: The type
|
||||
type: string
|
||||
required: true
|
||||
enum: [ProfileAttributeRule]
|
||||
example: ProfileAttributeRule
|
||||
condition_object_type:
|
||||
description: The condition_object_type
|
||||
type: string
|
||||
required: true
|
||||
enum: [ProfileSelectAttribute, ProfileSearchAttribute, OwnerSelectAttribute, OwnerSearchAttribute, ContributorSelectAttribute, ContributorSearchAttribute]
|
||||
example: OwnerSearchAttribute
|
||||
condition_object_id:
|
||||
description: The condition_object_id
|
||||
type: string
|
||||
required: true
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
comparison_operator:
|
||||
description: The comparison_operator
|
||||
type: string
|
||||
required: true
|
||||
enum: ['include?', 'exclude?']
|
||||
example: include?
|
||||
value:
|
||||
description: The value
|
||||
type: string
|
||||
required: true
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
|
||||
@@ -1,44 +1,31 @@
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
description: the id
|
||||
type: string
|
||||
format: uuid
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
uid:
|
||||
description: the uid
|
||||
type: string
|
||||
minLength: 32
|
||||
maxLength: 32
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
type:
|
||||
description: The type
|
||||
type: string
|
||||
required: true
|
||||
enum: [ProfileAttributeRule]
|
||||
example: ProfileAttributeRule
|
||||
condition_object_type:
|
||||
description: The condition_object_type
|
||||
type: string
|
||||
required: true
|
||||
enum: [TextFieldAttribute, TextAreaAttribute]
|
||||
example: TextAreaAttribute
|
||||
condition_object_id:
|
||||
description: The condition_object_id
|
||||
type: string
|
||||
required: true
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
comparison_operator:
|
||||
description: The operator to use for comparison
|
||||
type: string
|
||||
required: true
|
||||
enum: ['==', '!=', '>', '<', 'start_with?', 'end_with?', 'include?']
|
||||
example: ==
|
||||
value:
|
||||
description: The value
|
||||
type: string
|
||||
required: true
|
||||
example: Some value
|
||||
|
||||
@@ -1,32 +1,22 @@
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
description: The id
|
||||
type: string
|
||||
format: uuid
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
uid:
|
||||
description: The uid
|
||||
type: string
|
||||
minLength: 32
|
||||
maxLength: 32
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
type:
|
||||
description: The type
|
||||
type: string
|
||||
required: true
|
||||
enum: [ProfileStatusRule]
|
||||
example: ProfileStatusRule
|
||||
comparison_operator:
|
||||
description: The comparison operator
|
||||
type: string
|
||||
enum: ['==', '!=']
|
||||
example: ==
|
||||
value:
|
||||
description: The value
|
||||
type: string
|
||||
enum: [Active, Inactive, Leave of absence, Terminated]
|
||||
example: Active
|
||||
|
||||
@@ -1,107 +1,61 @@
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
description: The id
|
||||
type: string
|
||||
format: uuid
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
uid:
|
||||
description: The uid
|
||||
type: string
|
||||
minLength: 32
|
||||
maxLength: 32
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
name:
|
||||
description: the name
|
||||
type: string
|
||||
example: my profile type
|
||||
bypass_dup_protection:
|
||||
description: bypass duplicate protection?
|
||||
type: boolean
|
||||
example: false
|
||||
archived:
|
||||
description: is this profile type archived?
|
||||
type: boolean
|
||||
example: false
|
||||
permitted_role_ids:
|
||||
description: permitted role_ids for this profile_type
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
format: uuid
|
||||
example:
|
||||
- db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
- db6f8e8b-65c2-47d5-a0db-90bcc4e9df92
|
||||
profile_type_dup_attributes:
|
||||
description: The profile type duplicate attributes
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
description: the id
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
uid:
|
||||
description: the uid
|
||||
type: string
|
||||
minLength: 32
|
||||
maxLength: 32
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
profile_type_id:
|
||||
description: the profile type id
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
ne_attribute_id:
|
||||
description: the ne attribute id
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
example:
|
||||
- id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
uid: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9f
|
||||
profile_type_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9g
|
||||
ne_attribute_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9h
|
||||
profile_type_namings:
|
||||
description: the profile type namings
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
description: the id
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
uid:
|
||||
description: the uid
|
||||
type: string
|
||||
minLength: 32
|
||||
maxLength: 32
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
profile_type_id:
|
||||
description: the profile type id
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
ne_attribute_id:
|
||||
description: the ne attribute id
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
order:
|
||||
description: the order
|
||||
type: integer
|
||||
format: int32
|
||||
minimum: 0
|
||||
example: 0
|
||||
example:
|
||||
- id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
uid: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9f
|
||||
profile_type_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9g
|
||||
ne_attribute_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9h
|
||||
order: 0
|
||||
|
||||
@@ -1,32 +1,22 @@
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
description: The id
|
||||
type: string
|
||||
format: uuid
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
uid:
|
||||
description: The uuid
|
||||
type: string
|
||||
minLength: 32
|
||||
maxLength: 32
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
type:
|
||||
description: The type
|
||||
type: string
|
||||
required: true
|
||||
enum: [ProfileTypeRule]
|
||||
example: ProfileTypeRule
|
||||
comparison_operator:
|
||||
description: The comparison operator
|
||||
type: string
|
||||
enum: ['==', '!=']
|
||||
example: ==
|
||||
value:
|
||||
description: The value
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
|
||||
@@ -3,20 +3,4 @@ properties:
|
||||
profiles:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../GET/Profile.yaml'
|
||||
example:
|
||||
- id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
uid: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
name: my profile
|
||||
profile_type_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
status: Active
|
||||
id_proofing_status: pending
|
||||
created_at: 2023-05-01T09:12:28Z
|
||||
updated_at: 2023-05-01T09:12:28Z
|
||||
attributes:
|
||||
text_attribute_uid: static text
|
||||
date_attribute_uid: 01/15/2020
|
||||
profile_select_attribute_uid: Profile Name
|
||||
multiple_profile_select_attribute_uid: Profile Name,Second Profile Name,Third Profile Name
|
||||
contributor_select_attribute_uid: User Name
|
||||
multiple_contributor_select_attribute_uid: User Name,Second User Name,Third User Name
|
||||
$ref: '../GET/Profile.yaml'
|
||||
@@ -1,31 +1,19 @@
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
description: the id
|
||||
type: string
|
||||
format: uuid
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
uid:
|
||||
description: the uid
|
||||
type: string
|
||||
minLength: 32
|
||||
maxLength: 32
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
label:
|
||||
description: The label
|
||||
type: string
|
||||
example: my_risk_level
|
||||
points:
|
||||
description: The risk points
|
||||
type: number
|
||||
format: decimal
|
||||
multipleOf: 0.01
|
||||
example: 0.5
|
||||
order:
|
||||
description: The order of this risk level
|
||||
type: integer
|
||||
format: int32
|
||||
minimum: 0
|
||||
example: 0
|
||||
minimum: 0
|
||||
@@ -1,39 +1,27 @@
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
description: The id
|
||||
type: string
|
||||
format: uuid
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
uid:
|
||||
description: the uid
|
||||
type: string
|
||||
minLength: 32
|
||||
maxLength: 32
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
type:
|
||||
description: The type
|
||||
type: string
|
||||
required: true
|
||||
enum: [RiskRule]
|
||||
example: RiskRule
|
||||
comparison_operator:
|
||||
description: The operator to use for comparison
|
||||
type: string
|
||||
enum: ['==', '>', '<']
|
||||
example: ==
|
||||
value:
|
||||
description: Id of the Risk Level being compared against
|
||||
type: string
|
||||
summary: id of the Risk Level being compared against
|
||||
required: true
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
secondary_value:
|
||||
description: The secondary value
|
||||
type: string
|
||||
required: true
|
||||
enum: [OverallRisk]
|
||||
example: OverallRisk
|
||||
@@ -1,58 +1,35 @@
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
description: id
|
||||
type: string
|
||||
format: uuid
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
uid:
|
||||
description: the uid
|
||||
type: string
|
||||
minLength: 32
|
||||
maxLength: 32
|
||||
readOnly: true
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
object_id:
|
||||
description: the object id
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
object_type:
|
||||
description: the object type
|
||||
type: string
|
||||
enum: [Profile, WorkflowSession]
|
||||
example: Profile
|
||||
overall_score:
|
||||
description: Overall score
|
||||
type: number
|
||||
format: decimal
|
||||
multipleOf: 0.01
|
||||
example: 0.2
|
||||
overall_risk_level_id:
|
||||
description: the overall risk level id
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
impact_score:
|
||||
description: the impact score
|
||||
type: number
|
||||
format: decimal
|
||||
multipleOf: 0.01
|
||||
example: 0.4
|
||||
impact_risk_level_id:
|
||||
description: the impact risk level id
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
probability_score:
|
||||
description: the probability_score
|
||||
type: number
|
||||
format: decimal
|
||||
multipleOf: 0.01
|
||||
example: 0.5
|
||||
probability_risk_level_id:
|
||||
description: The probability risk level id
|
||||
type: string
|
||||
format: uuid
|
||||
example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
|
||||
format: uuid
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user