mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 20:37:47 +00:00
Update to powershell SDK docs: 13122455471
This commit is contained in:
@@ -1,3 +1,4 @@
|
||||
|
||||
---
|
||||
id: v2024-account-usages
|
||||
title: AccountUsages
|
||||
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v2024/methods/account-usages
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountUsages', 'V2024AccountUsages']
|
||||
---
|
||||
|
||||
|
||||
# AccountUsages
|
||||
Use this API to implement account usage insight functionality.
|
||||
With this functionality in place, administrators can gather information and insights about how their tenants' source accounts are being used.
|
||||
@@ -23,9 +23,7 @@ Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**Get-V2024UsagesByAccountId**](#get-usages-by-account-id) | **GET** `/account-usages/{accountId}/summaries` | Returns account usage insights
|
||||
|
||||
|
||||
## get-usages-by-account-id
|
||||
|
||||
This API returns a summary of account usage insights for past 12 months.
|
||||
|
||||
### Parameters
|
||||
@@ -38,7 +36,6 @@ Path | AccountId | **String** | True | ID of IDN account
|
||||
Query | Sorters | **String** | (optional) | 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**
|
||||
|
||||
### Return type
|
||||
|
||||
[**AccountUsage[]**](../models/account-usage)
|
||||
|
||||
### Responses
|
||||
@@ -52,7 +49,6 @@ Code | Description | Data Type
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
@@ -63,7 +59,9 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
|
||||
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
||||
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
||||
$Sorters = "-date" # String | 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** (optional)
|
||||
|
||||
# Returns account usage insights
|
||||
|
||||
try {
|
||||
Get-V2024UsagesByAccountId-V2024AccountId $AccountId
|
||||
|
||||
@@ -74,7 +72,4 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user