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

updated docs with tag descreptions

Browse Source
This commit is contained in:
darrell-thobe-sp
2025-01-29 07:04:59 -05:00
parent c69a78b807
commit 2627599191
207 changed files with 3281 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -11,6 +11,14 @@ 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.
An authentication profile represents an identity profile's authentication configuration.
When the identity profile is created, its authentication profile is also created.
An authentication profile includes information like its authentication profile type (`BLOCK`, `MFA`, `NON_PTA`, PTA`) and settings controlling whether or not it blocks access from off network or untrusted geographies.
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
@@ -29,6 +37,7 @@ This API returns auth profile information.
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Path | Id | **String** | True | ID of the Auth Profile to patch.
### Return type
@@ -53,12 +62,13 @@ Code | Description | Data Type
### Example
```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
Get-V2024ProfileConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024Id $Id
# Below is a request that includes all optional parameters
# Get-V2024ProfileConfig -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024ProfileConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProfileConfig"
Write-Host $_.ErrorDetails