LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 20:37:46 +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

94
docs/tools/sdk/python/Reference/Beta/Methods/EntitlementsApi.md
View File

@@ -112,7 +112,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.entitlements_api import EntitlementsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.entitlement import Entitlement
@@ -120,6 +119,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id.
attribute_key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
@@ -128,12 +128,12 @@ with ApiClient(configuration) as api_client:
try:
# Add metadata to an entitlement.
results =EntitlementsApi(api_client).create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value)
results = EntitlementsApi(api_client).create_access_model_metadata_for_entitlement(id=id, attribute_key=attribute_key, attribute_value=attribute_value)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value)
print("The response of EntitlementsApi->create_access_model_metadata_for_entitlement:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling EntitlementsApi->create_access_model_metadata_for_entitlement: %s\n" % e)
```
@@ -175,13 +175,13 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.entitlements_api import EntitlementsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id.
attribute_key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
@@ -190,10 +190,10 @@ with ApiClient(configuration) as api_client:
try:
# Remove metadata from an entitlement.
EntitlementsApi(api_client).delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value)
EntitlementsApi(api_client).delete_access_model_metadata_from_entitlement(id=id, attribute_key=attribute_key, attribute_value=attribute_value)
# Below is a request that includes all optional parameters
# EntitlementsApi(api_client).delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value)
except Exception as e:
except Exception as e:
print("Exception when calling EntitlementsApi->delete_access_model_metadata_from_entitlement: %s\n" % e)
```
@@ -234,7 +234,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.entitlements_api import EntitlementsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.entitlement import Entitlement
@@ -242,18 +241,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808874ff91550175097daaec161c' # str | The entitlement ID # str | The entitlement ID
try:
# Get an entitlement
results =EntitlementsApi(api_client).get_entitlement(id)
results = EntitlementsApi(api_client).get_entitlement(id=id)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).get_entitlement(id)
print("The response of EntitlementsApi->get_entitlement:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling EntitlementsApi->get_entitlement: %s\n" % e)
```
@@ -294,7 +294,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.entitlements_api import EntitlementsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.entitlement_request_config import EntitlementRequestConfig
@@ -302,18 +301,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id
try:
# Get Entitlement Request Config
results =EntitlementsApi(api_client).get_entitlement_request_config(id)
results = EntitlementsApi(api_client).get_entitlement_request_config(id=id)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).get_entitlement_request_config(id)
print("The response of EntitlementsApi->get_entitlement_request_config:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling EntitlementsApi->get_entitlement_request_config: %s\n" % e)
```
@@ -361,7 +361,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.entitlements_api import EntitlementsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.load_entitlement_task import LoadEntitlementTask
@@ -369,6 +368,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id
csv_file = None # bytearray | The CSV file containing the source entitlements to aggregate. (optional) # bytearray | The CSV file containing the source entitlements to aggregate. (optional)
@@ -376,12 +376,12 @@ with ApiClient(configuration) as api_client:
try:
# Aggregate Entitlements
results =EntitlementsApi(api_client).import_entitlements_by_source(id, )
results = EntitlementsApi(api_client).import_entitlements_by_source(id=id)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).import_entitlements_by_source(id, csv_file)
print("The response of EntitlementsApi->import_entitlements_by_source:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling EntitlementsApi->import_entitlements_by_source: %s\n" % e)
```
@@ -427,7 +427,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.entitlements_api import EntitlementsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.entitlement import Entitlement
@@ -435,6 +434,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id
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)
@@ -446,12 +446,12 @@ with ApiClient(configuration) as api_client:
try:
# List of entitlements children
results =EntitlementsApi(api_client).list_entitlement_children(id, )
results = EntitlementsApi(api_client).list_entitlement_children(id=id)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).list_entitlement_children(id, limit, offset, count, sorters, filters)
print("The response of EntitlementsApi->list_entitlement_children:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e)
```
@@ -497,7 +497,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.entitlements_api import EntitlementsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.entitlement import Entitlement
@@ -505,6 +504,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808c74ff913f0175097daa9d59cd' # str | Entitlement Id # str | Entitlement Id
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)
@@ -516,12 +516,12 @@ with ApiClient(configuration) as api_client:
try:
# List of entitlements parents
results =EntitlementsApi(api_client).list_entitlement_parents(id, )
results = EntitlementsApi(api_client).list_entitlement_parents(id=id)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).list_entitlement_parents(id, limit, offset, count, sorters, filters)
print("The response of EntitlementsApi->list_entitlement_parents:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e)
```
@@ -573,7 +573,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.entitlements_api import EntitlementsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.entitlement import Entitlement
@@ -581,6 +580,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (optional) # str | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (optional)
segmented_for_identity = 'me' # str | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) # str | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional)
@@ -595,12 +595,12 @@ with ApiClient(configuration) as api_client:
try:
# Gets a list of entitlements.
results =EntitlementsApi(api_client).list_entitlements()
results = EntitlementsApi(api_client).list_entitlements()
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).list_entitlements(account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters)
print("The response of EntitlementsApi->list_entitlements:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e)
```
@@ -648,7 +648,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.entitlements_api import EntitlementsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.entitlement import Entitlement
@@ -657,25 +656,20 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the entitlement to patch # str | ID of the entitlement to patch
[{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}] # List[JsonPatchOperation] | (optional)
json_patch_operation = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] | (optional)
json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}]''' # List[JsonPatchOperation] | (optional)
try:
# Patch an entitlement
results =EntitlementsApi(api_client).patch_entitlement(id, )
results = EntitlementsApi(api_client).patch_entitlement(id=id)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).patch_entitlement(id, new_json_patch_operation)
print("The response of EntitlementsApi->patch_entitlement:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling EntitlementsApi->patch_entitlement: %s\n" % e)
```
@@ -717,7 +711,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.entitlements_api import EntitlementsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.entitlement_request_config import EntitlementRequestConfig
@@ -725,9 +718,10 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | Entitlement ID # str | Entitlement ID
entitlement_request_config = {
entitlement_request_config = '''{
"accessRequestConfig" : {
"denialCommentRequired" : false,
"approvalSchemes" : [ {
@@ -739,18 +733,17 @@ with ApiClient(configuration) as api_client:
} ],
"requestCommentRequired" : true
}
} # EntitlementRequestConfig |
}''' # EntitlementRequestConfig |
try:
# Replace Entitlement Request Config
new_entitlement_request_config = EntitlementRequestConfig()
new_entitlement_request_config.from_json(entitlement_request_config)
results =EntitlementsApi(api_client).put_entitlement_request_config(id, new_entitlement_request_config)
new_entitlement_request_config = EntitlementRequestConfig.from_json(entitlement_request_config)
results = EntitlementsApi(api_client).put_entitlement_request_config(id=id, entitlement_request_config=new_entitlement_request_config)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).put_entitlement_request_config(id, new_entitlement_request_config)
print("The response of EntitlementsApi->put_entitlement_request_config:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling EntitlementsApi->put_entitlement_request_config: %s\n" % e)
```
@@ -791,7 +784,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.entitlements_api import EntitlementsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.entitlement_source_reset_base_reference_dto import EntitlementSourceResetBaseReferenceDto
@@ -799,18 +791,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c91808a7813090a017814121919ecca' # str | ID of source for the entitlement reset # str | ID of source for the entitlement reset
try:
# Reset Source Entitlements
results =EntitlementsApi(api_client).reset_source_entitlements(source_id)
results = EntitlementsApi(api_client).reset_source_entitlements(source_id=source_id)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).reset_source_entitlements(source_id)
print("The response of EntitlementsApi->reset_source_entitlements:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling EntitlementsApi->reset_source_entitlements: %s\n" % e)
```
@@ -863,7 +856,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.entitlements_api import EntitlementsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.entitlement_bulk_update_request import EntitlementBulkUpdateRequest
@@ -871,8 +863,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
entitlement_bulk_update_request = {
entitlement_bulk_update_request = '''{
"entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ],
"jsonPatch" : [ {
"op" : "replace",
@@ -883,16 +876,15 @@ with ApiClient(configuration) as api_client:
"path" : "/requestable",
"value" : false
} ]
} # EntitlementBulkUpdateRequest |
}''' # EntitlementBulkUpdateRequest |
try:
# Bulk update an entitlement list
new_entitlement_bulk_update_request = EntitlementBulkUpdateRequest()
new_entitlement_bulk_update_request.from_json(entitlement_bulk_update_request)
EntitlementsApi(api_client).update_entitlements_in_bulk(new_entitlement_bulk_update_request)
new_entitlement_bulk_update_request = EntitlementBulkUpdateRequest.from_json(entitlement_bulk_update_request)
EntitlementsApi(api_client).update_entitlements_in_bulk(entitlement_bulk_update_request=new_entitlement_bulk_update_request)
# Below is a request that includes all optional parameters
# EntitlementsApi(api_client).update_entitlements_in_bulk(new_entitlement_bulk_update_request)
except Exception as e:
except Exception as e:
print("Exception when calling EntitlementsApi->update_entitlements_in_bulk: %s\n" % e)
```