mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 12:27:47 +00:00
Update python SDK docs: 16269863689
This commit is contained in:
developer-relations-sp
@@ -232,17 +232,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## close-access-request
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Close access request
|
||||
This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request's lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/).
|
||||
|
||||
@@ -263,7 +252,6 @@ This API triggers the [Provisioning Completed event trigger](https://developer.s
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Body | close_access_request | [**CloseAccessRequest**](../models/close-access-request) | True |
|
||||
|
||||
### Return type
|
||||
@@ -292,10 +280,8 @@ from sailpoint.v2025.models.close_access_request import CloseAccessRequest
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = True
|
||||
|
||||
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",
|
||||
"accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
|
||||
@@ -306,9 +292,9 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# Close access request
|
||||
new_close_access_request = CloseAccessRequest.from_json(close_access_request)
|
||||
results = AccessRequestsApi(api_client).close_access_request(x_sail_point_experimental=x_sail_point_experimental, close_access_request=new_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(x_sail_point_experimental, new_close_access_request)
|
||||
# results = AccessRequestsApi(api_client).close_access_request(new_close_access_request)
|
||||
print("The response of AccessRequestsApi->close_access_request:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
|
||||
@@ -29,17 +29,6 @@ Method | HTTP request | Description
|
||||
|
||||
|
||||
## get-account-aggregation-status
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
In-progress account aggregation status
|
||||
This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far.
|
||||
|
||||
@@ -57,7 +46,6 @@ required to call this API.
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | The account aggregation id
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**AccountAggregationStatus**](../models/account-aggregation-status)
|
||||
@@ -66,6 +54,7 @@ Path | id | **str** | True | The account aggregation id
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | An account aggregation status object | AccountAggregationStatus | - |
|
||||
400 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
@@ -85,18 +74,16 @@ from sailpoint.v2025.models.account_aggregation_status import AccountAggregation
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = True
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = '2c91808477a6b0c60177a81146b8110b' # str | The account aggregation id # str | The account aggregation id
|
||||
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')
|
||||
|
||||
try:
|
||||
# In-progress account aggregation status
|
||||
|
||||
results = AccountAggregationsApi(api_client).get_account_aggregation_status(id=id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
results = AccountAggregationsApi(api_client).get_account_aggregation_status(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = AccountAggregationsApi(api_client).get_account_aggregation_status(id, x_sail_point_experimental)
|
||||
# results = AccountAggregationsApi(api_client).get_account_aggregation_status(id)
|
||||
print("The response of AccountAggregationsApi->get_account_aggregation_status:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
|
||||
@@ -202,17 +202,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-account-async
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Remove account
|
||||
Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation.
|
||||
|
||||
@@ -229,7 +218,6 @@ This endpoint is good for:
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | The account id
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**TaskResultDto**](../models/task-result-dto)
|
||||
@@ -257,18 +245,16 @@ from sailpoint.v2025.models.task_result_dto import TaskResultDto
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = True
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'c350d6aa4f104c61b062cb632421ad10' # str | The account id # str | The account id
|
||||
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')
|
||||
|
||||
try:
|
||||
# Remove account
|
||||
|
||||
results = AccountsApi(api_client).delete_account_async(id=id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
results = AccountsApi(api_client).delete_account_async(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = AccountsApi(api_client).delete_account_async(id, x_sail_point_experimental)
|
||||
# results = AccountsApi(api_client).delete_account_async(id)
|
||||
print("The response of AccountsApi->delete_account_async:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
@@ -345,17 +331,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## disable-account-for-identity
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Disable idn account for identity
|
||||
This API submits a task to disable IDN account for a single identity.
|
||||
|
||||
@@ -366,7 +341,6 @@ This API submits a task to disable IDN account for a single identity.
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | The identity id.
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
**object**
|
||||
@@ -394,18 +368,16 @@ from sailpoint.v2025.api_client import ApiClient
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = True
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id.
|
||||
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')
|
||||
|
||||
try:
|
||||
# Disable idn account for identity
|
||||
|
||||
results = AccountsApi(api_client).disable_account_for_identity(id=id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
results = AccountsApi(api_client).disable_account_for_identity(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = AccountsApi(api_client).disable_account_for_identity(id, x_sail_point_experimental)
|
||||
# results = AccountsApi(api_client).disable_account_for_identity(id)
|
||||
print("The response of AccountsApi->disable_account_for_identity:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
@@ -417,17 +389,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## disable-accounts-for-identities
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Disable idn accounts for identities
|
||||
This API submits tasks to disable IDN account for each identity provided in the request body.
|
||||
|
||||
@@ -437,7 +398,6 @@ This API submits tasks to disable IDN account for each identity provided in the
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Body | identities_accounts_bulk_request | [**IdentitiesAccountsBulkRequest**](../models/identities-accounts-bulk-request) | True |
|
||||
|
||||
### Return type
|
||||
@@ -467,10 +427,8 @@ from sailpoint.v2025.models.identities_accounts_bulk_request import IdentitiesAc
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = True
|
||||
|
||||
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')
|
||||
identities_accounts_bulk_request = '''{
|
||||
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
|
||||
}''' # IdentitiesAccountsBulkRequest |
|
||||
@@ -478,9 +436,9 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# Disable idn accounts for identities
|
||||
new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest.from_json(identities_accounts_bulk_request)
|
||||
results = AccountsApi(api_client).disable_accounts_for_identities(x_sail_point_experimental=x_sail_point_experimental, identities_accounts_bulk_request=new_identities_accounts_bulk_request)
|
||||
results = AccountsApi(api_client).disable_accounts_for_identities(identities_accounts_bulk_request=new_identities_accounts_bulk_request)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = AccountsApi(api_client).disable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request)
|
||||
# results = AccountsApi(api_client).disable_accounts_for_identities(new_identities_accounts_bulk_request)
|
||||
print("The response of AccountsApi->disable_accounts_for_identities:\n")
|
||||
for item in results:
|
||||
print(item.model_dump_json(by_alias=True, indent=4))
|
||||
@@ -558,17 +516,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## enable-account-for-identity
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Enable idn account for identity
|
||||
This API submits a task to enable IDN account for a single identity.
|
||||
|
||||
@@ -579,7 +526,6 @@ This API submits a task to enable IDN account for a single identity.
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | The identity id.
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
**object**
|
||||
@@ -607,18 +553,16 @@ from sailpoint.v2025.api_client import ApiClient
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = True
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id.
|
||||
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')
|
||||
|
||||
try:
|
||||
# Enable idn account for identity
|
||||
|
||||
results = AccountsApi(api_client).enable_account_for_identity(id=id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
results = AccountsApi(api_client).enable_account_for_identity(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = AccountsApi(api_client).enable_account_for_identity(id, x_sail_point_experimental)
|
||||
# results = AccountsApi(api_client).enable_account_for_identity(id)
|
||||
print("The response of AccountsApi->enable_account_for_identity:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
@@ -630,17 +574,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## enable-accounts-for-identities
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Enable idn accounts for identities
|
||||
This API submits tasks to enable IDN account for each identity provided in the request body.
|
||||
|
||||
@@ -650,7 +583,6 @@ This API submits tasks to enable IDN account for each identity provided in the r
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Body | identities_accounts_bulk_request | [**IdentitiesAccountsBulkRequest**](../models/identities-accounts-bulk-request) | True |
|
||||
|
||||
### Return type
|
||||
@@ -680,10 +612,8 @@ from sailpoint.v2025.models.identities_accounts_bulk_request import IdentitiesAc
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = True
|
||||
|
||||
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')
|
||||
identities_accounts_bulk_request = '''{
|
||||
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
|
||||
}''' # IdentitiesAccountsBulkRequest |
|
||||
@@ -691,9 +621,9 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# Enable idn accounts for identities
|
||||
new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest.from_json(identities_accounts_bulk_request)
|
||||
results = AccountsApi(api_client).enable_accounts_for_identities(x_sail_point_experimental=x_sail_point_experimental, identities_accounts_bulk_request=new_identities_accounts_bulk_request)
|
||||
results = AccountsApi(api_client).enable_accounts_for_identities(identities_accounts_bulk_request=new_identities_accounts_bulk_request)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = AccountsApi(api_client).enable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request)
|
||||
# results = AccountsApi(api_client).enable_accounts_for_identities(new_identities_accounts_bulk_request)
|
||||
print("The response of AccountsApi->enable_accounts_for_identities:\n")
|
||||
for item in results:
|
||||
print(item.model_dump_json(by_alias=True, indent=4))
|
||||
|
||||
@@ -649,7 +649,7 @@ Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Query | account_id | **str** | (optional) | 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).
|
||||
Query | segmented_for_identity | **str** | (optional) | 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.
|
||||
Query | segmented_for_identity | **str** | (optional) | 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. 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.
|
||||
Query | for_segment_ids | **str** | (optional) | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s).
|
||||
Query | include_unsegmented | **bool** | (optional) (default to True) | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error.
|
||||
Query | offset | **int** | (optional) (default to 0) | 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.
|
||||
@@ -689,7 +689,7 @@ configuration.experimental = True
|
||||
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')
|
||||
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). (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). (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)
|
||||
segmented_for_identity = 'e554098913544630b5985e9042f5e44b' # 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. 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. 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)
|
||||
for_segment_ids = '041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649' # str | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) # str | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional)
|
||||
include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to True)
|
||||
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)
|
||||
|
||||
@@ -23,27 +23,13 @@ Method | HTTP request | Description
|
||||
|
||||
|
||||
## get-org-config
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Get org config settings
|
||||
Get the current organization's configuration settings, only external accessible properties.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-org-config)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
[**OrgConfig**](../models/org-config)
|
||||
@@ -72,17 +58,15 @@ from sailpoint.v2025.models.org_config import OrgConfig
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = True
|
||||
|
||||
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')
|
||||
|
||||
try:
|
||||
# Get org config settings
|
||||
|
||||
results = OrgConfigApi(api_client).get_org_config(x_sail_point_experimental=x_sail_point_experimental)
|
||||
results = OrgConfigApi(api_client).get_org_config()
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = OrgConfigApi(api_client).get_org_config(x_sail_point_experimental)
|
||||
# results = OrgConfigApi(api_client).get_org_config()
|
||||
print("The response of OrgConfigApi->get_org_config:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
@@ -170,17 +154,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## patch-org-config
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Patch org config
|
||||
Patch the current organization's configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization's time zone.
|
||||
|
||||
@@ -190,7 +163,6 @@ Patch the current organization's configuration, using http://jsonpatch.com/ synt
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
||||
|
||||
### Return type
|
||||
@@ -221,18 +193,16 @@ from sailpoint.v2025.models.org_config import OrgConfig
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = True
|
||||
|
||||
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')
|
||||
json_patch_operation = '''[{op=replace, path=/timeZone, value=America/Toronto}]''' # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
||||
|
||||
try:
|
||||
# Patch org config
|
||||
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
|
||||
results = OrgConfigApi(api_client).patch_org_config(x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation)
|
||||
results = OrgConfigApi(api_client).patch_org_config(json_patch_operation=new_json_patch_operation)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = OrgConfigApi(api_client).patch_org_config(x_sail_point_experimental, new_json_patch_operation)
|
||||
# results = OrgConfigApi(api_client).patch_org_config(new_json_patch_operation)
|
||||
print("The response of OrgConfigApi->patch_org_config:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
|
||||
@@ -24,6 +24,7 @@ Method | HTTP request | Description
|
||||
## list-requestable-objects
|
||||
Requestable objects list
|
||||
Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter.
|
||||
This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter.
|
||||
Any authenticated token can call this endpoint to see their requestable access items.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-requestable-objects)
|
||||
|
||||
@@ -76,7 +76,7 @@ Method | HTTP request | Description
|
||||
[**create-source**](#create-source) | **POST** `/sources` | Creates a source in identitynow.
|
||||
[**create-source-schedule**](#create-source-schedule) | **POST** `/sources/{sourceId}/schedules` | Create schedule on source
|
||||
[**create-source-schema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create schema on source
|
||||
[**delete-accounts-async**](#delete-accounts-async) | **POST** `/sources/{id}/remove-accounts` | Remove all accounts in a source
|
||||
[**delete-accounts-async**](#delete-accounts-async) | **POST** `/sources/{id}/remove-accounts` | Remove all accounts in source
|
||||
[**delete-native-change-detection-config**](#delete-native-change-detection-config) | **DELETE** `/sources/{sourceId}/native-change-detection-config` | Delete native change detection configuration
|
||||
[**delete-provisioning-policy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete provisioning policy by usagetype
|
||||
[**delete-source**](#delete-source) | **DELETE** `/sources/{id}` | Delete source by id
|
||||
@@ -492,18 +492,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-accounts-async
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Remove all accounts in a source
|
||||
Remove all accounts in source
|
||||
Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation.
|
||||
|
||||
This endpoint is good for:
|
||||
@@ -519,7 +508,6 @@ This endpoint is good for:
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | The source id
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**TaskResultDto**](../models/task-result-dto)
|
||||
@@ -547,18 +535,16 @@ from sailpoint.v2025.models.task_result_dto import TaskResultDto
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = True
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'ebbf35756e1140699ce52b233121384a' # str | The source id # str | The source id
|
||||
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')
|
||||
|
||||
try:
|
||||
# Remove all accounts in a source
|
||||
# Remove all accounts in source
|
||||
|
||||
results = SourcesApi(api_client).delete_accounts_async(id=id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
results = SourcesApi(api_client).delete_accounts_async(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SourcesApi(api_client).delete_accounts_async(id, x_sail_point_experimental)
|
||||
# results = SourcesApi(api_client).delete_accounts_async(id)
|
||||
print("The response of SourcesApi->delete_accounts_async:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
@@ -2134,17 +2120,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## import-uncorrelated-accounts
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Process uncorrelated accounts
|
||||
File is required for upload. You will also need to set the Content-Type header to `multipart/form-data`
|
||||
|
||||
@@ -2155,7 +2130,6 @@ File is required for upload. You will also need to set the Content-Type header t
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | Source Id
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
| file | **bytearray** | (optional) |
|
||||
|
||||
### Return type
|
||||
@@ -2184,19 +2158,17 @@ from sailpoint.v2025.models.load_uncorrelated_accounts_task import LoadUncorrela
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = True
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = '75dbec1ebe154d5785da27b95e1dd5d7' # str | Source Id # str | Source Id
|
||||
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')
|
||||
file = None # bytearray | (optional) # bytearray | (optional)
|
||||
|
||||
try:
|
||||
# Process uncorrelated accounts
|
||||
|
||||
results = SourcesApi(api_client).import_uncorrelated_accounts(id=id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
results = SourcesApi(api_client).import_uncorrelated_accounts(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SourcesApi(api_client).import_uncorrelated_accounts(id, x_sail_point_experimental, file)
|
||||
# results = SourcesApi(api_client).import_uncorrelated_accounts(id, file)
|
||||
print("The response of SourcesApi->import_uncorrelated_accounts:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
|
||||
Reference in New Issue
Block a user