LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update python SDK docs: 16971661330

Browse Source
This commit is contained in:
developer-relations-sp
2025-08-14 17:03:25 +00:00
parent dd751e3100
commit 182ea28187
39 changed files with 3296 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/tools/sdk/python/Reference/Beta/Methods/CertificationCampaignsApi.md
View File

@@ -206,7 +206,7 @@ Param Type | Name | Data Type | Required | Description
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | This response indicates that the requested campaign was successfully created, and the API returns its representation. | Campaign | - |
202 | This response indicates that the requested campaign has been successfully accepted into the system, and its representation is returned by the API. | Campaign | - |
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. | ListAccessModelMetadataAttribute401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |

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

@@ -36,6 +36,7 @@ Method | HTTP request | Description
[**close-access-request**](#close-access-request) | **POST** `/access-requests/close` | Close access request
[**create-access-request**](#create-access-request) | **POST** `/access-requests` | Submit access request
[**get-access-request-config**](#get-access-request-config) | **GET** `/access-request-config` | Get access request configuration
[**get-entitlement-details-for-identity**](#get-entitlement-details-for-identity) | **GET** `/revocable-objects` | Identity entitlement details
[**list-access-request-status**](#list-access-request-status) | **GET** `/access-request-status` | Access request status
[**list-administrators-access-request-status**](#list-administrators-access-request-status) | **GET** `/access-request-administration` | Access request status for administrators
[**load-account-selections**](#load-account-selections) | **POST** `/access-requests/accounts-selection` | Get accounts selections for identity
@@ -609,6 +610,81 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-entitlement-details-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
```
:::
Identity entitlement details
Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement-details-for-identity)
### 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.
Path | identity_id | **str** | True | The identity ID.
Path | entitlement_id | **str** | True | The entitlement ID
### Return type
[**IdentityEntitlementDetails**](../models/identity-entitlement-details)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | Entitlement and Account Reference | IdentityEntitlementDetails | - |
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 | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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**: Not defined
- **Accept**: application/json
### Example
```python
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_entitlement_details import IdentityEntitlementDetails
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')
identity_id = '7025c863c2704ba6beeaedf3cb091573' # str | The identity ID. # str | The identity ID.
entitlement_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The entitlement ID # str | The entitlement ID
try:
# Identity entitlement details
results = AccessRequestsApi(api_client).get_entitlement_details_for_identity(x_sail_point_experimental=x_sail_point_experimental, identity_id=identity_id, entitlement_id=entitlement_id)
# Below is a request that includes all optional parameters
# results = AccessRequestsApi(api_client).get_entitlement_details_for_identity(x_sail_point_experimental, identity_id, entitlement_id)
print("The response of AccessRequestsApi->get_entitlement_details_for_identity:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling AccessRequestsApi->get_entitlement_details_for_identity: %s\n" % e)
```
[[Back to top]](#)
## list-access-request-status
@@ -783,6 +859,17 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## load-account-selections
:::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 accounts selections for identity
Use this API to fetch account information for an identity against the items in an access request.
@@ -795,6 +882,7 @@ Used to fetch accountSelection for the AccessRequest prior to submitting for asy
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 | accounts_selection_request | [**AccountsSelectionRequest**](../models/accounts-selection-request) | True |
### Return type
@@ -824,8 +912,10 @@ from sailpoint.v2024.models.accounts_selection_response import AccountsSelection
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')
accounts_selection_request = '''{
"requestedFor" : "2c918084660f45d6016617daa9210584",
"clientMetadata" : {
@@ -894,9 +984,9 @@ with ApiClient(configuration) as api_client:
try:
# Get accounts selections for identity
new_accounts_selection_request = AccountsSelectionRequest.from_json(accounts_selection_request)
results = AccessRequestsApi(api_client).load_account_selections(accounts_selection_request=new_accounts_selection_request)
results = AccessRequestsApi(api_client).load_account_selections(x_sail_point_experimental=x_sail_point_experimental, accounts_selection_request=new_accounts_selection_request)
# Below is a request that includes all optional parameters
# results = AccessRequestsApi(api_client).load_account_selections(new_accounts_selection_request)
# results = AccessRequestsApi(api_client).load_account_selections(x_sail_point_experimental, new_accounts_selection_request)
print("The response of AccessRequestsApi->load_account_selections:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:

2
docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md
View File

@@ -196,7 +196,7 @@ Param Type | Name | Data Type | Required | Description
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | This response indicates that the requested campaign was successfully created, and the API returns its representation. | Campaign | - |
202 | This response indicates that the requested campaign has been successfully accepted into the system, and its representation is returned by the API. | Campaign | - |
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 | - |

85
docs/tools/sdk/python/Reference/V2024/Methods/IdentitiesApi.md
View File

@@ -35,6 +35,7 @@ Method | HTTP request | Description
[**get-identity-ownership-details**](#get-identity-ownership-details) | **GET** `/identities/{identityId}/ownership` | Get ownership details
[**get-role-assignment**](#get-role-assignment) | **GET** `/identities/{identityId}/role-assignments/{assignmentId}` | Role assignment details
[**get-role-assignments**](#get-role-assignments) | **GET** `/identities/{identityId}/role-assignments` | List role assignments
[**list-entitlements-by-identity**](#list-entitlements-by-identity) | **GET** `/entitlements/identities/{id}/entitlements` | List of entitlements by identity.
[**list-identities**](#list-identities) | **GET** `/identities` | List identities
[**reset-identity**](#reset-identity) | **POST** `/identities/{id}/reset` | Reset an identity
[**send-identity-verification-account-token**](#send-identity-verification-account-token) | **POST** `/identities/{id}/verification/account/send` | Send password reset email
@@ -342,6 +343,72 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-entitlements-by-identity
List of entitlements by identity.
The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-entitlements-by-identity)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Identity Id
Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
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.
Query | count | **bool** | (optional) (default to False) | 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.
### Return type
[**List[IdentityEntitlements]**](../models/identity-entitlements)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | List of all Entitlements for given Identity | List[IdentityEntitlements] | - |
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 | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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**: Not defined
- **Accept**: application/json
### Example
```python
from sailpoint.v2024.api.identities_api import IdentitiesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_entitlements import IdentityEntitlements
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id
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)
try:
# List of entitlements by identity.
results = IdentitiesApi(api_client).list_entitlements_by_identity(id=id)
# Below is a request that includes all optional parameters
# results = IdentitiesApi(api_client).list_entitlements_by_identity(id, limit, offset, count)
print("The response of IdentitiesApi->list_entitlements_by_identity:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IdentitiesApi->list_entitlements_by_identity: %s\n" % e)
```
[[Back to top]](#)
## list-identities
@@ -547,6 +614,17 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## start-identities-invite
:::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
```
:::
Invite identities to register
This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options.
@@ -561,6 +639,7 @@ The executed task status can be checked by Task Management > [Get task status by
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 | invite_identities_request | [**InviteIdentitiesRequest**](../models/invite-identities-request) | True |
### Return type
@@ -591,8 +670,10 @@ from sailpoint.v2024.models.task_status import TaskStatus
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')
invite_identities_request = '''{
"ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ],
"uninvited" : false
@@ -601,9 +682,9 @@ with ApiClient(configuration) as api_client:
try:
# Invite identities to register
new_invite_identities_request = InviteIdentitiesRequest.from_json(invite_identities_request)
results = IdentitiesApi(api_client).start_identities_invite(invite_identities_request=new_invite_identities_request)
results = IdentitiesApi(api_client).start_identities_invite(x_sail_point_experimental=x_sail_point_experimental, invite_identities_request=new_invite_identities_request)
# Below is a request that includes all optional parameters
# results = IdentitiesApi(api_client).start_identities_invite(new_invite_identities_request)
# results = IdentitiesApi(api_client).start_identities_invite(x_sail_point_experimental, new_invite_identities_request)
print("The response of IdentitiesApi->start_identities_invite:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:

18
docs/tools/sdk/python/Reference/V2024/Methods/IdentityProfilesApi.md
View File

@@ -334,17 +334,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## generate-identity-preview
:::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
```
:::
Generate identity profile preview
This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy''s attribute config is applied.
@@ -354,7 +343,6 @@ This generates a non-persisted IdentityDetails object that will represent as 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 | identity_preview_request | [**IdentityPreviewRequest**](../models/identity-preview-request) | True | Identity Preview request body.
### Return type
@@ -384,10 +372,8 @@ from sailpoint.v2024.models.identity_preview_response import IdentityPreviewResp
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')
identity_preview_request = '''{
"identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"identityAttributeConfig" : {
@@ -419,9 +405,9 @@ with ApiClient(configuration) as api_client:
try:
# Generate identity profile preview
new_identity_preview_request = IdentityPreviewRequest.from_json(identity_preview_request)
results = IdentityProfilesApi(api_client).generate_identity_preview(x_sail_point_experimental=x_sail_point_experimental, identity_preview_request=new_identity_preview_request)
results = IdentityProfilesApi(api_client).generate_identity_preview(identity_preview_request=new_identity_preview_request)
# Below is a request that includes all optional parameters
# results = IdentityProfilesApi(api_client).generate_identity_preview(x_sail_point_experimental, new_identity_preview_request)
# results = IdentityProfilesApi(api_client).generate_identity_preview(new_identity_preview_request)
print("The response of IdentityProfilesApi->generate_identity_preview:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:

406
docs/tools/sdk/python/Reference/V2024/Methods/LaunchersApi.md Normal file
View File

@@ -0,0 +1,406 @@
---
id: v2024-launchers
title: Launchers
pagination_label: Launchers
sidebar_label: Launchers
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'Launchers', 'V2024Launchers']
slug: /tools/sdk/python/v2024/methods/launchers
tags: ['SDK', 'Software Development Kit', 'Launchers', 'V2024Launchers']
---
# sailpoint.v2024.LaunchersApi
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-launcher**](#create-launcher) | **POST** `/launchers` | Create launcher
[**delete-launcher**](#delete-launcher) | **DELETE** `/launchers/{launcherID}` | Delete launcher
[**get-launcher**](#get-launcher) | **GET** `/launchers/{launcherID}` | Get launcher by id
[**get-launchers**](#get-launchers) | **GET** `/launchers` | List all launchers for tenant
[**put-launcher**](#put-launcher) | **PUT** `/launchers/{launcherID}` | Replace launcher
[**start-launcher**](#start-launcher) | **POST** `/launchers/{launcherID}/launch` | Launch a launcher
## create-launcher
Create launcher
Create a Launcher with given information
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-launcher)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Body | launcher_request | [**LauncherRequest**](../models/launcher-request) | True | Payload to create a Launcher
### Return type
[**Launcher**](../models/launcher)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
201 | Launcher created successfully | Launcher | - |
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 | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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**: application/json
- **Accept**: application/json
### Example
```python
from sailpoint.v2024.api.launchers_api import LaunchersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.launcher import Launcher
from sailpoint.v2024.models.launcher_request import LauncherRequest
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
launcher_request = '''{
"reference" : {
"id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5",
"type" : "WORKFLOW"
},
"name" : "Group Create",
"description" : "Create a new Active Directory Group",
"disabled" : false,
"type" : "INTERACTIVE_PROCESS",
"config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}"
}''' # LauncherRequest | Payload to create a Launcher
try:
# Create launcher
new_launcher_request = LauncherRequest.from_json(launcher_request)
results = LaunchersApi(api_client).create_launcher(launcher_request=new_launcher_request)
# Below is a request that includes all optional parameters
# results = LaunchersApi(api_client).create_launcher(new_launcher_request)
print("The response of LaunchersApi->create_launcher:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling LaunchersApi->create_launcher: %s\n" % e)
```
[[Back to top]](#)
## delete-launcher
Delete launcher
Delete the given Launcher ID
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-launcher)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | launcher_id | **str** | True | ID of the Launcher to be deleted
### Return type
(empty response body)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
204 | Launcher deleted successfully | | - |
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 | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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**: Not defined
- **Accept**: application/json
### Example
```python
from sailpoint.v2024.api.launchers_api import LaunchersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be deleted # str | ID of the Launcher to be deleted
try:
# Delete launcher
LaunchersApi(api_client).delete_launcher(launcher_id=launcher_id)
# Below is a request that includes all optional parameters
# LaunchersApi(api_client).delete_launcher(launcher_id)
except Exception as e:
print("Exception when calling LaunchersApi->delete_launcher: %s\n" % e)
```
[[Back to top]](#)
## get-launcher
Get launcher by id
Get details for the given Launcher ID
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-launcher)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | launcher_id | **str** | True | ID of the Launcher to be retrieved
### Return type
[**Launcher**](../models/launcher)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | Launcher retrieved successfully | Launcher | - |
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 | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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**: Not defined
- **Accept**: application/json
### Example
```python
from sailpoint.v2024.api.launchers_api import LaunchersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.launcher import Launcher
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be retrieved # str | ID of the Launcher to be retrieved
try:
# Get launcher by id
results = LaunchersApi(api_client).get_launcher(launcher_id=launcher_id)
# Below is a request that includes all optional parameters
# results = LaunchersApi(api_client).get_launcher(launcher_id)
print("The response of LaunchersApi->get_launcher:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling LaunchersApi->get_launcher: %s\n" % e)
```
[[Back to top]](#)
## get-launchers
List all launchers for tenant
Return a list of Launchers for the authenticated tenant
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-launchers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **description**: *sw* **disabled**: *eq* **name**: *sw*
Query | next | **str** | (optional) | Pagination marker
Query | limit | **int** | (optional) (default to 10) | Number of Launchers to return
### Return type
[**GetLaunchers200Response**](../models/get-launchers200-response)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | List of Launchers | GetLaunchers200Response | - |
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 | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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**: Not defined
- **Accept**: application/json
### Example
```python
from sailpoint.v2024.api.launchers_api import LaunchersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.get_launchers200_response import GetLaunchers200Response
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
filters = 'disabled eq \"true\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional)
next = 'eyJuZXh0IjoxMjN9Cg==' # str | Pagination marker (optional) # str | Pagination marker (optional)
limit = 10 # int | Number of Launchers to return (optional) (default to 10) # int | Number of Launchers to return (optional) (default to 10)
try:
# List all launchers for tenant
results = LaunchersApi(api_client).get_launchers()
# Below is a request that includes all optional parameters
# results = LaunchersApi(api_client).get_launchers(filters, next, limit)
print("The response of LaunchersApi->get_launchers:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling LaunchersApi->get_launchers: %s\n" % e)
```
[[Back to top]](#)
## put-launcher
Replace launcher
Replace the given Launcher ID with given payload
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-launcher)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | launcher_id | **str** | True | ID of the Launcher to be replaced
Body | launcher_request | [**LauncherRequest**](../models/launcher-request) | True | Payload to replace Launcher
### Return type
[**Launcher**](../models/launcher)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | Launcher replaced successfully | Launcher | - |
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 | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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**: application/json
- **Accept**: application/json
### Example
```python
from sailpoint.v2024.api.launchers_api import LaunchersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.launcher import Launcher
from sailpoint.v2024.models.launcher_request import LauncherRequest
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be replaced # str | ID of the Launcher to be replaced
launcher_request = '''{
"reference" : {
"id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5",
"type" : "WORKFLOW"
},
"name" : "Group Create",
"description" : "Create a new Active Directory Group",
"disabled" : false,
"type" : "INTERACTIVE_PROCESS",
"config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}"
}''' # LauncherRequest | Payload to replace Launcher
try:
# Replace launcher
new_launcher_request = LauncherRequest.from_json(launcher_request)
results = LaunchersApi(api_client).put_launcher(launcher_id=launcher_id, launcher_request=new_launcher_request)
# Below is a request that includes all optional parameters
# results = LaunchersApi(api_client).put_launcher(launcher_id, new_launcher_request)
print("The response of LaunchersApi->put_launcher:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling LaunchersApi->put_launcher: %s\n" % e)
```
[[Back to top]](#)
## start-launcher
Launch a launcher
Launch the given Launcher ID
[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-launcher)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | launcher_id | **str** | True | ID of the Launcher to be launched
### Return type
[**StartLauncher200Response**](../models/start-launcher200-response)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | Launcher launched successfully | StartLauncher200Response | - |
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 | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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**: Not defined
- **Accept**: application/json
### Example
```python
from sailpoint.v2024.api.launchers_api import LaunchersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.start_launcher200_response import StartLauncher200Response
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be launched # str | ID of the Launcher to be launched
try:
# Launch a launcher
results = LaunchersApi(api_client).start_launcher(launcher_id=launcher_id)
# Below is a request that includes all optional parameters
# results = LaunchersApi(api_client).start_launcher(launcher_id)
print("The response of LaunchersApi->start_launcher:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling LaunchersApi->start_launcher: %s\n" % e)
```
[[Back to top]](#)

287
docs/tools/sdk/python/Reference/V2024/Methods/TagsApi.md Normal file
View File

@@ -0,0 +1,287 @@
---
id: v2024-tags
title: Tags
pagination_label: Tags
sidebar_label: Tags
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'Tags', 'V2024Tags']
slug: /tools/sdk/python/v2024/methods/tags
tags: ['SDK', 'Software Development Kit', 'Tags', 'V2024Tags']
---
# sailpoint.v2024.TagsApi
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-tag**](#create-tag) | **POST** `/tags` | Create tag
[**delete-tag-by-id**](#delete-tag-by-id) | **DELETE** `/tags/{id}` | Delete tag
[**get-tag-by-id**](#get-tag-by-id) | **GET** `/tags/{id}` | Get tag by id
[**list-tags**](#list-tags) | **GET** `/tags` | List tags
## create-tag
Create tag
This API creates new tag.
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-tag)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Body | tag | [**Tag**](../models/tag) | True |
### Return type
[**Tag**](../models/tag)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
201 | Created tag. | Tag | - |
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**: application/json
- **Accept**: application/json
### Example
```python
from sailpoint.v2024.api.tags_api import TagsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.tag import Tag
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
tag = '''{
"created" : "2022-05-04T14:48:49Z",
"tagCategoryRefs" : [ {
"name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local",
"id" : "2c91809773dee32014e13e122092014e",
"type" : "ENTITLEMENT"
}, {
"name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local",
"id" : "2c91809773dee32014e13e122092014e",
"type" : "ENTITLEMENT"
} ],
"name" : "PCI",
"modified" : "2022-07-14T16:31:11Z",
"id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f"
}''' # Tag |
try:
# Create tag
new_tag = Tag.from_json(tag)
results = TagsApi(api_client).create_tag(tag=new_tag)
# Below is a request that includes all optional parameters
# results = TagsApi(api_client).create_tag(new_tag)
print("The response of TagsApi->create_tag:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling TagsApi->create_tag: %s\n" % e)
```
[[Back to top]](#)
## delete-tag-by-id
Delete tag
This API deletes a tag by specified id.
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-tag-by-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | The ID of the object reference to delete.
### Return type
(empty response body)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
204 | No content. | | - |
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 | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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**: Not defined
- **Accept**: application/json
### Example
```python
from sailpoint.v2024.api.tags_api import TagsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '329d96cf-3bdb-40a9-988a-b5037ab89022' # str | The ID of the object reference to delete. # str | The ID of the object reference to delete.
try:
# Delete tag
TagsApi(api_client).delete_tag_by_id(id=id)
# Below is a request that includes all optional parameters
# TagsApi(api_client).delete_tag_by_id(id)
except Exception as e:
print("Exception when calling TagsApi->delete_tag_by_id: %s\n" % e)
```
[[Back to top]](#)
## get-tag-by-id
Get tag by id
Returns a tag by its id.
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tag-by-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | The ID of the object reference to retrieve.
### Return type
[**Tag**](../models/tag)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | Tag | Tag | - |
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 | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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**: Not defined
- **Accept**: application/json
### Example
```python
from sailpoint.v2024.api.tags_api import TagsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.tag import Tag
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '329d96cf-3bdb-40a9-988a-b5037ab89022' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve.
try:
# Get tag by id
results = TagsApi(api_client).get_tag_by_id(id=id)
# Below is a request that includes all optional parameters
# results = TagsApi(api_client).get_tag_by_id(id)
print("The response of TagsApi->get_tag_by_id:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling TagsApi->get_tag_by_id: %s\n" % e)
```
[[Back to top]](#)
## list-tags
List tags
This API returns a list of tags.
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-tags)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
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.
Query | count | **bool** | (optional) (default to False) | 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.
Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw*
Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified**
### Return type
[**List[Tag]**](../models/tag)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | List of all tags. | List[Tag] | - |
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**: Not defined
- **Accept**: application/json
### Example
```python
from sailpoint.v2024.api.tags_api import TagsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.tag import Tag
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
filters = 'id eq \"27462f54-61c7-4140-b5da-d5dbe27fc6db\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional)
sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified** (optional)
try:
# List tags
results = TagsApi(api_client).list_tags()
# Below is a request that includes all optional parameters
# results = TagsApi(api_client).list_tags(limit, offset, count, filters, sorters)
print("The response of TagsApi->list_tags:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling TagsApi->list_tags: %s\n" % e)
```
[[Back to top]](#)

51
docs/tools/sdk/python/Reference/V2024/Models/GetLaunchers200Response.md Normal file
View File

@@ -0,0 +1,51 @@
---
id: v2024-get-launchers200-response
title: GetLaunchers200Response
pagination_label: GetLaunchers200Response
sidebar_label: GetLaunchers200Response
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'GetLaunchers200Response', 'V2024GetLaunchers200Response']
slug: /tools/sdk/python/v2024/models/get-launchers200-response
tags: ['SDK', 'Software Development Kit', 'GetLaunchers200Response', 'V2024GetLaunchers200Response']
---
# GetLaunchers200Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**next** | **str** | Pagination marker | [optional]
**items** | [**[]Launcher**](launcher) | | [optional]
}
## Example
```python
from sailpoint.v2024.models.get_launchers200_response import GetLaunchers200Response
get_launchers200_response = GetLaunchers200Response(
next='',
items=[
sailpoint.v2024.models.launcher.Launcher(
id = '1b630bed-0941-4792-a712-57a5868ca34d',
created = '2024-04-16T20:07:30.601016489Z',
modified = '2024-04-17T18:02:07.320143194Z',
owner = sailpoint.v2024.models.launcher_owner.Launcher_owner(
type = 'IDENTITY',
id = '123180847373330f0173c7e1756b6890', ),
name = 'Group Create',
description = 'Create a new Active Directory Group',
type = 'INTERACTIVE_PROCESS',
disabled = False,
reference = sailpoint.v2024.models.launcher_reference.Launcher_reference(
type = 'WORKFLOW',
id = '2fd6ff94-2081-4d29-acbc-83a0a2f744a5', ),
config = '{"workflowId" : "6b42d9be-61b6-46af-827e-ea29ba8aa3d9"}', )
]
)
```
[[Back to top]](#)

53
docs/tools/sdk/python/Reference/V2024/Models/IdentityEntitlementDetails.md Normal file
View File

@@ -0,0 +1,53 @@
---
id: v2024-identity-entitlement-details
title: IdentityEntitlementDetails
pagination_label: IdentityEntitlementDetails
sidebar_label: IdentityEntitlementDetails
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'IdentityEntitlementDetails', 'V2024IdentityEntitlementDetails']
slug: /tools/sdk/python/v2024/models/identity-entitlement-details
tags: ['SDK', 'Software Development Kit', 'IdentityEntitlementDetails', 'V2024IdentityEntitlementDetails']
---
# IdentityEntitlementDetails
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identity_id** | **str** | Id of Identity | [optional]
**entitlement** | [**IdentityEntitlementDetailsEntitlementDto**](identity-entitlement-details-entitlement-dto) | | [optional]
**source_id** | **str** | Id of Source | [optional]
**account_targets** | [**[]IdentityEntitlementDetailsAccountTarget**](identity-entitlement-details-account-target) | A list of account targets on the identity provisioned with the requested entitlement. | [optional]
}
## Example
```python
from sailpoint.v2024.models.identity_entitlement_details import IdentityEntitlementDetails
identity_entitlement_details = IdentityEntitlementDetails(
identity_id='5928c61f-3f2e-417a-8d65-f76451e2050a',
entitlement=sailpoint.v2024.models.identity_entitlement_details_entitlement_dto.Identity Entitlement Details Entitlement Dto(
id = '2c91808874ff91550175097daaec161c',
name = 'LauncherTest2',
created = '2020-10-08T18:33:52.029Z',
modified = '2020-10-08T18:33:52.029Z',
description = 'CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local',
type = 'ENTITLEMENT',
source_id = '2c9180827ca885d7017ca8ce28a000eb',
source_name = 'ODS-AD-Source',
owner = sailpoint.v2024.models.owner_dto.Owner Dto(
type = 'IDENTITY',
id = '2c9180a46faadee4016fb4e018c20639',
name = 'Support', ),
value = 'CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local',
flags = [privileged], ),
source_id='b56728da-a24d-4177-a207-2bc4d42cba27',
account_targets=[{accountId=e7ef11cee24542b78618ce017117699f, accountName=Adalberto.XYZ, accountUUID=null, sourceId=0108906b66634d9ab7819a03eb263a88, sourceName=ODS-AD-FF-Source [source-XYZ], removeDate=null, assignmentId=null, revocable=true}]
)
```
[[Back to top]](#)

47
docs/tools/sdk/python/Reference/V2024/Models/IdentityEntitlementDetailsAccountTarget.md Normal file
View File

@@ -0,0 +1,47 @@
---
id: v2024-identity-entitlement-details-account-target
title: IdentityEntitlementDetailsAccountTarget
pagination_label: IdentityEntitlementDetailsAccountTarget
sidebar_label: IdentityEntitlementDetailsAccountTarget
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'IdentityEntitlementDetailsAccountTarget', 'V2024IdentityEntitlementDetailsAccountTarget']
slug: /tools/sdk/python/v2024/models/identity-entitlement-details-account-target
tags: ['SDK', 'Software Development Kit', 'IdentityEntitlementDetailsAccountTarget', 'V2024IdentityEntitlementDetailsAccountTarget']
---
# IdentityEntitlementDetailsAccountTarget
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**account_id** | **str** | The id of account | [optional]
**account_name** | **str** | The name of account | [optional]
**account_uuid** | **str** | The UUID representation of the account if available | [optional]
**source_id** | **str** | The id of Source | [optional]
**source_name** | **str** | The name of Source | [optional]
**remove_date** | **str** | The removal date scheduled for the entitlement on the Identity | [optional]
**assignment_id** | **str** | The assignmentId of the entitlement on the Identity | [optional]
**revocable** | **bool** | If the entitlement can be revoked | [optional] [default to False]
}
## Example
```python
from sailpoint.v2024.models.identity_entitlement_details_account_target import IdentityEntitlementDetailsAccountTarget
identity_entitlement_details_account_target = IdentityEntitlementDetailsAccountTarget(
account_id='c5ef070e-92c6-4276-a006-98490f132dec',
account_name='Adalberto.XYZ',
account_uuid='2236c29e-68a6-494d-a469-d072172f46cf',
source_id='9269d764-8358-4ab9-9748-d4b7418548ca',
source_name='JDBC XYZ Source',
remove_date='2035-01-01T12:00:00.000Z',
assignment_id='77a5b7b4-262f-4b6a-a2aa-87f84f45f96f',
revocable=True
)
```
[[Back to top]](#)

56
docs/tools/sdk/python/Reference/V2024/Models/IdentityEntitlementDetailsEntitlementDto.md Normal file
View File

@@ -0,0 +1,56 @@
---
id: v2024-identity-entitlement-details-entitlement-dto
title: IdentityEntitlementDetailsEntitlementDto
pagination_label: IdentityEntitlementDetailsEntitlementDto
sidebar_label: IdentityEntitlementDetailsEntitlementDto
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'IdentityEntitlementDetailsEntitlementDto', 'V2024IdentityEntitlementDetailsEntitlementDto']
slug: /tools/sdk/python/v2024/models/identity-entitlement-details-entitlement-dto
tags: ['SDK', 'Software Development Kit', 'IdentityEntitlementDetailsEntitlementDto', 'V2024IdentityEntitlementDetailsEntitlementDto']
---
# IdentityEntitlementDetailsEntitlementDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The entitlement id | [optional]
**name** | **str** | The entitlement name | [optional]
**created** | **datetime** | Time when the entitlement was last modified | [optional]
**modified** | **datetime** | Time when the entitlement was last modified | [optional]
**description** | **str** | The description of the entitlement | [optional]
**type** | **str** | The type of the object, will always be \"ENTITLEMENT\" | [optional]
**source_id** | **str** | The source ID | [optional]
**source_name** | **str** | The source name | [optional]
**owner** | [**OwnerDto**](owner-dto) | | [optional]
**value** | **str** | The value of the entitlement | [optional]
**flags** | **[]str** | a list of properties informing the viewer about the entitlement | [optional]
}
## Example
```python
from sailpoint.v2024.models.identity_entitlement_details_entitlement_dto import IdentityEntitlementDetailsEntitlementDto
identity_entitlement_details_entitlement_dto = IdentityEntitlementDetailsEntitlementDto(
id='2c91808874ff91550175097daaec161c',
name='LauncherTest2',
created='2020-10-08T18:33:52.029Z',
modified='2020-10-08T18:33:52.029Z',
description='CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local',
type='ENTITLEMENT',
source_id='2c9180827ca885d7017ca8ce28a000eb',
source_name='ODS-AD-Source',
owner=sailpoint.v2024.models.owner_dto.Owner Dto(
type = 'IDENTITY',
id = '2c9180a46faadee4016fb4e018c20639',
name = 'Support', ),
value='CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local',
flags=[privileged]
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/V2024/Models/IdentityEntitlements.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: v2024-identity-entitlements
title: IdentityEntitlements
pagination_label: IdentityEntitlements
sidebar_label: IdentityEntitlements
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'IdentityEntitlements', 'V2024IdentityEntitlements']
slug: /tools/sdk/python/v2024/models/identity-entitlements
tags: ['SDK', 'Software Development Kit', 'IdentityEntitlements', 'V2024IdentityEntitlements']
---
# IdentityEntitlements
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**object_ref** | [**TaggedObjectDto**](tagged-object-dto) | | [optional]
**tags** | **[]str** | Labels to be applied to object. | [optional]
}
## Example
```python
from sailpoint.v2024.models.identity_entitlements import IdentityEntitlements
identity_entitlements = IdentityEntitlements(
object_ref=sailpoint.v2024.models.tagged_object_dto.Tagged Object Dto(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'William Wilson', ),
tags=[BU_FINANCE, PCI]
)
```
[[Back to top]](#)

55
docs/tools/sdk/python/Reference/V2024/Models/Launcher.md Normal file
View File

@@ -0,0 +1,55 @@
---
id: v2024-launcher
title: Launcher
pagination_label: Launcher
sidebar_label: Launcher
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'Launcher', 'V2024Launcher']
slug: /tools/sdk/python/v2024/models/launcher
tags: ['SDK', 'Software Development Kit', 'Launcher', 'V2024Launcher']
---
# Launcher
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | ID of the Launcher | [required]
**created** | **datetime** | Date the Launcher was created | [required]
**modified** | **datetime** | Date the Launcher was last modified | [required]
**owner** | [**LauncherOwner**](launcher-owner) | | [required]
**name** | **str** | Name of the Launcher, limited to 255 characters | [required]
**description** | **str** | Description of the Launcher, limited to 2000 characters | [required]
**type** | **Enum** [ 'INTERACTIVE_PROCESS' ] | Launcher type | [required]
**disabled** | **bool** | State of the Launcher | [required]
**reference** | [**LauncherReference**](launcher-reference) | | [optional]
**config** | **str** | JSON configuration associated with this Launcher, restricted to a max size of 4KB | [required]
}
## Example
```python
from sailpoint.v2024.models.launcher import Launcher
launcher = Launcher(
id='1b630bed-0941-4792-a712-57a5868ca34d',
created='2024-04-16T20:07:30.601016489Z',
modified='2024-04-17T18:02:07.320143194Z',
owner=sailpoint.v2024.models.launcher_owner.Launcher_owner(
type = 'IDENTITY',
id = '123180847373330f0173c7e1756b6890', ),
name='Group Create',
description='Create a new Active Directory Group',
type='INTERACTIVE_PROCESS',
disabled=False,
reference=sailpoint.v2024.models.launcher_reference.Launcher_reference(
type = 'WORKFLOW',
id = '2fd6ff94-2081-4d29-acbc-83a0a2f744a5', ),
config='{"workflowId" : "6b42d9be-61b6-46af-827e-ea29ba8aa3d9"}'
)
```
[[Back to top]](#)

36
docs/tools/sdk/python/Reference/V2024/Models/LauncherOwner.md Normal file
View File

@@ -0,0 +1,36 @@
---
id: v2024-launcher-owner
title: LauncherOwner
pagination_label: LauncherOwner
sidebar_label: LauncherOwner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'LauncherOwner', 'V2024LauncherOwner']
slug: /tools/sdk/python/v2024/models/launcher-owner
tags: ['SDK', 'Software Development Kit', 'LauncherOwner', 'V2024LauncherOwner']
---
# LauncherOwner
Owner of the Launcher
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | Owner type | [required]
**id** | **str** | Owner ID | [required]
}
## Example
```python
from sailpoint.v2024.models.launcher_owner import LauncherOwner
launcher_owner = LauncherOwner(
type='IDENTITY',
id='123180847373330f0173c7e1756b6890'
)
```
[[Back to top]](#)

35
docs/tools/sdk/python/Reference/V2024/Models/LauncherReference.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: v2024-launcher-reference
title: LauncherReference
pagination_label: LauncherReference
sidebar_label: LauncherReference
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'LauncherReference', 'V2024LauncherReference']
slug: /tools/sdk/python/v2024/models/launcher-reference
tags: ['SDK', 'Software Development Kit', 'LauncherReference', 'V2024LauncherReference']
---
# LauncherReference
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'WORKFLOW' ] | Type of Launcher reference | [optional]
**id** | **str** | ID of Launcher reference | [optional]
}
## Example
```python
from sailpoint.v2024.models.launcher_reference import LauncherReference
launcher_reference = LauncherReference(
type='WORKFLOW',
id='2fd6ff94-2081-4d29-acbc-83a0a2f744a5'
)
```
[[Back to top]](#)

45
docs/tools/sdk/python/Reference/V2024/Models/LauncherRequest.md Normal file
View File

@@ -0,0 +1,45 @@
---
id: v2024-launcher-request
title: LauncherRequest
pagination_label: LauncherRequest
sidebar_label: LauncherRequest
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'LauncherRequest', 'V2024LauncherRequest']
slug: /tools/sdk/python/v2024/models/launcher-request
tags: ['SDK', 'Software Development Kit', 'LauncherRequest', 'V2024LauncherRequest']
---
# LauncherRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Name of the Launcher, limited to 255 characters | [required]
**description** | **str** | Description of the Launcher, limited to 2000 characters | [required]
**type** | **Enum** [ 'INTERACTIVE_PROCESS' ] | Launcher type | [required]
**disabled** | **bool** | State of the Launcher | [required]
**reference** | [**LauncherRequestReference**](launcher-request-reference) | | [optional]
**config** | **str** | JSON configuration associated with this Launcher, restricted to a max size of 4KB | [required]
}
## Example
```python
from sailpoint.v2024.models.launcher_request import LauncherRequest
launcher_request = LauncherRequest(
name='Group Create',
description='Create a new Active Directory Group',
type='INTERACTIVE_PROCESS',
disabled=False,
reference=sailpoint.v2024.models.launcher_request_reference.LauncherRequest_reference(
type = 'WORKFLOW',
id = '2fd6ff94-2081-4d29-acbc-83a0a2f744a5', ),
config='{"workflowId" : "6b42d9be-61b6-46af-827e-ea29ba8aa3d9"}'
)
```
[[Back to top]](#)

35
docs/tools/sdk/python/Reference/V2024/Models/LauncherRequestReference.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: v2024-launcher-request-reference
title: LauncherRequestReference
pagination_label: LauncherRequestReference
sidebar_label: LauncherRequestReference
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'LauncherRequestReference', 'V2024LauncherRequestReference']
slug: /tools/sdk/python/v2024/models/launcher-request-reference
tags: ['SDK', 'Software Development Kit', 'LauncherRequestReference', 'V2024LauncherRequestReference']
---
# LauncherRequestReference
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'WORKFLOW' ] | Type of Launcher reference | [required]
**id** | **str** | ID of Launcher reference | [required]
}
## Example
```python
from sailpoint.v2024.models.launcher_request_reference import LauncherRequestReference
launcher_request_reference = LauncherRequestReference(
type='WORKFLOW',
id='2fd6ff94-2081-4d29-acbc-83a0a2f744a5'
)
```
[[Back to top]](#)

33
docs/tools/sdk/python/Reference/V2024/Models/StartLauncher200Response.md Normal file
View File

@@ -0,0 +1,33 @@
---
id: v2024-start-launcher200-response
title: StartLauncher200Response
pagination_label: StartLauncher200Response
sidebar_label: StartLauncher200Response
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'StartLauncher200Response', 'V2024StartLauncher200Response']
slug: /tools/sdk/python/v2024/models/start-launcher200-response
tags: ['SDK', 'Software Development Kit', 'StartLauncher200Response', 'V2024StartLauncher200Response']
---
# StartLauncher200Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**interactive_process_id** | **str** | ID of the Interactive Process that was launched | [required]
}
## Example
```python
from sailpoint.v2024.models.start_launcher200_response import StartLauncher200Response
start_launcher200_response = StartLauncher200Response(
interactive_process_id='5da68cfe-2d60-4b09-858f-0d03acd2f47a'
)
```
[[Back to top]](#)

46
docs/tools/sdk/python/Reference/V2024/Models/Tag.md Normal file
View File

@@ -0,0 +1,46 @@
---
id: v2024-tag
title: Tag
pagination_label: Tag
sidebar_label: Tag
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'Tag', 'V2024Tag']
slug: /tools/sdk/python/v2024/models/tag
tags: ['SDK', 'Software Development Kit', 'Tag', 'V2024Tag']
---
# Tag
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Tag id | [required][readonly]
**name** | **str** | Name of the tag. | [required]
**created** | **datetime** | Date the tag was created. | [required][readonly]
**modified** | **datetime** | Date the tag was last modified. | [required][readonly]
**tag_category_refs** | [**[]TagTagCategoryRefsInner**](tag-tag-category-refs-inner) | | [required][readonly]
}
## Example
```python
from sailpoint.v2024.models.tag import Tag
tag = Tag(
id='449ecdc0-d4ff-4341-acf6-92f6f7ce604f',
name='PCI',
created='2022-05-04T14:48:49Z',
modified='2022-07-14T16:31:11Z',
tag_category_refs=[
sailpoint.v2024.models.tag_tag_category_refs_inner.Tag_tagCategoryRefs_inner(
type = 'ENTITLEMENT',
id = '2c91809773dee32014e13e122092014e',
name = 'CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local', )
]
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/V2024/Models/TagTagCategoryRefsInner.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: v2024-tag-tag-category-refs-inner
title: TagTagCategoryRefsInner
pagination_label: TagTagCategoryRefsInner
sidebar_label: TagTagCategoryRefsInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'TagTagCategoryRefsInner', 'V2024TagTagCategoryRefsInner']
slug: /tools/sdk/python/v2024/models/tag-tag-category-refs-inner
tags: ['SDK', 'Software Development Kit', 'TagTagCategoryRefsInner', 'V2024TagTagCategoryRefsInner']
---
# TagTagCategoryRefsInner
Tagged object's category.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'ACCESS_PROFILE', 'APPLICATION', 'CAMPAIGN', 'ENTITLEMENT', 'IDENTITY', 'ROLE', 'SOD_POLICY', 'SOURCE' ] | DTO type of the tagged object's category. | [optional]
**id** | **str** | Tagged object's ID. | [optional]
**name** | **str** | Tagged object's display name. | [optional]
}
## Example
```python
from sailpoint.v2024.models.tag_tag_category_refs_inner import TagTagCategoryRefsInner
tag_tag_category_refs_inner = TagTagCategoryRefsInner(
type='ENTITLEMENT',
id='2c91809773dee32014e13e122092014e',
name='CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local'
)
```
[[Back to top]](#)

18
docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestsApi.md
View File

@@ -859,6 +859,17 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## load-account-selections
:::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 accounts selections for identity
Use this API to fetch account information for an identity against the items in an access request.
@@ -871,6 +882,7 @@ Used to fetch accountSelection for the AccessRequest prior to submitting for asy
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 | accounts_selection_request | [**AccountsSelectionRequest**](../models/accounts-selection-request) | True |
### Return type
@@ -900,8 +912,10 @@ from sailpoint.v2025.models.accounts_selection_response import AccountsSelection
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')
accounts_selection_request = '''{
"requestedFor" : "2c918084660f45d6016617daa9210584",
"clientMetadata" : {
@@ -970,9 +984,9 @@ with ApiClient(configuration) as api_client:
try:
# Get accounts selections for identity
new_accounts_selection_request = AccountsSelectionRequest.from_json(accounts_selection_request)
results = AccessRequestsApi(api_client).load_account_selections(accounts_selection_request=new_accounts_selection_request)
results = AccessRequestsApi(api_client).load_account_selections(x_sail_point_experimental=x_sail_point_experimental, accounts_selection_request=new_accounts_selection_request)
# Below is a request that includes all optional parameters
# results = AccessRequestsApi(api_client).load_account_selections(new_accounts_selection_request)
# results = AccessRequestsApi(api_client).load_account_selections(x_sail_point_experimental, new_accounts_selection_request)
print("The response of AccessRequestsApi->load_account_selections:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:

2
docs/tools/sdk/python/Reference/V2025/Methods/CertificationCampaignsApi.md
View File

@@ -196,7 +196,7 @@ Param Type | Name | Data Type | Required | Description
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | This response indicates that the requested campaign was successfully created, and the API returns its representation. | Campaign | - |
202 | This response indicates that the requested campaign has been successfully accepted into the system, and its representation is returned by the API. | Campaign | - |
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 | - |

18
docs/tools/sdk/python/Reference/V2025/Methods/IdentitiesApi.md
View File

@@ -628,6 +628,17 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## start-identities-invite
:::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
```
:::
Invite identities to register
This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options.
@@ -642,6 +653,7 @@ The executed task status can be checked by Task Management > [Get task status by
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 | invite_identities_request | [**InviteIdentitiesRequest**](../models/invite-identities-request) | True |
### Return type
@@ -672,8 +684,10 @@ from sailpoint.v2025.models.task_status import TaskStatus
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')
invite_identities_request = '''{
"ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ],
"uninvited" : false
@@ -682,9 +696,9 @@ with ApiClient(configuration) as api_client:
try:
# Invite identities to register
new_invite_identities_request = InviteIdentitiesRequest.from_json(invite_identities_request)
results = IdentitiesApi(api_client).start_identities_invite(invite_identities_request=new_invite_identities_request)
results = IdentitiesApi(api_client).start_identities_invite(x_sail_point_experimental=x_sail_point_experimental, invite_identities_request=new_invite_identities_request)
# Below is a request that includes all optional parameters
# results = IdentitiesApi(api_client).start_identities_invite(new_invite_identities_request)
# results = IdentitiesApi(api_client).start_identities_invite(x_sail_point_experimental, new_invite_identities_request)
print("The response of IdentitiesApi->start_identities_invite:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:

18
docs/tools/sdk/python/Reference/V2025/Methods/IdentityProfilesApi.md
View File

@@ -334,17 +334,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## generate-identity-preview
:::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
```
:::
Generate identity profile preview
This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy''s attribute config is applied.
@@ -354,7 +343,6 @@ This generates a non-persisted IdentityDetails object that will represent as 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 | identity_preview_request | [**IdentityPreviewRequest**](../models/identity-preview-request) | True | Identity Preview request body.
### Return type
@@ -384,10 +372,8 @@ from sailpoint.v2025.models.identity_preview_response import IdentityPreviewResp
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')
identity_preview_request = '''{
"identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"identityAttributeConfig" : {
@@ -419,9 +405,9 @@ with ApiClient(configuration) as api_client:
try:
# Generate identity profile preview
new_identity_preview_request = IdentityPreviewRequest.from_json(identity_preview_request)
results = IdentityProfilesApi(api_client).generate_identity_preview(x_sail_point_experimental=x_sail_point_experimental, identity_preview_request=new_identity_preview_request)
results = IdentityProfilesApi(api_client).generate_identity_preview(identity_preview_request=new_identity_preview_request)
# Below is a request that includes all optional parameters
# results = IdentityProfilesApi(api_client).generate_identity_preview(x_sail_point_experimental, new_identity_preview_request)
# results = IdentityProfilesApi(api_client).generate_identity_preview(new_identity_preview_request)
print("The response of IdentityProfilesApi->generate_identity_preview:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:

406
docs/tools/sdk/python/Reference/V2025/Methods/LaunchersApi.md Normal file
View File

@@ -0,0 +1,406 @@
---
id: v2025-launchers
title: Launchers
pagination_label: Launchers
sidebar_label: Launchers
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'Launchers', 'V2025Launchers']
slug: /tools/sdk/python/v2025/methods/launchers
tags: ['SDK', 'Software Development Kit', 'Launchers', 'V2025Launchers']
---
# sailpoint.v2025.LaunchersApi
All URIs are relative to *https://sailpoint.api.identitynow.com/v2025*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-launcher**](#create-launcher) | **POST** `/launchers` | Create launcher
[**delete-launcher**](#delete-launcher) | **DELETE** `/launchers/{launcherID}` | Delete launcher
[**get-launcher**](#get-launcher) | **GET** `/launchers/{launcherID}` | Get launcher by id
[**get-launchers**](#get-launchers) | **GET** `/launchers` | List all launchers for tenant
[**put-launcher**](#put-launcher) | **PUT** `/launchers/{launcherID}` | Replace launcher
[**start-launcher**](#start-launcher) | **POST** `/launchers/{launcherID}/launch` | Launch a launcher
## create-launcher
Create launcher
Create a Launcher with given information
[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-launcher)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Body | launcher_request | [**LauncherRequest**](../models/launcher-request) | True | Payload to create a Launcher
### Return type
[**Launcher**](../models/launcher)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
201 | Launcher created successfully | Launcher | - |
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 | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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**: application/json
- **Accept**: application/json
### Example
```python
from sailpoint.v2025.api.launchers_api import LaunchersApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.launcher import Launcher
from sailpoint.v2025.models.launcher_request import LauncherRequest
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
launcher_request = '''{
"reference" : {
"id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5",
"type" : "WORKFLOW"
},
"name" : "Group Create",
"description" : "Create a new Active Directory Group",
"disabled" : false,
"type" : "INTERACTIVE_PROCESS",
"config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}"
}''' # LauncherRequest | Payload to create a Launcher
try:
# Create launcher
new_launcher_request = LauncherRequest.from_json(launcher_request)
results = LaunchersApi(api_client).create_launcher(launcher_request=new_launcher_request)
# Below is a request that includes all optional parameters
# results = LaunchersApi(api_client).create_launcher(new_launcher_request)
print("The response of LaunchersApi->create_launcher:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling LaunchersApi->create_launcher: %s\n" % e)
```
[[Back to top]](#)
## delete-launcher
Delete launcher
Delete the given Launcher ID
[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-launcher)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | launcher_id | **str** | True | ID of the Launcher to be deleted
### Return type
(empty response body)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
204 | Launcher deleted successfully | | - |
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 | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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**: Not defined
- **Accept**: application/json
### Example
```python
from sailpoint.v2025.api.launchers_api import LaunchersApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be deleted # str | ID of the Launcher to be deleted
try:
# Delete launcher
LaunchersApi(api_client).delete_launcher(launcher_id=launcher_id)
# Below is a request that includes all optional parameters
# LaunchersApi(api_client).delete_launcher(launcher_id)
except Exception as e:
print("Exception when calling LaunchersApi->delete_launcher: %s\n" % e)
```
[[Back to top]](#)
## get-launcher
Get launcher by id
Get details for the given Launcher ID
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-launcher)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | launcher_id | **str** | True | ID of the Launcher to be retrieved
### Return type
[**Launcher**](../models/launcher)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | Launcher retrieved successfully | Launcher | - |
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 | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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**: Not defined
- **Accept**: application/json
### Example
```python
from sailpoint.v2025.api.launchers_api import LaunchersApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.launcher import Launcher
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be retrieved # str | ID of the Launcher to be retrieved
try:
# Get launcher by id
results = LaunchersApi(api_client).get_launcher(launcher_id=launcher_id)
# Below is a request that includes all optional parameters
# results = LaunchersApi(api_client).get_launcher(launcher_id)
print("The response of LaunchersApi->get_launcher:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling LaunchersApi->get_launcher: %s\n" % e)
```
[[Back to top]](#)
## get-launchers
List all launchers for tenant
Return a list of Launchers for the authenticated tenant
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-launchers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **description**: *sw* **disabled**: *eq* **name**: *sw*
Query | next | **str** | (optional) | Pagination marker
Query | limit | **int** | (optional) (default to 10) | Number of Launchers to return
### Return type
[**GetLaunchers200Response**](../models/get-launchers200-response)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | List of Launchers | GetLaunchers200Response | - |
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 | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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**: Not defined
- **Accept**: application/json
### Example
```python
from sailpoint.v2025.api.launchers_api import LaunchersApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.get_launchers200_response import GetLaunchers200Response
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
filters = 'disabled eq \"true\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional)
next = 'eyJuZXh0IjoxMjN9Cg==' # str | Pagination marker (optional) # str | Pagination marker (optional)
limit = 10 # int | Number of Launchers to return (optional) (default to 10) # int | Number of Launchers to return (optional) (default to 10)
try:
# List all launchers for tenant
results = LaunchersApi(api_client).get_launchers()
# Below is a request that includes all optional parameters
# results = LaunchersApi(api_client).get_launchers(filters, next, limit)
print("The response of LaunchersApi->get_launchers:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling LaunchersApi->get_launchers: %s\n" % e)
```
[[Back to top]](#)
## put-launcher
Replace launcher
Replace the given Launcher ID with given payload
[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-launcher)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | launcher_id | **str** | True | ID of the Launcher to be replaced
Body | launcher_request | [**LauncherRequest**](../models/launcher-request) | True | Payload to replace Launcher
### Return type
[**Launcher**](../models/launcher)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | Launcher replaced successfully | Launcher | - |
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 | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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**: application/json
- **Accept**: application/json
### Example
```python
from sailpoint.v2025.api.launchers_api import LaunchersApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.launcher import Launcher
from sailpoint.v2025.models.launcher_request import LauncherRequest
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be replaced # str | ID of the Launcher to be replaced
launcher_request = '''{
"reference" : {
"id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5",
"type" : "WORKFLOW"
},
"name" : "Group Create",
"description" : "Create a new Active Directory Group",
"disabled" : false,
"type" : "INTERACTIVE_PROCESS",
"config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}"
}''' # LauncherRequest | Payload to replace Launcher
try:
# Replace launcher
new_launcher_request = LauncherRequest.from_json(launcher_request)
results = LaunchersApi(api_client).put_launcher(launcher_id=launcher_id, launcher_request=new_launcher_request)
# Below is a request that includes all optional parameters
# results = LaunchersApi(api_client).put_launcher(launcher_id, new_launcher_request)
print("The response of LaunchersApi->put_launcher:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling LaunchersApi->put_launcher: %s\n" % e)
```
[[Back to top]](#)
## start-launcher
Launch a launcher
Launch the given Launcher ID
[API Spec](https://developer.sailpoint.com/docs/api/v2025/start-launcher)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | launcher_id | **str** | True | ID of the Launcher to be launched
### Return type
[**StartLauncher200Response**](../models/start-launcher200-response)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | Launcher launched successfully | StartLauncher200Response | - |
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 | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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**: Not defined
- **Accept**: application/json
### Example
```python
from sailpoint.v2025.api.launchers_api import LaunchersApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.start_launcher200_response import StartLauncher200Response
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be launched # str | ID of the Launcher to be launched
try:
# Launch a launcher
results = LaunchersApi(api_client).start_launcher(launcher_id=launcher_id)
# Below is a request that includes all optional parameters
# results = LaunchersApi(api_client).start_launcher(launcher_id)
print("The response of LaunchersApi->start_launcher:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling LaunchersApi->start_launcher: %s\n" % e)
```
[[Back to top]](#)

90
docs/tools/sdk/python/Reference/V2025/Methods/PasswordPoliciesApi.md
View File

@@ -31,6 +31,17 @@ Method | HTTP request | Description
## create-password-policy
:::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
```
:::
Create password policy
This API creates the specified password policy.
@@ -40,6 +51,7 @@ This API creates the specified password policy.
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 | password_policy_v3_dto | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | True |
### Return type
@@ -69,8 +81,10 @@ from sailpoint.v2025.models.password_policy_v3_dto import PasswordPolicyV3Dto
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')
password_policy_v3_dto = '''{
"validateAgainstAccountName" : true,
"minLength" : 8,
@@ -108,9 +122,9 @@ with ApiClient(configuration) as api_client:
try:
# Create password policy
new_password_policy_v3_dto = PasswordPolicyV3Dto.from_json(password_policy_v3_dto)
results = PasswordPoliciesApi(api_client).create_password_policy(password_policy_v3_dto=new_password_policy_v3_dto)
results = PasswordPoliciesApi(api_client).create_password_policy(x_sail_point_experimental=x_sail_point_experimental, password_policy_v3_dto=new_password_policy_v3_dto)
# Below is a request that includes all optional parameters
# results = PasswordPoliciesApi(api_client).create_password_policy(new_password_policy_v3_dto)
# results = PasswordPoliciesApi(api_client).create_password_policy(x_sail_point_experimental, new_password_policy_v3_dto)
print("The response of PasswordPoliciesApi->create_password_policy:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
@@ -122,6 +136,17 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-password-policy
:::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
```
:::
Delete password policy by id
This API deletes the specified password policy.
@@ -132,6 +157,7 @@ This API deletes the specified password policy.
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | The ID of password policy to delete.
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
### Return type
(empty response body)
@@ -159,16 +185,18 @@ from sailpoint.v2025.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
id = 'ff808081838d9e9d01838da6a03e0002' # str | The ID of password policy to delete. # str | The ID of password policy to delete.
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:
# Delete password policy by id
PasswordPoliciesApi(api_client).delete_password_policy(id=id)
PasswordPoliciesApi(api_client).delete_password_policy(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# PasswordPoliciesApi(api_client).delete_password_policy(id)
# PasswordPoliciesApi(api_client).delete_password_policy(id, x_sail_point_experimental)
except Exception as e:
print("Exception when calling PasswordPoliciesApi->delete_password_policy: %s\n" % e)
```
@@ -178,6 +206,17 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-password-policy-by-id
:::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 password policy by id
This API returns the password policy for the specified ID.
@@ -188,6 +227,7 @@ This API returns the password policy for the specified ID.
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | The ID of password policy to retrieve.
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
### Return type
[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto)
@@ -216,16 +256,18 @@ from sailpoint.v2025.models.password_policy_v3_dto import PasswordPolicyV3Dto
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
id = 'ff808081838d9e9d01838da6a03e0005' # str | The ID of password policy to retrieve. # str | The ID of password policy to retrieve.
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 password policy by id
results = PasswordPoliciesApi(api_client).get_password_policy_by_id(id=id)
results = PasswordPoliciesApi(api_client).get_password_policy_by_id(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = PasswordPoliciesApi(api_client).get_password_policy_by_id(id)
# results = PasswordPoliciesApi(api_client).get_password_policy_by_id(id, x_sail_point_experimental)
print("The response of PasswordPoliciesApi->get_password_policy_by_id:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
@@ -237,6 +279,17 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-password-policies
:::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 password policies
This gets list of all Password Policies.
Requires role of ORG_ADMIN
@@ -247,6 +300,7 @@ Requires role of ORG_ADMIN
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 | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
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.
Query | count | **bool** | (optional) (default to False) | 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.
@@ -277,8 +331,10 @@ from sailpoint.v2025.models.password_policy_v3_dto import PasswordPolicyV3Dto
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')
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)
@@ -286,9 +342,9 @@ with ApiClient(configuration) as api_client:
try:
# List password policies
results = PasswordPoliciesApi(api_client).list_password_policies()
results = PasswordPoliciesApi(api_client).list_password_policies(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count)
# results = PasswordPoliciesApi(api_client).list_password_policies(x_sail_point_experimental, limit, offset, count)
print("The response of PasswordPoliciesApi->list_password_policies:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
@@ -301,6 +357,17 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## set-password-policy
:::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
```
:::
Update password policy by id
This API updates the specified password policy.
@@ -311,6 +378,7 @@ This API updates the specified password policy.
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | The ID of password policy to update.
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
Body | password_policy_v3_dto | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | True |
### Return type
@@ -340,9 +408,11 @@ from sailpoint.v2025.models.password_policy_v3_dto import PasswordPolicyV3Dto
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
id = 'ff808081838d9e9d01838da6a03e0007' # str | The ID of password policy to update. # str | The ID of password policy to update.
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')
password_policy_v3_dto = '''{
"validateAgainstAccountName" : true,
"minLength" : 8,
@@ -380,9 +450,9 @@ with ApiClient(configuration) as api_client:
try:
# Update password policy by id
new_password_policy_v3_dto = PasswordPolicyV3Dto.from_json(password_policy_v3_dto)
results = PasswordPoliciesApi(api_client).set_password_policy(id=id, password_policy_v3_dto=new_password_policy_v3_dto)
results = PasswordPoliciesApi(api_client).set_password_policy(id=id, x_sail_point_experimental=x_sail_point_experimental, password_policy_v3_dto=new_password_policy_v3_dto)
# Below is a request that includes all optional parameters
# results = PasswordPoliciesApi(api_client).set_password_policy(id, new_password_policy_v3_dto)
# results = PasswordPoliciesApi(api_client).set_password_policy(id, x_sail_point_experimental, new_password_policy_v3_dto)
print("The response of PasswordPoliciesApi->set_password_policy:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:

287
docs/tools/sdk/python/Reference/V2025/Methods/TagsApi.md Normal file
View File

@@ -0,0 +1,287 @@
---
id: v2025-tags
title: Tags
pagination_label: Tags
sidebar_label: Tags
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'Tags', 'V2025Tags']
slug: /tools/sdk/python/v2025/methods/tags
tags: ['SDK', 'Software Development Kit', 'Tags', 'V2025Tags']
---
# sailpoint.v2025.TagsApi
All URIs are relative to *https://sailpoint.api.identitynow.com/v2025*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-tag**](#create-tag) | **POST** `/tags` | Create tag
[**delete-tag-by-id**](#delete-tag-by-id) | **DELETE** `/tags/{id}` | Delete tag
[**get-tag-by-id**](#get-tag-by-id) | **GET** `/tags/{id}` | Get tag by id
[**list-tags**](#list-tags) | **GET** `/tags` | List tags
## create-tag
Create tag
This API creates new tag.
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-tag)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Body | tag | [**Tag**](../models/tag) | True |
### Return type
[**Tag**](../models/tag)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
201 | Created tag. | Tag | - |
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**: application/json
- **Accept**: application/json
### Example
```python
from sailpoint.v2025.api.tags_api import TagsApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.tag import Tag
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
tag = '''{
"created" : "2022-05-04T14:48:49Z",
"tagCategoryRefs" : [ {
"name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local",
"id" : "2c91809773dee32014e13e122092014e",
"type" : "ENTITLEMENT"
}, {
"name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local",
"id" : "2c91809773dee32014e13e122092014e",
"type" : "ENTITLEMENT"
} ],
"name" : "PCI",
"modified" : "2022-07-14T16:31:11Z",
"id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f"
}''' # Tag |
try:
# Create tag
new_tag = Tag.from_json(tag)
results = TagsApi(api_client).create_tag(tag=new_tag)
# Below is a request that includes all optional parameters
# results = TagsApi(api_client).create_tag(new_tag)
print("The response of TagsApi->create_tag:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling TagsApi->create_tag: %s\n" % e)
```
[[Back to top]](#)
## delete-tag-by-id
Delete tag
This API deletes a tag by specified id.
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-tag-by-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | The ID of the object reference to delete.
### Return type
(empty response body)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
204 | No content. | | - |
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 | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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**: Not defined
- **Accept**: application/json
### Example
```python
from sailpoint.v2025.api.tags_api import TagsApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '329d96cf-3bdb-40a9-988a-b5037ab89022' # str | The ID of the object reference to delete. # str | The ID of the object reference to delete.
try:
# Delete tag
TagsApi(api_client).delete_tag_by_id(id=id)
# Below is a request that includes all optional parameters
# TagsApi(api_client).delete_tag_by_id(id)
except Exception as e:
print("Exception when calling TagsApi->delete_tag_by_id: %s\n" % e)
```
[[Back to top]](#)
## get-tag-by-id
Get tag by id
Returns a tag by its id.
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-tag-by-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | The ID of the object reference to retrieve.
### Return type
[**Tag**](../models/tag)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | Tag | Tag | - |
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 | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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**: Not defined
- **Accept**: application/json
### Example
```python
from sailpoint.v2025.api.tags_api import TagsApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.tag import Tag
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '329d96cf-3bdb-40a9-988a-b5037ab89022' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve.
try:
# Get tag by id
results = TagsApi(api_client).get_tag_by_id(id=id)
# Below is a request that includes all optional parameters
# results = TagsApi(api_client).get_tag_by_id(id)
print("The response of TagsApi->get_tag_by_id:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling TagsApi->get_tag_by_id: %s\n" % e)
```
[[Back to top]](#)
## list-tags
List tags
This API returns a list of tags.
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-tags)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
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.
Query | count | **bool** | (optional) (default to False) | 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.
Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw*
Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified**
### Return type
[**List[Tag]**](../models/tag)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | List of all tags. | List[Tag] | - |
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**: Not defined
- **Accept**: application/json
### Example
```python
from sailpoint.v2025.api.tags_api import TagsApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.tag import Tag
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
filters = 'id eq \"27462f54-61c7-4140-b5da-d5dbe27fc6db\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional)
sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified** (optional)
try:
# List tags
results = TagsApi(api_client).list_tags()
# Below is a request that includes all optional parameters
# results = TagsApi(api_client).list_tags(limit, offset, count, filters, sorters)
print("The response of TagsApi->list_tags:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling TagsApi->list_tags: %s\n" % e)
```
[[Back to top]](#)

51
docs/tools/sdk/python/Reference/V2025/Models/GetLaunchers200Response.md Normal file
View File

@@ -0,0 +1,51 @@
---
id: v2025-get-launchers200-response
title: GetLaunchers200Response
pagination_label: GetLaunchers200Response
sidebar_label: GetLaunchers200Response
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'GetLaunchers200Response', 'V2025GetLaunchers200Response']
slug: /tools/sdk/python/v2025/models/get-launchers200-response
tags: ['SDK', 'Software Development Kit', 'GetLaunchers200Response', 'V2025GetLaunchers200Response']
---
# GetLaunchers200Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**next** | **str** | Pagination marker | [optional]
**items** | [**[]Launcher**](launcher) | | [optional]
}
## Example
```python
from sailpoint.v2025.models.get_launchers200_response import GetLaunchers200Response
get_launchers200_response = GetLaunchers200Response(
next='',
items=[
sailpoint.v2025.models.launcher.Launcher(
id = '1b630bed-0941-4792-a712-57a5868ca34d',
created = '2024-04-16T20:07:30.601016489Z',
modified = '2024-04-17T18:02:07.320143194Z',
owner = sailpoint.v2025.models.launcher_owner.Launcher_owner(
type = 'IDENTITY',
id = '123180847373330f0173c7e1756b6890', ),
name = 'Group Create',
description = 'Create a new Active Directory Group',
type = 'INTERACTIVE_PROCESS',
disabled = False,
reference = sailpoint.v2025.models.launcher_reference.Launcher_reference(
type = 'WORKFLOW',
id = '2fd6ff94-2081-4d29-acbc-83a0a2f744a5', ),
config = '{"workflowId" : "6b42d9be-61b6-46af-827e-ea29ba8aa3d9"}', )
]
)
```
[[Back to top]](#)

55
docs/tools/sdk/python/Reference/V2025/Models/Launcher.md Normal file
View File

@@ -0,0 +1,55 @@
---
id: v2025-launcher
title: Launcher
pagination_label: Launcher
sidebar_label: Launcher
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'Launcher', 'V2025Launcher']
slug: /tools/sdk/python/v2025/models/launcher
tags: ['SDK', 'Software Development Kit', 'Launcher', 'V2025Launcher']
---
# Launcher
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | ID of the Launcher | [required]
**created** | **datetime** | Date the Launcher was created | [required]
**modified** | **datetime** | Date the Launcher was last modified | [required]
**owner** | [**LauncherOwner**](launcher-owner) | | [required]
**name** | **str** | Name of the Launcher, limited to 255 characters | [required]
**description** | **str** | Description of the Launcher, limited to 2000 characters | [required]
**type** | **Enum** [ 'INTERACTIVE_PROCESS' ] | Launcher type | [required]
**disabled** | **bool** | State of the Launcher | [required]
**reference** | [**LauncherReference**](launcher-reference) | | [optional]
**config** | **str** | JSON configuration associated with this Launcher, restricted to a max size of 4KB | [required]
}
## Example
```python
from sailpoint.v2025.models.launcher import Launcher
launcher = Launcher(
id='1b630bed-0941-4792-a712-57a5868ca34d',
created='2024-04-16T20:07:30.601016489Z',
modified='2024-04-17T18:02:07.320143194Z',
owner=sailpoint.v2025.models.launcher_owner.Launcher_owner(
type = 'IDENTITY',
id = '123180847373330f0173c7e1756b6890', ),
name='Group Create',
description='Create a new Active Directory Group',
type='INTERACTIVE_PROCESS',
disabled=False,
reference=sailpoint.v2025.models.launcher_reference.Launcher_reference(
type = 'WORKFLOW',
id = '2fd6ff94-2081-4d29-acbc-83a0a2f744a5', ),
config='{"workflowId" : "6b42d9be-61b6-46af-827e-ea29ba8aa3d9"}'
)
```
[[Back to top]](#)

36
docs/tools/sdk/python/Reference/V2025/Models/LauncherOwner.md Normal file
View File

@@ -0,0 +1,36 @@
---
id: v2025-launcher-owner
title: LauncherOwner
pagination_label: LauncherOwner
sidebar_label: LauncherOwner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'LauncherOwner', 'V2025LauncherOwner']
slug: /tools/sdk/python/v2025/models/launcher-owner
tags: ['SDK', 'Software Development Kit', 'LauncherOwner', 'V2025LauncherOwner']
---
# LauncherOwner
Owner of the Launcher
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | Owner type | [required]
**id** | **str** | Owner ID | [required]
}
## Example
```python
from sailpoint.v2025.models.launcher_owner import LauncherOwner
launcher_owner = LauncherOwner(
type='IDENTITY',
id='123180847373330f0173c7e1756b6890'
)
```
[[Back to top]](#)

35
docs/tools/sdk/python/Reference/V2025/Models/LauncherReference.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: v2025-launcher-reference
title: LauncherReference
pagination_label: LauncherReference
sidebar_label: LauncherReference
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'LauncherReference', 'V2025LauncherReference']
slug: /tools/sdk/python/v2025/models/launcher-reference
tags: ['SDK', 'Software Development Kit', 'LauncherReference', 'V2025LauncherReference']
---
# LauncherReference
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'WORKFLOW' ] | Type of Launcher reference | [optional]
**id** | **str** | ID of Launcher reference | [optional]
}
## Example
```python
from sailpoint.v2025.models.launcher_reference import LauncherReference
launcher_reference = LauncherReference(
type='WORKFLOW',
id='2fd6ff94-2081-4d29-acbc-83a0a2f744a5'
)
```
[[Back to top]](#)

45
docs/tools/sdk/python/Reference/V2025/Models/LauncherRequest.md Normal file
View File

@@ -0,0 +1,45 @@
---
id: v2025-launcher-request
title: LauncherRequest
pagination_label: LauncherRequest
sidebar_label: LauncherRequest
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'LauncherRequest', 'V2025LauncherRequest']
slug: /tools/sdk/python/v2025/models/launcher-request
tags: ['SDK', 'Software Development Kit', 'LauncherRequest', 'V2025LauncherRequest']
---
# LauncherRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Name of the Launcher, limited to 255 characters | [required]
**description** | **str** | Description of the Launcher, limited to 2000 characters | [required]
**type** | **Enum** [ 'INTERACTIVE_PROCESS' ] | Launcher type | [required]
**disabled** | **bool** | State of the Launcher | [required]
**reference** | [**LauncherRequestReference**](launcher-request-reference) | | [optional]
**config** | **str** | JSON configuration associated with this Launcher, restricted to a max size of 4KB | [required]
}
## Example
```python
from sailpoint.v2025.models.launcher_request import LauncherRequest
launcher_request = LauncherRequest(
name='Group Create',
description='Create a new Active Directory Group',
type='INTERACTIVE_PROCESS',
disabled=False,
reference=sailpoint.v2025.models.launcher_request_reference.LauncherRequest_reference(
type = 'WORKFLOW',
id = '2fd6ff94-2081-4d29-acbc-83a0a2f744a5', ),
config='{"workflowId" : "6b42d9be-61b6-46af-827e-ea29ba8aa3d9"}'
)
```
[[Back to top]](#)

35
docs/tools/sdk/python/Reference/V2025/Models/LauncherRequestReference.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: v2025-launcher-request-reference
title: LauncherRequestReference
pagination_label: LauncherRequestReference
sidebar_label: LauncherRequestReference
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'LauncherRequestReference', 'V2025LauncherRequestReference']
slug: /tools/sdk/python/v2025/models/launcher-request-reference
tags: ['SDK', 'Software Development Kit', 'LauncherRequestReference', 'V2025LauncherRequestReference']
---
# LauncherRequestReference
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'WORKFLOW' ] | Type of Launcher reference | [required]
**id** | **str** | ID of Launcher reference | [required]
}
## Example
```python
from sailpoint.v2025.models.launcher_request_reference import LauncherRequestReference
launcher_request_reference = LauncherRequestReference(
type='WORKFLOW',
id='2fd6ff94-2081-4d29-acbc-83a0a2f744a5'
)
```
[[Back to top]](#)

33
docs/tools/sdk/python/Reference/V2025/Models/StartLauncher200Response.md Normal file
View File

@@ -0,0 +1,33 @@
---
id: v2025-start-launcher200-response
title: StartLauncher200Response
pagination_label: StartLauncher200Response
sidebar_label: StartLauncher200Response
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'StartLauncher200Response', 'V2025StartLauncher200Response']
slug: /tools/sdk/python/v2025/models/start-launcher200-response
tags: ['SDK', 'Software Development Kit', 'StartLauncher200Response', 'V2025StartLauncher200Response']
---
# StartLauncher200Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**interactive_process_id** | **str** | ID of the Interactive Process that was launched | [required]
}
## Example
```python
from sailpoint.v2025.models.start_launcher200_response import StartLauncher200Response
start_launcher200_response = StartLauncher200Response(
interactive_process_id='5da68cfe-2d60-4b09-858f-0d03acd2f47a'
)
```
[[Back to top]](#)

46
docs/tools/sdk/python/Reference/V2025/Models/Tag.md Normal file
View File

@@ -0,0 +1,46 @@
---
id: v2025-tag
title: Tag
pagination_label: Tag
sidebar_label: Tag
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'Tag', 'V2025Tag']
slug: /tools/sdk/python/v2025/models/tag
tags: ['SDK', 'Software Development Kit', 'Tag', 'V2025Tag']
---
# Tag
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Tag id | [required][readonly]
**name** | **str** | Name of the tag. | [required]
**created** | **datetime** | Date the tag was created. | [required][readonly]
**modified** | **datetime** | Date the tag was last modified. | [required][readonly]
**tag_category_refs** | [**[]TagTagCategoryRefsInner**](tag-tag-category-refs-inner) | | [required][readonly]
}
## Example
```python
from sailpoint.v2025.models.tag import Tag
tag = Tag(
id='449ecdc0-d4ff-4341-acf6-92f6f7ce604f',
name='PCI',
created='2022-05-04T14:48:49Z',
modified='2022-07-14T16:31:11Z',
tag_category_refs=[
sailpoint.v2025.models.tag_tag_category_refs_inner.Tag_tagCategoryRefs_inner(
type = 'ENTITLEMENT',
id = '2c91809773dee32014e13e122092014e',
name = 'CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local', )
]
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/V2025/Models/TagTagCategoryRefsInner.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: v2025-tag-tag-category-refs-inner
title: TagTagCategoryRefsInner
pagination_label: TagTagCategoryRefsInner
sidebar_label: TagTagCategoryRefsInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'TagTagCategoryRefsInner', 'V2025TagTagCategoryRefsInner']
slug: /tools/sdk/python/v2025/models/tag-tag-category-refs-inner
tags: ['SDK', 'Software Development Kit', 'TagTagCategoryRefsInner', 'V2025TagTagCategoryRefsInner']
---
# TagTagCategoryRefsInner
Tagged object's category.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'ACCESS_PROFILE', 'APPLICATION', 'CAMPAIGN', 'ENTITLEMENT', 'IDENTITY', 'ROLE', 'SOD_POLICY', 'SOURCE' ] | DTO type of the tagged object's category. | [optional]
**id** | **str** | Tagged object's ID. | [optional]
**name** | **str** | Tagged object's display name. | [optional]
}
## Example
```python
from sailpoint.v2025.models.tag_tag_category_refs_inner import TagTagCategoryRefsInner
tag_tag_category_refs_inner = TagTagCategoryRefsInner(
type='ENTITLEMENT',
id='2c91809773dee32014e13e122092014e',
name='CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local'
)
```
[[Back to top]](#)

2
docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignsApi.md
View File

@@ -196,7 +196,7 @@ Param Type | Name | Data Type | Required | Description
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | This response indicates that the requested campaign was successfully created, and the API returns its representation. | Campaign | - |
202 | This response indicates that the requested campaign has been successfully accepted into the system, and its representation is returned by the API. | Campaign | - |
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 | - |