Automated build 'Automated commit 'Merge pull request #2019 from sailpoint/devrel-2136-v3

devrel-2136 v3' by github action: 13953156774' python sdk: 13953168358

Author: developer-relations-sp

sailpoint/v3/api/search_attribute_configuration_api.py

@@ -17,7 +17,7 @@
 from typing_extensions import Annotated
 
 from pydantic import Field, StrictStr
-from typing import Any, Dict, List
+from typing import Any, Dict, List, Optional
 from typing_extensions import Annotated
 from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
 from sailpoint.v3.models.search_attribute_config import SearchAttributeConfig
@@ -59,7 +59,7 @@ def create_search_attribute_config(
     ) -> object:
         """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.
+        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`.**
 
         :param search_attribute_config: (required)
         :type search_attribute_config: SearchAttributeConfig
@@ -132,7 +132,7 @@ def create_search_attribute_config_with_http_info(
     ) -> ApiResponse[object]:
         """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.
+        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`.**
 
         :param search_attribute_config: (required)
         :type search_attribute_config: SearchAttributeConfig
@@ -205,7 +205,7 @@ def create_search_attribute_config_without_preload_content(
     ) -> RESTResponseType:
         """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.
+        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`.**
 
         :param search_attribute_config: (required)
         :type search_attribute_config: SearchAttributeConfig
@@ -616,6 +616,8 @@ def _delete_search_attribute_config_serialize(
     @validate_call
     def get_search_attribute_config(
         self,
+        limit: Annotated[Optional[Annotated[int, Field(le=250, strict=True, ge=0)]], Field(description="Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.")] = None,
+        offset: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="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.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -631,8 +633,12 @@ def get_search_attribute_config(
     ) -> List[SearchAttributeConfig]:
         """List Extended Search Attributes
 
-        Get a list of attribute/application associates currently configured in Identity Security Cloud (ISC).
+        Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC).
 
+        :param limit: Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
+        :type limit: int
+        :param offset: 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.
+        :type offset: int
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -656,6 +662,8 @@ def get_search_attribute_config(
         """ # noqa: E501
 
         _param = self._get_search_attribute_config_serialize(
+            limit=limit,
+            offset=offset,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -684,6 +692,8 @@ def get_search_attribute_config(
     @validate_call
     def get_search_attribute_config_with_http_info(
         self,
+        limit: Annotated[Optional[Annotated[int, Field(le=250, strict=True, ge=0)]], Field(description="Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.")] = None,
+        offset: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="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.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -699,8 +709,12 @@ def get_search_attribute_config_with_http_info(
     ) -> ApiResponse[List[SearchAttributeConfig]]:
         """List Extended Search Attributes
 
-        Get a list of attribute/application associates currently configured in Identity Security Cloud (ISC).
+        Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC).
 
+        :param limit: Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
+        :type limit: int
+        :param offset: 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.
+        :type offset: int
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -724,6 +738,8 @@ def get_search_attribute_config_with_http_info(
         """ # noqa: E501
 
         _param = self._get_search_attribute_config_serialize(
+            limit=limit,
+            offset=offset,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -752,6 +768,8 @@ def get_search_attribute_config_with_http_info(
     @validate_call
     def get_search_attribute_config_without_preload_content(
         self,
+        limit: Annotated[Optional[Annotated[int, Field(le=250, strict=True, ge=0)]], Field(description="Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.")] = None,
+        offset: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="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.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -767,8 +785,12 @@ def get_search_attribute_config_without_preload_content(
     ) -> RESTResponseType:
         """List Extended Search Attributes
 
-        Get a list of attribute/application associates currently configured in Identity Security Cloud (ISC).
+        Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC).
 
+        :param limit: Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
+        :type limit: int
+        :param offset: 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.
+        :type offset: int
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -792,6 +814,8 @@ def get_search_attribute_config_without_preload_content(
         """ # noqa: E501
 
         _param = self._get_search_attribute_config_serialize(
+            limit=limit,
+            offset=offset,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -815,6 +839,8 @@ def get_search_attribute_config_without_preload_content(
 
     def _get_search_attribute_config_serialize(
         self,
+        limit,
+        offset,
         _request_auth,
         _content_type,
         _headers,
@@ -837,6 +863,14 @@ def _get_search_attribute_config_serialize(
 
         # process the path parameters
         # process the query parameters
+        if limit is not None:
+            
+            _query_params.append(('limit', limit))
+            
+        if offset is not None:
+            
+            _query_params.append(('offset', offset))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter

sailpoint/v3/docs/SearchAttributeConfigurationApi.md

@@ -42,7 +42,8 @@ Method | HTTP request | Description
 
 ## 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.
+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](https://developer.sailpoint.com/docs/api/v3/create-search-attribute-config)
 
@@ -166,12 +167,16 @@ with ApiClient(configuration) as api_client:
 
 ## get-search-attribute-config
 List Extended Search Attributes
-Get a list of attribute/application associates currently configured in Identity Security Cloud (ISC).
+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)
 
 ### Parameters 
-This endpoint does not need any parameter. 
+
+Param Type | Name | Data Type | Required  | Description
+------------- | ------------- | ------------- | ------------- | ------------- 
+  Query | limit | **int** |   (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
+  Query | offset | **int** |   (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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
 
 ### Return type
 [**List[SearchAttributeConfig]**](../models/search-attribute-config)
@@ -202,13 +207,15 @@ 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()
+        # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset)
         print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n")
         pprint(results)
     except Exception as e:

sailpoint/v3/docs/SearchAttributeConfigurationApideveloperSite_code_examples.yaml

@@ -69,12 +69,14 @@
 
 
         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()
+            # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset)
             print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n")
             pprint(results)
         except Exception as e:

sailpoint/v3/docs/TransformsApi.md

@@ -12,8 +12,7 @@ tags: ['SDK', 'Software Development Kit', 'Transforms', 'Transforms']
 # sailpoint.v3.TransformsApi
   The purpose of this API is to expose functionality for the manipulation of Transform objects.
 Transforms are a form of configurable objects which define an easy way to manipulate attribute data without having
-to write code. These endpoints don't require API calls to other resources, audit service is used for keeping track
-of which users have made changes to the Transforms.
+to write code. 
 
 Refer to [Transforms](https://developer.sailpoint.com/docs/extensibility/transforms/) for more information about transforms.