mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 12:27:47 +00:00
Update to powershell SDK docs: 13122455471
This commit is contained in:
@@ -1,3 +1,4 @@
|
||||
|
||||
---
|
||||
id: source-usages
|
||||
title: SourceUsages
|
||||
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/source-usages
|
||||
tags: ['SDK', 'Software Development Kit', 'SourceUsages', 'SourceUsages']
|
||||
---
|
||||
|
||||
|
||||
# SourceUsages
|
||||
Use this API to implement source usage insight functionality.
|
||||
With this functionality in place, administrators can gather information and insights about how their tenants' sources are being used.
|
||||
@@ -24,9 +24,7 @@ Method | HTTP request | Description
|
||||
[**Get-StatusBySourceId**](#get-status-by-source-id) | **GET** `/source-usages/{sourceId}/status` | Finds status of source usage
|
||||
[**Get-UsagesBySourceId**](#get-usages-by-source-id) | **GET** `/source-usages/{sourceId}/summaries` | Returns source usage insights
|
||||
|
||||
|
||||
## get-status-by-source-id
|
||||
|
||||
This API returns the status of the source usage insights setup by IDN source ID.
|
||||
|
||||
### Parameters
|
||||
@@ -35,7 +33,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Path | SourceId | **String** | True | ID of IDN source
|
||||
|
||||
### Return type
|
||||
|
||||
[**SourceUsageStatus**](../models/source-usage-status)
|
||||
|
||||
### Responses
|
||||
@@ -49,14 +46,15 @@ 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
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source
|
||||
|
||||
# Finds status of source usage
|
||||
|
||||
try {
|
||||
Get-StatusBySourceId-SourceId $SourceId
|
||||
|
||||
@@ -67,11 +65,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-usages-by-source-id
|
||||
|
||||
This API returns a summary of source usage insights for past 12 months.
|
||||
|
||||
### Parameters
|
||||
@@ -84,7 +79,6 @@ Path | SourceId | **String** | True | ID of IDN source
|
||||
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
|
||||
|
||||
[**SourceUsage[]**](../models/source-usage)
|
||||
|
||||
### Responses
|
||||
@@ -98,7 +92,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
|
||||
|
||||
@@ -109,7 +102,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 source usage insights
|
||||
|
||||
try {
|
||||
Get-UsagesBySourceId-SourceId $SourceId
|
||||
|
||||
@@ -120,7 +115,4 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user