mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 12:27:47 +00:00
starting point for adding python sdk docs
This commit is contained in:
darrell-thobe-sp
@@ -0,0 +1,340 @@
|
||||
---
|
||||
id: v2024-search-attribute-configuration
|
||||
title: Search_Attribute_Configuration
|
||||
pagination_label: Search_Attribute_Configuration
|
||||
sidebar_label: Search_Attribute_Configuration
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'Search_Attribute_Configuration', 'V2024Search_Attribute_Configuration']
|
||||
slug: /tools/sdk/python/v2024/methods/search-attribute-configuration
|
||||
tags: ['SDK', 'Software Development Kit', 'Search_Attribute_Configuration', 'V2024Search_Attribute_Configuration']
|
||||
---
|
||||
|
||||
# sailpoint.v2024.SearchAttributeConfigurationApi
|
||||
Use this API to implement search attribute configuration functionality, along with [Search](https://developer.sailpoint.com/docs/api/v3/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](https://documentation.sailpoint.com/saas/help/search/building-query.html) for more information about how to construct specific search queries.
|
||||
|
||||
Refer to [Using Search](https://documentation.sailpoint.com/saas/help/search/index.html) 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.
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_search_attribute_config**](SearchAttributeConfigurationApi#create-search-attribute-config) | **POST** `/accounts/search-attribute-config` | Create Extended Search Attributes
|
||||
[**delete_search_attribute_config**](SearchAttributeConfigurationApi#delete-search-attribute-config) | **DELETE** `/accounts/search-attribute-config/{name}` | Delete Extended Search Attribute
|
||||
[**get_search_attribute_config**](SearchAttributeConfigurationApi#get-search-attribute-config) | **GET** `/accounts/search-attribute-config` | List Extended Search Attributes
|
||||
[**get_single_search_attribute_config**](SearchAttributeConfigurationApi#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute
|
||||
[**patch_search_attribute_config**](SearchAttributeConfigurationApi#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute
|
||||
|
||||
|
||||
## create-search-attribute-config
|
||||
Create Extended Search Attributes
|
||||
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)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Body | search_attribute_config | [**SearchAttributeConfig**](../models/search-attribute-config) | True |
|
||||
|
||||
### Return type
|
||||
**object**
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
202 | Accepted - Returned if the request was successfully accepted into the system. | object | - |
|
||||
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
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.models.search_attribute_config import SearchAttributeConfig
|
||||
from sailpoint.v2024.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
search_attribute_config = {
|
||||
"displayName" : "New Mail Attribute",
|
||||
"name" : "newMailAttribute",
|
||||
"applicationAttributes" : {
|
||||
"2c91808b79fd2422017a0b35d30f3968" : "employeeNumber",
|
||||
"2c91808b79fd2422017a0b36008f396b" : "employeeNumber"
|
||||
}
|
||||
} # SearchAttributeConfig |
|
||||
|
||||
try:
|
||||
# Create Extended Search Attributes
|
||||
Result = search_attribute_config.from_json(search_attribute_config)
|
||||
api_response = api_instance.create_search_attribute_config(Result)
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.create_search_attribute_config(Result)
|
||||
print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-search-attribute-config
|
||||
Delete Extended Search Attribute
|
||||
Delete an extended attribute configuration by name.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-search-attribute-config)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | name | **str** | True | Name of the extended search attribute configuration to delete.
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
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
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete.
|
||||
|
||||
try:
|
||||
# Delete Extended Search Attribute
|
||||
|
||||
api_instance.delete_search_attribute_config(name)
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_instance.delete_search_attribute_config(name)
|
||||
except Exception as e:
|
||||
print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-search-attribute-config
|
||||
List Extended Search Attributes
|
||||
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)
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
[**List[SearchAttributeConfig]**](../models/search-attribute-config)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | List of attribute configurations in IdentityNow. | List[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
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.models.search_attribute_config import SearchAttributeConfig
|
||||
from sailpoint.v2024.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
|
||||
try:
|
||||
# List Extended Search Attributes
|
||||
|
||||
api_response = api_instance.get_search_attribute_config()
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.get_search_attribute_config()
|
||||
print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-single-search-attribute-config
|
||||
Get Extended Search Attribute
|
||||
Get an extended attribute configuration by name.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-single-search-attribute-config)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | name | **str** | True | Name of the extended search attribute configuration to retrieve.
|
||||
|
||||
### Return type
|
||||
[**List[SearchAttributeConfig]**](../models/search-attribute-config)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Specific attribute configuration in ISC. | List[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
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.models.search_attribute_config import SearchAttributeConfig
|
||||
from sailpoint.v2024.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
name = 'newMailAttribute' # str | Name of the extended search attribute configuration to retrieve. # str | Name of the extended search attribute configuration to retrieve.
|
||||
|
||||
try:
|
||||
# Get Extended Search Attribute
|
||||
|
||||
api_response = api_instance.get_single_search_attribute_config(name)
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.get_single_search_attribute_config(name)
|
||||
print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## patch-search-attribute-config
|
||||
Update Extended Search Attribute
|
||||
Update an existing search attribute configuration.
|
||||
You can patch these fields:
|
||||
* name * displayName * applicationAttributes
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-search-attribute-config)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | name | **str** | True | Name of the search attribute configuration to patch.
|
||||
Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True |
|
||||
|
||||
### Return type
|
||||
[**SearchAttributeConfig**](../models/search-attribute-config)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
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
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
|
||||
from sailpoint.v2024.models.search_attribute_config import SearchAttributeConfig
|
||||
from sailpoint.v2024.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
name = 'promotedMailAttribute' # str | Name of the search attribute configuration to patch. # str | Name of the search attribute configuration to patch.
|
||||
[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}] # List[JsonPatchOperation] |
|
||||
json_patch_operation = {
|
||||
"op" : "replace",
|
||||
"path" : "/description",
|
||||
"value" : "New description"
|
||||
} # List[JsonPatchOperation] |
|
||||
|
||||
|
||||
try:
|
||||
# Update Extended Search Attribute
|
||||
Result = json_patch_operation.from_json(json_patch_operation)
|
||||
api_response = api_instance.patch_search_attribute_config(name, Result)
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.patch_search_attribute_config(name, Result)
|
||||
print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user