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

64
docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md
View File

@@ -72,7 +72,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_requests_api import AccessRequestsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.cancel_access_request import CancelAccessRequest
@@ -80,22 +79,22 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
cancel_access_request = {
cancel_access_request = '''{
"accountActivityId" : "2c9180835d2e5168015d32f890ca1581",
"comment" : "I requested this role by mistake."
} # CancelAccessRequest |
}''' # CancelAccessRequest |
try:
# Cancel Access Request
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)
new_cancel_access_request = CancelAccessRequest.from_json(cancel_access_request)
results = AccessRequestsApi(api_client).cancel_access_request(cancel_access_request=new_cancel_access_request)
# Below is a request that includes all optional parameters
# results = AccessRequestsApi(api_client).cancel_access_request(new_cancel_access_request)
print("The response of AccessRequestsApi->cancel_access_request:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling AccessRequestsApi->cancel_access_request: %s\n" % e)
```
@@ -146,7 +145,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_requests_api import AccessRequestsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.close_access_request import CloseAccessRequest
@@ -154,24 +152,24 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
close_access_request = {
close_access_request = '''{
"executionStatus" : "Terminated",
"accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
"completionStatus" : "Failure",
"message" : "The IdentityNow Administrator manually closed this request."
} # CloseAccessRequest |
}''' # CloseAccessRequest |
try:
# Close Access Request
new_close_access_request = CloseAccessRequest()
new_close_access_request.from_json(close_access_request)
results =AccessRequestsApi(api_client).close_access_request(new_close_access_request)
new_close_access_request = CloseAccessRequest.from_json(close_access_request)
results = AccessRequestsApi(api_client).close_access_request(close_access_request=new_close_access_request)
# Below is a request that includes all optional parameters
# results = AccessRequestsApi(api_client).close_access_request(new_close_access_request)
print("The response of AccessRequestsApi->close_access_request:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling AccessRequestsApi->close_access_request: %s\n" % e)
```
@@ -241,7 +239,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_requests_api import AccessRequestsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.access_request import AccessRequest
@@ -250,8 +247,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
access_request = {
access_request = '''{
"requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ],
"clientMetadata" : {
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1",
@@ -304,18 +302,17 @@ with ApiClient(configuration) as api_client:
"id" : "2c9180835d2e5168015d32f890ca1581",
"type" : "ACCESS_PROFILE"
} ]
} # AccessRequest |
}''' # AccessRequest |
try:
# Submit Access Request
new_access_request = AccessRequest()
new_access_request.from_json(access_request)
results =AccessRequestsApi(api_client).create_access_request(new_access_request)
new_access_request = AccessRequest.from_json(access_request)
results = AccessRequestsApi(api_client).create_access_request(access_request=new_access_request)
# Below is a request that includes all optional parameters
# results = AccessRequestsApi(api_client).create_access_request(new_access_request)
print("The response of AccessRequestsApi->create_access_request:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling AccessRequestsApi->create_access_request: %s\n" % e)
```
@@ -352,7 +349,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_requests_api import AccessRequestsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.access_request_config import AccessRequestConfig
@@ -360,17 +356,18 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Access Request Configuration
results =AccessRequestsApi(api_client).get_access_request_config()
results = AccessRequestsApi(api_client).get_access_request_config()
# Below is a request that includes all optional parameters
# results = AccessRequestsApi(api_client).get_access_request_config()
print("The response of AccessRequestsApi->get_access_request_config:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e)
```
@@ -421,7 +418,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_requests_api import AccessRequestsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.requested_item_status import RequestedItemStatus
@@ -429,6 +425,7 @@ 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)
@@ -444,12 +441,12 @@ with ApiClient(configuration) as api_client:
try:
# Access Request Status
results =AccessRequestsApi(api_client).list_access_request_status()
results = AccessRequestsApi(api_client).list_access_request_status()
# Below is a request that includes all optional parameters
# 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(results)
except Exception as e:
except Exception as e:
print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e)
```
@@ -489,7 +486,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_requests_api import AccessRequestsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.access_request_config import AccessRequestConfig
@@ -497,8 +493,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
access_request_config = {
access_request_config = '''{
"requestOnBehalfOfConfig" : {
"allowRequestOnBehalfOfEmployeeByManager" : true,
"allowRequestOnBehalfOfAnyoneByAnyone" : true
@@ -523,18 +520,17 @@ with ApiClient(configuration) as api_client:
},
"reauthorizationEnabled" : true,
"approvalsMustBeExternal" : true
} # AccessRequestConfig |
}''' # AccessRequestConfig |
try:
# Update Access Request Configuration
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)
new_access_request_config = AccessRequestConfig.from_json(access_request_config)
results = AccessRequestsApi(api_client).set_access_request_config(access_request_config=new_access_request_config)
# Below is a request that includes all optional parameters
# results = AccessRequestsApi(api_client).set_access_request_config(new_access_request_config)
print("The response of AccessRequestsApi->set_access_request_config:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling AccessRequestsApi->set_access_request_config: %s\n" % e)
```