Automated commit 'Merge pull request #59 from sailpoint/NERRA-1795

NERRA-1795: Add documentation for the isc_accounts API endpoint' by github action: 12712499763

nerm/parameters/query/category.yaml

@@ -0,0 +1,7 @@
+name: category
+in: query
+description: The category parameter is used to retrieve profiles belonging to profile types categorized under the allowed schema mapping categories. The permitted categories allowed are 'non-employee' and 'assignment'.
+required: false
+schema:
+  type: string
+  example: non-employee

nerm/parameters/query/use_schema.yaml

@@ -0,0 +1,8 @@
+name: use_schema
+in: query
+description: The use_schema parameter returns schema-mapped field names in the Profiles API response when set to true.
+required: false
+schema:
+  type: boolean
+  default: false
+  example: true

nerm/paths/isc_account.yaml

@@ -0,0 +1,15 @@
+get:
+  summary: Retrieve single schema-mapped profile
+  operationId: getSingleSchemaMappedProfile
+  description: It returns a single stored profile, optionally with schema-mapped field names.
+  tags:
+    - isc accounts
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  responses:
+    '200':
+      $ref: "../responses/Profile.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/isc_accounts.yaml

@@ -0,0 +1,18 @@
+get:
+  summary: Retrieve schema-mapped profiles collection
+  operationId: getSchemaMappedProfilesCollection
+  description: It returns a collection of stored profiles, optionally using schema-mapped field names if requested.
+  tags:
+    - isc accounts
+  parameters:
+    - $ref: "../parameters/query/category.yaml"
+    - $ref: "../parameters/query/page.yaml"
+    - $ref: "../parameters/query/per_page.yaml"
+    - $ref: "../parameters/query/use_schema.yaml"
+  responses:
+    '200':
+      $ref: "../responses/IscAccounts.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/responses/IscAccounts.yaml

@@ -0,0 +1,10 @@
+description: Expected response to a valid request
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        profiles:
+          type: array
+          items:
+            $ref: '../schemas/GET/Profile.yaml'