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

73
docs/tools/sdk/python/Reference/V2024/Methods/DimensionsApi.md
View File

@@ -62,7 +62,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.dimensions_api import DimensionsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.dimension import Dimension
@@ -70,9 +69,10 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension.
dimension = {
dimension = '''{
"owner" : {
"name" : "support",
"id" : "2c9180a46faadee4016fb4e018c20639",
@@ -158,18 +158,17 @@ with ApiClient(configuration) as api_client:
"type" : "STANDARD"
},
"parentId" : "2c918086749d78830174a1a40e121518"
} # Dimension |
}''' # Dimension |
try:
# Create a Dimension
new_dimension = Dimension()
new_dimension.from_json(dimension)
results =DimensionsApi(api_client).create_dimension(role_id, new_dimension)
new_dimension = Dimension.from_json(dimension)
results = DimensionsApi(api_client).create_dimension(role_id=role_id, dimension=new_dimension)
# Below is a request that includes all optional parameters
# results = DimensionsApi(api_client).create_dimension(role_id, new_dimension)
print("The response of DimensionsApi->create_dimension:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling DimensionsApi->create_dimension: %s\n" % e)
```
@@ -213,7 +212,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.dimensions_api import DimensionsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.dimension_bulk_delete_request import DimensionBulkDeleteRequest
@@ -222,22 +220,22 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimensions. # str | Parent Role Id of the dimensions.
dimension_bulk_delete_request = {
dimension_bulk_delete_request = '''{
"dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ]
} # DimensionBulkDeleteRequest |
}''' # DimensionBulkDeleteRequest |
try:
# Delete Dimension(s)
new_dimension_bulk_delete_request = DimensionBulkDeleteRequest()
new_dimension_bulk_delete_request.from_json(dimension_bulk_delete_request)
results =DimensionsApi(api_client).delete_bulk_dimensions(role_id, new_dimension_bulk_delete_request)
new_dimension_bulk_delete_request = DimensionBulkDeleteRequest.from_json(dimension_bulk_delete_request)
results = DimensionsApi(api_client).delete_bulk_dimensions(role_id=role_id, dimension_bulk_delete_request=new_dimension_bulk_delete_request)
# Below is a request that includes all optional parameters
# results = DimensionsApi(api_client).delete_bulk_dimensions(role_id, new_dimension_bulk_delete_request)
print("The response of DimensionsApi->delete_bulk_dimensions:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling DimensionsApi->delete_bulk_dimensions: %s\n" % e)
```
@@ -279,13 +277,13 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.dimensions_api import DimensionsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension.
dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension
@@ -293,10 +291,10 @@ with ApiClient(configuration) as api_client:
try:
# Delete a Dimension
DimensionsApi(api_client).delete_dimension(role_id, dimension_id)
DimensionsApi(api_client).delete_dimension(role_id=role_id, dimension_id=dimension_id)
# Below is a request that includes all optional parameters
# DimensionsApi(api_client).delete_dimension(role_id, dimension_id)
except Exception as e:
except Exception as e:
print("Exception when calling DimensionsApi->delete_dimension: %s\n" % e)
```
@@ -339,7 +337,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.dimensions_api import DimensionsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.dimension import Dimension
@@ -347,6 +344,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension.
dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension
@@ -354,12 +352,12 @@ with ApiClient(configuration) as api_client:
try:
# Get a Dimension under Role.
results =DimensionsApi(api_client).get_dimension(role_id, dimension_id)
results = DimensionsApi(api_client).get_dimension(role_id=role_id, dimension_id=dimension_id)
# Below is a request that includes all optional parameters
# results = DimensionsApi(api_client).get_dimension(role_id, dimension_id)
print("The response of DimensionsApi->get_dimension:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling DimensionsApi->get_dimension: %s\n" % e)
```
@@ -407,7 +405,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.dimensions_api import DimensionsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.entitlement import Entitlement
@@ -415,6 +412,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension.
dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension
@@ -427,12 +425,12 @@ with ApiClient(configuration) as api_client:
try:
# List Dimension's Entitlements
results =DimensionsApi(api_client).get_dimension_entitlements(role_id, dimension_id, )
results = DimensionsApi(api_client).get_dimension_entitlements(role_id=role_id, dimension_id=dimension_id)
# Below is a request that includes all optional parameters
# results = DimensionsApi(api_client).get_dimension_entitlements(role_id, dimension_id, limit, offset, count, filters, sorters)
print("The response of DimensionsApi->get_dimension_entitlements:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling DimensionsApi->get_dimension_entitlements: %s\n" % e)
```
@@ -481,7 +479,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.dimensions_api import DimensionsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_profile import AccessProfile
@@ -489,6 +486,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension.
dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension
@@ -501,12 +499,12 @@ with ApiClient(configuration) as api_client:
try:
# List Dimension's Access Profiles
results =DimensionsApi(api_client).list_dimension_access_profiles(role_id, dimension_id, )
results = DimensionsApi(api_client).list_dimension_access_profiles(role_id=role_id, dimension_id=dimension_id)
# Below is a request that includes all optional parameters
# results = DimensionsApi(api_client).list_dimension_access_profiles(role_id, dimension_id, limit, offset, count, filters, sorters)
print("The response of DimensionsApi->list_dimension_access_profiles:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling DimensionsApi->list_dimension_access_profiles: %s\n" % e)
```
@@ -554,7 +552,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.dimensions_api import DimensionsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.dimension import Dimension
@@ -562,6 +559,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension.
for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional)
@@ -574,12 +572,12 @@ with ApiClient(configuration) as api_client:
try:
# List Dimensions
results =DimensionsApi(api_client).list_dimensions(role_id, )
results = DimensionsApi(api_client).list_dimensions(role_id=role_id)
# Below is a request that includes all optional parameters
# results = DimensionsApi(api_client).list_dimensions(role_id, for_subadmin, limit, offset, count, filters, sorters)
print("The response of DimensionsApi->list_dimensions:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling DimensionsApi->list_dimensions: %s\n" % e)
```
@@ -625,7 +623,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.dimensions_api import DimensionsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.dimension import Dimension
@@ -634,27 +631,21 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension.
dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension
[{op=replace, path=/description, value=Test Description}, {op=replace, path=/name, value=new name}] # List[JsonPatchOperation] |
json_patch_operation = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] |
json_patch_operation = '''[{op=replace, path=/description, value=Test Description}, {op=replace, path=/name, value=new name}]''' # List[JsonPatchOperation] |
try:
# Patch a specified Dimension
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =DimensionsApi(api_client).patch_dimension(role_id, dimension_id, new_json_patch_operation)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = DimensionsApi(api_client).patch_dimension(role_id=role_id, dimension_id=dimension_id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = DimensionsApi(api_client).patch_dimension(role_id, dimension_id, new_json_patch_operation)
print("The response of DimensionsApi->patch_dimension:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling DimensionsApi->patch_dimension: %s\n" % e)
```