mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-10 04:19:19 +00:00
78e5982ae6
* ADI-706 add specs to public beta and v3 * ADI-706 updated descriptions' by github action: 6249488971
50 lines
1.5 KiB
YAML
50 lines
1.5 KiB
YAML
get:
|
|
tags:
|
|
- Account Usages
|
|
summary: Returns account usage insights
|
|
description: >-
|
|
This API returns a 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:
|
|
- UserContextAuth: [ 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' |