mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-11 04:19:42 +00:00
add method and model docs for powershell and python v2025
This commit is contained in:
97
docs/tools/sdk/python/Reference/V2025/Models/Entitlement.md
Normal file
97
docs/tools/sdk/python/Reference/V2025/Models/Entitlement.md
Normal file
@@ -0,0 +1,97 @@
|
||||
---
|
||||
id: v2025-entitlement
|
||||
title: Entitlement
|
||||
pagination_label: Entitlement
|
||||
sidebar_label: Entitlement
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'Entitlement', 'V2025Entitlement']
|
||||
slug: /tools/sdk/python/v2025/models/entitlement
|
||||
tags: ['SDK', 'Software Development Kit', 'Entitlement', 'V2025Entitlement']
|
||||
---
|
||||
|
||||
# Entitlement
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | The entitlement id | [optional]
|
||||
**name** | **str** | The entitlement name | [optional]
|
||||
**attribute** | **str** | The entitlement attribute name | [optional]
|
||||
**value** | **str** | The value of the entitlement | [optional]
|
||||
**source_schema_object_type** | **str** | The object type of the entitlement from the source schema | [optional]
|
||||
**description** | **str** | The description of the entitlement | [optional]
|
||||
**privileged** | **bool** | True if the entitlement is privileged | [optional]
|
||||
**cloud_governed** | **bool** | True if the entitlement is cloud governed | [optional]
|
||||
**requestable** | **bool** | True if the entitlement is able to be directly requested | [optional] [default to False]
|
||||
**owner** | [**EntitlementOwner**](entitlement-owner) | | [optional]
|
||||
**manually_updated_fields** | **map[string]object** | A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. | [optional]
|
||||
**access_model_metadata** | [**EntitlementAccessModelMetadata**](entitlement-access-model-metadata) | | [optional]
|
||||
**created** | **datetime** | Time when the entitlement was created | [optional]
|
||||
**modified** | **datetime** | Time when the entitlement was last modified | [optional]
|
||||
**source** | [**EntitlementSource**](entitlement-source) | | [optional]
|
||||
**attributes** | **map[string]object** | A map of free-form key-value pairs from the source system | [optional]
|
||||
**segments** | **[]str** | List of IDs of segments, if any, to which this Entitlement is assigned. | [optional]
|
||||
**direct_permissions** | [**[]PermissionDto**](permission-dto) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2025.models.entitlement import Entitlement
|
||||
|
||||
entitlement = Entitlement(
|
||||
id='2c91808874ff91550175097daaec161c',
|
||||
name='LauncherTest2',
|
||||
attribute='memberOf',
|
||||
value='CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local',
|
||||
source_schema_object_type='group',
|
||||
description='CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local',
|
||||
privileged=True,
|
||||
cloud_governed=True,
|
||||
requestable=True,
|
||||
owner=sailpoint.v2025.models.entitlement_owner.Entitlement_owner(
|
||||
id = '2c9180827ca885d7017ca8ce28a000eb',
|
||||
type = 'IDENTITY',
|
||||
name = 'john.doe', ),
|
||||
manually_updated_fields={DISPLAY_NAME=true, DESCRIPTION=true},
|
||||
access_model_metadata=sailpoint.v2025.models.entitlement_access_model_metadata.Entitlement_accessModelMetadata(
|
||||
attributes = [
|
||||
sailpoint.v2025.models.access_model_metadata.AccessModelMetadata(
|
||||
key = 'iscCsp',
|
||||
name = 'CSP',
|
||||
multiselect = True,
|
||||
status = 'active',
|
||||
type = 'governance',
|
||||
object_types = [
|
||||
'general'
|
||||
],
|
||||
description = 'Indicates the type of deployment environment of an access item.',
|
||||
values = [
|
||||
sailpoint.v2025.models.access_model_metadata_values_inner.AccessModelMetadata_values_inner(
|
||||
value = 'development',
|
||||
name = 'Development',
|
||||
status = 'active', )
|
||||
], )
|
||||
], ),
|
||||
created='2020-10-08T18:33:52.029Z',
|
||||
modified='2020-10-08T18:33:52.029Z',
|
||||
source=sailpoint.v2025.models.entitlement_source.Entitlement_source(
|
||||
id = '2c9180827ca885d7017ca8ce28a000eb',
|
||||
type = 'SOURCE',
|
||||
name = 'ODS-AD-Source', ),
|
||||
attributes={fieldName=fieldValue},
|
||||
segments=[f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a],
|
||||
direct_permissions=[
|
||||
sailpoint.v2025.models.permission_dto.PermissionDto(
|
||||
rights = [
|
||||
'SELECT'
|
||||
],
|
||||
target = 'SYS.GV_$TRANSACTION', )
|
||||
]
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
Reference in New Issue
Block a user