Update PowerShell SDK docs: 16836059621

This commit is contained in:
developer-relations-sp
2025-08-08 17:01:26 +00:00
parent aff8bdf249
commit 79b99e77cd
16 changed files with 36 additions and 24 deletions

View File

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
- Prepare the resource - Prepare the resource
```powershell ```powershell
$AccountUsage = Initialize-BetaAccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` $AccountUsage = Initialize-BetaAccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
-Count 10 -Count 10
``` ```

View File

@@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-BetaNonEmployeeRequestWithou
-ApprovalStatus null ` -ApprovalStatus null `
-Comment approved ` -Comment approved `
-CompletionDate 2020-03-24T11:11:41.139-05:00 ` -CompletionDate 2020-03-24T11:11:41.139-05:00 `
-StartDate Mon Mar 23 20:00:00 EDT 2020 ` -StartDate Tue Mar 24 00:00:00 UTC 2020 `
-EndDate Wed Mar 24 20:00:00 EDT 2021 ` -EndDate Thu Mar 25 00:00:00 UTC 2021 `
-Modified 2020-03-24T11:11:41.139-05:00 ` -Modified 2020-03-24T11:11:41.139-05:00 `
-Created 2020-03-24T11:11:41.139-05:00 -Created 2020-03-24T11:11:41.139-05:00
``` ```

View File

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
- Prepare the resource - Prepare the resource
```powershell ```powershell
$SourceUsage = Initialize-BetaSourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` $SourceUsage = Initialize-BetaSourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
-Count 10.45 -Count 10.45
``` ```

View File

@@ -607,6 +607,9 @@ try {
[[Back to top]](#) [[Back to top]](#)
## list-administrators-access-request-status ## list-administrators-access-request-status
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. Use this API to get access request statuses of all the access requests in the org based on the specified query parameters.
Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses
@@ -615,6 +618,7 @@ Any user with user level ORG_ADMIN or scope idn:access-request-administration:re
### Parameters ### Parameters
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Query | RequestedFor | **String** | (optional) | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. Query | RequestedFor | **String** | (optional) | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*.
Query | RequestedBy | **String** | (optional) | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. Query | RequestedBy | **String** | (optional) | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.
Query | RegardingIdentity | **String** | (optional) | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. Query | RegardingIdentity | **String** | (optional) | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*.
@@ -645,6 +649,7 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
$RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
$RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional)
@@ -659,10 +664,10 @@ $RequestState = "request-state=EXECUTING" # String | Filter the results by the s
# Access request status for administrators # Access request status for administrators
try { try {
Get-V2024AdministratorsAccessRequestStatus Get-V2024AdministratorsAccessRequestStatus -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024AdministratorsAccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState # Get-V2024AdministratorsAccessRequestStatus -XSailPointExperimental $XSailPointExperimental -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AdministratorsAccessRequestStatus" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AdministratorsAccessRequestStatus"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails

View File

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
- Prepare the resource - Prepare the resource
```powershell ```powershell
$AccountUsage = Initialize-V2024AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` $AccountUsage = Initialize-V2024AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
-Count 10 -Count 10
``` ```

View File

@@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-V2024NonEmployeeRequestWitho
-ApprovalStatus null ` -ApprovalStatus null `
-Comment approved ` -Comment approved `
-CompletionDate 2020-03-24T11:11:41.139-05:00 ` -CompletionDate 2020-03-24T11:11:41.139-05:00 `
-StartDate Mon Mar 23 20:00:00 EDT 2020 ` -StartDate Tue Mar 24 00:00:00 UTC 2020 `
-EndDate Wed Mar 24 20:00:00 EDT 2021 ` -EndDate Thu Mar 25 00:00:00 UTC 2021 `
-Modified 2020-03-24T11:11:41.139-05:00 ` -Modified 2020-03-24T11:11:41.139-05:00 `
-Created 2020-03-24T11:11:41.139-05:00 -Created 2020-03-24T11:11:41.139-05:00
``` ```

View File

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
- Prepare the resource - Prepare the resource
```powershell ```powershell
$SourceUsage = Initialize-V2024SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` $SourceUsage = Initialize-V2024SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
-Count 10.45 -Count 10.45
``` ```

View File

@@ -661,6 +661,9 @@ try {
[[Back to top]](#) [[Back to top]](#)
## list-administrators-access-request-status ## list-administrators-access-request-status
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. Use this API to get access request statuses of all the access requests in the org based on the specified query parameters.
Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses
@@ -669,6 +672,7 @@ Any user with user level ORG_ADMIN or scope idn:access-request-administration:re
### Parameters ### Parameters
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Query | RequestedFor | **String** | (optional) | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. Query | RequestedFor | **String** | (optional) | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*.
Query | RequestedBy | **String** | (optional) | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. Query | RequestedBy | **String** | (optional) | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.
Query | RegardingIdentity | **String** | (optional) | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. Query | RegardingIdentity | **String** | (optional) | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*.
@@ -699,6 +703,7 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
$RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
$RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional)
@@ -713,10 +718,10 @@ $RequestState = "request-state=EXECUTING" # String | Filter the results by the s
# Access request status for administrators # Access request status for administrators
try { try {
Get-V2025AdministratorsAccessRequestStatus Get-V2025AdministratorsAccessRequestStatus -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2025AdministratorsAccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState # Get-V2025AdministratorsAccessRequestStatus -XSailPointExperimental $XSailPointExperimental -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AdministratorsAccessRequestStatus" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AdministratorsAccessRequestStatus"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails

View File

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
- Prepare the resource - Prepare the resource
```powershell ```powershell
$AccountUsage = Initialize-V2025AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` $AccountUsage = Initialize-V2025AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
-Count 10 -Count 10
``` ```

View File

@@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-V2025NonEmployeeRequestWitho
-ApprovalStatus null ` -ApprovalStatus null `
-Comment approved ` -Comment approved `
-CompletionDate 2020-03-24T11:11:41.139-05:00 ` -CompletionDate 2020-03-24T11:11:41.139-05:00 `
-StartDate Mon Mar 23 20:00:00 EDT 2020 ` -StartDate Tue Mar 24 00:00:00 UTC 2020 `
-EndDate Wed Mar 24 20:00:00 EDT 2021 ` -EndDate Thu Mar 25 00:00:00 UTC 2021 `
-Modified 2020-03-24T11:11:41.139-05:00 ` -Modified 2020-03-24T11:11:41.139-05:00 `
-Created 2020-03-24T11:11:41.139-05:00 -Created 2020-03-24T11:11:41.139-05:00
``` ```

View File

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
- Prepare the resource - Prepare the resource
```powershell ```powershell
$SourceUsage = Initialize-V2025SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` $SourceUsage = Initialize-V2025SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
-Count 10.45 -Count 10.45
``` ```

View File

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
- Prepare the resource - Prepare the resource
```powershell ```powershell
$AccountUsage = Initialize-AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` $AccountUsage = Initialize-AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
-Count 10 -Count 10
``` ```

View File

@@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-NonEmployeeRequestWithoutApp
-ApprovalStatus null ` -ApprovalStatus null `
-Comment approved ` -Comment approved `
-CompletionDate 2020-03-24T11:11:41.139-05:00 ` -CompletionDate 2020-03-24T11:11:41.139-05:00 `
-StartDate Mon Mar 23 20:00:00 EDT 2020 ` -StartDate Tue Mar 24 00:00:00 UTC 2020 `
-EndDate Wed Mar 24 20:00:00 EDT 2021 ` -EndDate Thu Mar 25 00:00:00 UTC 2021 `
-Modified 2020-03-24T11:11:41.139-05:00 ` -Modified 2020-03-24T11:11:41.139-05:00 `
-Created 2020-03-24T11:11:41.139-05:00 -Created 2020-03-24T11:11:41.139-05:00
``` ```

View File

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
- Prepare the resource - Prepare the resource
```powershell ```powershell
$SourceUsage = Initialize-SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` $SourceUsage = Initialize-SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
-Count 10.45 -Count 10.45
``` ```

View File

@@ -873,6 +873,7 @@
- lang: PowerShell - lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/access-requests#list-administrators-access-request-status label: SDK_tools/sdk/powershell/v2024/methods/access-requests#list-administrators-access-request-status
source: | source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
$RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
$RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional)
@@ -887,10 +888,10 @@
# Access request status for administrators # Access request status for administrators
try { try {
Get-V2024AdministratorsAccessRequestStatus Get-V2024AdministratorsAccessRequestStatus -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024AdministratorsAccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState # Get-V2024AdministratorsAccessRequestStatus -XSailPointExperimental $XSailPointExperimental -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AdministratorsAccessRequestStatus" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AdministratorsAccessRequestStatus"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails

View File

@@ -1100,6 +1100,7 @@
- lang: PowerShell - lang: PowerShell
label: SDK_tools/sdk/powershell/v2025/methods/access-requests#list-administrators-access-request-status label: SDK_tools/sdk/powershell/v2025/methods/access-requests#list-administrators-access-request-status
source: | source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
$RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
$RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional)
@@ -1114,10 +1115,10 @@
# Access request status for administrators # Access request status for administrators
try { try {
Get-V2025AdministratorsAccessRequestStatus Get-V2025AdministratorsAccessRequestStatus -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2025AdministratorsAccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState # Get-V2025AdministratorsAccessRequestStatus -XSailPointExperimental $XSailPointExperimental -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AdministratorsAccessRequestStatus" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AdministratorsAccessRequestStatus"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails