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: 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

33
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSearchAttributeConfigurationApi.md
View File

@@ -41,10 +41,13 @@ Method | HTTP request | Description
[**Get-BetaSingleSearchAttributeConfig**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute
[**Update-BetaSearchAttributeConfig**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute
## create-search-attribute-config
Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create and attribute promotion configuration in the Link ObjectConfig.
A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-search-attribute-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -83,19 +86,22 @@ $SearchAttributeConfig = @"{
try {
$Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig
New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $Result
New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $Result
# Below is a request that includes all optional parameters
# New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $SearchAttributeConfig
# New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-search-attribute-config
Delete an extended attribute configuration by name.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-search-attribute-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -125,20 +131,23 @@ $Name = "newMailAttribute" # String | Name of the extended search attribute conf
# Delete Extended Search Attribute
try {
Remove-BetaSearchAttributeConfig -BetaName $Name
Remove-BetaSearchAttributeConfig -Name $Name
# Below is a request that includes all optional parameters
# Remove-BetaSearchAttributeConfig -BetaName $Name
# Remove-BetaSearchAttributeConfig -Name $Name
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-search-attribute-config
Get a list of attribute/application associates currently configured in Identity Security Cloud (ISC).
A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-search-attribute-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -165,7 +174,7 @@ Code | Description | Data Type
# List Extended Search Attributes
try {
Get-BetaSearchAttributeConfig
Get-BetaSearchAttributeConfig
# Below is a request that includes all optional parameters
# Get-BetaSearchAttributeConfig
@@ -175,9 +184,12 @@ try {
}
```
[[Back to top]](#)
## get-single-search-attribute-config
Get an extended attribute configuration by name.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-single-search-attribute-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -208,21 +220,24 @@ $Name = "newMailAttribute" # String | Name of the extended search attribute conf
# Get Extended Search Attribute
try {
Get-BetaSingleSearchAttributeConfig -BetaName $Name
Get-BetaSingleSearchAttributeConfig -Name $Name
# Below is a request that includes all optional parameters
# Get-BetaSingleSearchAttributeConfig -BetaName $Name
# Get-BetaSingleSearchAttributeConfig -Name $Name
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-search-attribute-config
Update an existing search attribute configuration.
You can patch these fields:
* name * displayName * applicationAttributes
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-search-attribute-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -261,10 +276,10 @@ $Name = "promotedMailAttribute" # String | Name of the extended search attribute
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-BetaSearchAttributeConfig -BetaName $Name -BetaJsonPatchOperation $Result
Update-BetaSearchAttributeConfig -Name $Name -BetaJsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-BetaSearchAttributeConfig -BetaName $Name -BetaJsonPatchOperation $JsonPatchOperation
# Update-BetaSearchAttributeConfig -Name $Name -BetaJsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig"
Write-Host $_.ErrorDetails