Skip to main content

sailpoint.beta.SearchAttributeConfigurationApi

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.

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

MethodHTTP requestDescription
create-search-attribute-configPOST /accounts/search-attribute-configCreate Extended Search Attributes
delete-search-attribute-configDELETE /accounts/search-attribute-config/{name}Delete Extended Search Attribute
get-search-attribute-configGET /accounts/search-attribute-configList Extended Search Attributes
get-single-search-attribute-configGET /accounts/search-attribute-config/{name}Get Extended Search Attribute
patch-search-attribute-configPATCH /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 the attribute promotion configuration in the Link ObjectConfig.

Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes' applicationAttributes.

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
Bodysearch_attribute_configSearchAttributeConfigTrue

Return type​

object

Responses​

CodeDescriptionData TypeResponse headers
202Accepted - Returned if the request was successfully accepted into the system.object-
400Client Error - Returned if the request body is invalid.ErrorResponseDto-
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessModelMetadataAttribute401Response-
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto-
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto-
429Too 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.ListAccessModelMetadataAttribute429Response-
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto-

HTTP request headers​

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

Example​

from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    search_attribute_config = '''{
          "displayName" : "New Mail Attribute",
          "name" : "newMailAttribute",
          "applicationAttributes" : {
            "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber",
            "2c91808b79fd2422017a0b36008f396b" : "employeeNumber"
          }
        }''' # SearchAttributeConfig | 

    try:
        # Create Extended Search Attributes
        new_search_attribute_config = SearchAttributeConfig.from_json(search_attribute_config)
        results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(search_attribute_config=new_search_attribute_config)
        # Below is a request that includes all optional parameters
        # results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(new_search_attribute_config)
        print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    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

Parameters​

Param TypeNameData TypeRequiredDescription
PathnamestrTrueName of the extended search attribute configuration to delete.

Return type​

(empty response body)

Responses​

CodeDescriptionData TypeResponse headers
204No content - indicates the request was successful but there is no content to be returned in the response.-
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessModelMetadataAttribute401Response-
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto-
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto-
429Too 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.ListAccessModelMetadataAttribute429Response-
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto-

HTTP request headers​

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

Example​

from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    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
        
        SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name)
        # Below is a request that includes all optional parameters
        # SearchAttributeConfigurationApi(api_client).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 attributes currently configured in Identity Security Cloud (ISC). A token with ORG_ADMIN authority is required to call this API.

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
Querylimitint(optional) (default to 250)Max number of results to return. See V3 API Standard Collection Parameters for more information.
Queryoffsetint(optional) (default to 0)Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

Return type​

List[SearchAttributeConfig]

Responses​

CodeDescriptionData TypeResponse headers
200List of attribute configurations in ISC.List[SearchAttributeConfig]-
400Client Error - Returned if the request body is invalid.ErrorResponseDto-
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessModelMetadataAttribute401Response-
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto-
429Too 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.ListAccessModelMetadataAttribute429Response-
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto-

HTTP request headers​

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

Example​

from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
    offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)

    try:
        # List Extended Search Attributes
        
        results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config()
        # Below is a request that includes all optional parameters
        # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset)
        print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n")
        for item in results:
            print(item.model_dump_json(by_alias=True, indent=4))
    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

Parameters​

Param TypeNameData TypeRequiredDescription
PathnamestrTrueName of the extended search attribute configuration to get.

Return type​

List[SearchAttributeConfig]

Responses​

CodeDescriptionData TypeResponse headers
200Specific attribute configuration in IdentityNow.List[SearchAttributeConfig]-
204No content - indicates the request was successful but there is no content to be returned in the response.-
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessModelMetadataAttribute401Response-
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto-
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto-
429Too 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.ListAccessModelMetadataAttribute429Response-
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto-

HTTP request headers​

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

Example​

from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get.

    try:
        # Get Extended Search Attribute
        
        results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name)
        # Below is a request that includes all optional parameters
        # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name)
        print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n")
        for item in results:
            print(item.model_dump_json(by_alias=True, indent=4))
    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

Parameters​

Param TypeNameData TypeRequiredDescription
PathnamestrTrueName of the extended search attribute configuration to patch.
Bodyjson_patch_operation[]JsonPatchOperationTrue

Return type​

SearchAttributeConfig

Responses​

CodeDescriptionData TypeResponse headers
200Responds with the search attribute configuration as updated.SearchAttributeConfig-
400Client Error - Returned if the request body is invalid.ErrorResponseDto-
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessModelMetadataAttribute401Response-
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto-
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto-
429Too 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.ListAccessModelMetadataAttribute429Response-
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto-

HTTP request headers​

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

Example​

from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.json_patch_operation import JsonPatchOperation
from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    name = 'promotedMailAttribute' # str | Name of the extended search attribute configuration to patch. # str | Name of the extended search attribute configuration to patch.
    json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] | 

    try:
        # Update Extended Search Attribute
        new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
        results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name=name, json_patch_operation=new_json_patch_operation)
        # Below is a request that includes all optional parameters
        # results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, new_json_patch_operation)
        print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e)

[Back to top]