Add nerm specifications to api specs repo

nerm/openapi.yaml

@@ -0,0 +1,119 @@
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: SecZetta Lifecycle API
+  description: The Lifecycle API can be used to access and modify various resources in your environment.
+  license:
+    name: MIT
+paths:
+# Users
+  /user:
+    $ref: "./paths/user.yaml"
+  /users:
+    $ref: "./paths/users.yaml"
+  /users/{id}:
+    $ref: "./paths/users_id.yaml"
+  /users/{id}/avatar:
+    $ref: "./paths/users_id_avatar.yaml"
+# User Manager Relationships
+  /user_manager:
+    $ref: "./paths/user_manager.yaml"
+  /user_managers:
+    $ref: "./paths/user_managers.yaml"
+  /user_managers/{id}:
+    $ref: "./paths/user_managers_id.yaml"
+# Roles
+  /roles:
+    $ref: "./paths/roles.yaml"
+  /role:
+    $ref: "./paths/role.yaml"
+  /roles/{id}:
+    $ref: "./paths/roles_id.yaml"
+# User Roles
+  /user_role:
+    $ref: "./paths/user_role.yaml"
+  /user_roles:
+    $ref: "./paths/user_roles.yaml"
+  /user_roles/{id}:
+    $ref: "./paths/user_roles_id.yaml"
+  /user_role/{id}:
+    $ref: "./paths/user_role_id.yaml"
+# Attributes
+  /ne_attributes:
+    $ref: "./paths/ne_attributes.yaml"
+  /ne_attributes/{id}:
+    $ref: "./paths/ne_attributes_id.yaml"
+  /ne_attribute_option:
+    $ref: "./paths/ne_attribute_option.yaml"
+  /ne_attribute_options:
+    $ref: "./paths/ne_attribute_options.yaml"
+  /ne_attribute_options/{id}:
+    $ref: "./paths/ne_attribute_options_id.yaml"
+# Profile Types
+  /profile_type:
+    $ref: "./paths/profile_type.yaml"
+  /profile_types:
+    $ref: "./paths/profile_types.yaml"
+  /profile_types/{id}:
+    $ref: "./paths/profile_types_id.yaml"
+# Profiles
+  /profile:
+    $ref: "./paths/profile.yaml"
+  /profiles:
+    $ref: "./paths/profiles.yaml"
+  /profiles/{id}:
+    $ref: "./paths/profiles_id.yaml"
+  /profiles/{id}/upload/{attribute_id}:
+    $ref: "./paths/profiles_id_upload_attribute_id.yaml"
+  /profiles/{id}/avatar:
+    $ref: "./paths/profiles_id_avatar.yaml"
+# Risk Scores
+  /risk_scores:
+    $ref: "./paths/risk_scores.yaml"
+  /risk_scores/{id}:
+    $ref: "./paths/risk_scores_id.yaml"
+# Risk Levels
+  /risk_levels:
+    $ref: "./paths/risk_levels.yaml"
+  /risk_levels/{id}:
+    $ref: "./paths/risk_levels_id.yaml"
+# User Contributor Relationships
+  /user_profile:
+    $ref: "./paths/user_profile.yaml"
+  /user_profiles:
+    $ref: "./paths/user_profiles.yaml"
+  /user_profiles/{id}:
+    $ref: "./paths/user_profiles_id.yaml"
+  /user_profile/{id}:
+    $ref: "./paths/user_profile_id.yaml"
+# Role Contributor Relationships
+  /role_profile:
+    $ref: "./paths/role_profile.yaml"
+  /role_profiles:
+    $ref: "./paths/role_profiles.yaml"
+  /role_profiles/{id}:
+    $ref: "./paths/role_profiles_id.yaml"
+  /role_profile/{id}:
+    $ref: "./paths/role_profile_id.yaml"
+# Workflow Sessions
+  /workflow_sessions:
+    $ref: "./paths/workflow_sessions.yaml"
+  /workflow_sessions/{id}:
+    $ref: "./paths/workflow_sessions_id.yaml"
+  /workflow_sessions/{id}/upload/{attribute_id}:
+    $ref: "./paths/workflow_sessions_id_upload_attribute_id.yaml"
+# Identity Proofing Results
+  /identity_proofing_results:
+    $ref: "./paths/identity_proofing_results.yaml"
+# Advanced Search
+  /advanced_search:
+    $ref: "./paths/advanced_search.yaml"
+  /advanced_search/run:
+    $ref: "./paths/advanced_search_run.yaml"
+  /advanced_search/{id}:
+    $ref: "./paths/advanced_search_id.yaml"
+  /advanced_search/{id}/run:
+    $ref: "./paths/advanced_search_id_run.yaml"
+# Jobs
+  /job_status:
+    $ref: "./paths/job_status.yaml"

nerm/parameters/_index.yaml

@@ -0,0 +1,60 @@
+# Path
+id:
+  $ref: './path/id.yaml'
+attribute_id:
+  $ref: './path/attribute_id.yaml'
+# Query
+limit:
+  $ref: './query/limit.yaml'
+offset:
+  $ref: './query/offset.yaml'
+user_id:
+  $ref: './query/user_id.yaml'
+manager_id:
+  $ref: './query/manager_id.yaml'
+role_id:
+  $ref: './query/role_id.yaml'
+label:
+  $ref: './query/label.yaml'
+data_type:
+  $ref: './query/data_type.yaml'
+ne_attribute_id:
+  $ref: './query/ne_attribute_id.yaml'
+option:
+  $ref: './query/option.yaml'
+name:
+  $ref: './query/name.yaml'
+archived:
+  $ref: './query/archived.yaml'
+profile_type_id:
+  $ref: './query/profile_type_id.yaml'
+status:
+  $ref: './query/status.yaml'
+object_id:
+  $ref: './query/object_id.yaml'
+object_type:
+  $ref: './query/object_type.yaml'
+overall_risk_level_id:
+  $ref: './query/overall_risk_level_id.yaml'
+impact_risk_level_id:
+  $ref: './query/impact_risk_level_id.yaml'
+probability_risk_level_id:
+  $ref: './query/probability_risk_level_id.yaml'
+profile_id:
+  $ref: './query/profile_id.yaml'
+relationship_type:
+  $ref: './query/relationship_type.yaml'
+uid:
+  $ref: './query/uid.yaml'
+workflow_id:
+  $ref: './query/workflow_id.yaml'
+requester_id:
+  $ref: './query/requester_id.yaml'
+status_uid:
+  $ref: './query/status_uid.yaml'
+workflow_session_id:
+  $ref: './query/workflow_session_id.yaml'
+result:
+  $ref: './query/result.yaml'
+metadata:
+  $ref: './query/metadata.yaml'

nerm/parameters/path/attribute_id.yaml

@@ -0,0 +1,7 @@
+name: attribute_id
+in: path
+description: The id of the attachment attribute
+required: true
+schema:
+  type: string
+  format: uuid

nerm/parameters/path/id.yaml

@@ -0,0 +1,7 @@
+name: id
+in: path
+description: ID of the object to retrieve or update
+required: true
+schema:
+  type: string
+  format: uuid

nerm/parameters/query/archived.yaml

@@ -0,0 +1,7 @@
+name: archived
+in: query
+description: Filter by archive status
+required: false
+schema:
+  type: boolean
+  default: false

nerm/parameters/query/data_type.yaml

@@ -0,0 +1,7 @@
+name: data_type
+in: query
+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]

nerm/parameters/query/email.yaml

@@ -0,0 +1,7 @@
+name: email
+in: query
+description: The user email to search by
+required: false
+schema:
+  type: string
+  format: email

nerm/parameters/query/exclude_attributes.yaml

@@ -0,0 +1,7 @@
+name: exclude_attributes
+in: query
+description: Allows for optimization by not returning the associated attribute data for the returned profiles
+required: false
+schema:
+  type: boolean
+  default: false

nerm/parameters/query/impact_risk_level_id.yaml

@@ -0,0 +1,7 @@
+name: impact_risk_level_id
+in: query
+description: Impact risk level to filter by
+required: false
+schema:
+  type: string
+  format: uuid

nerm/parameters/query/job_id.yaml

@@ -0,0 +1,6 @@
+name: job_id
+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

nerm/parameters/query/label.yaml

@@ -0,0 +1,6 @@
+name: label
+in: query
+description: The attribute label to filter by
+required: false
+schema:
+  type: string

nerm/parameters/query/login.yaml

@@ -0,0 +1,6 @@
+name: login
+in: query
+description: The user login to search by
+required: false
+schema:
+  type: string

nerm/parameters/query/manager_id.yaml

@@ -0,0 +1,7 @@
+name: manager_id
+in: query
+description: The ID of a user for filtering
+required: false
+schema:
+  type: string
+  format: uuid

nerm/parameters/query/metadata.yaml

@@ -0,0 +1,7 @@
+name: metadata
+in: query
+description: Returns batching metadata in the response
+required: false
+schema:
+  type: boolean
+  default: false

nerm/parameters/query/name.yaml

@@ -0,0 +1,6 @@
+name: name
+in: query
+description: object name for filtering
+required: false
+schema:
+  type: string

nerm/parameters/query/ne_attribute_id.yaml

@@ -0,0 +1,7 @@
+name: ne_attribute_id
+in: query
+description: ID of an attribute for filtering
+required: false
+schema:
+  type: string
+  format: uuid

nerm/parameters/query/object_id.yaml

@@ -0,0 +1,7 @@
+name: object_id
+in: query
+description: ID of an object for filtering. Used along with object_type
+required: false
+schema:
+  type: string
+  format: uuid

nerm/parameters/query/object_type.yaml

@@ -0,0 +1,7 @@
+name: object_type
+in: query
+description: Type of object that object_id represents
+required: false
+schema:
+  type: string
+  enum: [Profile, WorkflowSession]

nerm/parameters/query/option.yaml

@@ -0,0 +1,6 @@
+name: option
+in: query
+description: attribute option label for filtering
+required: false
+schema:
+  type: string

nerm/parameters/query/overall_risk_level_id.yaml

@@ -0,0 +1,7 @@
+name: overall_risk_level_id
+in: query
+description: Overall risk level to filter by
+required: false
+schema:
+  type: string
+  format: uuid

nerm/parameters/query/probability_risk_level_id.yaml

@@ -0,0 +1,7 @@
+name: probability_risk_level_id
+in: query
+description: Probability risk level to filter by
+required: false
+schema:
+  type: string
+  format: uuid

nerm/parameters/query/profile_id.yaml

@@ -0,0 +1,7 @@
+name: profile_id
+in: query
+description: Profile ID to filter by
+required: false
+schema:
+  type: string
+  format: uuid

nerm/parameters/query/profile_type_id.yaml

@@ -0,0 +1,7 @@
+name: profile_type_id
+in: query
+description: Profile Type ID for filtering
+required: false
+schema:
+  type: string
+  format: uuid

nerm/parameters/query/query.yaml

@@ -0,0 +1,18 @@
+name: query
+in: query
+description: Allows for pagination and sorting.
+required: false
+schema:
+  type: object
+  properties:
+    limit:
+      type: integer
+      example: 100
+    offset:
+      type: integer
+      example: 50
+    order:
+      type: string
+      example: created_at
+style: deepObject
+explode: true

nerm/parameters/query/relationship_type.yaml

@@ -0,0 +1,7 @@
+name: relationship_type
+in: query
+description: Type of user contributor relationship to filter by
+required: false
+schema:
+  type: string
+  enum: [owner, contributor]

nerm/parameters/query/requester_id.yaml

@@ -0,0 +1,7 @@
+name: requester_id
+in: query
+description: Requester ID for filtering
+required: false
+schema:
+  type: string
+  format: uuid

nerm/parameters/query/result.yaml

@@ -0,0 +1,7 @@
+name: result
+in: query
+description: ID Proofing Result to filter by
+required: false
+schema:
+  type: string
+  enum: [pass, fail]

nerm/parameters/query/role_id.yaml

@@ -0,0 +1,7 @@
+name: role_id
+in: query
+description: The ID of a role for filtering
+required: false
+schema:
+  type: string
+  format: uuid

nerm/parameters/query/run.yaml

@@ -0,0 +1,7 @@
+name: run
+in: query
+description: Will run the created/updated workflow session if successful
+required: false
+schema:
+  type: boolean
+  default: false

nerm/parameters/query/status.yaml

@@ -0,0 +1,7 @@
+name: status
+in: query
+description: status value for filtering
+required: false
+schema:
+  type: string
+  enum: [Active, Inactive, On Leave, Terminated]

nerm/parameters/query/title.yaml

@@ -0,0 +1,6 @@
+name: title
+in: query
+description: The user title to search by
+required: false
+schema:
+  type: string

nerm/parameters/query/uid.yaml

@@ -0,0 +1,8 @@
+name: uid
+in: query
+description: Workflow session uid for filtering
+required: false
+schema:
+  type: string
+  minLength: 32
+  maxLength: 32

nerm/parameters/query/user_id.yaml

@@ -0,0 +1,7 @@
+name: user_id
+in: query
+description: The ID of a user for filtering
+required: false
+schema:
+  type: string
+  format: uuid

nerm/parameters/query/workflow_id.yaml

@@ -0,0 +1,7 @@
+name: workflow_id
+in: query
+description: Workflow ID for filtering
+required: false
+schema:
+  type: string
+  format: uuid

nerm/parameters/query/workflow_session_id.yaml

@@ -0,0 +1,7 @@
+name: workflow_session_id
+in: query
+description: Workflow Session ID to filter by
+required: false
+schema:
+  type: string
+  format: uuid

nerm/parameters/query/workflow_session_status.yaml

@@ -0,0 +1,70 @@
+name: status
+in: query
+description: filter by workflow session status
+required: false
+schema:
+  type: string
+  enum: [
+    "waiting on workflow",
+    "identity proofing completed",
+    "new",
+    "closing",
+    "pending request",
+    "requested",
+    "pending approval",
+    "approved",
+    "pending notification",
+    "notified",
+    "pending review",
+    "reviewed",
+    "pending trigger",
+    "stored procedure",
+    "pending status change",
+    "status changed",
+    "pending update",
+    "non employee updated",
+    "non employee created",
+    "pending creation",
+    "rejected",
+    "pending assignment",
+    "assigned",
+    "default",
+    "failed",
+    "un assigned",
+    "auto assigned",
+    "ldap provided",
+    "pending ldap",
+    "pending fulfillment",
+    "pending stored procedure",
+    "pending courion add",
+    "fulfilled",
+    "pending courion update",
+    "courion add",
+    "pending courion_extend",
+    "courion update",
+    "pending courion terminate",
+    "courion extend",
+    "pending profile select",
+    "courion terminate",
+    "batch completed",
+    "profiles selected",
+    "answered questions",
+    "pending questions",
+    "attempting to start workflow",
+    "started workflow",
+    "profile check complete",
+    "completed",
+    "processing",
+    "pending set attribute",
+    "invitation sent",
+    "action skipped",
+    "api request sent",
+    "attribute set",
+    "disabled",
+    "duplicates resolved",
+    "soap request sent",
+    "checking for duplicates",
+    "pending identity proofing",
+    "closed",
+    "workflow changed"
+  ]

nerm/paths/advanced_search.yaml

@@ -0,0 +1,20 @@
+get:
+  summary: Get saved advanced search queries
+  operationId: getAdvancedSearch
+  description: Get saved advanced search queries
+  tags:
+    - advanced search
+  responses:
+    '200':
+      $ref: "../responses/AdvancedSearches.yaml"
+post:
+  summary: Save an advanced search query for later use
+  operationId: postAdvancedSearch
+  description: Save an advanced search query for later use
+  tags:
+    - advanced search
+  requestBody:
+    $ref: "../requestBodies/POST/AdvancedSearch.yaml"
+  responses:
+    '200':
+      $ref: "../responses/AdvancedSearch.yaml"

nerm/paths/advanced_search_id.yaml

@@ -0,0 +1,13 @@
+patch:
+  summary: Update a saved advanced search query
+  operationId: patchAdvancedSearch
+  description: Update a saved advanced search query
+  tags:
+    - advanced search
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  requestBody:
+    $ref: "../requestBodies/PATCH/AdvancedSearch.yaml"
+  responses:
+    '200':
+      $ref: "../responses/AdvancedSearch.yaml"

nerm/paths/advanced_search_id_run.yaml

@@ -0,0 +1,12 @@
+get:
+  summary: Run a saved advanced search query
+  operationId: runAdvancedSearchbyID
+  description: Run a saved advanced search query
+  tags:
+    - advanced search
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+    - $ref: "../parameters/query/query.yaml"
+  responses:
+    '200':
+      $ref: "../responses/Profiles.yaml"

nerm/paths/advanced_search_run.yaml

@@ -0,0 +1,13 @@
+post:
+  summary: Run an advanced search for profiles, without saving the query
+  operationId: runAdvancedSearch
+  description: Run an advanced search for profiles, without saving the query
+  tags:
+    - advanced search
+  parameters:
+    - $ref: "../parameters/query/query.yaml"
+  requestBody:
+    $ref: "../requestBodies/POST/AdvancedSearch.yaml"
+  responses:
+    '200':
+      $ref: "../responses/Profiles.yaml"

nerm/paths/identity_proofing_results.yaml

@@ -0,0 +1,15 @@
+get:
+  summary: Get identity proofing result data in bulk
+  operationId: getIdentityProofingResults
+  description: This endpoint can retrieve identity proofing result data in bulk from Lifecycle
+  tags:
+    - identity proofing results
+  parameters:
+    - $ref: "../parameters/query/query.yaml"
+    - $ref: "../parameters/query/profile_id.yaml"
+    - $ref: "../parameters/query/workflow_session_id.yaml"
+    - $ref: "../parameters/query/result.yaml"
+    - $ref: "../parameters/query/metadata.yaml"
+  responses:
+    '200':
+      $ref: "../responses/IdentityProofingResults.yaml"

nerm/paths/job_status.yaml

@@ -0,0 +1,15 @@
+get:
+  summary: Get the status of a bulk job
+  operationId: getJobStatus
+  description: Get the status of a bulk job
+  tags:
+    - job status
+  parameters:
+    - $ref: "../parameters/query/job_id.yaml"
+  responses:
+    '200':
+      $ref: "../responses/Job.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/ne_attribute_option.yaml

@@ -0,0 +1,13 @@
+post:
+  summary: Add a value to an option based attribute
+  operationId: postAttributeOption
+  description: Add a value to an option based attribute
+  tags:
+    - attribute options
+  requestBody:
+    $ref: "../requestBodies/POST/AttributeOption.yaml"
+  responses:
+    '200':
+      $ref: "../responses/AttributeOption.yaml"
+    '405':
+      $ref: "../responses/InvalidInput.yaml"

nerm/paths/ne_attribute_options.yaml

@@ -0,0 +1,48 @@
+get:
+  summary: Get option based attribute values
+  operationId: getAttributeOptions
+  description: Get option based attribute values
+  tags:
+    - attribute options
+  parameters:
+    - $ref: "../parameters/query/query.yaml"
+    - $ref: "../parameters/query/ne_attribute_id.yaml"
+#   - $ref: "../parameters/query/option.yaml" - Not implemented as of 4.16.2
+    - $ref: "../parameters/query/metadata.yaml"
+  responses:
+    '200':
+      $ref: "../responses/AttributeOptions_Meta.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+post:
+  summary: Create multiple new option based attribute values
+  operationId: postAttributeOptions
+  description: Create multiple new option based attribute values
+  tags:
+    - attribute options
+  requestBody:
+    $ref: "../requestBodies/POST/AttributeOptions.yaml"
+  responses:
+    '200':
+      $ref: "../responses/AttributeOptionsJob.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+patch:
+  summary: Update multiple option based attribute values
+  operationId: patchAttributeOptions
+  description: Update multiple option based attribute values
+  tags:
+    - attribute options
+  requestBody:
+    $ref: "../requestBodies/PATCH/AttributeOptions.yaml"
+  responses:
+    '200':
+      $ref: "../responses/AttributeOptionsJob.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/ne_attribute_options_id.yaml

@@ -0,0 +1,47 @@
+get:
+  summary: Find option based attribute value by id
+  operationId: getAttributeOption
+  description: Info for a specific option based attribute value
+  tags:
+    - attribute options
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  responses:
+    '200':
+      $ref: "../responses/AttributeOption.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+patch:
+  summary: Update a option based attribute value by id
+  operationId: patchAttributeOption
+  description: Update a option based attribute value by id
+  tags:
+    - attribute options
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  requestBody:
+    $ref: "../requestBodies/PATCH/AttributeOption.yaml"
+  responses:
+    '200':
+      $ref: "../responses/AttributeOption.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+delete:
+  summary: Delete a option based attribute value by id
+  operationId: deleteAttributeOption
+  description: Delete a option based attribute value by id
+  tags:
+    - attribute options
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  responses:
+    '200':
+      $ref: "../responses/DeleteConfirmation.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/ne_attributes.yaml

@@ -0,0 +1,18 @@
+get:
+  summary: Get attribute data in bulk
+  operationId: getAttributes
+  description: This endpoint can retrieve attribute data in bulk from Lifecycle or you can search for attributes using parameters
+  tags:
+    - attributes
+  parameters:
+    - $ref: "../parameters/query/query.yaml"
+    - $ref: "../parameters/query/label.yaml"
+    - $ref: "../parameters/query/data_type.yaml"
+    - $ref: "../parameters/query/metadata.yaml"
+  responses:
+    '200':
+      $ref: "../responses/Attributes_Meta.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/ne_attributes_id.yaml

@@ -0,0 +1,15 @@
+get:
+  summary: Find attribute data by id
+  operationId: getAttribute
+  description: Info for a specific attribute
+  tags:
+    - attributes
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  responses:
+    '200':
+      $ref: "../responses/Attribute.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/profile.yaml

@@ -0,0 +1,15 @@
+post:
+  summary: Create a profile
+  operationId: postProfile
+  description: Create a profile
+  tags:
+    - profiles
+  requestBody:
+    $ref: "../requestBodies/POST/Profile.yaml"
+  responses:
+    '200':
+      $ref: "../responses/Profile.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/profile_type.yaml

@@ -0,0 +1,15 @@
+post:
+  summary: Create a profile type
+  operationId: postProfileType
+  description: Create a profile type
+  tags:
+    - profile types
+  requestBody:
+    $ref: "../requestBodies/POST/ProfileType.yaml"
+  responses:
+    '200':
+      $ref: "../responses/ProfileType.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/profile_types.yaml

@@ -0,0 +1,18 @@
+get:
+  summary: Get profile types
+  operationId: getProfileTypes
+  description: Get option based attribute values
+  tags:
+    - profile types
+  parameters:
+    - $ref: "../parameters/query/query.yaml"
+    - $ref: "../parameters/query/name.yaml"
+    - $ref: "../parameters/query/archived.yaml"
+    - $ref: "../parameters/query/metadata.yaml"
+  responses:
+    '200':
+      $ref: "../responses/ProfileTypes_Meta.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/profile_types_id.yaml

@@ -0,0 +1,48 @@
+get:
+  summary: Find profile type by id
+  operationId: getProfileType
+  description: Find profile type by id
+  tags:
+    - profile types
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  responses:
+    '200':
+      $ref: "../responses/ProfileType.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+patch:
+  summary: Update a profile type by id
+  operationId: patchProfileType
+  description: Update a profile type by id
+  tags:
+    - profile types
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  requestBody:
+    $ref: "../requestBodies/PATCH/ProfileType.yaml"
+  responses:
+    '200':
+      $ref: "../responses/ProfileType.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+# There is a foregin key constraint due to a profile profile_type_id dependency
+delete:
+  summary: Delete profile type
+  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
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  responses:
+    '200':
+      $ref: "../responses/info.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/profiles.yaml

@@ -0,0 +1,65 @@
+get:
+  summary: Get profiles
+  operationId: getProfiles
+  description: Get profiles
+  tags:
+    - profiles
+  parameters:
+    - $ref: "../parameters/query/query.yaml"
+    - $ref: "../parameters/query/exclude_attributes.yaml"
+    - $ref: "../parameters/query/name.yaml"
+    - $ref: "../parameters/query/profile_type_id.yaml"
+    - $ref: "../parameters/query/status.yaml"
+    - $ref: "../parameters/query/metadata.yaml"
+  responses:
+    '200':
+      $ref: "../responses/Profiles_Meta.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+post:
+  summary: Create multiple profiles
+  operationId: postProfiles
+  description: Create multiple profiles
+  tags:
+    - profiles
+  requestBody:
+    $ref: "../requestBodies/POST/Profiles.yaml"
+  responses:
+    '200':
+      $ref: "../responses/ProfilesJob.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+patch:
+  summary: Update multiple profiles
+  operationId: patchProfiles
+  description: Update multiple profiles
+  tags:
+    - profiles
+  requestBody:
+    $ref: "../requestBodies/PATCH/Profiles.yaml"
+  responses:
+    '200':
+      $ref: "../responses/ProfilesJob.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+delete:
+  summary: Delete multiple profiles
+  operationId: deleteProfiles
+  description: Delete multiple profiles
+  tags:
+    - profiles
+  requestBody:
+    $ref: "../requestBodies/DELETE/Profiles.yaml"
+  responses:
+    '200':
+      $ref: "../responses/ProfilesJob.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/profiles_id.yaml

@@ -0,0 +1,32 @@
+get:
+  summary: Find profile by id
+  operationId: getProfile
+  description: Find profile by id
+  tags:
+    - profiles
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  responses:
+    '200':
+      $ref: "../responses/Profile.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+patch:
+  summary: Update a profile by id
+  operationId: patchProfile
+  description: Update a profile by id
+  tags:
+    - profiles
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  requestBody:
+    $ref: "../requestBodies/PATCH/Profile.yaml"
+  responses:
+    '200':
+      $ref: "../responses/Profile.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/profiles_id_avatar.yaml

@@ -0,0 +1,32 @@
+get:
+  summary: Retrieves the URL of the profile avatar
+  operationId: getProfileAvatar
+  description: Retrieves the URL of the profile avatar
+  tags:
+    - profiles
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  responses:
+    '200':
+      $ref: "../responses/Url.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+post:
+  summary: Uploads a new profile avatar
+  operationId: postProfileAvatar
+  description: Uploads a new profile avatar
+  tags:
+    - profiles
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  requestBody:
+    $ref: "../requestBodies/POST/File.yaml"
+  responses:
+    '200':
+      $ref: "../responses/Url.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/profiles_id_upload_attribute_id.yaml

@@ -0,0 +1,34 @@
+get:
+  summary: Retrieves the URL of an attachment attribute value from a profile
+  operationId: getProfileUpload
+  description: Retrieves the URL of an attachment attribute value from a profile
+  tags:
+    - profiles
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+    - $ref: "../parameters/path/attribute_id.yaml"
+  responses:
+    '200':
+      $ref: "../responses/Url.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+post:
+  summary: Uploads a new attachment attribute value to a profile
+  operationId: postProfileUpload
+  description: Uploads a new attachment attribute value to a profile
+  tags:
+    - profiles
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+    - $ref: "../parameters/path/attribute_id.yaml"
+  requestBody:
+    $ref: "../requestBodies/POST/File.yaml"
+  responses:
+    '200':
+      $ref: "../responses/Url.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/risk_levels.yaml

@@ -0,0 +1,17 @@
+get:
+  summary: Get risk level data in bulk
+  operationId: getRiskLevels
+  description: This endpoint can retrieve risk level data in bulk from Lifecycle
+  tags:
+    - risk levels
+  parameters:
+    - $ref: "../parameters/query/query.yaml"
+    - $ref: "../parameters/query/label.yaml"
+    - $ref: "../parameters/query/metadata.yaml"
+  responses:
+    '200':
+      $ref: "../responses/RiskLevels_Meta.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/risk_levels_id.yaml

@@ -0,0 +1,15 @@
+get:
+  summary: Find risk level data by id
+  operationId: getRiskLevel
+  description: Find risk level data by id
+  tags:
+    - risk levels
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  responses:
+    '200':
+      $ref: "../responses/RiskLevel.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/risk_scores.yaml

@@ -0,0 +1,21 @@
+get:
+  summary: Get risk score data in bulk
+  operationId: getRiskScores
+  description: This endpoint can retrieve risk score data in bulk from Lifecycle
+  tags:
+    - risk scores
+  parameters:
+    - $ref: "../parameters/query/query.yaml"
+    - $ref: "../parameters/query/object_id.yaml"
+    - $ref: "../parameters/query/object_type.yaml"
+    - $ref: "../parameters/query/overall_risk_level_id.yaml"
+    - $ref: "../parameters/query/impact_risk_level_id.yaml"
+    - $ref: "../parameters/query/probability_risk_level_id.yaml"
+    - $ref: "../parameters/query/metadata.yaml"
+  responses:
+    '200':
+      $ref: "../responses/RiskScores.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/risk_scores_id.yaml

@@ -0,0 +1,15 @@
+get:
+  summary: Find risk score data by id
+  operationId: getRiskScore
+  description: Find risk score data by id
+  tags:
+    - risk scores
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  responses:
+    '200':
+      $ref: "../responses/RiskScore.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/role.yaml

@@ -0,0 +1,15 @@
+post:
+  summary: Create a new role
+  operationId: postRole
+  description: Create a new role
+  tags:
+    - roles
+  requestBody:
+    $ref: "../requestBodies/POST/Role.yaml"
+  responses:
+    '200':
+      $ref: "../responses/Role.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/role_profile.yaml

@@ -0,0 +1,13 @@
+post:
+  summary: Create a role-profile contributor relationship
+  operationId: postRoleProfile
+  description: Create a role-profile contributor relationship
+  tags:
+    - role profiles
+  requestBody:
+    $ref: "../requestBodies/POST/RoleProfile.yaml"
+  responses:
+    '200':
+      $ref: "../responses/RoleProfile.yaml"
+    '405':
+      $ref: "../responses/InvalidInput.yaml"

nerm/paths/role_profile_id.yaml

@@ -0,0 +1,19 @@
+delete:
+  summary: Delete a role profile assignment
+  operationId: deleteRoleProfile
+  description: Delete a role profile assignment
+  tags:
+    - role profiles
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  responses:
+    '200':
+      description: "Role profile was destroyed"
+      content:
+        application/json:
+          schema:
+            type: object
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/role_profiles.yaml

@@ -0,0 +1,48 @@
+get:
+  summary: Get role-profile contributor relationships
+  operationId: getRoleProfiles
+  description: Get role-profile contributor relationships
+  tags:
+    - role profiles
+  parameters:
+    - $ref: "../parameters/query/query.yaml"
+    - $ref: "../parameters/query/role_id.yaml"
+    - $ref: "../parameters/query/profile_id.yaml"
+    - $ref: "../parameters/query/metadata.yaml"
+  responses:
+    '200':
+      $ref: "../responses/RoleProfiles_Meta.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+post:
+  summary: Create multiple role-profile contributor relationships
+  operationId: postRoleProfiles
+  description: Create multiple role-profile contributor relationships
+  tags:
+    - role profiles
+  requestBody:
+    $ref: "../requestBodies/POST/RoleProfiles.yaml"
+  responses:
+    '200':
+      $ref: "../responses/RoleProfilesJob.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+patch:
+  summary: Update multiple role-profile contributor relationships
+  operationId: patchRoleProfiles
+  description: Update multiple role-profile contributor relationships
+  tags:
+    - role profiles
+  requestBody:
+    $ref: "../requestBodies/PATCH/RoleProfiles.yaml"
+  responses:
+    '200':
+      $ref: "../responses/RoleProfilesJob.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/role_profiles_id.yaml

@@ -0,0 +1,32 @@
+get:
+  summary: Find role-profile contributor relationship by id
+  operationId: getRoleProfile
+  description: Find role-profile contributor relationship by id
+  tags:
+    - role profiles
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  responses:
+    '200':
+      $ref: "../responses/RoleProfile.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+patch:
+  summary: Update a role-profile contributor relationship by id
+  operationId: patchRoleProfile
+  description: Update a role-profile contributor relationship by id
+  tags:
+    - role profiles
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  requestBody:
+    $ref: "../requestBodies/PATCH/RoleProfile.yaml"
+  responses:
+    '200':
+      $ref: "../responses/RoleProfile.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/roles.yaml

@@ -0,0 +1,46 @@
+get:
+  summary: Get roles
+  operationId: getRoles
+  description: This endpoint can retrieve roles from NERM. Optionally you can provide parameters to filter results.
+  tags:
+    - roles
+  parameters:
+    - $ref: "../parameters/query/query.yaml"
+    - $ref: "../parameters/query/metadata.yaml"
+  responses:
+    '200':
+      $ref: "../responses/Roles_Meta.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+post:
+  summary: Create multiple new roles
+  operationId: postRoles
+  description: Create multiple new users
+  tags:
+    - roles
+  requestBody:
+    $ref: "../requestBodies/POST/Roles.yaml"
+  responses:
+    '200':
+      $ref: "../responses/RolesJob.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+patch:
+  summary: Update multiple roles
+  operationId: patchRoles
+  description: Update multiple users
+  tags:
+    - roles
+  requestBody:
+    $ref: "../requestBodies/PATCH/Roles.yaml"
+  responses:
+    '200':
+      $ref: "../responses/RolesJob.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/roles_id.yaml

@@ -0,0 +1,32 @@
+get:
+  summary: Find role by id
+  operationId: getRole
+  description: Info for a specific user role
+  tags:
+    - roles
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  responses:
+    '200':
+      $ref: "../responses/Role.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+patch:
+  summary: Update an existing role
+  operationId: patchRole
+  description: Update an existing role
+  tags:
+    - roles
+  requestBody:
+    $ref: "../requestBodies/PATCH/Role.yaml"
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  responses:
+    '200':
+      $ref: "../responses/Role.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/user.yaml

@@ -0,0 +1,15 @@
+post:
+  summary: Create a new user
+  operationId: postUser
+  description: Create a new user
+  tags:
+    - users
+  requestBody:
+    $ref: "../requestBodies/POST/User.yaml"
+  responses:
+    '200':
+      $ref: "../responses/User.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/user_manager.yaml

@@ -0,0 +1,15 @@
+post:
+  summary: Create a new user-manager relationship
+  operationId: postUserManager
+  description: Create a new user-manager relationship
+  tags:
+    - user managers
+  requestBody:
+    $ref: "../requestBodies/POST/UserManager.yaml"
+  responses:
+    '200':
+      $ref: "../responses/UserManager.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/user_managers.yaml

@@ -0,0 +1,48 @@
+get:
+  summary: Get user-manager relationships
+  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
+  parameters:
+    - $ref: "../parameters/query/query.yaml"
+    - $ref: "../parameters/query/user_id.yaml"
+    - $ref: "../parameters/query/manager_id.yaml"
+    - $ref: "../parameters/query/metadata.yaml"
+  responses:
+    '200':
+      $ref: "../responses/UserManagers_Meta.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+post:
+  summary: Create multiple new user-manager relationships
+  operationId: postUserManagers
+  description: Create multiple new user-manager relationships
+  tags:
+    - user managers
+  requestBody:
+    $ref: "../requestBodies/POST/UserManagers.yaml"
+  responses:
+    '200':
+      $ref: "../responses/UserManagersJob.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+patch:
+  summary: Update multiple user-manager relationships
+  operationId: patchUserManagers
+  description: Update multiple user-manager relationships
+  tags:
+    - user managers
+  requestBody:
+    $ref: "../requestBodies/PATCH/UserManagers.yaml"
+  responses:
+    '200':
+      $ref: "../responses/UserManagersJob.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/user_managers_id.yaml

@@ -0,0 +1,32 @@
+get:
+  summary: Find user-manager relationship by id
+  operationId: getUserManager
+  description: Info for a specific user-manager relationship
+  tags:
+    - user managers
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  responses:
+    '200':
+      $ref: "../responses/UserManager.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+patch:
+  summary: Update a user-manager relationship by id
+  operationId: patchUserManager
+  description: Update a user-manager relationship by id
+  tags:
+    - user managers
+  requestBody:
+    $ref: "../requestBodies/PATCH/UserManager.yaml"
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  responses:
+    '200':
+      $ref: "../responses/UserManager.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/user_profile.yaml

@@ -0,0 +1,13 @@
+post:
+  summary: Create a user-profile contributor relationship
+  operationId: postUserProfile
+  description: Create a user-profile contributor relationship
+  tags:
+    - user profiles
+  requestBody:
+    $ref: "../requestBodies/POST/UserProfile.yaml"
+  responses:
+    '200':
+      $ref: "../responses/UserProfile.yaml"
+    '405':
+      $ref: "../responses/InvalidInput.yaml"

nerm/paths/user_profile_id.yaml

@@ -0,0 +1,19 @@
+delete:
+  summary: Delete a user profile assignment
+  operationId: deleteUserProfile
+  description: Delete a user profile assignment
+  tags:
+    - user profiles
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  responses:
+    '200':
+      description: "User profile was destroyed"
+      content:
+        application/json:
+          schema:
+            type: object
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/user_profiles.yaml

@@ -0,0 +1,50 @@
+get:
+  summary: Get user-profile contributor relationships
+  operationId: getUserProfiles
+  description: Get user-profile contributor relationships
+  tags:
+    - user profiles
+  parameters:
+    - $ref: "../parameters/query/query.yaml"
+    - $ref: "../parameters/query/user_id.yaml"
+    - $ref: "../parameters/query/ne_attribute_id.yaml"
+    - $ref: "../parameters/query/profile_id.yaml"
+    - $ref: "../parameters/query/relationship_type.yaml"
+    - $ref: "../parameters/query/metadata.yaml"
+  responses:
+    '200':
+      $ref: "../responses/UserProfiles_Meta.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+post:
+  summary: Create multiple user-profile contributor relationships
+  operationId: postUserProfiles
+  description: Create multiple user-profile contributor relationships
+  tags:
+    - user profiles
+  requestBody:
+    $ref: "../requestBodies/POST/UserProfiles.yaml"
+  responses:
+    '200':
+      $ref: "../responses/UserProfilesJob.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+patch:
+  summary: Update multiple user-profile contributor relationships
+  operationId: patchUserProfiles
+  description: Update multiple user-profile contributor relationships
+  tags:
+    - user profiles
+  requestBody:
+    $ref: "../requestBodies/PATCH/UserProfiles.yaml"
+  responses:
+    '200':
+      $ref: "../responses/UserProfilesJob.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/user_profiles_id.yaml

@@ -0,0 +1,32 @@
+get:
+  summary: Find user-profile contributor relationship by id
+  operationId: getUserProfile
+  description: Find user-profile contributor relationship by id
+  tags:
+    - user profiles
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  responses:
+    '200':
+      $ref: "../responses/UserProfile.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+patch:
+  summary: Update a user-profile contributor relationship by id
+  operationId: patchUserProfile
+  description: Update a user-profile contributor relationship by id
+  tags:
+    - user profiles
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  requestBody:
+    $ref: "../requestBodies/PATCH/UserProfile.yaml"
+  responses:
+    '200':
+      $ref: "../responses/UserProfile.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/user_role.yaml

@@ -0,0 +1,15 @@
+post:
+  summary: Assign a new role to a user
+  operationId: postUserRole
+  description: Assign a new role to a user
+  tags:
+    - user roles
+  requestBody:
+    $ref: "../requestBodies/POST/UserRole.yaml"
+  responses:
+    '200':
+      $ref: "../responses/UserRole.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/user_role_id.yaml

@@ -0,0 +1,19 @@
+delete:
+  summary: Delete a user role assignment
+  operationId: deleteUserRole
+  description: Delete a user role assignment
+  tags:
+    - user roles
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  responses:
+    '200':
+      description: "User role was destroyed"
+      content:
+        application/json:
+          schema:
+            type: object
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/user_roles.yaml

@@ -0,0 +1,48 @@
+get:
+  summary: Get user role pairings
+  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
+  parameters:
+    - $ref: "../parameters/query/query.yaml"
+    - $ref: "../parameters/query/user_id.yaml"
+    - $ref: "../parameters/query/role_id.yaml"
+    - $ref: "../parameters/query/metadata.yaml"
+  responses:
+    '200':
+      $ref: "../responses/UserRoles_Meta.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+post:
+  summary: Create multiple new user role pairings
+  operationId: postUserRoles
+  description: Create multiple new user role pairings
+  tags:
+    - user roles
+  requestBody:
+    $ref: "../requestBodies/POST/UserRoles.yaml"
+  responses:
+    '200':
+      $ref: "../responses/UserRolesJob.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+patch:
+  summary: Update multiple user role pairings
+  operationId: patchUserRoles
+  description: Update multiple user role pairings
+  tags:
+    - user roles
+  requestBody:
+    $ref: "../requestBodies/PATCH/UserRoles.yaml"
+  responses:
+    '200':
+      $ref: "../responses/UserRolesJob.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/user_roles_id.yaml

@@ -0,0 +1,32 @@
+get:
+  summary: Find user role pairing by id
+  operationId: getUserRole
+  description: Info for a specific user role pairing
+  tags:
+    - user roles
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  responses:
+    '200':
+      $ref: "../responses/UserRole.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+patch:
+  summary: Update a user role pairing by id
+  operationId: patchUserRole
+  description: Update a user role pairing by id
+  tags:
+    - user roles
+  requestBody:
+    $ref: "../requestBodies/PATCH/UserRole.yaml"
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  responses:
+    '200':
+      $ref: "../responses/UserRole.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/users.yaml

@@ -0,0 +1,51 @@
+get:
+  summary: Get users
+  operationId: getUsers
+  description: This endpoint can retrieve users from Lifecycle or you can search for users using parameters
+  tags:
+    - users
+  parameters:
+    - $ref: "../parameters/query/query.yaml"
+    - $ref: "../parameters/query/name.yaml"
+    - $ref: "../parameters/query/login.yaml"
+    - $ref: "../parameters/query/title.yaml"
+    - $ref: "../parameters/query/status.yaml"
+    - $ref: "../parameters/query/email.yaml"
+    - $ref: "../parameters/query/metadata.yaml"
+  responses:
+    '200':
+      $ref: "../responses/Users_Meta.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+post:
+  summary: Create multiple new users
+  operationId: postUsers
+  description: Create multiple new users
+  tags:
+    - users
+  requestBody:
+    $ref: "../requestBodies/POST/Users.yaml"
+  responses:
+    '200':
+      $ref: "../responses/UsersJob.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+patch:
+  summary: Update multiple users
+  operationId: patchUsers
+  description: Update multiple users
+  tags:
+    - users
+  requestBody:
+    $ref: "../requestBodies/PATCH/Users.yaml"
+  responses:
+    '200':
+      $ref: "../responses/UsersJob.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/users_id.yaml

@@ -0,0 +1,47 @@
+get:
+  summary: Find user by id
+  operationId: getUser
+  description: Info for a specific user
+  tags:
+    - users
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  responses:
+    '200':
+      $ref: "../responses/User.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+patch:
+  summary: Update a user by id
+  operationId: patchUser
+  description: Update a user by id
+  tags:
+    - users
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  requestBody:
+    $ref: "../requestBodies/PATCH/User.yaml"
+  responses:
+    '200':
+      $ref: "../responses/User.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+delete:
+  summary: Delete a user
+  operationId: deleteUser
+  description: Delete a user
+  tags:
+    - users
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  responses:
+    '200':
+      $ref: "../responses/info.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/users_id_avatar.yaml

@@ -0,0 +1,32 @@
+get:
+  summary: Retrieves the URL of the user avatar
+  operationId: getUserAvatar
+  description: Retrieves the URL of the user avatar
+  tags:
+    - users
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  responses:
+    '200':
+      $ref: "../responses/Url.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+post:
+  summary: Uploads a new user avatar
+  operationId: postUserAvatar
+  description: Uploads a new user avatar
+  tags:
+    - users
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  requestBody:
+    $ref: "../requestBodies/POST/File.yaml"
+  responses:
+    '200':
+      $ref: "../responses/Url.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/workflow_sessions.yaml

@@ -0,0 +1,38 @@
+get:
+  summary: Get workflow sessions
+  operationId: getWorkflowSessions
+  description: Get workflow sessions
+  tags:
+    - workflow sessions
+  parameters:
+    - $ref: "../parameters/query/query.yaml"
+    - $ref: "../parameters/query/profile_id.yaml"
+    - $ref: "../parameters/query/uid.yaml"
+    - $ref: "../parameters/query/workflow_id.yaml"
+    - $ref: "../parameters/query/requester_id.yaml"
+    - $ref: "../parameters/query/workflow_session_status.yaml"
+    - $ref: "../parameters/query/metadata.yaml"
+  responses:
+    '200':
+      $ref: "../responses/WorkflowSessions_Meta.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+post:
+  summary: Create a workflow session
+  operationId: postWorkflowSession
+  description: Create a workflow session
+  tags:
+    - workflow sessions
+  parameters:
+    - $ref: "../parameters/query/run.yaml"
+  requestBody:
+    $ref: "../requestBodies/POST/WorkflowSession.yaml"
+  responses:
+    '200':
+      $ref: "../responses/WorkflowSession.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/workflow_sessions_id.yaml

@@ -0,0 +1,33 @@
+get:
+  summary: Find workflow session by id
+  operationId: getWorkflowSession
+  description: Find workflow session by id
+  tags:
+    - workflow sessions
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  responses:
+    '200':
+      $ref: "../responses/WorkflowSession.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+patch:
+  summary: Update a workflow session by id
+  operationId: patchWorkflowSession
+  description: Update a workflow session by id
+  tags:
+    - workflow sessions
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+    - $ref: "../parameters/query/run.yaml"
+  requestBody:
+    $ref: "../requestBodies/PATCH/WorkflowSession.yaml"
+  responses:
+    '200':
+      $ref: "../responses/WorkflowSession.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/workflow_sessions_id_upload_attribute_id.yaml

@@ -0,0 +1,34 @@
+get:
+  summary: Retrieves the URL of an attachment attribute value from a workflow session
+  operationId: getWorkflowSessionUpload
+  description: Retrieves the URL of an attachment attribute value from a workflow session
+  tags:
+    - workflow sessions
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+    - $ref: "../parameters/path/attribute_id.yaml"
+  responses:
+    '200':
+      $ref: "../responses/Url.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"
+post:
+  summary: Uploads a new attachment attribute value to a workflow session
+  operationId: postWorkflowSessionUpload
+  description: Uploads a new attachment attribute value to a workflow session
+  tags:
+    - workflow sessions
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+    - $ref: "../parameters/path/attribute_id.yaml"
+  requestBody:
+    $ref: "../requestBodies/POST/File.yaml"
+  responses:
+    '200':
+      $ref: "../responses/Url.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/requestBodies/DELETE/Profiles.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

nerm/requestBodies/PATCH/AdvancedSearch.yaml

@@ -0,0 +1,9 @@
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        advanced_search:
+          type: object
+          $ref: "../../schemas/PATCH/AdvancedSearch.yaml"

nerm/requestBodies/PATCH/AttributeOption.yaml

@@ -0,0 +1,9 @@
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        ne_attribute_option:
+          type: object
+          $ref: "../../schemas/PATCH/AttributeOption.yaml"

nerm/requestBodies/PATCH/AttributeOptions.yaml

@@ -0,0 +1,10 @@
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        ne_attribute_options:
+          type: array
+          items:
+            $ref: "../../schemas/PATCH/AttributeOptions.yaml"

nerm/requestBodies/PATCH/Profile.yaml

@@ -0,0 +1,9 @@
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        profile:
+          type: object
+          $ref: "../../schemas/PATCH/Profile.yaml"

nerm/requestBodies/PATCH/ProfileType.yaml

@@ -0,0 +1,9 @@
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        profile_type:
+          type: object
+          $ref: "../../schemas/PATCH/ProfileType.yaml"

nerm/requestBodies/PATCH/Profiles.yaml

@@ -0,0 +1,10 @@
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        profiles:
+          type: array
+          items:
+            $ref: "../../schemas/PATCH/Profiles.yaml"

nerm/requestBodies/PATCH/Role.yaml

@@ -0,0 +1,9 @@
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        role:
+          type: object
+          $ref: "../../schemas/PATCH/Role.yaml"

nerm/requestBodies/PATCH/RoleProfile.yaml

@@ -0,0 +1,9 @@
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        role_profile:
+          type: object
+          $ref: "../../schemas/PATCH/RoleProfile.yaml"

nerm/requestBodies/PATCH/RoleProfiles.yaml

@@ -0,0 +1,10 @@
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        role_profiles:
+          type: array
+          items:
+            $ref: "../../schemas/PATCH/RoleProfiles.yaml"

nerm/requestBodies/PATCH/Roles.yaml

@@ -0,0 +1,10 @@
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        roles:
+          type: array
+          items:
+            $ref: "../../schemas/PATCH/Role.yaml"

nerm/requestBodies/PATCH/User.yaml

@@ -0,0 +1,9 @@
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        user:
+          type: object
+          $ref: "../../schemas/PATCH/User.yaml"

nerm/requestBodies/PATCH/UserManager.yaml

@@ -0,0 +1,9 @@
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        user_manager:
+          type: object
+          $ref: "../../schemas/PATCH/UserManager.yaml"

nerm/requestBodies/PATCH/UserManagers.yaml

@@ -0,0 +1,10 @@
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        user_managers:
+          type: array
+          items:
+            $ref: "../../schemas/PATCH/UserManagers.yaml"

nerm/requestBodies/PATCH/UserProfile.yaml

@@ -0,0 +1,9 @@
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        user_profile:
+          type: object
+          $ref: "../../schemas/PATCH/UserProfile.yaml"

nerm/requestBodies/PATCH/UserProfiles.yaml

@@ -0,0 +1,10 @@
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        user_profiles:
+          type: array
+          items:
+            $ref: "../../schemas/PATCH/UserProfiles.yaml"