Use this API to implement search attribute configuration functionality, along with Search.
With this functionality in place, administrators can create custom search attributes that and run extended searches based on those attributes to further narrow down their searches and get the information and insights they want.
Identity Security Cloud (ISC) enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential.
Its search goes through all those sources and finds the results quickly and specifically.
The search query is flexible - it can be very broad or very narrow.
The search only returns results for searchable objects it is filtering for.
The following objects are searchable: identities, roles, access profiles, entitlements, events, and account activities.
By default, no filter is applied, so a search for "Ad" returns both the identity "Adam.Archer" as well as the role "Administrator."
Users can further narrow their results by using ISC's specific syntax and punctuation to structure their queries.
For example, the query "attributes.location:austin AND NOT manager.name:amanda.ross" returns all results associated with the Austin location, but it excludes those associated with the manager Amanda Ross.
Refer to Building a Search Query for more information about how to construct specific search queries.
Refer to Using Search for more information about ISC's search and its different possibilities.
With Search Attribute Configuration, administrators can create, manage, and run searches based on the attributes they want to search.
:::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.
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
$XSailPointExperimental="true"# String | Use this header to enable this experimental API. (default to "true")$SearchAttributeConfig=@"{
"displayName" : "NewMailAttribute",
"name" : "newMailAttribute",
"applicationAttributes" : {
"2c91808b79fd2422017a0b35d30f3968" : "employeeNumber",
"2c91808b79fd2422017a0b36008f396b" : "employeeNumber"
}
}"@# Create Extended Search Attributestry{$Result=ConvertFrom-JsonToSearchAttributeConfig-Json$SearchAttributeConfigNew-V2024SearchAttributeConfig-XSailPointExperimental$XSailPointExperimental-SearchAttributeConfig$Result# Below is a request that includes all optional parameters# New-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -SearchAttributeConfig $Result }catch{Write-Host$_.Exception.Response.StatusCode.value__"Exception occurred when calling New-V2024SearchAttributeConfig"Write-Host$_.ErrorDetails}
:::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.
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)
Responses
Code
Description
Data Type
204
No content - indicates the request was successful but there is no content to be returned in the response.
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.$XSailPointExperimental="true"# String | Use this header to enable this experimental API. (default to "true")# Delete Extended Search Attributetry{Remove-V2024SearchAttributeConfig-Name$Name-XSailPointExperimental$XSailPointExperimental# Below is a request that includes all optional parameters# Remove-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental }catch{Write-Host$_.Exception.Response.StatusCode.value__"Exception occurred when calling Remove-V2024SearchAttributeConfig"Write-Host$_.ErrorDetails}
:::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).
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
$XSailPointExperimental="true"# String | Use this header to enable this experimental API. (default to "true")# List Extended Search Attributestry{Get-V2024SearchAttributeConfig-XSailPointExperimental$XSailPointExperimental# Below is a request that includes all optional parameters# Get-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental }catch{Write-Host$_.Exception.Response.StatusCode.value__"Exception occurred when calling Get-V2024SearchAttributeConfig"Write-Host$_.ErrorDetails}
:::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.
No content - indicates the request was successful but there is no content to be returned in the response.
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 get.$XSailPointExperimental="true"# String | Use this header to enable this experimental API. (default to "true")# Get Extended Search Attributetry{Get-V2024SingleSearchAttributeConfig-Name$Name-XSailPointExperimental$XSailPointExperimental# Below is a request that includes all optional parameters# Get-V2024SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental }catch{Write-Host$_.Exception.Response.StatusCode.value__"Exception occurred when calling Get-V2024SingleSearchAttributeConfig"Write-Host$_.ErrorDetails}
:::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:
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
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.$XSailPointExperimental="true"# String | Use this header to enable this experimental API. (default to "true")$JsonPatchOperation=@"{
"op" : "replace",
"path" : "/description",
"value" : "Newdescription"
}"@# JsonPatchOperation[] | # Update Extended Search Attributetry{$Result=ConvertFrom-JsonToJsonPatchOperation-Json$JsonPatchOperationUpdate-V2024SearchAttributeConfig-Name$Name-XSailPointExperimental$XSailPointExperimental-JsonPatchOperation$Result# Below is a request that includes all optional parameters# Update-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result }catch{Write-Host$_.Exception.Response.StatusCode.value__"Exception occurred when calling Update-V2024SearchAttributeConfig"Write-Host$_.ErrorDetails}
