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: 16300035339

Browse Source
This commit is contained in:
developer-relations-sp
2025-07-15 17:25:39 +00:00
parent 18336d2225
commit 0a291d270d
8 changed files with 1101 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
docs/tools/sdk/python/Reference/V2025/Models/HierarchicalRightSet.md Normal file
View File

@@ -0,0 +1,48 @@
---
id: v2025-hierarchical-right-set
title: HierarchicalRightSet
pagination_label: HierarchicalRightSet
sidebar_label: HierarchicalRightSet
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'HierarchicalRightSet', 'V2025HierarchicalRightSet']
slug: /tools/sdk/python/v2025/models/hierarchical-right-set
tags: ['SDK', 'Software Development Kit', 'HierarchicalRightSet', 'V2025HierarchicalRightSet']
---
# HierarchicalRightSet
A HierarchicalRightSet
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique identifier of the RightSet. | [optional]
**name** | **str** | The human-readable name of the RightSet. | [optional]
**description** | **str** | A human-readable description of the RightSet. | [optional]
**category** | **str** | The category of the RightSet. | [optional]
**nested_config** | [**NestedConfig**](nested-config) | | [optional]
**children** | [**[]HierarchicalRightSet**](hierarchical-right-set) | List of child HierarchicalRightSets. | [optional]
}
## Example
```python
from sailpoint.v2025.models.hierarchical_right_set import HierarchicalRightSet
hierarchical_right_set = HierarchicalRightSet(
id='idn:ui-right-set-example',
name='Hierarchical Right Set Name',
description='This is a description of the HierarchicalRightSet.',
category='identity',
nested_config=sailpoint.v2025.models.nested_config.NestedConfig(
ancestor_id = 'idn:ui-ancestor-example',
depth = 2,
parent_id = 'idn:ui-parent-example',
children_ids = [idn:ui-child-one-example, idn:ui-child-two-example], ),
children={id=idn:ui-identity-details-example, name=Identity Details, description=Read only access for identity details., category=identity, nestedConfig={ancestorId=idn:ui-identity-management-example, depth=1, parentId=idn:ui-identity-management-example, childrenIds=[]}, children=[]}
)
```
[[Back to top]](#)

40
docs/tools/sdk/python/Reference/V2025/Models/NestedConfig.md Normal file
View File

@@ -0,0 +1,40 @@
---
id: v2025-nested-config
title: NestedConfig
pagination_label: NestedConfig
sidebar_label: NestedConfig
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'NestedConfig', 'V2025NestedConfig']
slug: /tools/sdk/python/v2025/models/nested-config
tags: ['SDK', 'Software Development Kit', 'NestedConfig', 'V2025NestedConfig']
---
# NestedConfig
A NestedConfig
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ancestor_id** | **str** | The unique identifier of the ancestor RightSet. | [optional]
**depth** | **int** | The depth level of the configuration. | [optional]
**parent_id** | **str** | The unique identifier of the parent RightSet. | [optional]
**children_ids** | **[]str** | List of unique identifiers for child configurations. | [optional]
}
## Example
```python
from sailpoint.v2025.models.nested_config import NestedConfig
nested_config = NestedConfig(
ancestor_id='idn:ui-ancestor-example',
depth=2,
parent_id='idn:ui-parent-example',
children_ids=[idn:ui-child-one-example, idn:ui-child-two-example]
)
```
[[Back to top]](#)

54
docs/tools/sdk/python/Reference/V2025/Models/RightSetDTO.md Normal file
View File

@@ -0,0 +1,54 @@
---
id: v2025-right-set-dto
title: RightSetDTO
pagination_label: RightSetDTO
sidebar_label: RightSetDTO
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'RightSetDTO', 'V2025RightSetDTO']
slug: /tools/sdk/python/v2025/models/right-set-dto
tags: ['SDK', 'Software Development Kit', 'RightSetDTO', 'V2025RightSetDTO']
---
# RightSetDTO
A RightSetDTO represents a collection of rights that assigned to capability or scope, enabling them to possess specific rights to access corresponding APIs.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique identifier of the RightSet. | [optional]
**name** | **str** | The human-readable name of the RightSet. | [optional]
**description** | **str** | A human-readable description of the RightSet. | [optional]
**category** | **str** | The category of the RightSet. | [optional]
**rights** | **[]str** | Right is the most granular unit that determines specific API permissions, this is a list of rights associated with the RightSet. | [optional]
**right_set_ids** | **[]str** | List of unique identifiers for related RightSets, current RightSet contains rights from these RightSets. | [optional]
**ui_assignable_child_right_set_ids** | **[]str** | List of unique identifiers for UI-assignable child RightSets, used to build UI components. | [optional]
**ui_assignable** | **bool** | Indicates whether the RightSet is UI-assignable. | [optional] [default to False]
**translated_name** | **str** | The translated name of the RightSet. | [optional]
**translated_description** | **str** | The translated description of the RightSet. | [optional]
**parent_id** | **str** | The unique identifier of the parent RightSet for UI Assignable RightSet. | [optional]
}
## Example
```python
from sailpoint.v2025.models.right_set_dto import RightSetDTO
right_set_dto = RightSetDTO(
id='idn:ui-right-set-example',
name='Right Set Name',
description='This is a description of the RightSet.',
category='identity',
rights=[idn:ui-right-set-example:read, idn:ui-right-set-example:write],
right_set_ids=[idn:ui-right-set-example-update, idn:ui-right-set-example-delete],
ui_assignable_child_right_set_ids=[idn:ui-right-set-example-detail, idn:ui-right-set-example-management],
ui_assignable=True,
translated_name='Translated Right Set Name',
translated_description='This is a translated description of the RightSet.',
parent_id='idn:ui-parent-example'
)
```
[[Back to top]](#)

40
docs/tools/sdk/python/Reference/V2025/Models/UserLevelPublishSummary.md Normal file
View File

@@ -0,0 +1,40 @@
---
id: v2025-user-level-publish-summary
title: UserLevelPublishSummary
pagination_label: UserLevelPublishSummary
sidebar_label: UserLevelPublishSummary
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'UserLevelPublishSummary', 'V2025UserLevelPublishSummary']
slug: /tools/sdk/python/v2025/models/user-level-publish-summary
tags: ['SDK', 'Software Development Kit', 'UserLevelPublishSummary', 'V2025UserLevelPublishSummary']
---
# UserLevelPublishSummary
It represents a summary of a user level publish operation, including its metadata and status.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**user_level_id** | **str** | The unique identifier of the UserLevel. | [optional]
**publish** | **bool** | Indicates whether the API call triggered a publish operation. | [optional] [default to False]
**status** | **str** | The status of the UserLevel publish operation. | [optional]
**modified** | **datetime** | The last modification timestamp of the UserLevel. | [optional]
}
## Example
```python
from sailpoint.v2025.models.user_level_publish_summary import UserLevelPublishSummary
user_level_publish_summary = UserLevelPublishSummary(
user_level_id='6e110911-5984-491b-be74-2707980a46a7',
publish=True,
status='ACTIVE',
modified='2023-01-02T12:00Z'
)
```
[[Back to top]](#)

43
docs/tools/sdk/python/Reference/V2025/Models/UserLevelRequest.md Normal file
View File

@@ -0,0 +1,43 @@
---
id: v2025-user-level-request
title: UserLevelRequest
pagination_label: UserLevelRequest
sidebar_label: UserLevelRequest
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'UserLevelRequest', 'V2025UserLevelRequest']
slug: /tools/sdk/python/v2025/models/user-level-request
tags: ['SDK', 'Software Development Kit', 'UserLevelRequest', 'V2025UserLevelRequest']
---
# UserLevelRequest
Payload containing details for creating a custom user level.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | The name of the user level. | [required]
**description** | **str** | A brief description of the user level. | [required]
**owner** | [**BaseReferenceDto**](base-reference-dto) | | [required]
**right_sets** | **[]str** | A list of rights associated with the user level. | [optional]
}
## Example
```python
from sailpoint.v2025.models.user_level_request import UserLevelRequest
user_level_request = UserLevelRequest(
name='Custom User Level Name',
description='This is a description of the custom user level.',
owner=sailpoint.v2025.models.base_reference_dto.BaseReferenceDto(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'William Wilson', ),
right_sets=[idn:ui-right-set-list-read-example, idn:ui-right-set-write-example]
)
```
[[Back to top]](#)

78
docs/tools/sdk/python/Reference/V2025/Models/UserLevelSummaryDTO.md Normal file
View File

@@ -0,0 +1,78 @@
---
id: v2025-user-level-summary-dto
title: UserLevelSummaryDTO
pagination_label: UserLevelSummaryDTO
sidebar_label: UserLevelSummaryDTO
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'UserLevelSummaryDTO', 'V2025UserLevelSummaryDTO']
slug: /tools/sdk/python/v2025/models/user-level-summary-dto
tags: ['SDK', 'Software Development Kit', 'UserLevelSummaryDTO', 'V2025UserLevelSummaryDTO']
---
# UserLevelSummaryDTO
It represents a summary of a user level, including its metadata, attributes, and associated properties.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique identifier of the UserLevel. | [optional]
**name** | **str** | The human-readable name of the UserLevel. | [optional]
**description** | **str** | A human-readable description of the UserLevel. | [optional]
**legacy_group** | **str** | The legacy group associated with the UserLevel, used for backward compatibility for the UserLevel id. | [optional]
**right_sets** | [**[]RightSetDTO**](right-set-dto) | List of RightSets associated with the UserLevel. | [optional]
**custom** | **bool** | Indicates whether the UserLevel is custom. | [optional] [default to True]
**admin_assignable** | **bool** | Indicates whether the UserLevel is admin-assignable. | [optional] [default to True]
**translated_name** | **str** | The translated name of the UserLevel. | [optional]
**translated_grant** | **str** | The translated grant message for the UserLevel. | [optional]
**translated_remove** | **str** | The translated remove message for the UserLevel. | [optional]
**owner** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
**status** | **Enum** [ 'ACTIVE', 'DRAFT' ] | The status of the UserLevel. | [optional]
**created** | **datetime** | The creation timestamp of the UserLevel. | [optional]
**modified** | **datetime** | The last modification timestamp of the UserLevel. | [optional]
**associated_identities_count** | **int** | The count of associated identities for the UserLevel. | [optional]
}
## Example
```python
from sailpoint.v2025.models.user_level_summary_dto import UserLevelSummaryDTO
user_level_summary_dto = UserLevelSummaryDTO(
id='beb02a57-010f-4c29-a6d2-fae9628bda73',
name='Custom User Level Name',
description='This is a description of the CustomUserLevel.',
legacy_group='ORG_ADMIN',
right_sets=[
sailpoint.v2025.models.right_set_dto.RightSetDTO(
id = 'idn:ui-right-set-example',
name = 'Right Set Name',
description = 'This is a description of the RightSet.',
category = 'identity',
rights = [idn:ui-right-set-example:read, idn:ui-right-set-example:write],
right_set_ids = [idn:ui-right-set-example-update, idn:ui-right-set-example-delete],
ui_assignable_child_right_set_ids = [idn:ui-right-set-example-detail, idn:ui-right-set-example-management],
ui_assignable = True,
translated_name = 'Translated Right Set Name',
translated_description = 'This is a translated description of the RightSet.',
parent_id = 'idn:ui-parent-example', )
],
custom=True,
admin_assignable=True,
translated_name='Translated Custom User Level Name',
translated_grant='Grant Message',
translated_remove='Remove Message',
owner=sailpoint.v2025.models.base_reference_dto.BaseReferenceDto(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'William Wilson', ),
status='Active',
created='2023-01-01T12:00Z',
modified='2023-01-02T12:00Z',
associated_identities_count=10
)
```
[[Back to top]](#)