mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 12:27:47 +00:00
Update python SDK docs: 15116515953
This commit is contained in:
developer-relations-sp
@@ -33,15 +33,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create-search-attribute-config**](#create-search-attribute-config) | **POST** `/accounts/search-attribute-config` | Create Extended Search Attributes
|
||||
[**delete-search-attribute-config**](#delete-search-attribute-config) | **DELETE** `/accounts/search-attribute-config/{name}` | Delete Extended Search Attribute
|
||||
[**get-search-attribute-config**](#get-search-attribute-config) | **GET** `/accounts/search-attribute-config` | List Extended Search Attributes
|
||||
[**get-single-search-attribute-config**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute
|
||||
[**patch-search-attribute-config**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute
|
||||
[**create-search-attribute-config**](#create-search-attribute-config) | **POST** `/accounts/search-attribute-config` | Create extended search attributes
|
||||
[**delete-search-attribute-config**](#delete-search-attribute-config) | **DELETE** `/accounts/search-attribute-config/{name}` | Delete extended search attribute
|
||||
[**get-search-attribute-config**](#get-search-attribute-config) | **GET** `/accounts/search-attribute-config` | List extended search attributes
|
||||
[**get-single-search-attribute-config**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get extended search attribute
|
||||
[**patch-search-attribute-config**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update extended search attribute
|
||||
|
||||
|
||||
## create-search-attribute-config
|
||||
Create Extended Search Attributes
|
||||
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`.**
|
||||
|
||||
@@ -92,7 +92,7 @@ with ApiClient(configuration) as api_client:
|
||||
}''' # SearchAttributeConfig |
|
||||
|
||||
try:
|
||||
# Create Extended Search Attributes
|
||||
# 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
|
||||
@@ -108,7 +108,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-search-attribute-config
|
||||
Delete Extended Search Attribute
|
||||
Delete extended search attribute
|
||||
Delete an extended attribute configuration by name.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-search-attribute-config)
|
||||
@@ -150,7 +150,7 @@ 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
|
||||
# Delete extended search attribute
|
||||
|
||||
SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -164,7 +164,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-search-attribute-config
|
||||
List Extended Search Attributes
|
||||
List extended search attributes
|
||||
Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC).
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-search-attribute-config)
|
||||
@@ -208,7 +208,7 @@ with ApiClient(configuration) as api_client:
|
||||
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
|
||||
# List extended search attributes
|
||||
|
||||
results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config()
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -225,7 +225,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-single-search-attribute-config
|
||||
Get Extended Search Attribute
|
||||
Get extended search attribute
|
||||
Get an extended attribute configuration by name.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-single-search-attribute-config)
|
||||
@@ -269,7 +269,7 @@ with ApiClient(configuration) as api_client:
|
||||
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
|
||||
# Get extended search attribute
|
||||
|
||||
results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -286,7 +286,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## patch-search-attribute-config
|
||||
Update Extended Search Attribute
|
||||
Update extended search attribute
|
||||
Update an existing search attribute configuration.
|
||||
You can patch these fields:
|
||||
* name * displayName * applicationAttributes
|
||||
@@ -334,7 +334,7 @@ with ApiClient(configuration) as api_client:
|
||||
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
|
||||
# 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
|
||||
|
||||
Reference in New Issue
Block a user