Automated commit by github action: 4790523104

static/api-specs/idn/beta/paths/account-usages.yaml

@@ -0,0 +1,50 @@
+get:
+  tags:
+    - Account Usages
+  summary: Returns account usage insights
+  description: >-
+    This API returns summary of account usage insights for past 12 months.
+  operationId: getUsagesByAccountId
+  parameters:
+    - name: accountId
+      in: path
+      description: ID of IDN account
+      required: true
+      schema:
+        type: string
+      example: 'ef38f94347e94562b5bb8424a56397d8'
+    - $ref: '../../v3/parameters/limit.yaml'
+    - $ref: '../../v3/parameters/offset.yaml'
+    - $ref: '../../v3/parameters/count.yaml'
+    - in: query
+      name: sorters
+      schema:
+        type: string
+        format: comma-separated
+      description: >-
+        Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
+        Sorting is supported for the following fields: **date**
+      example: -date
+  security:
+      - oauth2: [ idn:accounts:read ]
+  responses:
+    '200':
+      description: Summary of account usage insights for past 12 months.
+      content:
+        application/json:
+          schema:
+            type: array
+            items:
+              $ref: '../schemas/AccountUsage.yaml'
+    '400':
+      $ref: '../../v3/responses/400.yaml'
+    '401':
+      $ref: '../../v3/responses/401.yaml'
+    '403':
+      $ref: '../../v3/responses/403.yaml'
+    '429':
+      $ref: '../../v3/responses/429.yaml'
+    '500':
+      $ref: '../../v3/responses/500.yaml'

static/api-specs/idn/beta/paths/source-usage-status.yaml

@@ -0,0 +1,34 @@
+get:
+  tags:
+    - Source Usages
+  summary: Finds status of source usage
+  description: >-
+    This API returns the status of the source usage insights setup by IDN source ID.
+  operationId: getStatusBySourceId
+  parameters:
+    - name: sourceId
+      in: path
+      description: ID of IDN source
+      required: true
+      schema:
+        type: string
+      example: '2c9180835d191a86015d28455b4a2329'
+  security:
+    - oauth2: [ idn:accounts:read ]
+  responses:
+    '200':
+      description: Status of the source usage insights setup by IDN source ID.
+      content:
+        application/json:
+          schema:
+            $ref: '../schemas/SourceUsageStatus.yaml'
+    '400':
+      $ref: '../../v3/responses/400.yaml'
+    '401':
+      $ref: '../../v3/responses/401.yaml'
+    '403':
+      $ref: '../../v3/responses/403.yaml'
+    '429':
+      $ref: '../../v3/responses/429.yaml'
+    '500':
+      $ref: '../../v3/responses/500.yaml'

static/api-specs/idn/beta/paths/source-usages.yaml

@@ -0,0 +1,50 @@
+get:
+  tags:
+    - Source Usages
+  summary: Returns source usage insights
+  description: >-
+    This API returns summary of source usage insights for past 12 months.
+  operationId: getUsagesBySourceId
+  parameters:
+    - name: sourceId
+      in: path
+      description: ID of IDN source
+      required: true
+      schema:
+        type: string
+      example: '2c9180835d191a86015d28455b4a2329'
+    - $ref: '../../v3/parameters/limit.yaml'
+    - $ref: '../../v3/parameters/offset.yaml'
+    - $ref: '../../v3/parameters/count.yaml'
+    - in: query
+      name: sorters
+      schema:
+        type: string
+        format: comma-separated
+      description: >-
+        Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
+        Sorting is supported for the following fields: **date**
+      example: -date
+  security:
+    - oauth2: [ idn:accounts:read ]
+  responses:
+    '200':
+      description: Summary of source usage insights for past 12 months.
+      content:
+        application/json:
+          schema:
+            type: array
+            items:
+              $ref: '../schemas/SourceUsage.yaml'
+    '400':
+      $ref: '../../v3/responses/400.yaml'
+    '401':
+      $ref: '../../v3/responses/401.yaml'
+    '403':
+      $ref: '../../v3/responses/403.yaml'
+    '429':
+      $ref: '../../v3/responses/429.yaml'
+    '500':
+      $ref: '../../v3/responses/500.yaml'

static/api-specs/idn/beta/schemas/AccountUsage.yaml

@@ -0,0 +1,14 @@
+type: object
+properties:
+  date:
+    type: string
+    format: date
+    description:
+      The first day of the month for which activity is aggregated.
+    example: '2023-04-21'
+  count:
+    type: integer
+    format: int64
+    description: >-
+      The number of days within the month that the account was active in a source.
+    example: 10

static/api-specs/idn/beta/schemas/SourceUsage.yaml

@@ -0,0 +1,14 @@
+type: object
+properties:
+  date:
+    type: string
+    format: date
+    description: >-
+      The first day of the month for which activity is aggregated.
+    example: '2023-04-21'
+  count:
+    type: integer
+    format: int64
+    description: >-
+      The average number of days that accounts were active within this source, for the month.
+    example: 10

static/api-specs/idn/beta/schemas/SourceUsageStatus.yaml

@@ -0,0 +1,14 @@
+type: object
+properties:
+  status:
+    type: string
+    description: >-
+      Source Usage Status. Acceptable values are:
+        - COMPLETE
+            - This status means that an activity data source has been setup and usage insights are available for the source.
+        - INCOMPLETE
+            - This status means that an activity data source has not been setup and usage insights are not available for the source.
+    example: COMPLETE
+    enum:
+      - COMPLETE
+      - INCOMPLETE