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 layout for method examples

Browse Source
This commit is contained in:
darrell-thobe-sp
2025-02-25 11:46:14 -05:00
parent a4e2ab4717
commit aa76768244
208 changed files with 14924 additions and 9712 deletions
Download Patch File Download Diff File Expand all files Collapse all files

160
docs/tools/sdk/python/Reference/Beta/Methods/GovernanceGroupsApi.md
View File

@@ -65,10 +65,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.workgroup_dto import WorkgroupDto
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
workgroup_dto = {
"owner" : {
"emailAddress" : "support@sailpoint.com",
@@ -88,14 +92,14 @@ from pprint import pprint
try:
# Create a new Governance Group.
Result = workgroup_dto.from_json(workgroup_dto)
api_response = api_instance.create_workgroup(Result)
new_workgroup_dto = WorkgroupDto()
new_workgroup_dto.from_json(workgroup_dto)
results =GovernanceGroupsApi(api_client).create_workgroup(new_workgroup_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_workgroup(Result)
# results = GovernanceGroupsApi(api_client).create_workgroup(new_workgroup_dto)
print("The response of GovernanceGroupsApi->create_workgroup:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GovernanceGroupsApi->create_workgroup: %s\n" % e)
```
@@ -136,19 +140,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.rest import ApiException
from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi
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 = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group
try:
# Delete a Governance Group
api_instance.delete_workgroup(id)
GovernanceGroupsApi(api_client).delete_workgroup(id)
# Below is a request that includes all optional parameters
# api_instance.delete_workgroup(id)
except Exception as e:
# GovernanceGroupsApi(api_client).delete_workgroup(id)
except Exception as e:
print("Exception when calling GovernanceGroupsApi->delete_workgroup: %s\n" % e)
```
@@ -194,11 +201,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.bulk_workgroup_members_request_inner import BulkWorkgroupMembersRequestInner
from sailpoint.beta.models.workgroup_member_delete_item import WorkgroupMemberDeleteItem
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group.
[sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be removed from a Governance Group members list.
bulk_workgroup_members_request_inner = [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be removed from a Governance Group members list.
@@ -206,14 +217,14 @@ from pprint import pprint
try:
# Remove members from Governance Group
Result = bulk_workgroup_members_request_inner.from_json(bulk_workgroup_members_request_inner)
api_response = api_instance.delete_workgroup_members(workgroup_id, Result)
new_bulk_workgroup_members_request_inner = BulkWorkgroupMembersRequestInner()
new_bulk_workgroup_members_request_inner.from_json(bulk_workgroup_members_request_inner)
results =GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, new_bulk_workgroup_members_request_inner)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_workgroup_members(workgroup_id, Result)
# results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, new_bulk_workgroup_members_request_inner)
print("The response of GovernanceGroupsApi->delete_workgroup_members:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e)
```
@@ -265,25 +276,29 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.workgroup_bulk_delete_request import WorkgroupBulkDeleteRequest
from sailpoint.beta.models.workgroup_delete_item import WorkgroupDeleteItem
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
workgroup_bulk_delete_request = {
"ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ]
} # WorkgroupBulkDeleteRequest |
try:
# Delete Governance Group(s)
Result = workgroup_bulk_delete_request.from_json(workgroup_bulk_delete_request)
api_response = api_instance.delete_workgroups_in_bulk(Result)
new_workgroup_bulk_delete_request = WorkgroupBulkDeleteRequest()
new_workgroup_bulk_delete_request.from_json(workgroup_bulk_delete_request)
results =GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(new_workgroup_bulk_delete_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_workgroups_in_bulk(Result)
# results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(new_workgroup_bulk_delete_request)
print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e)
```
@@ -324,22 +339,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.workgroup_dto import WorkgroupDto
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group
try:
# Get Governance Group by Id
api_response = api_instance.get_workgroup(id)
results =GovernanceGroupsApi(api_client).get_workgroup(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_workgroup(id)
# results = GovernanceGroupsApi(api_client).get_workgroup(id)
print("The response of GovernanceGroupsApi->get_workgroup:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GovernanceGroupsApi->get_workgroup: %s\n" % e)
```
@@ -384,10 +402,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.workgroup_connection_dto import WorkgroupConnectionDto
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group.
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)
limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50)
@@ -397,13 +419,12 @@ from pprint import pprint
try:
# List connections for Governance Group
api_response = api_instance.list_connections(workgroup_id, )
results =GovernanceGroupsApi(api_client).list_connections(workgroup_id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_connections(workgroup_id, offset, limit, count, sorters)
# results = GovernanceGroupsApi(api_client).list_connections(workgroup_id, offset, limit, count, sorters)
print("The response of GovernanceGroupsApi->list_connections:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e)
```
@@ -448,10 +469,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.list_workgroup_members200_response_inner import ListWorkgroupMembers200ResponseInner
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group.
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)
limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50)
@@ -461,13 +486,12 @@ from pprint import pprint
try:
# List Governance Group Members
api_response = api_instance.list_workgroup_members(workgroup_id, )
results =GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_workgroup_members(workgroup_id, offset, limit, count, sorters)
# results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id, offset, limit, count, sorters)
print("The response of GovernanceGroupsApi->list_workgroup_members:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e)
```
@@ -512,10 +536,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.workgroup_dto import WorkgroupDto
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50)
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)
@@ -525,13 +553,12 @@ from pprint import pprint
try:
# List Governance Groups
api_response = api_instance.list_workgroups()
results =GovernanceGroupsApi(api_client).list_workgroups()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_workgroups(offset, limit, count, filters, sorters)
# results = GovernanceGroupsApi(api_client).list_workgroups(offset, limit, count, filters, sorters)
print("The response of GovernanceGroupsApi->list_workgroups:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e)
```
@@ -579,11 +606,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.json_patch_operation import JsonPatchOperation
from sailpoint.beta.models.workgroup_dto import WorkgroupDto
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group
[{op=replace, path=/description, value=Governance Group new description.}] # List[JsonPatchOperation] | (optional)
json_patch_operation = {
@@ -596,13 +627,12 @@ from pprint import pprint
try:
# Patch a Governance Group
api_response = api_instance.patch_workgroup(id, )
results =GovernanceGroupsApi(api_client).patch_workgroup(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_workgroup(id, Result)
# results = GovernanceGroupsApi(api_client).patch_workgroup(id, new_json_patch_operation)
print("The response of GovernanceGroupsApi->patch_workgroup:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GovernanceGroupsApi->patch_workgroup: %s\n" % e)
```
@@ -648,11 +678,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.bulk_workgroup_members_request_inner import BulkWorkgroupMembersRequestInner
from sailpoint.beta.models.workgroup_member_add_item import WorkgroupMemberAddItem
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group.
[sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be added to a Governance Group members list.
bulk_workgroup_members_request_inner = [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be added to a Governance Group members list.
@@ -660,14 +694,14 @@ from pprint import pprint
try:
# Add members to Governance Group
Result = bulk_workgroup_members_request_inner.from_json(bulk_workgroup_members_request_inner)
api_response = api_instance.update_workgroup_members(workgroup_id, Result)
new_bulk_workgroup_members_request_inner = BulkWorkgroupMembersRequestInner()
new_bulk_workgroup_members_request_inner.from_json(bulk_workgroup_members_request_inner)
results =GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, new_bulk_workgroup_members_request_inner)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_workgroup_members(workgroup_id, Result)
# results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, new_bulk_workgroup_members_request_inner)
print("The response of GovernanceGroupsApi->update_workgroup_members:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e)
```