Update python SDK docs: 16971661330

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

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]](#)

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]](#)

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]](#)

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]](#)

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]](#)

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]](#)

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]](#)

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]](#)

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]](#)