mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 20:37:47 +00:00
Update to powershell SDK docs: 13687248839
This commit is contained in:
developer-relations-sp
@@ -43,6 +43,9 @@ Method | HTTP request | Description
|
||||
|
||||
|
||||
## create-search-attribute-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.
|
||||
:::
|
||||
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.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-search-attribute-config)
|
||||
@@ -50,6 +53,7 @@ Create and configure extended search attributes. This API accepts an attribute n
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Body | SearchAttributeConfig | [**SearchAttributeConfig**](../models/search-attribute-config) | True |
|
||||
|
||||
### Return type
|
||||
@@ -72,6 +76,7 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$SearchAttributeConfig = @"{
|
||||
"displayName" : "New Mail Attribute",
|
||||
"name" : "newMailAttribute",
|
||||
@@ -85,10 +90,10 @@ $SearchAttributeConfig = @"{
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig
|
||||
New-V2024SearchAttributeConfig -SearchAttributeConfig $Result
|
||||
New-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -SearchAttributeConfig $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-V2024SearchAttributeConfig -SearchAttributeConfig $Result
|
||||
# New-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -SearchAttributeConfig $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SearchAttributeConfig"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -97,6 +102,9 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-search-attribute-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.
|
||||
:::
|
||||
Delete an extended attribute configuration by name.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-search-attribute-config)
|
||||
@@ -105,6 +113,7 @@ Delete an extended attribute configuration by name.
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Name | **String** | True | Name of the extended search attribute configuration to delete.
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
@@ -113,7 +122,6 @@ Path | Name | **String** | True | Name of the extended search attribute confi
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
204 | No content - indicates the request was successful but there is no content to be returned in the response. |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
|
||||
@@ -127,14 +135,15 @@ Code | Description | Data Type
|
||||
### Example
|
||||
```powershell
|
||||
$Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete.
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# Delete Extended Search Attribute
|
||||
|
||||
try {
|
||||
Remove-V2024SearchAttributeConfig -Name $Name
|
||||
Remove-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Remove-V2024SearchAttributeConfig -Name $Name
|
||||
# Remove-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SearchAttributeConfig"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -143,6 +152,9 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-search-attribute-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 a list of attribute/application associates currently configured in Identity Security Cloud (ISC).
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-search-attribute-config)
|
||||
@@ -150,6 +162,7 @@ Get a list of attribute/application associates currently configured in Identity
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**SearchAttributeConfig[]**](../models/search-attribute-config)
|
||||
@@ -157,8 +170,7 @@ Param Type | Name | Data Type | Required | Description
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | List of attribute configurations in IdentityNow. | SearchAttributeConfig[]
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
|
||||
200 | List of attribute configurations in ISC. | SearchAttributeConfig[]
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
|
||||
@@ -170,14 +182,15 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# List Extended Search Attributes
|
||||
|
||||
try {
|
||||
Get-V2024SearchAttributeConfig
|
||||
Get-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024SearchAttributeConfig
|
||||
# Get-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SearchAttributeConfig"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -186,6 +199,9 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-single-search-attribute-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 an extended attribute configuration by name.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-single-search-attribute-config)
|
||||
@@ -193,7 +209,8 @@ Get an extended attribute configuration by name.
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Name | **String** | True | Name of the extended search attribute configuration to retrieve.
|
||||
Path | Name | **String** | True | Name of the extended search attribute configuration to get.
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**SearchAttributeConfig[]**](../models/search-attribute-config)
|
||||
@@ -201,9 +218,8 @@ Path | Name | **String** | True | Name of the extended search attribute confi
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Specific attribute configuration in ISC. | SearchAttributeConfig[]
|
||||
200 | Specific attribute configuration in IdentityNow. | SearchAttributeConfig[]
|
||||
204 | No content - indicates the request was successful but there is no content to be returned in the response. |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
|
||||
@@ -216,15 +232,16 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$Name = "newMailAttribute" # String | Name of the extended search attribute configuration to retrieve.
|
||||
$Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get.
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# Get Extended Search Attribute
|
||||
|
||||
try {
|
||||
Get-V2024SingleSearchAttributeConfig -Name $Name
|
||||
Get-V2024SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024SingleSearchAttributeConfig -Name $Name
|
||||
# Get-V2024SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SingleSearchAttributeConfig"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -233,6 +250,9 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## patch-search-attribute-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.
|
||||
:::
|
||||
Update an existing search attribute configuration.
|
||||
You can patch these fields:
|
||||
* name * displayName * applicationAttributes
|
||||
@@ -243,6 +263,7 @@ You can patch these fields:
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Name | **String** | True | Name of the search attribute configuration to patch.
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True |
|
||||
|
||||
### Return type
|
||||
@@ -251,7 +272,7 @@ Path | Name | **String** | True | Name of the search attribute configuration
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | The updated search attribute configuration. | SearchAttributeConfig
|
||||
200 | Responds with the search attribute configuration as updated. | SearchAttributeConfig
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
@@ -266,6 +287,7 @@ Code | Description | Data Type
|
||||
### Example
|
||||
```powershell
|
||||
$Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch.
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$JsonPatchOperation = @"{
|
||||
"op" : "replace",
|
||||
"path" : "/description",
|
||||
@@ -277,10 +299,10 @@ $Name = "promotedMailAttribute" # String | Name of the search attribute configur
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
||||
Update-V2024SearchAttributeConfig -Name $Name -JsonPatchOperation $Result
|
||||
Update-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Update-V2024SearchAttributeConfig -Name $Name -JsonPatchOperation $Result
|
||||
# Update-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SearchAttributeConfig"
|
||||
Write-Host $_.ErrorDetails
|
||||
|
||||
Reference in New Issue
Block a user