LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to python SDK docs: 13820107626

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-12 19:41:45 +00:00
parent 184517209d
commit 113200f5fe
221 changed files with 8723 additions and 7883 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
docs/tools/sdk/python/Reference/V2024/Methods/AccessModelMetadataApi.md
View File

@@ -35,6 +35,14 @@ Method | HTTP request | Description
:::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.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Get Access Model Metadata Attribute
Get single Access Model Metadata Attribute
@@ -67,7 +75,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_model_metadata_api import AccessModelMetadataApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.attribute_dto import AttributeDTO
@@ -75,6 +82,8 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
@@ -82,12 +91,12 @@ with ApiClient(configuration) as api_client:
try:
# Get Access Model Metadata Attribute
results =AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key, x_sail_point_experimental)
results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key=key, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key, x_sail_point_experimental)
print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute: %s\n" % e)
```
@@ -99,6 +108,14 @@ with ApiClient(configuration) as api_client:
:::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.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Get Access Model Metadata Value
Get single Access Model Metadata Attribute Value
@@ -132,7 +149,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_model_metadata_api import AccessModelMetadataApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.attribute_value_dto import AttributeValueDTO
@@ -140,6 +156,8 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
value = 'public' # str | Technical name of the Attribute value. # str | Technical name of the Attribute value.
@@ -148,12 +166,12 @@ with ApiClient(configuration) as api_client:
try:
# Get Access Model Metadata Value
results =AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key, value, x_sail_point_experimental)
results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key=key, value=value, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key, value, x_sail_point_experimental)
print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute_value:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute_value: %s\n" % e)
```
@@ -165,6 +183,14 @@ with ApiClient(configuration) as api_client:
:::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.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
List Access Model Metadata Attributes
Get a list of Access Model Metadata Attributes
@@ -197,7 +223,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_model_metadata_api import AccessModelMetadataApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.attribute_dto import AttributeDTO
@@ -205,6 +230,8 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
filters = 'name eq \"Privacy\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional)
@@ -212,12 +239,12 @@ with ApiClient(configuration) as api_client:
try:
# List Access Model Metadata Attributes
results =AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental, )
results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental, filters)
print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e)
```
@@ -229,6 +256,14 @@ with ApiClient(configuration) as api_client:
:::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.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
List Access Model Metadata Values
Get a list of Access Model Metadata Attribute Values
@@ -261,7 +296,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_model_metadata_api import AccessModelMetadataApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.attribute_value_dto import AttributeValueDTO
@@ -269,6 +303,8 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
@@ -276,12 +312,12 @@ with ApiClient(configuration) as api_client:
try:
# List Access Model Metadata Values
results =AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key, x_sail_point_experimental)
results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key=key, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key, x_sail_point_experimental)
print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e)
```