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

Browse Source
This commit is contained in:
developer-relations-sp
2025-08-21 16:01:51 +00:00
parent 6529e8916a
commit ed086d4f22
36 changed files with 510 additions and 581 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
docs/tools/sdk/python/Reference/V3/Models/EntitlementRef1.md
View File

@@ -1,38 +0,0 @@
---
id: entitlement-ref1
title: EntitlementRef1
pagination_label: EntitlementRef1
sidebar_label: EntitlementRef1
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'EntitlementRef1', 'EntitlementRef1']
slug: /tools/sdk/python/v3/models/entitlement-ref1
tags: ['SDK', 'Software Development Kit', 'EntitlementRef1', 'EntitlementRef1']
---
# EntitlementRef1
Entitlement including a specific set of access.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'ENTITLEMENT' ] | Entitlement's DTO type. | [optional]
**id** | **str** | Entitlement's ID. | [optional]
**name** | **str** | Entitlement's display name. | [optional]
}
## Example
```python
from sailpoint.v3.models.entitlement_ref1 import EntitlementRef1
entitlement_ref1 = EntitlementRef1(
type='ENTITLEMENT',
id='2c91809773dee32014e13e122092014e',
name='CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local'
)
```
[[Back to top]](#)

2
docs/tools/sdk/python/Reference/V3/Models/IdentityWithNewAccess.md
View File

@@ -28,7 +28,7 @@ from sailpoint.v3.models.identity_with_new_access import IdentityWithNewAccess
identity_with_new_access = IdentityWithNewAccess(
identity_id='2c91808568c529c60168cca6f90c1313',
access_refs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}]
access_refs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]
)
```

40
docs/tools/sdk/python/Reference/V3/Models/IdentityWithNewAccess1.md
View File

@@ -1,40 +0,0 @@
---
id: identity-with-new-access1
title: IdentityWithNewAccess1
pagination_label: IdentityWithNewAccess1
sidebar_label: IdentityWithNewAccess1
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'IdentityWithNewAccess1', 'IdentityWithNewAccess1']
slug: /tools/sdk/python/v3/models/identity-with-new-access1
tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess1', 'IdentityWithNewAccess1']
---
# IdentityWithNewAccess1
An identity with a set of access to be added
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identity_id** | **str** | Set of identity IDs to be checked. | [required]
**access_refs** | [**[]EntitlementRef1**](entitlement-ref1) | The bundle of access profiles to be added to the identities specified. All references must be ENTITLEMENT type. | [required]
**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional]
}
## Example
```python
from sailpoint.v3.models.identity_with_new_access1 import IdentityWithNewAccess1
identity_with_new_access1 = IdentityWithNewAccess1(
identity_id='2c91809050db617d0150e0bf3215385e',
access_refs=[
null
],
client_metadata={clientName=client1, clientId=2c91808f7892918f0178b78da4a305a1}
)
```
[[Back to top]](#)

4
docs/tools/sdk/python/Reference/V3/Models/IdentityWithNewAccessAccessRefsInner.md
View File

@@ -19,7 +19,6 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'ENTITLEMENT' ] | Entitlement's DTO type. | [optional]
**id** | **str** | Entitlement's ID. | [optional]
**name** | **str** | Entitlement's display name. | [optional]
}
## Example
@@ -29,8 +28,7 @@ from sailpoint.v3.models.identity_with_new_access_access_refs_inner import Ident
identity_with_new_access_access_refs_inner = IdentityWithNewAccessAccessRefsInner(
type='ENTITLEMENT',
id='2c91809773dee32014e13e122092014e',
name='CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local'
id='2c91809773dee32014e13e122092014e'
)
```

5
docs/tools/sdk/python/Reference/V3/Models/ManagedCluster.md
View File

@@ -29,13 +29,14 @@ Name | Type | Description | Notes
**redis** | [**ManagedClusterRedis**](managed-cluster-redis) | | [optional]
**client_type** | [**ManagedClientType**](managed-client-type) | | [required]
**ccg_version** | **str** | CCG version used by the ManagedCluster | [required]
**pinned_config** | **bool** | boolean flag indiacting whether or not the cluster configuration is pinned | [optional] [default to False]
**pinned_config** | **bool** | boolean flag indicating whether or not the cluster configuration is pinned | [optional] [default to False]
**log_configuration** | [**ClientLogConfiguration**](client-log-configuration) | | [optional]
**operational** | **bool** | Whether or not the cluster is operational or not | [optional] [default to False]
**status** | **Enum** [ 'CONFIGURING', 'FAILED', 'NO_CLIENTS', 'NORMAL', 'WARNING' ] | Cluster status | [optional]
**public_key_certificate** | **str** | Public key certificate | [optional]
**public_key_thumbprint** | **str** | Public key thumbprint | [optional]
**public_key** | **str** | Public key | [optional]
**encryption_configuration** | [**ManagedClusterEncryptionConfig**](managed-cluster-encryption-config) | | [optional]
**alert_key** | **str** | Key describing any immediate cluster alerts | [optional]
**client_ids** | **[]str** | List of clients in a cluster | [optional]
**service_count** | **int** | Number of services bound to a cluster | [optional] [default to 0]
@@ -83,6 +84,8 @@ status='NORMAL',
public_key_certificate='-----BEGIN CERTIFICATE-----TCCAb2gAwIBAgIBADANBgkqhkiG9w0BAQsFADAuMQ0wCwYDVQQD-----END CERTIFICATE-----',
public_key_thumbprint='obc6pLiulGbtZ',
public_key='-----BEGIN PUBLIC KEY-----jANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3WgnsxP52MDgBTfHR+5n4-----END PUBLIC KEY-----',
encryption_configuration=sailpoint.v3.models.managed_cluster_encryption_configuration.Managed Cluster Encryption Configuration(
format = 'V3', ),
alert_key='LIMITED_RESOURCES',
client_ids=[1244, 1245],
service_count=6,

34
docs/tools/sdk/python/Reference/V3/Models/ManagedClusterEncryptionConfig.md Normal file
View File

@@ -0,0 +1,34 @@
---
id: managed-cluster-encryption-config
title: ManagedClusterEncryptionConfig
pagination_label: ManagedClusterEncryptionConfig
sidebar_label: ManagedClusterEncryptionConfig
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ManagedClusterEncryptionConfig', 'ManagedClusterEncryptionConfig']
slug: /tools/sdk/python/v3/models/managed-cluster-encryption-config
tags: ['SDK', 'Software Development Kit', 'ManagedClusterEncryptionConfig', 'ManagedClusterEncryptionConfig']
---
# ManagedClusterEncryptionConfig
Defines the encryption settings for a managed cluster, including the format used for storing and processing encrypted data.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**format** | **Enum** [ 'V2', 'V3' ] | Specifies the format used for encrypted data, such as secrets. The format determines how the encrypted data is structured and processed. | [optional]
}
## Example
```python
from sailpoint.v3.models.managed_cluster_encryption_config import ManagedClusterEncryptionConfig
managed_cluster_encryption_config = ManagedClusterEncryptionConfig(
format='V3'
)
```
[[Back to top]](#)