mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 04:19:37 +00:00
Update to python SDK docs: 13820107626
This commit is contained in:
@@ -32,6 +32,14 @@ Method | HTTP request | Description
|
||||
:::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
|
||||
```
|
||||
:::
|
||||
Gets a difference of count for each access item types for the given identity between 2 snapshots
|
||||
This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read'
|
||||
|
||||
@@ -70,7 +78,6 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.identity_compare_response import IdentityCompareResponse
|
||||
@@ -78,14 +85,14 @@ from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = true
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = '8c190e6787aa4ed9a90bd9d5344523fb' # 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')
|
||||
snapshot1 = '2007-03-01T13:00:00Z' # str | The snapshot 1 of identity (optional) # str | The snapshot 1 of identity (optional)
|
||||
snapshot2 = '2008-03-01T13:00:00Z' # str | The snapshot 2 of identity (optional) # str | The snapshot 2 of identity (optional)
|
||||
access_item_types = ['access_item_types_example'] # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional)
|
||||
|
||||
access_item_types = ['access_item_types_example'] # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional)
|
||||
access_item_types = '''['access_item_types_example']''' # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional)
|
||||
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
||||
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)
|
||||
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)
|
||||
@@ -93,12 +100,12 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# Gets a difference of count for each access item types for the given identity between 2 snapshots
|
||||
|
||||
results =IdentityHistoryApi(api_client).compare_identity_snapshots(id, x_sail_point_experimental, )
|
||||
results = IdentityHistoryApi(api_client).compare_identity_snapshots(id=id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = IdentityHistoryApi(api_client).compare_identity_snapshots(id, x_sail_point_experimental, snapshot1, snapshot2, access_item_types, limit, offset, count)
|
||||
print("The response of IdentityHistoryApi->compare_identity_snapshots:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -110,6 +117,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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
|
||||
```
|
||||
:::
|
||||
Gets a list of differences of specific accessType for the given identity between 2 snapshots
|
||||
This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read'
|
||||
|
||||
@@ -149,7 +164,6 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.access_item_diff import AccessItemDiff
|
||||
@@ -157,6 +171,8 @@ from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = true
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
|
||||
access_type = 'role' # str | The specific type which needs to be compared # str | The specific type which needs to be compared
|
||||
@@ -171,12 +187,12 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# Gets a list of differences of specific accessType for the given identity between 2 snapshots
|
||||
|
||||
results =IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, x_sail_point_experimental, )
|
||||
results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id=id, access_type=access_type, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, x_sail_point_experimental, access_associated, snapshot1, snapshot2, limit, offset, count)
|
||||
print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -188,6 +204,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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 latest snapshot of identity
|
||||
This method retrieves a specified identity Requires authorization scope of 'idn:identity-history:read'
|
||||
|
||||
@@ -220,7 +244,6 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.identity_history_response import IdentityHistoryResponse
|
||||
@@ -228,6 +251,8 @@ from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = true
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = '8c190e6787aa4ed9a90bd9d5344523fb' # 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')
|
||||
@@ -235,12 +260,12 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# Get latest snapshot of identity
|
||||
|
||||
results =IdentityHistoryApi(api_client).get_historical_identity(id, x_sail_point_experimental)
|
||||
results = IdentityHistoryApi(api_client).get_historical_identity(id=id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = IdentityHistoryApi(api_client).get_historical_identity(id, x_sail_point_experimental)
|
||||
print("The response of IdentityHistoryApi->get_historical_identity:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling IdentityHistoryApi->get_historical_identity: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -252,6 +277,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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
|
||||
```
|
||||
:::
|
||||
Lists all events for the given identity
|
||||
This method retrieves all access events for the identity Requires authorization scope of 'idn:identity-history:read'
|
||||
|
||||
@@ -291,7 +324,6 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.get_historical_identity_events200_response_inner import GetHistoricalIdentityEvents200ResponseInner
|
||||
@@ -299,16 +331,14 @@ from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = true
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = '8c190e6787aa4ed9a90bd9d5344523fb' # 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')
|
||||
var_from = '2024-03-01T13:00:00Z' # str | The optional instant until which access events are returned (optional) # str | The optional instant until which access events are returned (optional)
|
||||
event_types = ['[AccessAddedEvent, AccessRemovedEvent]'] # List[str] | An optional list of event types to return. If null or empty, all events are returned (optional)
|
||||
|
||||
event_types = ['[AccessAddedEvent, AccessRemovedEvent]'] # List[str] | An optional list of event types to return. If null or empty, all events are returned (optional)
|
||||
access_item_types = ['[entitlement, account]'] # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional)
|
||||
|
||||
access_item_types = ['[entitlement, account]'] # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional)
|
||||
event_types = '''['[AccessAddedEvent, AccessRemovedEvent]']''' # List[str] | An optional list of event types to return. If null or empty, all events are returned (optional)
|
||||
access_item_types = '''['[entitlement, account]']''' # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional)
|
||||
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
||||
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)
|
||||
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)
|
||||
@@ -316,12 +346,12 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# Lists all events for the given identity
|
||||
|
||||
results =IdentityHistoryApi(api_client).get_historical_identity_events(id, x_sail_point_experimental, )
|
||||
results = IdentityHistoryApi(api_client).get_historical_identity_events(id=id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = IdentityHistoryApi(api_client).get_historical_identity_events(id, x_sail_point_experimental, var_from, event_types, access_item_types, limit, offset, count)
|
||||
print("The response of IdentityHistoryApi->get_historical_identity_events:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -333,6 +363,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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
|
||||
```
|
||||
:::
|
||||
Gets an identity snapshot at a given date
|
||||
This method retrieves a specified identity snapshot at a given date Requires authorization scope of 'idn:identity-history:read'
|
||||
|
||||
@@ -366,7 +404,6 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.identity_history_response import IdentityHistoryResponse
|
||||
@@ -374,6 +411,8 @@ from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = true
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
|
||||
var_date = '2007-03-01T13:00:00Z' # str | The specified date # str | The specified date
|
||||
@@ -382,12 +421,12 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# Gets an identity snapshot at a given date
|
||||
|
||||
results =IdentityHistoryApi(api_client).get_identity_snapshot(id, var_date, x_sail_point_experimental)
|
||||
results = IdentityHistoryApi(api_client).get_identity_snapshot(id=id, var_date=var_date, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = IdentityHistoryApi(api_client).get_identity_snapshot(id, var_date, x_sail_point_experimental)
|
||||
print("The response of IdentityHistoryApi->get_identity_snapshot:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling IdentityHistoryApi->get_identity_snapshot: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -399,6 +438,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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
|
||||
```
|
||||
:::
|
||||
Gets the summary for the event count for a specific identity
|
||||
This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of 'idn:identity-history:read'
|
||||
|
||||
@@ -437,7 +484,6 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.metric_response import MetricResponse
|
||||
@@ -445,6 +491,8 @@ from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = true
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = '8c190e6787aa4ed9a90bd9d5344523fb' # 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')
|
||||
@@ -458,12 +506,12 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# Gets the summary for the event count for a specific identity
|
||||
|
||||
results =IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, x_sail_point_experimental, )
|
||||
results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id=id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, x_sail_point_experimental, before, interval, time_zone, limit, offset, count)
|
||||
print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -475,6 +523,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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
|
||||
```
|
||||
:::
|
||||
Gets the start date of the identity
|
||||
This method retrieves start date of the identity Requires authorization scope of 'idn:identity-history:read'
|
||||
|
||||
@@ -507,13 +563,14 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = true
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = '8c190e6787aa4ed9a90bd9d5344523fb' # 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')
|
||||
@@ -521,12 +578,12 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# Gets the start date of the identity
|
||||
|
||||
results =IdentityHistoryApi(api_client).get_identity_start_date(id, x_sail_point_experimental)
|
||||
results = IdentityHistoryApi(api_client).get_identity_start_date(id=id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = IdentityHistoryApi(api_client).get_identity_start_date(id, x_sail_point_experimental)
|
||||
print("The response of IdentityHistoryApi->get_identity_start_date:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling IdentityHistoryApi->get_identity_start_date: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -538,6 +595,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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
|
||||
```
|
||||
:::
|
||||
Lists all the identities
|
||||
This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of 'idn:identity-history:read'
|
||||
|
||||
@@ -574,7 +639,6 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.identity_list_item import IdentityListItem
|
||||
@@ -582,6 +646,8 @@ from pprint import pprint
|
||||
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')
|
||||
starts_with_query = 'Ada' # str | This param is used for starts-with search for first, last and display name of the identity (optional) # str | This param is used for starts-with search for first, last and display name of the identity (optional)
|
||||
@@ -593,12 +659,12 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# Lists all the identities
|
||||
|
||||
results =IdentityHistoryApi(api_client).list_historical_identities(x_sail_point_experimental, )
|
||||
results = IdentityHistoryApi(api_client).list_historical_identities(x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = IdentityHistoryApi(api_client).list_historical_identities(x_sail_point_experimental, starts_with_query, is_deleted, is_active, limit, offset)
|
||||
print("The response of IdentityHistoryApi->list_historical_identities:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -610,6 +676,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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
|
||||
```
|
||||
:::
|
||||
List Access Items by Identity
|
||||
This method retrieves a list of access item for the identity filtered by the access item type
|
||||
|
||||
@@ -648,7 +722,6 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner
|
||||
@@ -656,6 +729,8 @@ from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = true
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = '8c190e6787aa4ed9a90bd9d5344523fb' # 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')
|
||||
@@ -667,12 +742,12 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# List Access Items by Identity
|
||||
|
||||
results =IdentityHistoryApi(api_client).list_identity_access_items(id, x_sail_point_experimental, )
|
||||
results = IdentityHistoryApi(api_client).list_identity_access_items(id=id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = IdentityHistoryApi(api_client).list_identity_access_items(id, x_sail_point_experimental, type, limit, count, offset)
|
||||
print("The response of IdentityHistoryApi->list_identity_access_items:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -684,6 +759,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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
|
||||
```
|
||||
:::
|
||||
Gets the list of identity access items at a given date filterd by item type
|
||||
This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of 'idn:identity-history:read'
|
||||
|
||||
@@ -718,7 +801,6 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner
|
||||
@@ -726,6 +808,8 @@ from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = true
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
|
||||
var_date = '2007-03-01T13:00:00Z' # str | The specified date # str | The specified date
|
||||
@@ -735,12 +819,12 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# Gets the list of identity access items at a given date filterd by item type
|
||||
|
||||
results =IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, )
|
||||
results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id=id, var_date=var_date, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, type)
|
||||
print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -752,6 +836,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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
|
||||
```
|
||||
:::
|
||||
Lists all the snapshots for the identity
|
||||
This method retrieves all the snapshots for the identity Requires authorization scope of 'idn:identity-history:read'
|
||||
|
||||
@@ -789,7 +881,6 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.identity_snapshot_summary_response import IdentitySnapshotSummaryResponse
|
||||
@@ -797,6 +888,8 @@ from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = true
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = '8c190e6787aa4ed9a90bd9d5344523fb' # 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')
|
||||
@@ -809,12 +902,12 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# Lists all the snapshots for the identity
|
||||
|
||||
results =IdentityHistoryApi(api_client).list_identity_snapshots(id, x_sail_point_experimental, )
|
||||
results = IdentityHistoryApi(api_client).list_identity_snapshots(id=id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = IdentityHistoryApi(api_client).list_identity_snapshots(id, x_sail_point_experimental, start, interval, limit, offset, count)
|
||||
print("The response of IdentityHistoryApi->list_identity_snapshots:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user