add method and model docs for powershell and python v2025

2025-12-09 12:27:47 +00:00 · 2025-04-01 09:23:12 -04:00
parent c12ffb7efc
commit 5d8f458a33
2414 changed files with 191212 additions and 0 deletions
--- a/docs/tools/sdk/python/Reference/V2025/Models/RoleDocument.md
+++ b/docs/tools/sdk/python/Reference/V2025/Models/RoleDocument.md
@@ -0,0 +1,106 @@
+---
+id: v2025-role-document
+title: RoleDocument
+pagination_label: RoleDocument
+sidebar_label: RoleDocument
+sidebar_class_name: pythonsdk
+keywords: ['python', 'Python', 'sdk', 'RoleDocument', 'V2025RoleDocument'] 
+slug: /tools/sdk/python/v2025/models/role-document
+tags: ['SDK', 'Software Development Kit', 'RoleDocument', 'V2025RoleDocument']
+---
+
+# RoleDocument
+
+Role
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **str** | Access item's description. | [optional] 
+**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional] 
+**modified** | **datetime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] 
+**synced** | **datetime** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API.   This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database.  There may be some delay between the `synced` time and the time when the updated data is actually available in the search API.  | [optional] 
+**enabled** | **bool** | Indicates whether the access item is currently enabled. | [optional] [default to False]
+**requestable** | **bool** | Indicates whether the access item can be requested. | [optional] [default to True]
+**request_comments_required** | **bool** | Indicates whether comments are required for requests to access the item. | [optional] [default to False]
+**owner** | [**BaseAccessOwner**](base-access-owner) |  | [optional] 
+**id** | **str** | ID of the role. | [required]
+**name** | **str** | Name of the role. | [required]
+**access_profiles** | [**[]BaseAccessProfile**](base-access-profile) | Access profiles included with the role. | [optional] 
+**access_profile_count** | **int** | Number of access profiles included with the role. | [optional] 
+**tags** | **[]str** | Tags that have been applied to the object. | [optional] 
+**segments** | [**[]BaseSegment**](base-segment) | Segments with the role. | [optional] 
+**segment_count** | **int** | Number of segments with the role. | [optional] 
+**entitlements** | [**[]RoleDocumentAllOfEntitlements**](role-document-all-of-entitlements) | Entitlements included with the role. | [optional] 
+**entitlement_count** | **int** | Number of entitlements included with the role. | [optional] 
+**dimensional** | **bool** |  | [optional] [default to False]
+**dimension_schema_attribute_count** | **int** | Number of dimension attributes included with the role. | [optional] 
+**dimension_schema_attributes** | [**[]RoleDocumentAllOfDimensionSchemaAttributes**](role-document-all-of-dimension-schema-attributes) | Dimension attributes included with the role. | [optional] 
+**dimensions** | [**[]RoleDocumentAllOfDimensions**](role-document-all-of-dimensions) |  | [optional] 
+}
+
+## Example
+
+```python
+from sailpoint.v2025.models.role_document import RoleDocument
+
+role_document = RoleDocument(
+description='Admin access',
+created='2018-06-25T20:22:28.104Z',
+modified='2018-06-25T20:22:28.104Z',
+synced='2018-06-25T20:22:33.104Z',
+enabled=True,
+requestable=True,
+request_comments_required=False,
+owner=sailpoint.v2025.models.base_access_owner.BaseAccess_owner(
+                    type = 'IDENTITY', 
+                    id = '2c9180a46faadee4016fb4e018c20639', 
+                    name = 'Support', 
+                    email = 'cloud-support@sailpoint.com', ),
+id='2c91808375d8e80a0175e1f88a575222',
+name='Branch Manager Access',
+access_profiles=[
+                    sailpoint.v2025.models.base_access_profile.BaseAccessProfile(
+                        id = '2c91809c6faade77016fb4f0b63407ae', 
+                        name = 'Admin Access', )
+                    ],
+access_profile_count=1,
+tags=[TAG_1, TAG_2],
+segments=[
+                    sailpoint.v2025.models.base_segment.BaseSegment(
+                        id = 'b009b6e3-b56d-41d9-8735-cb532ea0b017', 
+                        name = 'Test Segment', )
+                    ],
+segment_count=1,
+entitlements=[
+                    null
+                    ],
+entitlement_count=3,
+dimensional=False,
+dimension_schema_attribute_count=3,
+dimension_schema_attributes=[
+                    sailpoint.v2025.models.role_document_all_of_dimension_schema_attributes.RoleDocument_allOf_dimensionSchemaAttributes(
+                        derived = True, 
+                        display_name = 'Department', 
+                        name = 'department', )
+                    ],
+dimensions=[
+                    sailpoint.v2025.models.role_document_all_of_dimensions.RoleDocument_allOf_dimensions(
+                        id = 'b3c28992ba964a40a7598978139d1ced', 
+                        name = 'Manager Austin Branch', 
+                        description = 'Managers located at the Austin branch', 
+                        entitlements = [
+                            null
+                            ], 
+                        access_profiles = [
+                            sailpoint.v2025.models.base_access_profile.BaseAccessProfile(
+                                id = '2c91809c6faade77016fb4f0b63407ae', 
+                                name = 'Admin Access', )
+                            ], )
+                    ]
+)
+
+```
+[[Back to top]](#) 
+