mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 04:19:37 +00:00
Update python SDK docs: 15446993818
This commit is contained in:
developer-relations-sp
@@ -26,7 +26,7 @@ Name | Type | Description | Notes
|
||||
from sailpoint.beta.models.account_usage import AccountUsage
|
||||
|
||||
account_usage = AccountUsage(
|
||||
var_date='Thu Apr 20 20:00:00 EDT 2023',
|
||||
var_date='Fri Apr 21 00:00:00 UTC 2023',
|
||||
count=10
|
||||
)
|
||||
|
||||
|
||||
@@ -56,8 +56,8 @@ data={description=Auditing},
|
||||
approval_status='APPROVED',
|
||||
comment='approved',
|
||||
completion_date='2020-03-24T11:11:41.139-05:00',
|
||||
start_date='Mon Mar 23 20:00:00 EDT 2020',
|
||||
end_date='Wed Mar 24 20:00:00 EDT 2021',
|
||||
start_date='Tue Mar 24 00:00:00 UTC 2020',
|
||||
end_date='Thu Mar 25 00:00:00 UTC 2021',
|
||||
modified='2020-03-24T11:11:41.139-05:00',
|
||||
created='2020-03-24T11:11:41.139-05:00'
|
||||
)
|
||||
|
||||
@@ -26,7 +26,7 @@ Name | Type | Description | Notes
|
||||
from sailpoint.beta.models.source_usage import SourceUsage
|
||||
|
||||
source_usage = SourceUsage(
|
||||
var_date='Thu Apr 20 20:00:00 EDT 2023',
|
||||
var_date='Fri Apr 21 00:00:00 UTC 2023',
|
||||
count=10.45
|
||||
)
|
||||
|
||||
|
||||
@@ -100,6 +100,7 @@ Method | HTTP request | Description
|
||||
[**import-accounts**](#import-accounts) | **POST** `/sources/{id}/load-accounts` | Account aggregation
|
||||
[**import-accounts-schema**](#import-accounts-schema) | **POST** `/sources/{id}/schemas/accounts` | Uploads source accounts schema template
|
||||
[**import-connector-file**](#import-connector-file) | **POST** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source
|
||||
[**import-entitlements**](#import-entitlements) | **POST** `/sources/{sourceId}/load-entitlements` | Entitlement aggregation
|
||||
[**import-entitlements-schema**](#import-entitlements-schema) | **POST** `/sources/{id}/schemas/entitlements` | Uploads source entitlements schema template
|
||||
[**import-uncorrelated-accounts**](#import-uncorrelated-accounts) | **POST** `/sources/{id}/load-uncorrelated-accounts` | Process uncorrelated accounts
|
||||
[**list-provisioning-policies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists provisioningpolicies
|
||||
@@ -2027,6 +2028,83 @@ with ApiClient(configuration) as api_client:
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## import-entitlements
|
||||
:::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
|
||||
```
|
||||
:::
|
||||
Entitlement aggregation
|
||||
Starts an entitlement aggregation on the specified source.
|
||||
If the target source is a delimited file source, then the CSV file needs to be included in the request body.
|
||||
You will also need to set the Content-Type header to `multipart/form-data`.
|
||||
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-entitlements)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | source_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) | The CSV file containing the source entitlements to aggregate.
|
||||
|
||||
### Return type
|
||||
[**LoadEntitlementTask**](../models/load-entitlement-task)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
202 | Aggregate Entitlements Task | LoadEntitlementTask | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
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 | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: multipart/form-data
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.sources_api import SourcesApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.load_entitlement_task import LoadEntitlementTask
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = True
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
source_id = 'ef38f94347e94562b5bb8424a56397d8' # 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 | The CSV file containing the source entitlements to aggregate. (optional) # bytearray | The CSV file containing the source entitlements to aggregate. (optional)
|
||||
|
||||
try:
|
||||
# Entitlement aggregation
|
||||
|
||||
results = SourcesApi(api_client).import_entitlements(source_id=source_id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SourcesApi(api_client).import_entitlements(source_id, x_sail_point_experimental, file)
|
||||
print("The response of SourcesApi->import_entitlements:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling SourcesApi->import_entitlements: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## import-entitlements-schema
|
||||
|
||||
@@ -26,7 +26,7 @@ Name | Type | Description | Notes
|
||||
from sailpoint.v2024.models.account_usage import AccountUsage
|
||||
|
||||
account_usage = AccountUsage(
|
||||
var_date='Thu Apr 20 20:00:00 EDT 2023',
|
||||
var_date='Fri Apr 21 00:00:00 UTC 2023',
|
||||
count=10
|
||||
)
|
||||
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
id: v2024-import-entitlements-request
|
||||
title: ImportEntitlementsRequest
|
||||
pagination_label: ImportEntitlementsRequest
|
||||
sidebar_label: ImportEntitlementsRequest
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ImportEntitlementsRequest', 'V2024ImportEntitlementsRequest']
|
||||
slug: /tools/sdk/python/v2024/models/import-entitlements-request
|
||||
tags: ['SDK', 'Software Development Kit', 'ImportEntitlementsRequest', 'V2024ImportEntitlementsRequest']
|
||||
---
|
||||
|
||||
# ImportEntitlementsRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**file** | **bytearray** | The CSV file containing the source entitlements to aggregate. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.import_entitlements_request import ImportEntitlementsRequest
|
||||
|
||||
import_entitlements_request = ImportEntitlementsRequest(
|
||||
file=bytes(b'blah')
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -56,8 +56,8 @@ data={description=Auditing},
|
||||
approval_status='APPROVED',
|
||||
comment='approved',
|
||||
completion_date='2020-03-24T11:11:41.139-05:00',
|
||||
start_date='Mon Mar 23 20:00:00 EDT 2020',
|
||||
end_date='Wed Mar 24 20:00:00 EDT 2021',
|
||||
start_date='Tue Mar 24 00:00:00 UTC 2020',
|
||||
end_date='Thu Mar 25 00:00:00 UTC 2021',
|
||||
modified='2020-03-24T11:11:41.139-05:00',
|
||||
created='2020-03-24T11:11:41.139-05:00'
|
||||
)
|
||||
|
||||
@@ -26,7 +26,7 @@ Name | Type | Description | Notes
|
||||
from sailpoint.v2024.models.source_usage import SourceUsage
|
||||
|
||||
source_usage = SourceUsage(
|
||||
var_date='Thu Apr 20 20:00:00 EDT 2023',
|
||||
var_date='Fri Apr 21 00:00:00 UTC 2023',
|
||||
count=10.45
|
||||
)
|
||||
|
||||
|
||||
@@ -100,6 +100,7 @@ Method | HTTP request | Description
|
||||
[**import-accounts**](#import-accounts) | **POST** `/sources/{id}/load-accounts` | Account aggregation
|
||||
[**import-accounts-schema**](#import-accounts-schema) | **POST** `/sources/{id}/schemas/accounts` | Uploads source accounts schema template
|
||||
[**import-connector-file**](#import-connector-file) | **POST** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source
|
||||
[**import-entitlements**](#import-entitlements) | **POST** `/sources/{sourceId}/load-entitlements` | Entitlement aggregation
|
||||
[**import-entitlements-schema**](#import-entitlements-schema) | **POST** `/sources/{id}/schemas/entitlements` | Uploads source entitlements schema template
|
||||
[**import-uncorrelated-accounts**](#import-uncorrelated-accounts) | **POST** `/sources/{id}/load-uncorrelated-accounts` | Process uncorrelated accounts
|
||||
[**list-provisioning-policies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists provisioningpolicies
|
||||
@@ -2013,6 +2014,83 @@ with ApiClient(configuration) as api_client:
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## import-entitlements
|
||||
:::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
|
||||
```
|
||||
:::
|
||||
Entitlement aggregation
|
||||
Starts an entitlement aggregation on the specified source.
|
||||
If the target source is a delimited file source, then the CSV file needs to be included in the request body.
|
||||
You will also need to set the Content-Type header to `multipart/form-data`.
|
||||
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/import-entitlements)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | source_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) | The CSV file containing the source entitlements to aggregate.
|
||||
|
||||
### Return type
|
||||
[**LoadEntitlementTask**](../models/load-entitlement-task)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
202 | Aggregate Entitlements Task | LoadEntitlementTask | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
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 | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: multipart/form-data
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2025.api.sources_api import SourcesApi
|
||||
from sailpoint.v2025.api_client import ApiClient
|
||||
from sailpoint.v2025.models.load_entitlement_task import LoadEntitlementTask
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = True
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
source_id = 'ef38f94347e94562b5bb8424a56397d8' # 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 | The CSV file containing the source entitlements to aggregate. (optional) # bytearray | The CSV file containing the source entitlements to aggregate. (optional)
|
||||
|
||||
try:
|
||||
# Entitlement aggregation
|
||||
|
||||
results = SourcesApi(api_client).import_entitlements(source_id=source_id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SourcesApi(api_client).import_entitlements(source_id, x_sail_point_experimental, file)
|
||||
print("The response of SourcesApi->import_entitlements:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling SourcesApi->import_entitlements: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## import-entitlements-schema
|
||||
|
||||
@@ -26,7 +26,7 @@ Name | Type | Description | Notes
|
||||
from sailpoint.v2025.models.account_usage import AccountUsage
|
||||
|
||||
account_usage = AccountUsage(
|
||||
var_date='Thu Apr 20 20:00:00 EDT 2023',
|
||||
var_date='Fri Apr 21 00:00:00 UTC 2023',
|
||||
count=10
|
||||
)
|
||||
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
id: v2025-import-entitlements-request
|
||||
title: ImportEntitlementsRequest
|
||||
pagination_label: ImportEntitlementsRequest
|
||||
sidebar_label: ImportEntitlementsRequest
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ImportEntitlementsRequest', 'V2025ImportEntitlementsRequest']
|
||||
slug: /tools/sdk/python/v2025/models/import-entitlements-request
|
||||
tags: ['SDK', 'Software Development Kit', 'ImportEntitlementsRequest', 'V2025ImportEntitlementsRequest']
|
||||
---
|
||||
|
||||
# ImportEntitlementsRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**file** | **bytearray** | The CSV file containing the source entitlements to aggregate. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2025.models.import_entitlements_request import ImportEntitlementsRequest
|
||||
|
||||
import_entitlements_request = ImportEntitlementsRequest(
|
||||
file=bytes(b'blah')
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -56,8 +56,8 @@ data={description=Auditing},
|
||||
approval_status='APPROVED',
|
||||
comment='approved',
|
||||
completion_date='2020-03-24T11:11:41.139-05:00',
|
||||
start_date='Mon Mar 23 20:00:00 EDT 2020',
|
||||
end_date='Wed Mar 24 20:00:00 EDT 2021',
|
||||
start_date='Tue Mar 24 00:00:00 UTC 2020',
|
||||
end_date='Thu Mar 25 00:00:00 UTC 2021',
|
||||
modified='2020-03-24T11:11:41.139-05:00',
|
||||
created='2020-03-24T11:11:41.139-05:00'
|
||||
)
|
||||
|
||||
@@ -26,7 +26,7 @@ Name | Type | Description | Notes
|
||||
from sailpoint.v2025.models.source_usage import SourceUsage
|
||||
|
||||
source_usage = SourceUsage(
|
||||
var_date='Thu Apr 20 20:00:00 EDT 2023',
|
||||
var_date='Fri Apr 21 00:00:00 UTC 2023',
|
||||
count=10.45
|
||||
)
|
||||
|
||||
|
||||
@@ -26,7 +26,7 @@ Name | Type | Description | Notes
|
||||
from sailpoint.v3.models.account_usage import AccountUsage
|
||||
|
||||
account_usage = AccountUsage(
|
||||
var_date='Thu Apr 20 20:00:00 EDT 2023',
|
||||
var_date='Fri Apr 21 00:00:00 UTC 2023',
|
||||
count=10
|
||||
)
|
||||
|
||||
|
||||
@@ -56,8 +56,8 @@ data={description=Auditing},
|
||||
approval_status='APPROVED',
|
||||
comment='approved',
|
||||
completion_date='2020-03-24T11:11:41.139-05:00',
|
||||
start_date='Mon Mar 23 20:00:00 EDT 2020',
|
||||
end_date='Wed Mar 24 20:00:00 EDT 2021',
|
||||
start_date='Tue Mar 24 00:00:00 UTC 2020',
|
||||
end_date='Thu Mar 25 00:00:00 UTC 2021',
|
||||
modified='2020-03-24T11:11:41.139-05:00',
|
||||
created='2020-03-24T11:11:41.139-05:00'
|
||||
)
|
||||
|
||||
@@ -26,7 +26,7 @@ Name | Type | Description | Notes
|
||||
from sailpoint.v3.models.source_usage import SourceUsage
|
||||
|
||||
source_usage = SourceUsage(
|
||||
var_date='Thu Apr 20 20:00:00 EDT 2023',
|
||||
var_date='Fri Apr 21 00:00:00 UTC 2023',
|
||||
count=10.45
|
||||
)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user