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

30
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AuthProfileApi.md
View File

@@ -27,9 +27,15 @@ Method | HTTP request | Description
[**Get-V2024ProfileConfigList**](#get-profile-config-list) | **GET** `/auth-profiles` | Get list of Auth Profiles.
[**Update-V2024ProfileConfig**](#patch-profile-config) | **PATCH** `/auth-profiles/{id}` | Patch a specified Auth Profile
## get-profile-config
:::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.
:::
This API returns auth profile information.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-profile-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -62,19 +68,25 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to pa
# Get Auth Profile.
try {
Get-V2024ProfileConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024Id $Id
Get-V2024ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024ProfileConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024Id $Id
# Get-V2024ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProfileConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-profile-config-list
:::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.
:::
This API returns a list of auth profiles.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-profile-config-list)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -104,20 +116,26 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get list of Auth Profiles.
try {
Get-V2024ProfileConfigList -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024ProfileConfigList -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024ProfileConfigList -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024ProfileConfigList -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProfileConfigList"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-profile-config
:::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.
:::
This API updates an existing Auth Profile. The following fields are patchable:
**offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type**
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-profile-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -157,10 +175,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024ProfileConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
Update-V2024ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024ProfileConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProfileConfig"
Write-Host $_.ErrorDetails