Update to powershell SDK docs: 13207859154

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

View File

@@ -30,9 +30,12 @@ Method | HTTP request | Description
[**Update-AuthOrgServiceProviderConfig**](#patch-auth-org-service-provider-config) | **PATCH** `/auth-org/service-provider-config` | Update Service Provider Configuration
[**Update-AuthOrgSessionConfig**](#patch-auth-org-session-config) | **PATCH** `/auth-org/session-config` | Update Auth Org Session Configuration
## create-auth-org-network-config
This API returns the details of an org's network auth configuration. Requires security scope of: 'sp:auth-org:manage'
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-auth-org-network-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -68,19 +71,22 @@ $NetworkConfiguration = @"{
try {
$Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration
New-AuthOrgNetworkConfig -NetworkConfiguration $Result
New-AuthOrgNetworkConfig -NetworkConfiguration $Result
# Below is a request that includes all optional parameters
# New-AuthOrgNetworkConfig -NetworkConfiguration $NetworkConfiguration
# New-AuthOrgNetworkConfig -NetworkConfiguration $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AuthOrgNetworkConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-auth-org-lockout-config
This API returns the details of an org's lockout auth configuration.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-org-lockout-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -109,7 +115,7 @@ Code | Description | Data Type
# Get Auth Org Lockout Configuration.
try {
Get-AuthOrgLockoutConfig
Get-AuthOrgLockoutConfig
# Below is a request that includes all optional parameters
# Get-AuthOrgLockoutConfig
@@ -119,9 +125,12 @@ try {
}
```
[[Back to top]](#)
## get-auth-org-network-config
This API returns the details of an org's network auth configuration.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-org-network-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -150,7 +159,7 @@ Code | Description | Data Type
# Get security network configuration.
try {
Get-AuthOrgNetworkConfig
Get-AuthOrgNetworkConfig
# Below is a request that includes all optional parameters
# Get-AuthOrgNetworkConfig
@@ -160,9 +169,12 @@ try {
}
```
[[Back to top]](#)
## get-auth-org-service-provider-config
This API returns the details of an org's service provider auth configuration.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-org-service-provider-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -191,7 +203,7 @@ Code | Description | Data Type
# Get Service Provider Configuration.
try {
Get-AuthOrgServiceProviderConfig
Get-AuthOrgServiceProviderConfig
# Below is a request that includes all optional parameters
# Get-AuthOrgServiceProviderConfig
@@ -201,9 +213,12 @@ try {
}
```
[[Back to top]](#)
## get-auth-org-session-config
This API returns the details of an org's session auth configuration.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-org-session-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -232,7 +247,7 @@ Code | Description | Data Type
# Get Auth Org Session Configuration.
try {
Get-AuthOrgSessionConfig
Get-AuthOrgSessionConfig
# Below is a request that includes all optional parameters
# Get-AuthOrgSessionConfig
@@ -242,10 +257,13 @@ try {
}
```
[[Back to top]](#)
## patch-auth-org-lockout-config
This API updates an existing lockout configuration for an org using PATCH
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-org-lockout-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -282,20 +300,23 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-AuthOrgLockoutConfig -JsonPatchOperation $Result
Update-AuthOrgLockoutConfig -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-AuthOrgLockoutConfig -JsonPatchOperation $JsonPatchOperation
# Update-AuthOrgLockoutConfig -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgLockoutConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-auth-org-network-config
This API updates an existing network configuration for an org using PATCH
Requires security scope of: 'sp:auth-org:manage'
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-org-network-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -332,19 +353,22 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-AuthOrgNetworkConfig -JsonPatchOperation $Result
Update-AuthOrgNetworkConfig -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-AuthOrgNetworkConfig -JsonPatchOperation $JsonPatchOperation
# Update-AuthOrgNetworkConfig -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgNetworkConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-auth-org-service-provider-config
This API updates an existing service provider configuration for an org using PATCH.
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-org-service-provider-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -381,19 +405,22 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-AuthOrgServiceProviderConfig -JsonPatchOperation $Result
Update-AuthOrgServiceProviderConfig -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-AuthOrgServiceProviderConfig -JsonPatchOperation $JsonPatchOperation
# Update-AuthOrgServiceProviderConfig -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgServiceProviderConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-auth-org-session-config
This API updates an existing session configuration for an org using PATCH.
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-org-session-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -430,10 +457,10 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-AuthOrgSessionConfig -JsonPatchOperation $Result
Update-AuthOrgSessionConfig -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-AuthOrgSessionConfig -JsonPatchOperation $JsonPatchOperation
# Update-AuthOrgSessionConfig -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgSessionConfig"
Write-Host $_.ErrorDetails