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/V2024OrgConfigApi.md
View File

@@ -23,9 +23,15 @@ Method | HTTP request | Description
[**Get-V2024ValidTimeZones**](#get-valid-time-zones) | **GET** `/org-config/valid-time-zones` | Get Valid Time Zones
[**Update-V2024OrgConfig**](#patch-org-config) | **PATCH** `/org-config` | Patch Org Config
## get-org-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.
:::
Get the current organization's configuration settings, only external accessible properties.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-org-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -56,19 +62,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get Org Config Settings
try {
Get-V2024OrgConfig -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024OrgConfig -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OrgConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-valid-time-zones
:::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.
:::
List the valid time zones that can be set in organization configurations.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-valid-time-zones)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -104,19 +116,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Get Valid Time Zones
try {
Get-V2024ValidTimeZones -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024ValidTimeZones -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024ValidTimeZones -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count
# Get-V2024ValidTimeZones -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ValidTimeZones"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-org-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.
:::
Patch the current organization's configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization's time zone.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-org-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -155,10 +173,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024OrgConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
Update-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024OrgConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024OrgConfig"
Write-Host $_.ErrorDetails