diff --git a/static/api-specs/nerm/openapi.yaml b/static/api-specs/nerm/openapi.yaml index af8ef899c..e024e75d9 100644 --- a/static/api-specs/nerm/openapi.yaml +++ b/static/api-specs/nerm/openapi.yaml @@ -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 diff --git a/static/api-specs/nerm/parameters/path/attribute_id.yaml b/static/api-specs/nerm/parameters/path/attribute_id.yaml index 34096d73d..bd5d28e89 100644 --- a/static/api-specs/nerm/parameters/path/attribute_id.yaml +++ b/static/api-specs/nerm/parameters/path/attribute_id.yaml @@ -4,5 +4,4 @@ description: The id of the attachment attribute required: true schema: type: string - format: uuid -example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file + format: uuid \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/path/id.yaml b/static/api-specs/nerm/parameters/path/id.yaml index eb12f2812..39d8bb7cc 100644 --- a/static/api-specs/nerm/parameters/path/id.yaml +++ b/static/api-specs/nerm/parameters/path/id.yaml @@ -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 \ No newline at end of file + example: 1246d8b3-ac29-4015-8154-dea4434a73fa \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/archived.yaml b/static/api-specs/nerm/parameters/query/archived.yaml index b357ed48c..3ca1144c3 100644 --- a/static/api-specs/nerm/parameters/query/archived.yaml +++ b/static/api-specs/nerm/parameters/query/archived.yaml @@ -4,5 +4,4 @@ description: Filter by archive status required: false schema: type: boolean - default: false -example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file + default: false \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/data_type.yaml b/static/api-specs/nerm/parameters/query/data_type.yaml index dc0cb0999..07ff572e4 100644 --- a/static/api-specs/nerm/parameters/query/data_type.yaml +++ b/static/api-specs/nerm/parameters/query/data_type.yaml @@ -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 \ No newline at end of file + 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] \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/email.yaml b/static/api-specs/nerm/parameters/query/email.yaml index 4418305cd..e7a35b61d 100644 --- a/static/api-specs/nerm/parameters/query/email.yaml +++ b/static/api-specs/nerm/parameters/query/email.yaml @@ -4,5 +4,4 @@ description: The user email to search by required: false schema: type: string - format: email -example: test@sailpoint.com \ No newline at end of file + format: email \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/exclude_attributes.yaml b/static/api-specs/nerm/parameters/query/exclude_attributes.yaml index 45818ac49..7d93aa0a8 100644 --- a/static/api-specs/nerm/parameters/query/exclude_attributes.yaml +++ b/static/api-specs/nerm/parameters/query/exclude_attributes.yaml @@ -4,5 +4,4 @@ description: Allows for optimization by not returning the associated attribute d required: false schema: type: boolean - default: false -example: true \ No newline at end of file + default: false \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/impact_risk_level_id.yaml b/static/api-specs/nerm/parameters/query/impact_risk_level_id.yaml index 2018f3e6f..7aa5afac7 100644 --- a/static/api-specs/nerm/parameters/query/impact_risk_level_id.yaml +++ b/static/api-specs/nerm/parameters/query/impact_risk_level_id.yaml @@ -4,6 +4,4 @@ description: Impact risk level to filter by required: false schema: type: string - format: uuid -example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - \ No newline at end of file + format: uuid \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/job_id.yaml b/static/api-specs/nerm/parameters/query/job_id.yaml index ab37f29ce..bc9b2f32c 100644 --- a/static/api-specs/nerm/parameters/query/job_id.yaml +++ b/static/api-specs/nerm/parameters/query/job_id.yaml @@ -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 \ No newline at end of file + type: string \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/label.yaml b/static/api-specs/nerm/parameters/query/label.yaml index 79b2fa488..e22136c34 100644 --- a/static/api-specs/nerm/parameters/query/label.yaml +++ b/static/api-specs/nerm/parameters/query/label.yaml @@ -2,6 +2,5 @@ name: label in: query description: The attribute label to filter by required: false -example: mylabel schema: type: string \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/login.yaml b/static/api-specs/nerm/parameters/query/login.yaml index e24061937..086e07974 100644 --- a/static/api-specs/nerm/parameters/query/login.yaml +++ b/static/api-specs/nerm/parameters/query/login.yaml @@ -3,5 +3,4 @@ in: query description: The user login to search by required: false schema: - type: string -example: myuser \ No newline at end of file + type: string \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/manager_id.yaml b/static/api-specs/nerm/parameters/query/manager_id.yaml index 99cef40a7..95e8a59b9 100644 --- a/static/api-specs/nerm/parameters/query/manager_id.yaml +++ b/static/api-specs/nerm/parameters/query/manager_id.yaml @@ -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 \ No newline at end of file + format: uuid \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/metadata.yaml b/static/api-specs/nerm/parameters/query/metadata.yaml index 3f684a8a9..040b24bbd 100644 --- a/static/api-specs/nerm/parameters/query/metadata.yaml +++ b/static/api-specs/nerm/parameters/query/metadata.yaml @@ -2,7 +2,7 @@ name: metadata in: query description: Returns batching metadata in the response required: false -example: true schema: type: boolean - default: false \ No newline at end of file + default: false + example: true \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/name.yaml b/static/api-specs/nerm/parameters/query/name.yaml index a0ad72942..140b4efa8 100644 --- a/static/api-specs/nerm/parameters/query/name.yaml +++ b/static/api-specs/nerm/parameters/query/name.yaml @@ -3,5 +3,4 @@ in: query description: object name for filtering required: false schema: - type: string -example: objectname + type: string \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/ne_attribute_id.yaml b/static/api-specs/nerm/parameters/query/ne_attribute_id.yaml index 38edb209b..07e391906 100644 --- a/static/api-specs/nerm/parameters/query/ne_attribute_id.yaml +++ b/static/api-specs/nerm/parameters/query/ne_attribute_id.yaml @@ -5,4 +5,4 @@ required: false schema: type: string format: uuid -example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/object_id.yaml b/static/api-specs/nerm/parameters/query/object_id.yaml index d5bcb301d..d2ccd7a71 100644 --- a/static/api-specs/nerm/parameters/query/object_id.yaml +++ b/static/api-specs/nerm/parameters/query/object_id.yaml @@ -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 - \ No newline at end of file + format: uuid \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/object_type.yaml b/static/api-specs/nerm/parameters/query/object_type.yaml index 86553d781..73e610fa3 100644 --- a/static/api-specs/nerm/parameters/query/object_type.yaml +++ b/static/api-specs/nerm/parameters/query/object_type.yaml @@ -4,5 +4,4 @@ description: Type of object that object_id represents required: false schema: type: string - enum: [Profile, WorkflowSession] -example: Profile \ No newline at end of file + enum: [Profile, WorkflowSession] \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/option.yaml b/static/api-specs/nerm/parameters/query/option.yaml index cb7edb91b..68a2c5265 100644 --- a/static/api-specs/nerm/parameters/query/option.yaml +++ b/static/api-specs/nerm/parameters/query/option.yaml @@ -3,5 +3,4 @@ in: query description: attribute option label for filtering required: false schema: - type: string -example: my_option_label \ No newline at end of file + type: string \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/overall_risk_level_id.yaml b/static/api-specs/nerm/parameters/query/overall_risk_level_id.yaml index 3f4f2e3fa..485693240 100644 --- a/static/api-specs/nerm/parameters/query/overall_risk_level_id.yaml +++ b/static/api-specs/nerm/parameters/query/overall_risk_level_id.yaml @@ -4,5 +4,4 @@ description: Overall risk level to filter by required: false schema: type: string - format: uuid -example: \ No newline at end of file + format: uuid \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/probability_risk_level_id.yaml b/static/api-specs/nerm/parameters/query/probability_risk_level_id.yaml index d2ddbaf32..a793f6bbc 100644 --- a/static/api-specs/nerm/parameters/query/probability_risk_level_id.yaml +++ b/static/api-specs/nerm/parameters/query/probability_risk_level_id.yaml @@ -4,6 +4,4 @@ description: Probability risk level to filter by required: false schema: type: string - format: uuid -example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - \ No newline at end of file + format: uuid \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/profile_id.yaml b/static/api-specs/nerm/parameters/query/profile_id.yaml index c12e6e1c1..5fdf90302 100644 --- a/static/api-specs/nerm/parameters/query/profile_id.yaml +++ b/static/api-specs/nerm/parameters/query/profile_id.yaml @@ -5,4 +5,4 @@ required: false schema: type: string format: uuid -example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file + example: 4e480441-451d-47d9-87c2-9a0f0fe135eb \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/profile_type_id.yaml b/static/api-specs/nerm/parameters/query/profile_type_id.yaml index 6728b2839..65075491e 100644 --- a/static/api-specs/nerm/parameters/query/profile_type_id.yaml +++ b/static/api-specs/nerm/parameters/query/profile_type_id.yaml @@ -4,5 +4,4 @@ description: Profile Type ID for filtering required: false schema: type: string - format: uuid -example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file + format: uuid \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/query.yaml b/static/api-specs/nerm/parameters/query/query.yaml index 7899ce9de..d16618c0d 100644 --- a/static/api-specs/nerm/parameters/query/query.yaml +++ b/static/api-specs/nerm/parameters/query/query.yaml @@ -1,53 +1,22 @@ name: query in: query -description: | - Allows for pagination and sorting using the deepObject notation. - -
- - `resource?query[limit]=50&query[offset]=0&query[order]=label` - -
- - - - - - - - - - - - - - - - - - - - - - - -
ParameterDescriptionDefault
limitLimits the number of results returned100
offsetReturns the results starting at the value provided0
orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
+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 diff --git a/static/api-specs/nerm/parameters/query/relationship_type.yaml b/static/api-specs/nerm/parameters/query/relationship_type.yaml index a3c235c5b..f4ec97e49 100644 --- a/static/api-specs/nerm/parameters/query/relationship_type.yaml +++ b/static/api-specs/nerm/parameters/query/relationship_type.yaml @@ -5,4 +5,4 @@ required: false schema: type: string enum: [owner, contributor] -example: owner \ No newline at end of file + example: contributor \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/requester_id.yaml b/static/api-specs/nerm/parameters/query/requester_id.yaml index a8bf3468b..f1ce95e91 100644 --- a/static/api-specs/nerm/parameters/query/requester_id.yaml +++ b/static/api-specs/nerm/parameters/query/requester_id.yaml @@ -4,5 +4,4 @@ description: Requester ID for filtering required: false schema: type: string - format: uuid -example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file + format: uuid \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/result.yaml b/static/api-specs/nerm/parameters/query/result.yaml index 430ffab9e..8f3fdcb3c 100644 --- a/static/api-specs/nerm/parameters/query/result.yaml +++ b/static/api-specs/nerm/parameters/query/result.yaml @@ -4,5 +4,4 @@ description: ID Proofing Result to filter by required: false schema: type: string - enum: [pass, fail] -example: fail \ No newline at end of file + enum: [pass, fail] \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/role_id.yaml b/static/api-specs/nerm/parameters/query/role_id.yaml index c454d3102..abb841bbe 100644 --- a/static/api-specs/nerm/parameters/query/role_id.yaml +++ b/static/api-specs/nerm/parameters/query/role_id.yaml @@ -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 \ No newline at end of file + format: uuid \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/run.yaml b/static/api-specs/nerm/parameters/query/run.yaml index 6821247e0..cf53c5f20 100644 --- a/static/api-specs/nerm/parameters/query/run.yaml +++ b/static/api-specs/nerm/parameters/query/run.yaml @@ -4,5 +4,4 @@ description: Will run the created/updated workflow session if successful required: false schema: type: boolean - default: false -example: true \ No newline at end of file + default: false \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/status.yaml b/static/api-specs/nerm/parameters/query/status.yaml index ba852f24f..f02190b79 100644 --- a/static/api-specs/nerm/parameters/query/status.yaml +++ b/static/api-specs/nerm/parameters/query/status.yaml @@ -4,5 +4,4 @@ description: status value for filtering required: false schema: type: string - enum: [Active, Inactive, On Leave, Terminated] -example: Active \ No newline at end of file + enum: [Active, Inactive, On Leave, Terminated] \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/title.yaml b/static/api-specs/nerm/parameters/query/title.yaml index 4f30ae8e0..617ea14b1 100644 --- a/static/api-specs/nerm/parameters/query/title.yaml +++ b/static/api-specs/nerm/parameters/query/title.yaml @@ -3,5 +3,4 @@ in: query description: The user title to search by required: false schema: - type: string -example: usertitle \ No newline at end of file + type: string \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/uid.yaml b/static/api-specs/nerm/parameters/query/uid.yaml index ae479401a..4f5408a1f 100644 --- a/static/api-specs/nerm/parameters/query/uid.yaml +++ b/static/api-specs/nerm/parameters/query/uid.yaml @@ -5,5 +5,4 @@ required: false schema: type: string minLength: 32 - maxLength: 32 -example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file + maxLength: 32 \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/user_id.yaml b/static/api-specs/nerm/parameters/query/user_id.yaml index 4859cdf16..d5e3e63f5 100644 --- a/static/api-specs/nerm/parameters/query/user_id.yaml +++ b/static/api-specs/nerm/parameters/query/user_id.yaml @@ -5,4 +5,4 @@ required: false schema: type: string format: uuid -example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file + example: bba9cfb2-96c1-4acb-ac79-a21732527265 \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/workflow_id.yaml b/static/api-specs/nerm/parameters/query/workflow_id.yaml index 9a34e2cb5..43b42fbc3 100644 --- a/static/api-specs/nerm/parameters/query/workflow_id.yaml +++ b/static/api-specs/nerm/parameters/query/workflow_id.yaml @@ -4,5 +4,4 @@ description: Workflow ID for filtering required: false schema: type: string - format: uuid -example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file + format: uuid \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/workflow_session_id.yaml b/static/api-specs/nerm/parameters/query/workflow_session_id.yaml index ac2e0323d..bac2602fa 100644 --- a/static/api-specs/nerm/parameters/query/workflow_session_id.yaml +++ b/static/api-specs/nerm/parameters/query/workflow_session_id.yaml @@ -4,5 +4,4 @@ description: Workflow Session ID to filter by required: false schema: type: string - format: uuid -example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file + format: uuid \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/workflow_session_status.yaml b/static/api-specs/nerm/parameters/query/workflow_session_status.yaml index 7727342cc..95e920c14 100644 --- a/static/api-specs/nerm/parameters/query/workflow_session_status.yaml +++ b/static/api-specs/nerm/parameters/query/workflow_session_status.yaml @@ -67,5 +67,4 @@ schema: "pending identity proofing", "closed", "workflow changed" - ] -example: batch completed \ No newline at end of file + ] \ No newline at end of file diff --git a/static/api-specs/nerm/paths/advanced_search.yaml b/static/api-specs/nerm/paths/advanced_search.yaml index c6f08618d..513fda0e0 100644 --- a/static/api-specs/nerm/paths/advanced_search.yaml +++ b/static/api-specs/nerm/paths/advanced_search.yaml @@ -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: diff --git a/static/api-specs/nerm/paths/advanced_search_id.yaml b/static/api-specs/nerm/paths/advanced_search_id.yaml index 76e6742c4..4525f182f 100644 --- a/static/api-specs/nerm/paths/advanced_search_id.yaml +++ b/static/api-specs/nerm/paths/advanced_search_id.yaml @@ -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: diff --git a/static/api-specs/nerm/paths/advanced_search_id_run.yaml b/static/api-specs/nerm/paths/advanced_search_id_run.yaml index 5edcd2fc8..4167b8532 100644 --- a/static/api-specs/nerm/paths/advanced_search_id_run.yaml +++ b/static/api-specs/nerm/paths/advanced_search_id_run.yaml @@ -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" diff --git a/static/api-specs/nerm/paths/advanced_search_run.yaml b/static/api-specs/nerm/paths/advanced_search_run.yaml index c43cbe9c9..b6a8b3c00 100644 --- a/static/api-specs/nerm/paths/advanced_search_run.yaml +++ b/static/api-specs/nerm/paths/advanced_search_run.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: diff --git a/static/api-specs/nerm/paths/identity_proofing_results.yaml b/static/api-specs/nerm/paths/identity_proofing_results.yaml index e613d9c14..f0e2d03b7 100644 --- a/static/api-specs/nerm/paths/identity_proofing_results.yaml +++ b/static/api-specs/nerm/paths/identity_proofing_results.yaml @@ -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" diff --git a/static/api-specs/nerm/paths/job_status.yaml b/static/api-specs/nerm/paths/job_status.yaml index ded7bb488..7eb53d8e5 100644 --- a/static/api-specs/nerm/paths/job_status.yaml +++ b/static/api-specs/nerm/paths/job_status.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: diff --git a/static/api-specs/nerm/paths/ne_attribute_option.yaml b/static/api-specs/nerm/paths/ne_attribute_option.yaml index 6023e09d9..bf5cf08e8 100644 --- a/static/api-specs/nerm/paths/ne_attribute_option.yaml +++ b/static/api-specs/nerm/paths/ne_attribute_option.yaml @@ -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: diff --git a/static/api-specs/nerm/paths/ne_attribute_options.yaml b/static/api-specs/nerm/paths/ne_attribute_options.yaml index 2c6cd6330..458e5dc99 100644 --- a/static/api-specs/nerm/paths/ne_attribute_options.yaml +++ b/static/api-specs/nerm/paths/ne_attribute_options.yaml @@ -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: diff --git a/static/api-specs/nerm/paths/ne_attribute_options_id.yaml b/static/api-specs/nerm/paths/ne_attribute_options_id.yaml index be4e3141f..13b628027 100644 --- a/static/api-specs/nerm/paths/ne_attribute_options_id.yaml +++ b/static/api-specs/nerm/paths/ne_attribute_options_id.yaml @@ -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: diff --git a/static/api-specs/nerm/paths/ne_attributes.yaml b/static/api-specs/nerm/paths/ne_attributes.yaml index 77d2c4ce4..ded091106 100644 --- a/static/api-specs/nerm/paths/ne_attributes.yaml +++ b/static/api-specs/nerm/paths/ne_attributes.yaml @@ -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" diff --git a/static/api-specs/nerm/paths/ne_attributes_id.yaml b/static/api-specs/nerm/paths/ne_attributes_id.yaml index 0f2cc3861..ff2982ab6 100644 --- a/static/api-specs/nerm/paths/ne_attributes_id.yaml +++ b/static/api-specs/nerm/paths/ne_attributes_id.yaml @@ -3,7 +3,7 @@ get: operationId: getAttribute description: Info for a specific attribute tags: - - Attributes + - attributes parameters: - $ref: "../parameters/path/id.yaml" responses: diff --git a/static/api-specs/nerm/paths/profile.yaml b/static/api-specs/nerm/paths/profile.yaml index 6d6ad316f..069406080 100644 --- a/static/api-specs/nerm/paths/profile.yaml +++ b/static/api-specs/nerm/paths/profile.yaml @@ -3,7 +3,7 @@ post: operationId: postProfile description: Create a profile tags: - - Profiles + - profiles requestBody: $ref: "../requestBodies/POST/Profile.yaml" responses: diff --git a/static/api-specs/nerm/paths/profile_type.yaml b/static/api-specs/nerm/paths/profile_type.yaml index b6090dc3c..cb3de27ed 100644 --- a/static/api-specs/nerm/paths/profile_type.yaml +++ b/static/api-specs/nerm/paths/profile_type.yaml @@ -3,7 +3,7 @@ post: operationId: postProfileType description: Create a profile type tags: - - Profile Types + - profile types requestBody: $ref: "../requestBodies/POST/ProfileType.yaml" responses: diff --git a/static/api-specs/nerm/paths/profile_types.yaml b/static/api-specs/nerm/paths/profile_types.yaml index 22e5df267..b9ef12cec 100644 --- a/static/api-specs/nerm/paths/profile_types.yaml +++ b/static/api-specs/nerm/paths/profile_types.yaml @@ -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" diff --git a/static/api-specs/nerm/paths/profile_types_id.yaml b/static/api-specs/nerm/paths/profile_types_id.yaml index e81796b22..d7c2d7b62 100644 --- a/static/api-specs/nerm/paths/profile_types_id.yaml +++ b/static/api-specs/nerm/paths/profile_types_id.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: diff --git a/static/api-specs/nerm/paths/profiles.yaml b/static/api-specs/nerm/paths/profiles.yaml index 009f895ee..e9e06c169 100644 --- a/static/api-specs/nerm/paths/profiles.yaml +++ b/static/api-specs/nerm/paths/profiles.yaml @@ -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: diff --git a/static/api-specs/nerm/paths/profiles_id.yaml b/static/api-specs/nerm/paths/profiles_id.yaml index 0dcc9987a..b404fe1db 100644 --- a/static/api-specs/nerm/paths/profiles_id.yaml +++ b/static/api-specs/nerm/paths/profiles_id.yaml @@ -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" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/profiles_id_avatar.yaml b/static/api-specs/nerm/paths/profiles_id_avatar.yaml index 0d4e44113..0c209a0d0 100644 --- a/static/api-specs/nerm/paths/profiles_id_avatar.yaml +++ b/static/api-specs/nerm/paths/profiles_id_avatar.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: diff --git a/static/api-specs/nerm/paths/profiles_id_upload_attribute_id.yaml b/static/api-specs/nerm/paths/profiles_id_upload_attribute_id.yaml index 34beae05b..f61597b2a 100644 --- a/static/api-specs/nerm/paths/profiles_id_upload_attribute_id.yaml +++ b/static/api-specs/nerm/paths/profiles_id_upload_attribute_id.yaml @@ -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" diff --git a/static/api-specs/nerm/paths/risk_levels.yaml b/static/api-specs/nerm/paths/risk_levels.yaml index 423431b4c..936af7101 100644 --- a/static/api-specs/nerm/paths/risk_levels.yaml +++ b/static/api-specs/nerm/paths/risk_levels.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" diff --git a/static/api-specs/nerm/paths/risk_levels_id.yaml b/static/api-specs/nerm/paths/risk_levels_id.yaml index a8ec737d0..6a6eae165 100644 --- a/static/api-specs/nerm/paths/risk_levels_id.yaml +++ b/static/api-specs/nerm/paths/risk_levels_id.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: diff --git a/static/api-specs/nerm/paths/risk_scores.yaml b/static/api-specs/nerm/paths/risk_scores.yaml index 38553734a..4c5f01004 100644 --- a/static/api-specs/nerm/paths/risk_scores.yaml +++ b/static/api-specs/nerm/paths/risk_scores.yaml @@ -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" diff --git a/static/api-specs/nerm/paths/risk_scores_id.yaml b/static/api-specs/nerm/paths/risk_scores_id.yaml index f4853c5a6..ff90d04f6 100644 --- a/static/api-specs/nerm/paths/risk_scores_id.yaml +++ b/static/api-specs/nerm/paths/risk_scores_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: diff --git a/static/api-specs/nerm/paths/role.yaml b/static/api-specs/nerm/paths/role.yaml index 3ef66a33e..c624e1280 100644 --- a/static/api-specs/nerm/paths/role.yaml +++ b/static/api-specs/nerm/paths/role.yaml @@ -3,7 +3,7 @@ post: operationId: postRole description: Create a new role tags: - - Roles + - roles requestBody: $ref: "../requestBodies/POST/Role.yaml" responses: diff --git a/static/api-specs/nerm/paths/role_profile.yaml b/static/api-specs/nerm/paths/role_profile.yaml index 64f7fb2d5..3cdf0aa4e 100644 --- a/static/api-specs/nerm/paths/role_profile.yaml +++ b/static/api-specs/nerm/paths/role_profile.yaml @@ -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: diff --git a/static/api-specs/nerm/paths/role_profile_id.yaml b/static/api-specs/nerm/paths/role_profile_id.yaml index 28d82c4c8..768951e2a 100644 --- a/static/api-specs/nerm/paths/role_profile_id.yaml +++ b/static/api-specs/nerm/paths/role_profile_id.yaml @@ -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: diff --git a/static/api-specs/nerm/paths/role_profiles.yaml b/static/api-specs/nerm/paths/role_profiles.yaml index 37d92bf6a..7212de626 100644 --- a/static/api-specs/nerm/paths/role_profiles.yaml +++ b/static/api-specs/nerm/paths/role_profiles.yaml @@ -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: diff --git a/static/api-specs/nerm/paths/role_profiles_id.yaml b/static/api-specs/nerm/paths/role_profiles_id.yaml index 7c90aa31d..4e3be3248 100644 --- a/static/api-specs/nerm/paths/role_profiles_id.yaml +++ b/static/api-specs/nerm/paths/role_profiles_id.yaml @@ -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: diff --git a/static/api-specs/nerm/paths/roles.yaml b/static/api-specs/nerm/paths/roles.yaml index f17b829eb..e7fa5f7c9 100644 --- a/static/api-specs/nerm/paths/roles.yaml +++ b/static/api-specs/nerm/paths/roles.yaml @@ -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: diff --git a/static/api-specs/nerm/paths/roles_id.yaml b/static/api-specs/nerm/paths/roles_id.yaml index db90e8f39..567954c5b 100644 --- a/static/api-specs/nerm/paths/roles_id.yaml +++ b/static/api-specs/nerm/paths/roles_id.yaml @@ -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: diff --git a/static/api-specs/nerm/paths/user.yaml b/static/api-specs/nerm/paths/user.yaml index ca61f0f11..ed1b22aef 100644 --- a/static/api-specs/nerm/paths/user.yaml +++ b/static/api-specs/nerm/paths/user.yaml @@ -3,7 +3,7 @@ post: operationId: postUser description: Create a new user tags: - - Users + - users requestBody: $ref: "../requestBodies/POST/User.yaml" responses: diff --git a/static/api-specs/nerm/paths/user_manager.yaml b/static/api-specs/nerm/paths/user_manager.yaml index d9f4de925..21c6e9daf 100644 --- a/static/api-specs/nerm/paths/user_manager.yaml +++ b/static/api-specs/nerm/paths/user_manager.yaml @@ -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: diff --git a/static/api-specs/nerm/paths/user_managers.yaml b/static/api-specs/nerm/paths/user_managers.yaml index 6a30fddf6..8b5a2831c 100644 --- a/static/api-specs/nerm/paths/user_managers.yaml +++ b/static/api-specs/nerm/paths/user_managers.yaml @@ -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: diff --git a/static/api-specs/nerm/paths/user_managers_id.yaml b/static/api-specs/nerm/paths/user_managers_id.yaml index 5e51e8ef0..4446a9615 100644 --- a/static/api-specs/nerm/paths/user_managers_id.yaml +++ b/static/api-specs/nerm/paths/user_managers_id.yaml @@ -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: diff --git a/static/api-specs/nerm/paths/user_profile.yaml b/static/api-specs/nerm/paths/user_profile.yaml index 30544f37f..22a5cb992 100644 --- a/static/api-specs/nerm/paths/user_profile.yaml +++ b/static/api-specs/nerm/paths/user_profile.yaml @@ -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: diff --git a/static/api-specs/nerm/paths/user_profile_id.yaml b/static/api-specs/nerm/paths/user_profile_id.yaml index 24112b92c..2b4495104 100644 --- a/static/api-specs/nerm/paths/user_profile_id.yaml +++ b/static/api-specs/nerm/paths/user_profile_id.yaml @@ -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: diff --git a/static/api-specs/nerm/paths/user_profiles.yaml b/static/api-specs/nerm/paths/user_profiles.yaml index d8fade868..9408bd678 100644 --- a/static/api-specs/nerm/paths/user_profiles.yaml +++ b/static/api-specs/nerm/paths/user_profiles.yaml @@ -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" diff --git a/static/api-specs/nerm/paths/user_profiles_id.yaml b/static/api-specs/nerm/paths/user_profiles_id.yaml index 536d6a5c2..f5299a0e8 100644 --- a/static/api-specs/nerm/paths/user_profiles_id.yaml +++ b/static/api-specs/nerm/paths/user_profiles_id.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: diff --git a/static/api-specs/nerm/paths/user_role.yaml b/static/api-specs/nerm/paths/user_role.yaml index 919152d3e..033b3061f 100644 --- a/static/api-specs/nerm/paths/user_role.yaml +++ b/static/api-specs/nerm/paths/user_role.yaml @@ -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: diff --git a/static/api-specs/nerm/paths/user_role_id.yaml b/static/api-specs/nerm/paths/user_role_id.yaml index 4b07b4376..70a7e90f5 100644 --- a/static/api-specs/nerm/paths/user_role_id.yaml +++ b/static/api-specs/nerm/paths/user_role_id.yaml @@ -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: diff --git a/static/api-specs/nerm/paths/user_roles.yaml b/static/api-specs/nerm/paths/user_roles.yaml index 9bf815b94..55dffe5b2 100644 --- a/static/api-specs/nerm/paths/user_roles.yaml +++ b/static/api-specs/nerm/paths/user_roles.yaml @@ -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: diff --git a/static/api-specs/nerm/paths/user_roles_id.yaml b/static/api-specs/nerm/paths/user_roles_id.yaml index 66849300a..7a74e7edb 100644 --- a/static/api-specs/nerm/paths/user_roles_id.yaml +++ b/static/api-specs/nerm/paths/user_roles_id.yaml @@ -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: diff --git a/static/api-specs/nerm/paths/users.yaml b/static/api-specs/nerm/paths/users.yaml index 1f1d3eef6..4f15bf620 100644 --- a/static/api-specs/nerm/paths/users.yaml +++ b/static/api-specs/nerm/paths/users.yaml @@ -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: diff --git a/static/api-specs/nerm/paths/users_id.yaml b/static/api-specs/nerm/paths/users_id.yaml index cdc61744f..4c998a02d 100644 --- a/static/api-specs/nerm/paths/users_id.yaml +++ b/static/api-specs/nerm/paths/users_id.yaml @@ -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: diff --git a/static/api-specs/nerm/paths/users_id_avatar.yaml b/static/api-specs/nerm/paths/users_id_avatar.yaml index de361b3ce..bb603c3b5 100644 --- a/static/api-specs/nerm/paths/users_id_avatar.yaml +++ b/static/api-specs/nerm/paths/users_id_avatar.yaml @@ -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: diff --git a/static/api-specs/nerm/paths/workflow_sessions.yaml b/static/api-specs/nerm/paths/workflow_sessions.yaml index 247671250..e53e34d78 100644 --- a/static/api-specs/nerm/paths/workflow_sessions.yaml +++ b/static/api-specs/nerm/paths/workflow_sessions.yaml @@ -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: diff --git a/static/api-specs/nerm/paths/workflow_sessions_id.yaml b/static/api-specs/nerm/paths/workflow_sessions_id.yaml index 63d09e438..65f8ea4be 100644 --- a/static/api-specs/nerm/paths/workflow_sessions_id.yaml +++ b/static/api-specs/nerm/paths/workflow_sessions_id.yaml @@ -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" diff --git a/static/api-specs/nerm/paths/workflow_sessions_id_upload_attribute_id.yaml b/static/api-specs/nerm/paths/workflow_sessions_id_upload_attribute_id.yaml index bb87c4da5..e94c2ad1c 100644 --- a/static/api-specs/nerm/paths/workflow_sessions_id_upload_attribute_id.yaml +++ b/static/api-specs/nerm/paths/workflow_sessions_id_upload_attribute_id.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" diff --git a/static/api-specs/nerm/requestBodies/DELETE/UserProfiles.yaml b/static/api-specs/nerm/requestBodies/DELETE/UserProfiles.yaml new file mode 100644 index 000000000..e1d0d310e --- /dev/null +++ b/static/api-specs/nerm/requestBodies/DELETE/UserProfiles.yaml @@ -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 \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/AdvancedSearch.yaml b/static/api-specs/nerm/schemas/GET/AdvancedSearch.yaml index c2b76594c..488d7c674 100644 --- a/static/api-specs/nerm/schemas/GET/AdvancedSearch.yaml +++ b/static/api-specs/nerm/schemas/GET/AdvancedSearch.yaml @@ -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 + diff --git a/static/api-specs/nerm/schemas/GET/Attribute.yaml b/static/api-specs/nerm/schemas/GET/Attribute.yaml index 3747d11aa..f87dd0c7e 100644 --- a/static/api-specs/nerm/schemas/GET/Attribute.yaml +++ b/static/api-specs/nerm/schemas/GET/Attribute.yaml @@ -1,120 +1,70 @@ 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_attribute description: - description: The description type: string - example: This is my attribute tool_tip: - description: The tool tip type: string - example: my attribute crypt: - description: Should this be encrypted? type: boolean - example: true archived: - description: Is this attribute archived? type: boolean - example: false archived_on: - description: When was this attribute archved type: string format: date-time readOnly: true - example: 2023-05-01T09:12:28Z created_at: - description: The created_at time type: string format: date-time readOnly: true - example: 2023-05-01T09:12:28Z updated_at: - description: The updated_at time type: string format: date-time readOnly: true - example: 2023-05-01T09:12:28Z date_format: - description: The format of the date type: string enum: [mm/dd/yyyy, mm-dd-yyyy, dd/mm/yyyy, dd-mm-yyyy, yyyy/mm/dd, yyyy-mm-dd] - example: mm/dd/yyyy selectable_status: - description: The selectable_status type: string - example: Active - risk_score_setting: - description: The risk score setting + risk_score_setting: type: string - example: standard risk_type: - description: The risk type type: string - example: inherited ownership_driver: - description: The ownership_driver type: boolean - example: true allow_multiple_selections: - description: allow multiple selections type: boolean - example: false filtered_by_ne_attribute: - description: Should this attribute be filtered_by_ne_attribute type: boolean - example: false filtering_ne_attribute_id: - description: The ne_attribute_id to use for filtering type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e ne_attribute_filter_id: - description: The ne_attribute_id to filter by type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e reverse_association_attribute_id: - description: The reverse association ne_attribute_id type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e profile_type_id: - description: The profile_type_id type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e legacy_id: - description: The legacy ID - type: integer - format: int32 - example: 123 + type: integer tmp_created_at: - description: (Deprecated) The temporary created_at field type: string format: date-time readOnly: true - example: 2023-05-01T09:12:28Z tmp_updated_at: - description: (Deprecated) The temporary updated_at field type: string format: date-time - readOnly: true - example: 2023-05-01T09:12:28Z - \ No newline at end of file + readOnly: true \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/AttributeOption.yaml b/static/api-specs/nerm/schemas/GET/AttributeOption.yaml index 8ea403c87..a9e909d0e 100644 --- a/static/api-specs/nerm/schemas/GET/AttributeOption.yaml +++ b/static/api-specs/nerm/schemas/GET/AttributeOption.yaml @@ -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 \ No newline at end of file + type: string \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/AttributeOptions.yaml b/static/api-specs/nerm/schemas/GET/AttributeOptions.yaml index e04935c79..f38fb3f2b 100644 --- a/static/api-specs/nerm/schemas/GET/AttributeOptions.yaml +++ b/static/api-specs/nerm/schemas/GET/AttributeOptions.yaml @@ -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' \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/IdentityProofingResult.yaml b/static/api-specs/nerm/schemas/GET/IdentityProofingResult.yaml index 04e2db4eb..dca88f133 100644 --- a/static/api-specs/nerm/schemas/GET/IdentityProofingResult.yaml +++ b/static/api-specs/nerm/schemas/GET/IdentityProofingResult.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 \ No newline at end of file + format: date-time \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/Profile.yaml b/static/api-specs/nerm/schemas/GET/Profile.yaml index 16bbfd95d..98cb3355b 100644 --- a/static/api-specs/nerm/schemas/GET/Profile.yaml +++ b/static/api-specs/nerm/schemas/GET/Profile.yaml @@ -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 diff --git a/static/api-specs/nerm/schemas/GET/ProfileAttributeRuleDate.yaml b/static/api-specs/nerm/schemas/GET/ProfileAttributeRuleDate.yaml index 928d90a3a..60f510a7a 100644 --- a/static/api-specs/nerm/schemas/GET/ProfileAttributeRuleDate.yaml +++ b/static/api-specs/nerm/schemas/GET/ProfileAttributeRuleDate.yaml @@ -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', ''] - 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 diff --git a/static/api-specs/nerm/schemas/GET/ProfileAttributeRuleId.yaml b/static/api-specs/nerm/schemas/GET/ProfileAttributeRuleId.yaml index 58c70b7cd..f5044e06e 100644 --- a/static/api-specs/nerm/schemas/GET/ProfileAttributeRuleId.yaml +++ b/static/api-specs/nerm/schemas/GET/ProfileAttributeRuleId.yaml @@ -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 diff --git a/static/api-specs/nerm/schemas/GET/ProfileAttributeRuleString.yaml b/static/api-specs/nerm/schemas/GET/ProfileAttributeRuleString.yaml index b2ca6df21..27d2d63f2 100644 --- a/static/api-specs/nerm/schemas/GET/ProfileAttributeRuleString.yaml +++ b/static/api-specs/nerm/schemas/GET/ProfileAttributeRuleString.yaml @@ -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 diff --git a/static/api-specs/nerm/schemas/GET/ProfileStatusRule.yaml b/static/api-specs/nerm/schemas/GET/ProfileStatusRule.yaml index acce840de..d0ed66400 100644 --- a/static/api-specs/nerm/schemas/GET/ProfileStatusRule.yaml +++ b/static/api-specs/nerm/schemas/GET/ProfileStatusRule.yaml @@ -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 \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/ProfileType.yaml b/static/api-specs/nerm/schemas/GET/ProfileType.yaml index b5b09a1d3..1b88fc163 100644 --- a/static/api-specs/nerm/schemas/GET/ProfileType.yaml +++ b/static/api-specs/nerm/schemas/GET/ProfileType.yaml @@ -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 diff --git a/static/api-specs/nerm/schemas/GET/ProfileTypeRule.yaml b/static/api-specs/nerm/schemas/GET/ProfileTypeRule.yaml index 901ee3c40..d6174cb04 100644 --- a/static/api-specs/nerm/schemas/GET/ProfileTypeRule.yaml +++ b/static/api-specs/nerm/schemas/GET/ProfileTypeRule.yaml @@ -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 \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/Profiles.yaml b/static/api-specs/nerm/schemas/GET/Profiles.yaml index 664a4e7c4..396514f83 100644 --- a/static/api-specs/nerm/schemas/GET/Profiles.yaml +++ b/static/api-specs/nerm/schemas/GET/Profiles.yaml @@ -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 \ No newline at end of file + $ref: '../GET/Profile.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/RiskLevel.yaml b/static/api-specs/nerm/schemas/GET/RiskLevel.yaml index 37717c185..1b3736a87 100644 --- a/static/api-specs/nerm/schemas/GET/RiskLevel.yaml +++ b/static/api-specs/nerm/schemas/GET/RiskLevel.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 \ No newline at end of file + minimum: 0 \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/RiskRule.yaml b/static/api-specs/nerm/schemas/GET/RiskRule.yaml index c5be879f7..177fc913a 100644 --- a/static/api-specs/nerm/schemas/GET/RiskRule.yaml +++ b/static/api-specs/nerm/schemas/GET/RiskRule.yaml @@ -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 \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/RiskScore.yaml b/static/api-specs/nerm/schemas/GET/RiskScore.yaml index cd2fb777f..929d3817a 100644 --- a/static/api-specs/nerm/schemas/GET/RiskScore.yaml +++ b/static/api-specs/nerm/schemas/GET/RiskScore.yaml @@ -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 \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/Role.yaml b/static/api-specs/nerm/schemas/GET/Role.yaml index 335db26df..359eca337 100644 --- a/static/api-specs/nerm/schemas/GET/Role.yaml +++ b/static/api-specs/nerm/schemas/GET/Role.yaml @@ -1,26 +1,20 @@ 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: "sponsors_role" name: - description: The name type: string example: "Sponsors" groups: - description: the groups type: array items: type: string - example: - - "ad_group_name" \ No newline at end of file + example: "ad_group_name" \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/RoleProfile.yaml b/static/api-specs/nerm/schemas/GET/RoleProfile.yaml index 79fc99bec..e20debdfe 100644 --- a/static/api-specs/nerm/schemas/GET/RoleProfile.yaml +++ b/static/api-specs/nerm/schemas/GET/RoleProfile.yaml @@ -1,26 +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 role_id: - description: The role 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 - \ No newline at end of file + format: uuid \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/RoleProfiles.yaml b/static/api-specs/nerm/schemas/GET/RoleProfiles.yaml index b73bc15e2..0577d729c 100644 --- a/static/api-specs/nerm/schemas/GET/RoleProfiles.yaml +++ b/static/api-specs/nerm/schemas/GET/RoleProfiles.yaml @@ -3,9 +3,4 @@ properties: role_profiles: type: array items: - $ref: '../GET/RoleProfile.yaml' - example: - id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - uid: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - role_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - profile_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + $ref: '../GET/RoleProfile.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/Roles.yaml b/static/api-specs/nerm/schemas/GET/Roles.yaml index e2fb1d687..d9205af72 100644 --- a/static/api-specs/nerm/schemas/GET/Roles.yaml +++ b/static/api-specs/nerm/schemas/GET/Roles.yaml @@ -1,13 +1,6 @@ type: object properties: roles: - description: the list of roles type: array items: - $ref: '../GET/Role.yaml' - example: - - id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - uid: "sponsors_role" - name: "Sponsors" - groups: - - "ad_group_name" \ No newline at end of file + $ref: '../GET/Role.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/User.yaml b/static/api-specs/nerm/schemas/GET/User.yaml index 59e9c2716..e3941aebe 100644 --- a/static/api-specs/nerm/schemas/GET/User.yaml +++ b/static/api-specs/nerm/schemas/GET/User.yaml @@ -1,59 +1,37 @@ 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: bob email: - description: The email type: string format: email - example: example@sailpoint.com type: - description: The type type: string enum: [NeprofileUser, NeaccessUser] default: NeprofileUser - example: NeprofileUser title: - description: The title type: string - example: mytitle status: - description: The status type: string enum: [Active, Disabled] - example: Active login: - description: The login type: string - example: bob last_login: - description: The last login time type: string format: date-time readOnly: true - example: "2023-05-01T09:12:28Z" cookies_accepted_at: - description: The time the cookies were accepted at type: string format: date-time readOnly: true - example: "2023-05-01T09:12:28Z" preferred_language: - description: The preferred language - type: string - example: en-US \ No newline at end of file + type: string \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/UserManager.yaml b/static/api-specs/nerm/schemas/GET/UserManager.yaml index 1704df944..29adf8233 100644 --- a/static/api-specs/nerm/schemas/GET/UserManager.yaml +++ b/static/api-specs/nerm/schemas/GET/UserManager.yaml @@ -1,25 +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 user_id: - description: the user id type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e manager_id: - description: the manager id type: string - format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + format: uuid \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/UserManagers.yaml b/static/api-specs/nerm/schemas/GET/UserManagers.yaml index 58762443c..2dcff404f 100644 --- a/static/api-specs/nerm/schemas/GET/UserManagers.yaml +++ b/static/api-specs/nerm/schemas/GET/UserManagers.yaml @@ -3,9 +3,4 @@ properties: user_managers: type: array items: - $ref: '../GET/UserManager.yaml' - example: - - id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - uid: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9g - user_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9h - manager_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9l \ No newline at end of file + $ref: '../GET/UserManager.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/UserProfile.yaml b/static/api-specs/nerm/schemas/GET/UserProfile.yaml index edaeac0b5..c9a9f6b03 100644 --- a/static/api-specs/nerm/schemas/GET/UserProfile.yaml +++ b/static/api-specs/nerm/schemas/GET/UserProfile.yaml @@ -1,35 +1,23 @@ 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 user_id: - description: The user 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 ne_attribute_id: - description: The ne_attribute_id type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e relationship_type: - description: the relationship_type type: string - enum: [owner, contributor] - example: owner \ No newline at end of file + enum: [owner, contributor] \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/UserProfiles.yaml b/static/api-specs/nerm/schemas/GET/UserProfiles.yaml index 7b3b9aa09..48e42dd57 100644 --- a/static/api-specs/nerm/schemas/GET/UserProfiles.yaml +++ b/static/api-specs/nerm/schemas/GET/UserProfiles.yaml @@ -3,16 +3,4 @@ properties: user_profiles: type: array items: - $ref: '../GET/UserProfile.yaml' - example: - - id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - uid: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - user_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - profile_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - ne_attribute_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - relationship_type: owner - - - - - \ No newline at end of file + $ref: '../GET/UserProfile.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/UserRole.yaml b/static/api-specs/nerm/schemas/GET/UserRole.yaml index 4328f93f4..93f737809 100644 --- a/static/api-specs/nerm/schemas/GET/UserRole.yaml +++ b/static/api-specs/nerm/schemas/GET/UserRole.yaml @@ -1,26 +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 user_id: - description: the user id type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e role_id: - description: the role id type: string - format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - \ No newline at end of file + format: uuid \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/UserRoles.yaml b/static/api-specs/nerm/schemas/GET/UserRoles.yaml index bc09ca4d7..fe14e7873 100644 --- a/static/api-specs/nerm/schemas/GET/UserRoles.yaml +++ b/static/api-specs/nerm/schemas/GET/UserRoles.yaml @@ -3,9 +3,4 @@ properties: user_roles: type: array items: - $ref: '../GET/UserRole.yaml' - example: - - id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9a - uid: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9b - user_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9c - role_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9d \ No newline at end of file + $ref: '../GET/UserRole.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/Users.yaml b/static/api-specs/nerm/schemas/GET/Users.yaml index 0fdebb499..395cdec80 100644 --- a/static/api-specs/nerm/schemas/GET/Users.yaml +++ b/static/api-specs/nerm/schemas/GET/Users.yaml @@ -3,16 +3,4 @@ properties: users: type: array items: - $ref: '../GET/User.yaml' - example: - - id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - uid: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - name: bob - email: example@sailpoint.com - type: NeprofileUser - title: mytitle - status: Active - login: bob - last_login: "2023-05-01T09:12:28Z" - cookies_accepted_at: "2023-05-01T09:12:28Z" - preferred_language: en-US \ No newline at end of file + $ref: '../GET/User.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/WorkflowSession.yaml b/static/api-specs/nerm/schemas/GET/WorkflowSession.yaml index 27498f0e8..786dcef1e 100644 --- a/static/api-specs/nerm/schemas/GET/WorkflowSession.yaml +++ b/static/api-specs/nerm/schemas/GET/WorkflowSession.yaml @@ -1,54 +1,38 @@ 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 workflow_id: - description: The workflow id type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e requester_id: - description: the requester id type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e requester_type: - description: The requester type type: string enum: [User, NeprofileUser, NeaccessUser] - example: User profile_id: type: string format: uuid description: The profile this workflow session will be working with. Only Applicable for Update workflows - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e profile_ids: type: array items: type: string format: uuid description: The profiles this workflow session will be working with. Only Applicable for Batch workflows - example: - - db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - - db6f8e8b-65c2-47d5-a0db-90bcc4e9df9t status: - description: The status type: string enum: [api_request_sent, approved, assigned, attempting_to_start_workflow, AUTH-STATUS1, AUTH-STATUS2, AUTH-STATUS3, AUTH-STATUS4, AUTH-STATUS5, AUTH-STATUS6, AUTH-STATUS7, AUTH-STATUS8, AUTH-STATUS9, auto_assigned, batch_completed, checking_for_duplicates, closed, completed, courion_add, courion_extend, courion_terminate, courion_update, duplicates_resolved, failed, fulfilled, invitation_sent, ldap_provided, new, non_employee_created, non_employee_updated, notified, pending_approval, pending_assignment, pending_courion_add, pending_courion_extend, pending_courion_terminate, pending_courion_update, pending_creation, pending_fulfillment, pending_ldap, pending_notification, pending_profile_select, pending_request, pending_review, pending_status_change, pending_stored_procedure, pending_trigger, pending_update, processing, profile_check_complete, profiles_selected, rejected, requested, reviewed, soap_request_sent, started_workflow, status_changed, stored_procedure, un_assigned, waiting_on_workflow, workflow_changed] example: completed attributes: - description: The attributes type: object additionalProperties: type: string diff --git a/static/api-specs/nerm/schemas/Job.yaml b/static/api-specs/nerm/schemas/Job.yaml index 3cbcf3636..9b38b7269 100644 --- a/static/api-specs/nerm/schemas/Job.yaml +++ b/static/api-specs/nerm/schemas/Job.yaml @@ -1,23 +1,17 @@ type: object properties: info: - description: info about the job type: string example: "job has started" job_status: - description: the status of the job type: object properties: job_id: - description: the job id type: string example: "3ce88e47ad6dba2ddf349d21" status: - description: the status type: string example: "queued" status: - description: the status - type: integer - format: int32 + type: int example: 200 \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/Metadata.yaml b/static/api-specs/nerm/schemas/Metadata.yaml index 8d0b24c62..aab30cde8 100644 --- a/static/api-specs/nerm/schemas/Metadata.yaml +++ b/static/api-specs/nerm/schemas/Metadata.yaml @@ -1,25 +1,14 @@ type: object properties: limit: - description: The limit type: integer - format: int32 - example: 50 offset: - description: The offset type: integer - format: int32 - example: 100 total: - description: The total type: integer - format: int32 - example: 10000 next: - description: The link to the next page of data type: string example: /endpoint?limit=10&offset=60 previous: - description: The link to the previous page of data type: string example: /endpoint?limit=10&offset=40 \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/AdvancedSearch.yaml b/static/api-specs/nerm/schemas/PATCH/AdvancedSearch.yaml index f3fead9f5..57a8d14f2 100644 --- a/static/api-specs/nerm/schemas/PATCH/AdvancedSearch.yaml +++ b/static/api-specs/nerm/schemas/PATCH/AdvancedSearch.yaml @@ -1,16 +1,11 @@ type: object properties: id: - description: the id of the object type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e label: - description: the label type: string - example: mylabel condition_rules_attributes: - description: The attributes for the condition rules type: array items: anyOf: @@ -20,12 +15,3 @@ 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 diff --git a/static/api-specs/nerm/schemas/PATCH/AttributeOption.yaml b/static/api-specs/nerm/schemas/PATCH/AttributeOption.yaml index b0c603b07..303e9c11a 100644 --- a/static/api-specs/nerm/schemas/PATCH/AttributeOption.yaml +++ b/static/api-specs/nerm/schemas/PATCH/AttributeOption.yaml @@ -1,11 +1,7 @@ type: object properties: 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: optionname \ No newline at end of file + type: string \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/AttributeOptions.yaml b/static/api-specs/nerm/schemas/PATCH/AttributeOptions.yaml index c583409a7..36cf6ac8f 100644 --- a/static/api-specs/nerm/schemas/PATCH/AttributeOptions.yaml +++ b/static/api-specs/nerm/schemas/PATCH/AttributeOptions.yaml @@ -1,16 +1,10 @@ type: object properties: id: - description: The 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 option: - description: The option - type: string - example: option \ No newline at end of file + type: string \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/Profile.yaml b/static/api-specs/nerm/schemas/PATCH/Profile.yaml index 5639cf1c5..0a4c5f64b 100644 --- a/static/api-specs/nerm/schemas/PATCH/Profile.yaml +++ b/static/api-specs/nerm/schemas/PATCH/Profile.yaml @@ -1,31 +1,20 @@ type: object properties: name: - description: the name type: string - example: testprofile 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_proofing_status type: string enum: [pending, pass, fail] - example: pending archived: - description: Return archived items type: boolean default: false - example: false attributes: - description: The attributes type: object additionalProperties: type: string diff --git a/static/api-specs/nerm/schemas/PATCH/ProfileAttributeRuleDate.yaml b/static/api-specs/nerm/schemas/PATCH/ProfileAttributeRuleDate.yaml index 857aa01b3..324dc9b47 100644 --- a/static/api-specs/nerm/schemas/PATCH/ProfileAttributeRuleDate.yaml +++ b/static/api-specs/nerm/schemas/PATCH/ProfileAttributeRuleDate.yaml @@ -1,70 +1,47 @@ 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 type: string required: true enum: ['Today', ''] - 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 _destroy: - description: should this be destroyed type: boolean default: false - example: false diff --git a/static/api-specs/nerm/schemas/PATCH/ProfileAttributeRuleId.yaml b/static/api-specs/nerm/schemas/PATCH/ProfileAttributeRuleId.yaml index 375d462f3..680385216 100644 --- a/static/api-specs/nerm/schemas/PATCH/ProfileAttributeRuleId.yaml +++ b/static/api-specs/nerm/schemas/PATCH/ProfileAttributeRuleId.yaml @@ -1,50 +1,34 @@ type: object properties: id: - description: the id type: string format: uuid readOnly: true - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e uid: - description: the iud 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: ProfileSearchAttribute 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: ['include?', 'exclude?'] - example: include? value: - description: the value type: string required: true format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e _destroy: - description: Should this be destroyed? type: boolean default: false - example: false diff --git a/static/api-specs/nerm/schemas/PATCH/ProfileAttributeRuleString.yaml b/static/api-specs/nerm/schemas/PATCH/ProfileAttributeRuleString.yaml index 6be525f0f..e9b4a3b8b 100644 --- a/static/api-specs/nerm/schemas/PATCH/ProfileAttributeRuleString.yaml +++ b/static/api-specs/nerm/schemas/PATCH/ProfileAttributeRuleString.yaml @@ -1,49 +1,34 @@ 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 used for comparisons type: string required: true enum: ['==', '!=', '>', '<', 'start_with?', 'end_with?', 'include?'] - example: == value: - description: The value type: string required: true example: Some value _destroy: - description: Destroy type: boolean default: false - example: false diff --git a/static/api-specs/nerm/schemas/PATCH/ProfileStatusRule.yaml b/static/api-specs/nerm/schemas/PATCH/ProfileStatusRule.yaml index cebb7022c..969676c19 100644 --- a/static/api-specs/nerm/schemas/PATCH/ProfileStatusRule.yaml +++ b/static/api-specs/nerm/schemas/PATCH/ProfileStatusRule.yaml @@ -1,30 +1,20 @@ type: object properties: id: - description: The id type: string format: uuid readOnly: true - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e type: - description: The type type: string required: true enum: [ProfileStatusRule] - example: ProfileStatusRule comparison_operator: - description: The operator to use to compare type: string enum: ['==', '!='] - example: == value: - description: The value type: string enum: [Active, Inactive, Leave of absence, Terminated] - example: Active _destroy: - description: Should this be destroyed type: boolean default: false - example: false \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/ProfileType.yaml b/static/api-specs/nerm/schemas/PATCH/ProfileType.yaml index 31d4e7985..935d9bfa2 100644 --- a/static/api-specs/nerm/schemas/PATCH/ProfileType.yaml +++ b/static/api-specs/nerm/schemas/PATCH/ProfileType.yaml @@ -1,82 +1,52 @@ type: object properties: name: - description: The name type: string - example: my_profile_type_name bypass_dup_protection: - description: Bypass duplicate protection type: boolean - example: false archived: - description: Is the profile type archived type: boolean - example: false permitted_role_ids: - description: Permitted role ids type: array items: type: string format: uuid - example: - - db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - - db6f8e8b-65c2-47d5-a0db-90bcc4e9df9b profile_type_dup_attributes: - description: 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 profile_type_namings: - description: 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 the profile type appears type: integer minimum: 0 - example: 0 diff --git a/static/api-specs/nerm/schemas/PATCH/ProfileTypeRule.yaml b/static/api-specs/nerm/schemas/PATCH/ProfileTypeRule.yaml index 04515f193..2d1511127 100644 --- a/static/api-specs/nerm/schemas/PATCH/ProfileTypeRule.yaml +++ b/static/api-specs/nerm/schemas/PATCH/ProfileTypeRule.yaml @@ -1,30 +1,20 @@ type: object properties: id: - description: the id type: string format: uuid readOnly: true - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e type: - description: the type type: string required: true enum: [ProfileTypeRule] - example: ProfileTypeRule comparison_operator: - description: The operator to use for comparison type: string enum: ['==', '!='] - example: == value: - description: The value to use in the comparison type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e _destroy: - description: Should this Profile type rule be destroyed? type: boolean default: false - example: false \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/Profiles.yaml b/static/api-specs/nerm/schemas/PATCH/Profiles.yaml index 74e3ae45c..caab35a58 100644 --- a/static/api-specs/nerm/schemas/PATCH/Profiles.yaml +++ b/static/api-specs/nerm/schemas/PATCH/Profiles.yaml @@ -1,36 +1,23 @@ type: object properties: id: - description: the id type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e name: - description: the name type: string - example: profile name here 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 proofing status type: string enum: [pending, pass, fail] - example: pending archived: - description: should profile be archived? type: boolean default: false - example: false attributes: - description: The attrbutes type: object additionalProperties: type: string diff --git a/static/api-specs/nerm/schemas/PATCH/RiskRule.yaml b/static/api-specs/nerm/schemas/PATCH/RiskRule.yaml index 76197efee..21b67c211 100644 --- a/static/api-specs/nerm/schemas/PATCH/RiskRule.yaml +++ b/static/api-specs/nerm/schemas/PATCH/RiskRule.yaml @@ -1,44 +1,30 @@ 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: the value 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 _destroy: - description: Should this riskrule be destroyed type: boolean default: false - example: false diff --git a/static/api-specs/nerm/schemas/PATCH/Role.yaml b/static/api-specs/nerm/schemas/PATCH/Role.yaml index 4c4d3d454..c596b34bf 100644 --- a/static/api-specs/nerm/schemas/PATCH/Role.yaml +++ b/static/api-specs/nerm/schemas/PATCH/Role.yaml @@ -1,18 +1,13 @@ type: object properties: type: - description: The type type: string enum: [NeprofileRole, NeaccessRole] - example: NeprofileRole name: - description: The name type: string example: "Sponsors" groups: - description: the groups type: array items: type: string - example: - - "ad_group_name" \ No newline at end of file + example: "ad_group_name" \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/RoleProfile.yaml b/static/api-specs/nerm/schemas/PATCH/RoleProfile.yaml index a4aa3cbc5..88b907b37 100644 --- a/static/api-specs/nerm/schemas/PATCH/RoleProfile.yaml +++ b/static/api-specs/nerm/schemas/PATCH/RoleProfile.yaml @@ -1,13 +1,8 @@ type: object properties: role_id: - description: the role 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 - \ No newline at end of file + format: uuid \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/RoleProfiles.yaml b/static/api-specs/nerm/schemas/PATCH/RoleProfiles.yaml index 4230798de..c2a75ac24 100644 --- a/static/api-specs/nerm/schemas/PATCH/RoleProfiles.yaml +++ b/static/api-specs/nerm/schemas/PATCH/RoleProfiles.yaml @@ -1,18 +1,11 @@ type: object properties: id: - description: the id type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e role_id: - description: the role 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 - \ No newline at end of file + format: uuid \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/User.yaml b/static/api-specs/nerm/schemas/PATCH/User.yaml index c8fd5b74c..28e2b8efc 100644 --- a/static/api-specs/nerm/schemas/PATCH/User.yaml +++ b/static/api-specs/nerm/schemas/PATCH/User.yaml @@ -1,50 +1,31 @@ type: object properties: id: - description: The id type: string format: uuid required: true writeOnly: true - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e name: - description: The name type: string - example: myusername email: - description: The email type: string format: email - example: test@sailpoint.com type: - description: The type type: string enum: [NeprofileUser, NeaccessUser] default: NeprofileUser - example: NeprofileUser profile_id: - description: The profile_id type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e title: - description: The title type: string - example: mytitle status: - description: The status type: string enum: [Active, Disabled] - example: Active login: - description: The login type: string - example: mylogin admin: - description: Is the user an admin type: boolean - example: false group_strings: - description: The group strings (used in roles later on) type: string example: "Administrator_group,Developer_group" \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/UserManager.yaml b/static/api-specs/nerm/schemas/PATCH/UserManager.yaml index ed89c88bc..b47647b12 100644 --- a/static/api-specs/nerm/schemas/PATCH/UserManager.yaml +++ b/static/api-specs/nerm/schemas/PATCH/UserManager.yaml @@ -1,13 +1,8 @@ type: object properties: user_id: - description: The user_id type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e manager_id: - description: The manager_id type: string - format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - \ No newline at end of file + format: uuid \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/UserManagers.yaml b/static/api-specs/nerm/schemas/PATCH/UserManagers.yaml index 047f19a7a..e04a8ba03 100644 --- a/static/api-specs/nerm/schemas/PATCH/UserManagers.yaml +++ b/static/api-specs/nerm/schemas/PATCH/UserManagers.yaml @@ -1,18 +1,11 @@ type: object properties: id: - description: The id type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e user_id: - description: The user_id type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e manager_id: - description: The manager_id type: string - format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - \ No newline at end of file + format: uuid \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/UserProfile.yaml b/static/api-specs/nerm/schemas/PATCH/UserProfile.yaml index 268ebf8ca..679b0cc4c 100644 --- a/static/api-specs/nerm/schemas/PATCH/UserProfile.yaml +++ b/static/api-specs/nerm/schemas/PATCH/UserProfile.yaml @@ -1,22 +1,14 @@ type: object properties: user_id: - description: The user_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 ne_attribute_id: - description: The ne_attribute_id type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e relationship_type: - description: The relationship_type type: string - enum: [owner, contributor] - example: owner \ No newline at end of file + enum: [owner, contributor] \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/UserProfiles.yaml b/static/api-specs/nerm/schemas/PATCH/UserProfiles.yaml index 702e4887c..8133d618d 100644 --- a/static/api-specs/nerm/schemas/PATCH/UserProfiles.yaml +++ b/static/api-specs/nerm/schemas/PATCH/UserProfiles.yaml @@ -1,27 +1,17 @@ type: object properties: id: - description: the id type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e user_id: - description: the user 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 ne_attribute_id: - description: the ne_attribute_id type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e relationship_type: - description: the relationship_type type: string - enum: [owner, contributor] - example: owner \ No newline at end of file + enum: [owner, contributor] \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/UserRole.yaml b/static/api-specs/nerm/schemas/PATCH/UserRole.yaml index 51a8819b9..ec36728cd 100644 --- a/static/api-specs/nerm/schemas/PATCH/UserRole.yaml +++ b/static/api-specs/nerm/schemas/PATCH/UserRole.yaml @@ -1,12 +1,8 @@ type: object properties: user_id: - description: The user_id type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e role_id: - description: The role_id type: string - format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file + format: uuid \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/UserRoles.yaml b/static/api-specs/nerm/schemas/PATCH/UserRoles.yaml index 308a22692..02acd5ca7 100644 --- a/static/api-specs/nerm/schemas/PATCH/UserRoles.yaml +++ b/static/api-specs/nerm/schemas/PATCH/UserRoles.yaml @@ -1,18 +1,11 @@ type: object properties: id: - description: The id type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e user_id: - description: The user_id type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e role_id: - description: The uuid type: string - format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - \ No newline at end of file + format: uuid \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/WorkflowSession.yaml b/static/api-specs/nerm/schemas/PATCH/WorkflowSession.yaml index 7fdbf00c1..90d9fad7a 100644 --- a/static/api-specs/nerm/schemas/PATCH/WorkflowSession.yaml +++ b/static/api-specs/nerm/schemas/PATCH/WorkflowSession.yaml @@ -1,41 +1,29 @@ type: object properties: workflow_id: - description: the workflow_id type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e requester_id: - description: the requester_id type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e requester_type: - description: the requester type type: string enum: [User, NeprofileUser, NeaccessUser] - example: User profile_id: type: string format: uuid description: The profile this workflow session will be working with. Only Applicable for Update workflows - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e profile_ids: type: array items: type: string format: uuid description: The profiles this workflow session will be working with. Only Applicable for Batch workflows - example: - - db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - - db6f8e8b-65c2-47d5-a0db-90bcc4e9df94 status: - description: the status type: string enum: [api_request_sent, approved, assigned, attempting_to_start_workflow, AUTH-STATUS1, AUTH-STATUS2, AUTH-STATUS3, AUTH-STATUS4, AUTH-STATUS5, AUTH-STATUS6, AUTH-STATUS7, AUTH-STATUS8, AUTH-STATUS9, auto_assigned, batch_completed, checking_for_duplicates, closed, completed, courion_add, courion_extend, courion_terminate, courion_update, duplicates_resolved, failed, fulfilled, invitation_sent, ldap_provided, new, non_employee_created, non_employee_updated, notified, pending_approval, pending_assignment, pending_courion_add, pending_courion_extend, pending_courion_terminate, pending_courion_update, pending_creation, pending_fulfillment, pending_ldap, pending_notification, pending_profile_select, pending_request, pending_review, pending_status_change, pending_stored_procedure, pending_trigger, pending_update, processing, profile_check_complete, profiles_selected, rejected, requested, reviewed, soap_request_sent, started_workflow, status_changed, stored_procedure, un_assigned, waiting_on_workflow, workflow_changed] example: completed attributes: - description: the attributes type: object additionalProperties: type: string diff --git a/static/api-specs/nerm/schemas/POST/AdvancedSearch.yaml b/static/api-specs/nerm/schemas/POST/AdvancedSearch.yaml index 3d7a14d1c..7f91e2193 100644 --- a/static/api-specs/nerm/schemas/POST/AdvancedSearch.yaml +++ b/static/api-specs/nerm/schemas/POST/AdvancedSearch.yaml @@ -1,11 +1,8 @@ type: object properties: label: - description: the label type: string - example: my search label condition_rules_attributes: - description: The condition rules attributes type: array items: anyOf: @@ -15,10 +12,3 @@ properties: - $ref: "./ProfileAttributeRuleDate.yaml" - $ref: "./ProfileAttributeRuleId.yaml" - $ref: "./RiskRule.yaml" - example: - - type: ProfileTypeRule - comparison_operator: == - value: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - - - diff --git a/static/api-specs/nerm/schemas/POST/AttributeOption.yaml b/static/api-specs/nerm/schemas/POST/AttributeOption.yaml index 5df4e59dc..303e9c11a 100644 --- a/static/api-specs/nerm/schemas/POST/AttributeOption.yaml +++ b/static/api-specs/nerm/schemas/POST/AttributeOption.yaml @@ -1,11 +1,7 @@ type: object properties: 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: option1 \ No newline at end of file + type: string \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/POST/Profile.yaml b/static/api-specs/nerm/schemas/POST/Profile.yaml index ebfbae544..d54aa6cd0 100644 --- a/static/api-specs/nerm/schemas/POST/Profile.yaml +++ b/static/api-specs/nerm/schemas/POST/Profile.yaml @@ -1,33 +1,22 @@ type: object properties: name: - description: The name type: string - example: my profile name profile_type_id: - description: the profile type id type: string format: uuid required: true - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e status: - description: the status type: string enum: [Active, Inactive, On Leave, Terminated] - example: Active required: true id_proofing_status: - description: the id proofing status type: string enum: [pending, pass, fail] - example: pending archived: - description: is this profile archived type: boolean default: false - example: false attributes: - description: the attributes type: object additionalProperties: type: string diff --git a/static/api-specs/nerm/schemas/POST/ProfileAttributeRuleDate.yaml b/static/api-specs/nerm/schemas/POST/ProfileAttributeRuleDate.yaml index 97af785c5..6a7390d63 100644 --- a/static/api-specs/nerm/schemas/POST/ProfileAttributeRuleDate.yaml +++ b/static/api-specs/nerm/schemas/POST/ProfileAttributeRuleDate.yaml @@ -1,50 +1,33 @@ type: object properties: 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 when comparing type: string enum: ['>', '<', 'after', 'before'] - example: after value: - description: The value type: string required: true enum: ['Today', ''] - 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 diff --git a/static/api-specs/nerm/schemas/POST/ProfileAttributeRuleId.yaml b/static/api-specs/nerm/schemas/POST/ProfileAttributeRuleId.yaml index 69de2b244..bb4022576 100644 --- a/static/api-specs/nerm/schemas/POST/ProfileAttributeRuleId.yaml +++ b/static/api-specs/nerm/schemas/POST/ProfileAttributeRuleId.yaml @@ -1,33 +1,22 @@ type: object properties: type: - description: The type type: string required: true enum: [ProfileAttributeRule] - example: ProfileAttributeRule condition_object_type: - description: The conditon object type type: string required: true enum: [ProfileSelectAttribute, ProfileSearchAttribute, OwnerSelectAttribute, OwnerSearchAttribute, ContributorSelectAttribute, ContributorSearchAttribute] - example: ProfileSearchAttribute 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: ['include?', 'exclude?'] - example: include? value: - description: The value type: string required: true format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - diff --git a/static/api-specs/nerm/schemas/POST/ProfileAttributeRuleString.yaml b/static/api-specs/nerm/schemas/POST/ProfileAttributeRuleString.yaml index c86f7999b..5242ad11f 100644 --- a/static/api-specs/nerm/schemas/POST/ProfileAttributeRuleString.yaml +++ b/static/api-specs/nerm/schemas/POST/ProfileAttributeRuleString.yaml @@ -1,31 +1,22 @@ type: object properties: 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 to use for comparison type: string required: true example: Some value diff --git a/static/api-specs/nerm/schemas/POST/ProfileStatusRule.yaml b/static/api-specs/nerm/schemas/POST/ProfileStatusRule.yaml index daae222a3..e7bcf9289 100644 --- a/static/api-specs/nerm/schemas/POST/ProfileStatusRule.yaml +++ b/static/api-specs/nerm/schemas/POST/ProfileStatusRule.yaml @@ -1,20 +1,14 @@ type: object properties: type: - description: the type type: string required: true enum: [ProfileStatusRule] - example: ProfileStatusRule comparison_operator: - description: The operator to use for comparison type: string required: true enum: ['==', '!='] - example: == value: - description: The value type: string required: true enum: [Active, Inactive, Leave of absence, Terminated] - example: Active diff --git a/static/api-specs/nerm/schemas/POST/ProfileType.yaml b/static/api-specs/nerm/schemas/POST/ProfileType.yaml index 838a4dd5c..f19fe6eb3 100644 --- a/static/api-specs/nerm/schemas/POST/ProfileType.yaml +++ b/static/api-specs/nerm/schemas/POST/ProfileType.yaml @@ -1,86 +1,54 @@ type: object properties: name: - description: The name type: string - example: great_profile_type bypass_dup_protection: - description: Bypass duplicate protection? type: boolean default: false - example: false archived: - description: Is this archived type: boolean default: false - example: false permitted_role_ids: - description: Permitted Role ids type: array items: type: string format: uuid - example: - - db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - - db6f8e8b-65c2-47d5-a0db-90bcc4e9df9d profile_type_dup_attributes: - description: Profile type duplicate attribgutes type: array items: type: object properties: id: - description: The id type: string format: uuid - example: b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e uid: - description: the uid type: string minLength: 32 maxLength: 32 - example: b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e profile_type_id: - description: The profile type ID type: string format: uuid - example: b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e ne_attribute_id: - description: The ne_attribute_id type: string format: uuid - example: b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e profile_type_namings: - description: The profile type namings type: array items: - description: The items type: object properties: id: - description: The id type: string format: uuid - example: b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e uid: - description: The uid type: string minLength: 32 maxLength: 32 - example: b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e profile_type_id: - description: The profile_type_id type: string format: uuid - example: b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e ne_attribute_id: - description: The ne_attribute_id type: string format: uuid - example: b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e order: - description: The order which this appears in type: integer - format: int32 minimum: 0 - example: 0 diff --git a/static/api-specs/nerm/schemas/POST/ProfileTypeRule.yaml b/static/api-specs/nerm/schemas/POST/ProfileTypeRule.yaml index 917b78fca..66efe7c51 100644 --- a/static/api-specs/nerm/schemas/POST/ProfileTypeRule.yaml +++ b/static/api-specs/nerm/schemas/POST/ProfileTypeRule.yaml @@ -1,20 +1,14 @@ type: object properties: type: - description: The type type: string required: true enum: [ProfileTypeRule] - example: ProfileTypeRule comparison_operator: - description: The operator to use for comparison type: string required: true enum: ['==', '!='] - example: == value: - description: The value type: string required: true format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e diff --git a/static/api-specs/nerm/schemas/POST/RiskRule.yaml b/static/api-specs/nerm/schemas/POST/RiskRule.yaml index 3470a64cf..3d63b85cc 100644 --- a/static/api-specs/nerm/schemas/POST/RiskRule.yaml +++ b/static/api-specs/nerm/schemas/POST/RiskRule.yaml @@ -1,26 +1,18 @@ type: object properties: 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: The value to use 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 to use type: string required: true enum: [OverallRisk] - example: OverallRisk \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/POST/Role.yaml b/static/api-specs/nerm/schemas/POST/Role.yaml index 56b37b06f..6ce215bf0 100644 --- a/static/api-specs/nerm/schemas/POST/Role.yaml +++ b/static/api-specs/nerm/schemas/POST/Role.yaml @@ -1,22 +1,17 @@ type: object properties: uid: - description: the uid type: string minLength: 32 maxLength: 32 example: "sponsors_role" type: - description: The role type type: string enum: [NeprofileRole, NeaccessRole] - example: NeaccessRole name: - description: The role name type: string example: "Sponsors" groups: - description: The role's groups type: array items: type: string diff --git a/static/api-specs/nerm/schemas/POST/RoleProfile.yaml b/static/api-specs/nerm/schemas/POST/RoleProfile.yaml index eb191e17b..88b907b37 100644 --- a/static/api-specs/nerm/schemas/POST/RoleProfile.yaml +++ b/static/api-specs/nerm/schemas/POST/RoleProfile.yaml @@ -1,12 +1,8 @@ type: object properties: role_id: - description: The role 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 \ No newline at end of file + format: uuid \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/POST/User.yaml b/static/api-specs/nerm/schemas/POST/User.yaml index 61cf43fd6..a27db3cff 100644 --- a/static/api-specs/nerm/schemas/POST/User.yaml +++ b/static/api-specs/nerm/schemas/POST/User.yaml @@ -1,48 +1,31 @@ type: object properties: name: - description: The users name type: string required: true - example: bob email: - description: Email type: string format: email required: true - example: test@sailpoint.com type: - description: The user type type: string enum: ['NeprofileUser', 'NeaccessUser'] default: NeprofileUser - example: NeprofileUser profile_id: - description: The user profile_id type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e title: - description: The user title type: string - example: my_user_title status: - description: The user status type: string enum: [Active, Disabled] required: true - example: Active login: - description: The user login type: string required: true - example: my_user admin: - description: Is the user an admin type: boolean default: false - example: false group_strings: - description: The users group strings type: string example: "Administrator_group,Developer_group" \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/POST/UserManager.yaml b/static/api-specs/nerm/schemas/POST/UserManager.yaml index cd88d3269..b47647b12 100644 --- a/static/api-specs/nerm/schemas/POST/UserManager.yaml +++ b/static/api-specs/nerm/schemas/POST/UserManager.yaml @@ -1,13 +1,8 @@ type: object properties: user_id: - description: The user id type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e manager_id: - description: the manager id type: string - format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - \ No newline at end of file + format: uuid \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/POST/UserProfile.yaml b/static/api-specs/nerm/schemas/POST/UserProfile.yaml index b488c1b4f..679b0cc4c 100644 --- a/static/api-specs/nerm/schemas/POST/UserProfile.yaml +++ b/static/api-specs/nerm/schemas/POST/UserProfile.yaml @@ -1,22 +1,14 @@ type: object properties: user_id: - description: The user 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 ne_attribute_id: - description: The ne_attribute_id type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e relationship_type: - description: the relationship type type: string - enum: [owner, contributor] - example: owner \ No newline at end of file + enum: [owner, contributor] \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/POST/UserRole.yaml b/static/api-specs/nerm/schemas/POST/UserRole.yaml index baa91986f..ec36728cd 100644 --- a/static/api-specs/nerm/schemas/POST/UserRole.yaml +++ b/static/api-specs/nerm/schemas/POST/UserRole.yaml @@ -1,13 +1,8 @@ type: object properties: user_id: - description: the user id type: string format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e role_id: - description: the role id type: string - format: uuid - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - \ No newline at end of file + format: uuid \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/POST/WorkflowSession.yaml b/static/api-specs/nerm/schemas/POST/WorkflowSession.yaml index 19cbe83ee..016cfc45e 100644 --- a/static/api-specs/nerm/schemas/POST/WorkflowSession.yaml +++ b/static/api-specs/nerm/schemas/POST/WorkflowSession.yaml @@ -1,39 +1,28 @@ type: object properties: workflow_id: - description: The workflow id type: string format: uuid required: true - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e requester_id: - description: The requester id type: string format: uuid required: true - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e requester_type: - description: The requester type type: string enum: [User, NeprofileUser, NeaccessUser] required: true - example: User profile_id: type: string format: uuid description: The profile this workflow session will be working with. Only Applicable for Update workflows - example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - profile_ids: + profile_ids: type: array items: type: string format: uuid description: The profiles this workflow session will be working with. Only Applicable for Batch workflows - example: - - db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e - - db6f8e8b-65c2-47d5-a0db-90bcc4e9df9f attributes: - description: The attributes type: object additionalProperties: type: string diff --git a/static/api-specs/nerm/schemas/Placeholder.yaml b/static/api-specs/nerm/schemas/Placeholder.yaml index 1bd361b3f..8d90375f9 100644 --- a/static/api-specs/nerm/schemas/Placeholder.yaml +++ b/static/api-specs/nerm/schemas/Placeholder.yaml @@ -1,6 +1,4 @@ type: object properties: placeholder: - description: The placeholder - type: string - example: abc123 + type: string \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/Url.yaml b/static/api-specs/nerm/schemas/Url.yaml index 1d9e02557..596ce1a02 100644 --- a/static/api-specs/nerm/schemas/Url.yaml +++ b/static/api-specs/nerm/schemas/Url.yaml @@ -1,8 +1,6 @@ type: object properties: url: - description: The url type: string format: url - readOnly: true - example: http://www.example.com \ No newline at end of file + readOnly: true \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/_index.yaml b/static/api-specs/nerm/schemas/_index.yaml index ef545b63c..952a7376a 100644 --- a/static/api-specs/nerm/schemas/_index.yaml +++ b/static/api-specs/nerm/schemas/_index.yaml @@ -32,9 +32,5 @@ ConditionRulesAttribute-ProfileTypeRule: $ref: './GET/ProfileTypeRule.yaml' ConditionRulesAttribute-ProfileStatusRule: $ref: './GET/ProfileStatusRule.yaml' -ConditionRulesAttribute-ProfileAttributeRuleDate: - $ref: './GET/ProfileAttributeRuleDate.yaml' -ConditionRulesAttribute-ProfileAttributeRuleId: - $ref: './GET/ProfileAttributeRuleId.yaml' -ConditionRulesAttribute-ProfileAttributeRuleString: - $ref: './GET/ProfileAttributeRuleString.yaml' \ No newline at end of file +ConditionRulesAttribute-ProfileAttributeRule: + $ref: './GET/ProfileAttributeRule.yaml' \ No newline at end of file