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
Files
42436403b2fea47293014cd61781d35eab998be1
developer.sailpoint.com/docs/tools/sdk/powershell/refrence/v2024/Methods/V2024SearchAttributeConfigurationApi.md
darrell-thobe-sp bddfeda20e adding method and model docs
2025-01-23 10:09:40 -05:00

12 KiB
Raw Blame History

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags
id title pagination_label sidebar_label sidebar_class_name keywords slug tags
search-attribute-configuration SearchAttributeConfiguration SearchAttributeConfiguration SearchAttributeConfiguration powershellsdk
powershell
PowerShell
sdk
SearchAttributeConfiguration
/tools/sdk/powershell/v2024/methods/search-attribute-configuration
SDK
Software Development Kit
SearchAttributeConfiguration

SearchAttributeConfiguration

All URIs are relative to https://sailpoint.api.identitynow.com/v2024

Method HTTP request Description
New-V2024SearchAttributeConfig POST /accounts/search-attribute-config Create Extended Search Attributes
Remove-V2024SearchAttributeConfig DELETE /accounts/search-attribute-config/{name} Delete Extended Search Attribute
Get-V2024SearchAttributeConfig GET /accounts/search-attribute-config List Extended Search Attributes
Get-V2024SingleSearchAttributeConfig GET /accounts/search-attribute-config/{name} Get Extended Search Attribute
Update-V2024SearchAttributeConfig 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.

Parameters

Param Type Name Data Type Required Description
Body SearchAttributeConfig SearchAttributeConfig True

Return type

SystemCollectionsHashtable

Responses

Code Description Data Type
202 Accepted - Returned if the request was successfully accepted into the system. SystemCollectionsHashtable
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
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
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

$SearchAttributeConfig = @"{
  "displayName" : "New Mail Attribute",
  "name" : "newMailAttribute",
  "applicationAttributes" : {
    "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber",
    "2c91808b79fd2422017a0b36008f396b" : "employeeNumber"
  }
}"@
# Create Extended Search Attributes
try {
    $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig
    New-V2024SearchAttributeConfig-V2024SearchAttributeConfig $Result
    
    # Below is a request that includes all optional parameters
    # New-V2024SearchAttributeConfig -V2024SearchAttributeConfig $SearchAttributeConfig  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SearchAttributeConfig"
    Write-Host $_.ErrorDetails
}

[Back to top]

delete-search-attribute-config

Delete 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 delete.

Return type

(empty response body)

Responses

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
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
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete.
# Delete Extended Search Attribute
try {
    Remove-V2024SearchAttributeConfig-V2024Name $Name 
    
    # Below is a request that includes all optional parameters
    # Remove-V2024SearchAttributeConfig -V2024Name $Name  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SearchAttributeConfig"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-search-attribute-config

Get a list of attribute/application associates currently configured in Identity Security Cloud (ISC).

Parameters

Param Type Name Data Type Required Description

Return type

SearchAttributeConfig[]

Responses

Code Description Data Type
200 List of attribute configurations in IdentityNow. 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
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
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

# List Extended Search Attributes
try {
    Get-V2024SearchAttributeConfig
    
    # Below is a request that includes all optional parameters
    # Get-V2024SearchAttributeConfig  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SearchAttributeConfig"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-single-search-attribute-config

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.

Return type

SearchAttributeConfig[]

Responses

Code Description Data Type
200 Specific attribute configuration in ISC. 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
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
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$Name = "newMailAttribute" # String | Name of the extended search attribute configuration to retrieve.
# Get Extended Search Attribute
try {
    Get-V2024SingleSearchAttributeConfig-V2024Name $Name 
    
    # Below is a request that includes all optional parameters
    # Get-V2024SingleSearchAttributeConfig -V2024Name $Name  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SingleSearchAttributeConfig"
    Write-Host $_.ErrorDetails
}

[Back to top]

patch-search-attribute-config

Update an existing search attribute configuration. You can patch these fields:

  • name * displayName * applicationAttributes

Parameters

Param Type Name Data Type Required Description
Path Name String True Name of the search attribute configuration to patch.
Body JsonPatchOperation []JsonPatchOperation True

Return type

SearchAttributeConfig

Responses

Code Description Data Type
200 The updated search attribute configuration. 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
404 Not Found - returned if the request URL refers to a resource or object that does not exist 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
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

$Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch.
 # JsonPatchOperation[] | 
 $JsonPatchOperation = @"{
  "op" : "replace",
  "path" : "/description",
  "value" : "New description"
}"@ 

# Update Extended Search Attribute
try {
    $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
    Update-V2024SearchAttributeConfig-V2024Name $Name -V2024JsonPatchOperation $Result
    
    # Below is a request that includes all optional parameters
    # Update-V2024SearchAttributeConfig -V2024Name $Name -V2024JsonPatchOperation $JsonPatchOperation  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SearchAttributeConfig"
    Write-Host $_.ErrorDetails
}

[Back to top]