LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to python SDK docs: 14455009748

Browse Source
This commit is contained in:
developer-relations-sp
2025-04-14 20:23:46 +00:00
parent 5111ee7368
commit 59a220c8cd
90 changed files with 12638 additions and 7669 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/tools/sdk/python/Reference/Beta/Models/AccessRequest.md
View File

@@ -20,6 +20,7 @@ Name | Type | Description | Notes
**request_type** | [**AccessRequestType**](access-request-type) | | [optional]
**requested_items** | [**[]AccessRequestItem**](access-request-item) | | [required]
**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional]
**requested_for_with_requested_items** | [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request | [optional]
}
## Example
@@ -28,9 +29,7 @@ Name | Type | Description | Notes
from sailpoint.beta.models.access_request import AccessRequest
access_request = AccessRequest(
requested_for=[
'2c918084660f45d6016617daa9210584'
],
requested_for=2c918084660f45d6016617daa9210584,
request_type='GRANT_ACCESS',
requested_items=[
sailpoint.beta.models.access_request_item.AccessRequestItem(
@@ -42,7 +41,30 @@ requested_items=[
assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc',
native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', )
],
client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app}
client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app},
requested_for_with_requested_items=[
sailpoint.beta.models.requested_for_dto_ref.RequestedForDtoRef(
identity_id = 'cb89bc2f1ee6445fbea12224c526ba3a',
requested_items = [
sailpoint.beta.models.requested_item_dto_ref.RequestedItemDtoRef(
type = 'ACCESS_PROFILE',
id = '2c9180835d2e5168015d32f890ca1581',
comment = 'Requesting access profile for John Doe',
client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1},
remove_date = '2020-07-11T21:23:15Z',
assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc',
native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN',
account_selection = [
sailpoint.beta.models.source_item_ref.SourceItemRef(
source_id = 'cb89bc2f1ee6445fbea12224c526ba3a',
accounts = [
sailpoint.beta.models.account_item_ref.AccountItemRef(
account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}',
native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', )
], )
], )
], )
]
)
```

35
docs/tools/sdk/python/Reference/Beta/Models/AccountItemRef.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: beta-account-item-ref
title: AccountItemRef
pagination_label: AccountItemRef
sidebar_label: AccountItemRef
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountItemRef', 'BetaAccountItemRef']
slug: /tools/sdk/python/beta/models/account-item-ref
tags: ['SDK', 'Software Development Kit', 'AccountItemRef', 'BetaAccountItemRef']
---
# AccountItemRef
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**account_uuid** | **str** | The uuid for the account, available under the 'objectguid' attribute | [optional]
**native_identity** | **str** | The 'distinguishedName' attribute for the account | [optional]
}
## Example
```python
from sailpoint.beta.models.account_item_ref import AccountItemRef
account_item_ref = AccountItemRef(
account_uuid='{fab7119e-004f-4822-9c33-b8d570d6c6a6}',
native_identity='CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local'
)
```
[[Back to top]](#)

2
docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md
View File

@@ -26,7 +26,7 @@ Name | Type | Description | Notes
from sailpoint.beta.models.account_usage import AccountUsage
account_usage = AccountUsage(
var_date='Fri Apr 21 00:00:00 UTC 2023',
var_date='Thu Apr 20 20:00:00 EDT 2023',
count=10
)

2
docs/tools/sdk/python/Reference/Beta/Models/AttributeDefinitionType.md
View File

@@ -23,5 +23,7 @@ The underlying type of the value which an AttributeDefinition represents.
* `BOOLEAN` (value: `'BOOLEAN'`)
* `DATE` (value: `'DATE'`)
[[Back to top]](#)

2
docs/tools/sdk/python/Reference/Beta/Models/ModelSchema.md
View File

@@ -22,7 +22,7 @@ Name | Type | Description | Notes
**identity_attribute** | **str** | The name of the attribute used to calculate the unique identifier for an object in the schema. | [optional]
**display_attribute** | **str** | The name of the attribute used to calculate the display value for an object in the schema. | [optional]
**hierarchy_attribute** | **str** | The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. | [optional]
**include_permissions** | **bool** | Flag indicating whether or not the include permissions with the object data when aggregating the schema. | [optional]
**include_permissions** | **bool** | Flag indicating whether or not the include permissions with the object data when aggregating the schema. | [optional] [default to False]
**features** | **[]str** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional]
**configuration** | **object** | Holds any extra configuration data that the schema may require. | [optional]
**attributes** | [**[]AttributeDefinition**](attribute-definition) | The attribute definitions which form the schema. | [optional]

4
docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md
View File

@@ -56,8 +56,8 @@ data={description=Auditing},
approval_status='APPROVED',
comment='approved',
completion_date='2020-03-24T11:11:41.139-05:00',
start_date='Tue Mar 24 00:00:00 UTC 2020',
end_date='Thu Mar 25 00:00:00 UTC 2021',
start_date='Mon Mar 23 20:00:00 EDT 2020',
end_date='Wed Mar 24 20:00:00 EDT 2021',
modified='2020-03-24T11:11:41.139-05:00',
created='2020-03-24T11:11:41.139-05:00'
)

53
docs/tools/sdk/python/Reference/Beta/Models/RequestedForDtoRef.md Normal file
View File

@@ -0,0 +1,53 @@
---
id: beta-requested-for-dto-ref
title: RequestedForDtoRef
pagination_label: RequestedForDtoRef
sidebar_label: RequestedForDtoRef
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'RequestedForDtoRef', 'BetaRequestedForDtoRef']
slug: /tools/sdk/python/beta/models/requested-for-dto-ref
tags: ['SDK', 'Software Development Kit', 'RequestedForDtoRef', 'BetaRequestedForDtoRef']
---
# RequestedForDtoRef
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identity_id** | **str** | The identity id for which the access is requested | [required]
**requested_items** | [**[]RequestedItemDtoRef**](requested-item-dto-ref) | the details for the access items that are requested for the identity | [required]
}
## Example
```python
from sailpoint.beta.models.requested_for_dto_ref import RequestedForDtoRef
requested_for_dto_ref = RequestedForDtoRef(
identity_id='cb89bc2f1ee6445fbea12224c526ba3a',
requested_items=[
sailpoint.beta.models.requested_item_dto_ref.RequestedItemDtoRef(
type = 'ACCESS_PROFILE',
id = '2c9180835d2e5168015d32f890ca1581',
comment = 'Requesting access profile for John Doe',
client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1},
remove_date = '2020-07-11T21:23:15Z',
assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc',
native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN',
account_selection = [
sailpoint.beta.models.source_item_ref.SourceItemRef(
source_id = 'cb89bc2f1ee6445fbea12224c526ba3a',
accounts = [
sailpoint.beta.models.account_item_ref.AccountItemRef(
account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}',
native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', )
], )
], )
]
)
```
[[Back to top]](#)

55
docs/tools/sdk/python/Reference/Beta/Models/RequestedItemDtoRef.md Normal file
View File

@@ -0,0 +1,55 @@
---
id: beta-requested-item-dto-ref
title: RequestedItemDtoRef
pagination_label: RequestedItemDtoRef
sidebar_label: RequestedItemDtoRef
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'RequestedItemDtoRef', 'BetaRequestedItemDtoRef']
slug: /tools/sdk/python/beta/models/requested-item-dto-ref
tags: ['SDK', 'Software Development Kit', 'RequestedItemDtoRef', 'BetaRequestedItemDtoRef']
---
# RequestedItemDtoRef
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of the item being requested. | [required]
**id** | **str** | ID of Role, Access Profile or Entitlement being requested. | [required]
**comment** | **str** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional]
**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional]
**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional]
**assignment_id** | **str** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional]
**native_identity** | **str** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional]
**account_selection** | [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional]
}
## Example
```python
from sailpoint.beta.models.requested_item_dto_ref import RequestedItemDtoRef
requested_item_dto_ref = RequestedItemDtoRef(
type='ACCESS_PROFILE',
id='2c9180835d2e5168015d32f890ca1581',
comment='Requesting access profile for John Doe',
client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1},
remove_date='2020-07-11T21:23:15Z',
assignment_id='ee48a191c00d49bf9264eb0a4fc3a9fc',
native_identity='CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN',
account_selection=[
sailpoint.beta.models.source_item_ref.SourceItemRef(
source_id = 'cb89bc2f1ee6445fbea12224c526ba3a',
accounts = [
sailpoint.beta.models.account_item_ref.AccountItemRef(
account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}',
native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', )
], )
]
)
```
[[Back to top]](#)

39
docs/tools/sdk/python/Reference/Beta/Models/SourceItemRef.md Normal file
View File

@@ -0,0 +1,39 @@
---
id: beta-source-item-ref
title: SourceItemRef
pagination_label: SourceItemRef
sidebar_label: SourceItemRef
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'SourceItemRef', 'BetaSourceItemRef']
slug: /tools/sdk/python/beta/models/source-item-ref
tags: ['SDK', 'Software Development Kit', 'SourceItemRef', 'BetaSourceItemRef']
---
# SourceItemRef
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**source_id** | **str** | The id for the source on which account selections are made | [optional]
**accounts** | [**[]AccountItemRef**](account-item-ref) | A list of account selections on the source. Currently, only one selection per source is supported. | [optional]
}
## Example
```python
from sailpoint.beta.models.source_item_ref import SourceItemRef
source_item_ref = SourceItemRef(
source_id='cb89bc2f1ee6445fbea12224c526ba3a',
accounts=[
sailpoint.beta.models.account_item_ref.AccountItemRef(
account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}',
native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', )
]
)
```
[[Back to top]](#)

2
docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md
View File

@@ -26,7 +26,7 @@ Name | Type | Description | Notes
from sailpoint.beta.models.source_usage import SourceUsage
source_usage = SourceUsage(
var_date='Fri Apr 21 00:00:00 UTC 2023',
var_date='Thu Apr 20 20:00:00 EDT 2023',
count=10.45
)