LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 20:37:46 +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/V2024OrgConfigApi.md
View File

@@ -1,3 +1,4 @@
---
id: v2024-org-config
title: OrgConfig
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v2024/methods/org-config
tags: ['SDK', 'Software Development Kit', 'OrgConfig', 'V2024OrgConfig']
---
# OrgConfig
Use this API to implement organization configuration functionality.
Administrators can use this functionality to manage organization settings, such as time zones.
@@ -24,9 +24,7 @@ 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
Get the current organization's configuration settings, only external accessible properties.
### Parameters
@@ -35,7 +33,6 @@ Param Type | Name | Data Type | Required | Description
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**OrgConfig**](../models/org-config)
### Responses
@@ -50,14 +47,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 Org Config Settings
try {
Get-V2024OrgConfig-V2024XSailPointExperimental $XSailPointExperimental
@@ -68,11 +66,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-valid-time-zones
List the valid time zones that can be set in organization configurations.
### Parameters
@@ -84,7 +79,6 @@ Param Type | Name | Data Type | Required | Description
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
### Return type
**String[]**
### Responses
@@ -98,7 +92,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
@@ -108,7 +101,9 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
$Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# Get Valid Time Zones
try {
Get-V2024ValidTimeZones-V2024XSailPointExperimental $XSailPointExperimental
@@ -119,11 +114,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-org-config
Patch the current organization's configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization's time zone.
### Parameters
@@ -133,7 +125,6 @@ Param Type | Name | Data Type | Required | Description
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
### Return type
[**OrgConfig**](../models/org-config)
### Responses
@@ -148,21 +139,21 @@ 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
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# JsonPatchOperation[] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
# Patch Org Config
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024OrgConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
@@ -174,7 +165,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)