LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 20:37:46 +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

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