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

Update to powershell SDK docs: 13122455471

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-03 20:42:04 +00:00
parent aeda961e54
commit bdb088c15d
207 changed files with 3520 additions and 8694 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,3 +1,4 @@
---
id: v2024-auth-profile
title: AuthProfile
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v2024/methods/auth-profile
tags: ['SDK', 'Software Development Kit', 'AuthProfile', 'V2024AuthProfile']
---
# AuthProfile
Use this API to implement Auth Profile functionality.
With this functionality in place, users can read authentication profiles and make changes to them.
@@ -28,9 +28,7 @@ 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
This API returns auth profile information.
### Parameters
@@ -40,7 +38,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the Auth Profile to patch.
### Return type
[**AuthProfile**](../models/auth-profile)
### Responses
@@ -55,7 +52,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 @@ Code | Description | Data Type
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch.
# Get Auth Profile.
try {
Get-V2024ProfileConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024Id $Id
@@ -74,11 +72,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-profile-config-list
This API returns a list of auth profiles.
### Parameters
@@ -87,7 +82,6 @@ Param Type | Name | Data Type | Required | Description
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**AuthProfileSummary**](../models/auth-profile-summary)
### Responses
@@ -101,14 +95,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
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get list of Auth Profiles.
try {
Get-V2024ProfileConfigList-V2024XSailPointExperimental $XSailPointExperimental
@@ -119,11 +114,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-profile-config
This API updates an existing Auth Profile. The following fields are patchable:
**offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type**
@@ -135,7 +127,6 @@ Path | Id | **String** | True | ID of the Auth Profile to patch.
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True |
### Return type
[**AuthProfile**](../models/auth-profile)
### Responses
@@ -149,7 +140,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
@@ -157,14 +147,15 @@ Code | Description | Data Type
```powershell
$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# JsonPatchOperation[] |
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] |
# Patch a specified Auth Profile
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024ProfileConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
@@ -176,7 +167,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)