LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to powershell SDK docs: 13207859154

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-07 20:53:08 +00:00
parent fea17715f4
commit 09ed592191
244 changed files with 12907 additions and 6931 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024OAuthClientsApi.md
View File

@@ -26,9 +26,12 @@ Method | HTTP request | Description
[**Get-V2024OauthClients**](#list-oauth-clients) | **GET** `/oauth-clients` | List OAuth Clients
[**Update-V2024OauthClient**](#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch OAuth Client
## create-oauth-client
This creates an OAuth client.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-oauth-client)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -75,19 +78,22 @@ $CreateOAuthClientRequest = @"{
try {
$Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest
New-V2024OauthClient -V2024CreateOAuthClientRequest $Result
New-V2024OauthClient -V2024CreateOAuthClientRequest $Result
# Below is a request that includes all optional parameters
# New-V2024OauthClient -V2024CreateOAuthClientRequest $CreateOAuthClientRequest
# New-V2024OauthClient -V2024CreateOAuthClientRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024OauthClient"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-oauth-client
This deletes an OAuth client.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-oauth-client)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -118,19 +124,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id
# Delete OAuth Client
try {
Remove-V2024OauthClient -V2024Id $Id
Remove-V2024OauthClient -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024OauthClient -V2024Id $Id
# Remove-V2024OauthClient -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024OauthClient"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-oauth-client
This gets details of an OAuth client.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-oauth-client)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -161,19 +170,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id
# Get OAuth Client
try {
Get-V2024OauthClient -V2024Id $Id
Get-V2024OauthClient -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024OauthClient -V2024Id $Id
# Get-V2024OauthClient -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OauthClient"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-oauth-clients
This gets a list of OAuth clients.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-oauth-clients)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -203,19 +215,22 @@ $Filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # String | Filter results usin
# List OAuth Clients
try {
Get-V2024OauthClients
Get-V2024OauthClients
# Below is a request that includes all optional parameters
# Get-V2024OauthClients -V2024Filters $Filters
# Get-V2024OauthClients -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OauthClients"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-oauth-client
This performs a targeted update to the field(s) of an OAuth client.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-oauth-client)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -254,10 +269,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024OauthClient -V2024Id $Id -V2024JsonPatchOperation $Result
Update-V2024OauthClient -Id $Id -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024OauthClient -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024OauthClient -Id $Id -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024OauthClient"
Write-Host $_.ErrorDetails