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 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

153
docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md
View File

@@ -75,10 +75,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.bulk_approve_access_request import BulkApproveAccessRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
bulk_approve_access_request = {
"comment" : "I approve these request items",
"approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ]
@@ -86,14 +90,14 @@ from pprint import pprint
try:
# Bulk Approve Access Request
Result = bulk_approve_access_request.from_json(bulk_approve_access_request)
api_response = api_instance.approve_bulk_access_request(Result)
new_bulk_approve_access_request = BulkApproveAccessRequest()
new_bulk_approve_access_request.from_json(bulk_approve_access_request)
results =AccessRequestsApi(api_client).approve_bulk_access_request(new_bulk_approve_access_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.approve_bulk_access_request(Result)
# results = AccessRequestsApi(api_client).approve_bulk_access_request(new_bulk_approve_access_request)
print("The response of AccessRequestsApi->approve_bulk_access_request:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestsApi->approve_bulk_access_request: %s\n" % e)
```
@@ -136,10 +140,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.cancel_access_request import CancelAccessRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
cancel_access_request = {
"accountActivityId" : "2c9180835d2e5168015d32f890ca1581",
"comment" : "I requested this role by mistake."
@@ -147,14 +155,14 @@ from pprint import pprint
try:
# Cancel Access Request
Result = cancel_access_request.from_json(cancel_access_request)
api_response = api_instance.cancel_access_request(Result)
new_cancel_access_request = CancelAccessRequest()
new_cancel_access_request.from_json(cancel_access_request)
results =AccessRequestsApi(api_client).cancel_access_request(new_cancel_access_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.cancel_access_request(Result)
# results = AccessRequestsApi(api_client).cancel_access_request(new_cancel_access_request)
print("The response of AccessRequestsApi->cancel_access_request:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestsApi->cancel_access_request: %s\n" % e)
```
@@ -197,10 +205,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.bulk_cancel_access_request import BulkCancelAccessRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
bulk_cancel_access_request = {
"accessRequestIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ],
"comment" : "I requested this role by mistake."
@@ -208,14 +220,14 @@ from pprint import pprint
try:
# Bulk Cancel Access Request
Result = bulk_cancel_access_request.from_json(bulk_cancel_access_request)
api_response = api_instance.cancel_access_request_in_bulk(Result)
new_bulk_cancel_access_request = BulkCancelAccessRequest()
new_bulk_cancel_access_request.from_json(bulk_cancel_access_request)
results =AccessRequestsApi(api_client).cancel_access_request_in_bulk(new_bulk_cancel_access_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.cancel_access_request_in_bulk(Result)
# results = AccessRequestsApi(api_client).cancel_access_request_in_bulk(new_bulk_cancel_access_request)
print("The response of AccessRequestsApi->cancel_access_request_in_bulk:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestsApi->cancel_access_request_in_bulk: %s\n" % e)
```
@@ -271,10 +283,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.close_access_request import CloseAccessRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
close_access_request = {
"executionStatus" : "Terminated",
@@ -285,14 +301,14 @@ from pprint import pprint
try:
# Close Access Request
Result = close_access_request.from_json(close_access_request)
api_response = api_instance.close_access_request(x_sail_point_experimental, Result)
new_close_access_request = CloseAccessRequest()
new_close_access_request.from_json(close_access_request)
results =AccessRequestsApi(api_client).close_access_request(x_sail_point_experimental, new_close_access_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.close_access_request(x_sail_point_experimental, Result)
# results = AccessRequestsApi(api_client).close_access_request(x_sail_point_experimental, new_close_access_request)
print("The response of AccessRequestsApi->close_access_request:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestsApi->close_access_request: %s\n" % e)
```
@@ -363,11 +379,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_request import AccessRequest
from sailpoint.v2024.models.access_request_response import AccessRequestResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
access_request = {
"requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ],
"clientMetadata" : {
@@ -425,14 +445,14 @@ from pprint import pprint
try:
# Submit Access Request
Result = access_request.from_json(access_request)
api_response = api_instance.create_access_request(Result)
new_access_request = AccessRequest()
new_access_request.from_json(access_request)
results =AccessRequestsApi(api_client).create_access_request(new_access_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_access_request(Result)
# results = AccessRequestsApi(api_client).create_access_request(new_access_request)
print("The response of AccessRequestsApi->create_access_request:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestsApi->create_access_request: %s\n" % e)
```
@@ -470,21 +490,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_request_config import AccessRequestConfig
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Access Request Configuration
api_response = api_instance.get_access_request_config()
results =AccessRequestsApi(api_client).get_access_request_config()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_access_request_config()
# results = AccessRequestsApi(api_client).get_access_request_config()
print("The response of AccessRequestsApi->get_access_request_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e)
```
@@ -536,10 +559,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.requested_item_status import RequestedItemStatus
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
requested_for = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
requested_by = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
regarding_identity = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # str | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional)
@@ -554,13 +581,12 @@ from pprint import pprint
try:
# Access Request Status
api_response = api_instance.list_access_request_status()
results =AccessRequestsApi(api_client).list_access_request_status()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state)
# results = AccessRequestsApi(api_client).list_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state)
print("The response of AccessRequestsApi->list_access_request_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e)
```
@@ -611,10 +637,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_request_admin_item_status import AccessRequestAdminItemStatus
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
requested_for = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
requested_by = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
regarding_identity = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # str | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional)
@@ -629,13 +659,12 @@ from pprint import pprint
try:
# Access Request Status for Administrators
api_response = api_instance.list_administrators_access_request_status()
results =AccessRequestsApi(api_client).list_administrators_access_request_status()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_administrators_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state)
# results = AccessRequestsApi(api_client).list_administrators_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state)
print("The response of AccessRequestsApi->list_administrators_access_request_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestsApi->list_administrators_access_request_status: %s\n" % e)
```
@@ -676,10 +705,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_request_config import AccessRequestConfig
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
access_request_config = {
"requestOnBehalfOfConfig" : {
"allowRequestOnBehalfOfEmployeeByManager" : true,
@@ -709,14 +742,14 @@ from pprint import pprint
try:
# Update Access Request Configuration
Result = access_request_config.from_json(access_request_config)
api_response = api_instance.set_access_request_config(Result)
new_access_request_config = AccessRequestConfig()
new_access_request_config.from_json(access_request_config)
results =AccessRequestsApi(api_client).set_access_request_config(new_access_request_config)
# Below is a request that includes all optional parameters
# api_response = api_instance.set_access_request_config(Result)
# results = AccessRequestsApi(api_client).set_access_request_config(new_access_request_config)
print("The response of AccessRequestsApi->set_access_request_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestsApi->set_access_request_config: %s\n" % e)
```