Skip to content

Commit f6fc230

Browse files
Automated build 'Automated commit by github action: 21084888478
Original commit message: IDNDENALI-12758: AMM Attribute API Documentation' python sdk: 21084894969
1 parent 46834ec commit f6fc230

658 files changed

Lines changed: 5720 additions & 779 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

sailpoint/beta/api/access_model_metadata_api.py

Lines changed: 1454 additions & 240 deletions
Large diffs are not rendered by default.

sailpoint/beta/docs/Examples/python_code_examples_overlay.yaml

Lines changed: 130 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,75 @@
1+
- path: /access-model-metadata/attributes
2+
method: POST
3+
xCodeSample:
4+
- lang: Python
5+
label: SDK_tools/sdk/python/beta/methods/access-model-metadata#create-access-model-metadata-attribute
6+
source: |
7+
from sailpoint.beta.api.access_model_metadata_api import AccessModelMetadataApi
8+
from sailpoint.beta.api_client import ApiClient
9+
from sailpoint.beta.models.attribute_dto import AttributeDTO
10+
from sailpoint.configuration import Configuration
11+
configuration = Configuration()
12+
13+
14+
with ApiClient(configuration) as api_client:
15+
attribute_dto = '''{
16+
"multiselect" : false,
17+
"values" : [ {
18+
"name" : "Public",
19+
"value" : "public",
20+
"status" : "active"
21+
}, {
22+
"name" : "Public",
23+
"value" : "public",
24+
"status" : "active"
25+
} ],
26+
"name" : "Privacy",
27+
"description" : "Specifies the level of privacy associated with an access item.",
28+
"type" : "governance",
29+
"objectTypes" : [ "entitlement" ],
30+
"key" : "iscPrivacy",
31+
"status" : "active"
32+
}''' # AttributeDTO | Attribute to create
33+
try:
34+
# Create access model metadata attribute
35+
new_attribute_dto = AttributeDto.from_json(attribute_dto)
36+
results = AccessModelMetadataApi(api_client).create_access_model_metadata_attribute(attribute_dto=new_attribute_dto)
37+
# Below is a request that includes all optional parameters
38+
# results = AccessModelMetadataApi(api_client).create_access_model_metadata_attribute(new_attribute_dto)
39+
print("The response of AccessModelMetadataApi->create_access_model_metadata_attribute:\n")
40+
print(results.model_dump_json(by_alias=True, indent=4))
41+
except Exception as e:
42+
print("Exception when calling AccessModelMetadataApi->create_access_model_metadata_attribute: %s\n" % e)
43+
- path: /access-model-metadata/attributes/{key}/values
44+
method: POST
45+
xCodeSample:
46+
- lang: Python
47+
label: SDK_tools/sdk/python/beta/methods/access-model-metadata#create-access-model-metadata-attribute-value
48+
source: |
49+
from sailpoint.beta.api.access_model_metadata_api import AccessModelMetadataApi
50+
from sailpoint.beta.api_client import ApiClient
51+
from sailpoint.beta.models.attribute_value_dto import AttributeValueDTO
52+
from sailpoint.configuration import Configuration
53+
configuration = Configuration()
54+
55+
56+
with ApiClient(configuration) as api_client:
57+
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
58+
attribute_value_dto = '''{
59+
"name" : "Public",
60+
"value" : "public",
61+
"status" : "active"
62+
}''' # AttributeValueDTO | Attribute value to create
63+
try:
64+
# Create access model metadata value
65+
new_attribute_value_dto = AttributeValueDto.from_json(attribute_value_dto)
66+
results = AccessModelMetadataApi(api_client).create_access_model_metadata_attribute_value(key=key, attribute_value_dto=new_attribute_value_dto)
67+
# Below is a request that includes all optional parameters
68+
# results = AccessModelMetadataApi(api_client).create_access_model_metadata_attribute_value(key, new_attribute_value_dto)
69+
print("The response of AccessModelMetadataApi->create_access_model_metadata_attribute_value:\n")
70+
print(results.model_dump_json(by_alias=True, indent=4))
71+
except Exception as e:
72+
print("Exception when calling AccessModelMetadataApi->create_access_model_metadata_attribute_value: %s\n" % e)
173
- path: /access-model-metadata/attributes/{key}
274
method: GET
375
xCodeSample:
@@ -63,17 +135,16 @@
63135

64136

65137
with ApiClient(configuration) as api_client:
66-
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: **key**: *eq* **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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* **Supported composite operators**: *and* (optional)
138+
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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators are *and, or* (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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators are *and, or* (optional)
67139
sorters = 'name,-key' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, key** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, key** (optional)
68-
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)
69140
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)
70141
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False)
71142
try:
72143
# List access model metadata attributes
73144

74145
results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute()
75146
# Below is a request that includes all optional parameters
76-
# results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(filters, sorters, offset, limit, count)
147+
# results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(filters, sorters, limit, count)
77148
print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n")
78149
for item in results:
79150
print(item.model_dump_json(by_alias=True, indent=4))
@@ -94,20 +165,74 @@
94165

95166
with ApiClient(configuration) as api_client:
96167
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
97-
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)
98168
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)
99169
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False)
100170
try:
101171
# List access model metadata values
102172

103173
results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key=key)
104174
# Below is a request that includes all optional parameters
105-
# results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key, offset, limit, count)
175+
# results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key, limit, count)
106176
print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n")
107177
for item in results:
108178
print(item.model_dump_json(by_alias=True, indent=4))
109179
except Exception as e:
110180
print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e)
181+
- path: /access-model-metadata/attributes/{key}
182+
method: PATCH
183+
xCodeSample:
184+
- lang: Python
185+
label: SDK_tools/sdk/python/beta/methods/access-model-metadata#update-access-model-metadata-attribute
186+
source: |
187+
from sailpoint.beta.api.access_model_metadata_api import AccessModelMetadataApi
188+
from sailpoint.beta.api_client import ApiClient
189+
from sailpoint.beta.models.attribute_dto import AttributeDTO
190+
from sailpoint.beta.models.json_patch_operation import JsonPatchOperation
191+
from sailpoint.configuration import Configuration
192+
configuration = Configuration()
193+
194+
195+
with ApiClient(configuration) as api_client:
196+
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
197+
json_patch_operation = '''[sailpoint.beta.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSON Patch array to apply
198+
try:
199+
# Update access model metadata attribute
200+
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
201+
results = AccessModelMetadataApi(api_client).update_access_model_metadata_attribute(key=key, json_patch_operation=new_json_patch_operation)
202+
# Below is a request that includes all optional parameters
203+
# results = AccessModelMetadataApi(api_client).update_access_model_metadata_attribute(key, new_json_patch_operation)
204+
print("The response of AccessModelMetadataApi->update_access_model_metadata_attribute:\n")
205+
print(results.model_dump_json(by_alias=True, indent=4))
206+
except Exception as e:
207+
print("Exception when calling AccessModelMetadataApi->update_access_model_metadata_attribute: %s\n" % e)
208+
- path: /access-model-metadata/attributes/{key}/values/{value}
209+
method: PATCH
210+
xCodeSample:
211+
- lang: Python
212+
label: SDK_tools/sdk/python/beta/methods/access-model-metadata#update-access-model-metadata-attribute-value
213+
source: |
214+
from sailpoint.beta.api.access_model_metadata_api import AccessModelMetadataApi
215+
from sailpoint.beta.api_client import ApiClient
216+
from sailpoint.beta.models.attribute_value_dto import AttributeValueDTO
217+
from sailpoint.beta.models.json_patch_operation import JsonPatchOperation
218+
from sailpoint.configuration import Configuration
219+
configuration = Configuration()
220+
221+
222+
with ApiClient(configuration) as api_client:
223+
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
224+
value = 'public' # str | Technical name of the Attribute value. # str | Technical name of the Attribute value.
225+
json_patch_operation = '''[sailpoint.beta.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSON Patch array to apply
226+
try:
227+
# Update access model metadata value
228+
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
229+
results = AccessModelMetadataApi(api_client).update_access_model_metadata_attribute_value(key=key, value=value, json_patch_operation=new_json_patch_operation)
230+
# Below is a request that includes all optional parameters
231+
# results = AccessModelMetadataApi(api_client).update_access_model_metadata_attribute_value(key, value, new_json_patch_operation)
232+
print("The response of AccessModelMetadataApi->update_access_model_metadata_attribute_value:\n")
233+
print(results.model_dump_json(by_alias=True, indent=4))
234+
except Exception as e:
235+
print("Exception when calling AccessModelMetadataApi->update_access_model_metadata_attribute_value: %s\n" % e)
111236
- path: /access-profiles
112237
method: POST
113238
xCodeSample:

0 commit comments

Comments
 (0)