mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 20:37:46 +00:00
starting point for adding python sdk docs
This commit is contained in:
41
docs/tools/sdk/python/Reference/V3/Models/Access.md
Normal file
41
docs/tools/sdk/python/Reference/V3/Models/Access.md
Normal file
@@ -0,0 +1,41 @@
|
||||
---
|
||||
id: access
|
||||
title: Access
|
||||
pagination_label: Access
|
||||
sidebar_label: Access
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'Access', 'Access']
|
||||
slug: /tools/sdk/python/v3/models/access
|
||||
tags: ['SDK', 'Software Development Kit', 'Access', 'Access']
|
||||
---
|
||||
|
||||
# Access
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | The unique ID of the referenced object. | [optional]
|
||||
**name** | **str** | The human readable name of the referenced object. | [optional]
|
||||
**display_name** | **str** | | [optional]
|
||||
**type** | [**DtoType**](dto-type) | | [optional]
|
||||
**description** | **str** | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access import Access
|
||||
|
||||
access = Access(
|
||||
id='2c91808568c529c60168cca6f90c1313',
|
||||
name='John Doe',
|
||||
display_name='John Q. Doe',
|
||||
type='IDENTITY',
|
||||
description=''
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: access-constraint
|
||||
title: AccessConstraint
|
||||
pagination_label: AccessConstraint
|
||||
sidebar_label: AccessConstraint
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessConstraint', 'AccessConstraint']
|
||||
slug: /tools/sdk/python/v3/models/access-constraint
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessConstraint', 'AccessConstraint']
|
||||
---
|
||||
|
||||
# AccessConstraint
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **Enum** [ 'ENTITLEMENT', 'ACCESS_PROFILE', 'ROLE' ] | Type of Access | [required]
|
||||
**ids** | **[]str** | Must be set only if operator is SELECTED. | [optional]
|
||||
**operator** | **Enum** [ 'ALL', 'SELECTED' ] | Used to determine whether the scope of the campaign should be reduced for selected ids or all. | [required]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_constraint import AccessConstraint
|
||||
|
||||
access_constraint = AccessConstraint(
|
||||
type='ENTITLEMENT',
|
||||
ids=[2c90ad2a70ace7d50170acf22ca90010],
|
||||
operator='SELECTED'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
35
docs/tools/sdk/python/Reference/V3/Models/AccessCriteria.md
Normal file
35
docs/tools/sdk/python/Reference/V3/Models/AccessCriteria.md
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: access-criteria
|
||||
title: AccessCriteria
|
||||
pagination_label: AccessCriteria
|
||||
sidebar_label: AccessCriteria
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessCriteria', 'AccessCriteria']
|
||||
slug: /tools/sdk/python/v3/models/access-criteria
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessCriteria', 'AccessCriteria']
|
||||
---
|
||||
|
||||
# AccessCriteria
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | Business name for the access construct list | [optional]
|
||||
**criteria_list** | [**[]AccessCriteriaCriteriaListInner**](access-criteria-criteria-list-inner) | List of criteria. There is a min of 1 and max of 50 items in the list. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_criteria import AccessCriteria
|
||||
|
||||
access_criteria = AccessCriteria(
|
||||
name='money-in',
|
||||
criteria_list=[{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}]
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: access-criteria-criteria-list-inner
|
||||
title: AccessCriteriaCriteriaListInner
|
||||
pagination_label: AccessCriteriaCriteriaListInner
|
||||
sidebar_label: AccessCriteriaCriteriaListInner
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessCriteriaCriteriaListInner', 'AccessCriteriaCriteriaListInner']
|
||||
slug: /tools/sdk/python/v3/models/access-criteria-criteria-list-inner
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessCriteriaCriteriaListInner', 'AccessCriteriaCriteriaListInner']
|
||||
---
|
||||
|
||||
# AccessCriteriaCriteriaListInner
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **Enum** [ 'ENTITLEMENT' ] | Type of the propery to which this reference applies to | [optional]
|
||||
**id** | **str** | ID of the object to which this reference applies to | [optional]
|
||||
**name** | **str** | Human-readable display name of the object to which this reference applies to | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_criteria_criteria_list_inner import AccessCriteriaCriteriaListInner
|
||||
|
||||
access_criteria_criteria_list_inner = AccessCriteriaCriteriaListInner(
|
||||
type='ENTITLEMENT',
|
||||
id='2c91808568c529c60168cca6f90c1313',
|
||||
name='Administrator'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
id: access-item-requested-for
|
||||
title: AccessItemRequestedFor
|
||||
pagination_label: AccessItemRequestedFor
|
||||
sidebar_label: AccessItemRequestedFor
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessItemRequestedFor', 'AccessItemRequestedFor']
|
||||
slug: /tools/sdk/python/v3/models/access-item-requested-for
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessItemRequestedFor', 'AccessItemRequestedFor']
|
||||
---
|
||||
|
||||
# AccessItemRequestedFor
|
||||
|
||||
Identity the access item is requested for.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity the access item is requested for. | [optional]
|
||||
**id** | **str** | ID of identity the access item is requested for. | [optional]
|
||||
**name** | **str** | Human-readable display name of identity the access item is requested for. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_item_requested_for import AccessItemRequestedFor
|
||||
|
||||
access_item_requested_for = AccessItemRequestedFor(
|
||||
type='IDENTITY',
|
||||
id='2c4180a46faadee4016fb4e018c20626',
|
||||
name='Robert Robinson'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
id: access-item-requester
|
||||
title: AccessItemRequester
|
||||
pagination_label: AccessItemRequester
|
||||
sidebar_label: AccessItemRequester
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessItemRequester', 'AccessItemRequester']
|
||||
slug: /tools/sdk/python/v3/models/access-item-requester
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessItemRequester', 'AccessItemRequester']
|
||||
---
|
||||
|
||||
# AccessItemRequester
|
||||
|
||||
Access item requester's identity.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **Enum** [ 'IDENTITY' ] | Access item requester's DTO type. | [optional]
|
||||
**id** | **str** | Access item requester's identity ID. | [optional]
|
||||
**name** | **str** | Access item owner's human-readable display name. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_item_requester import AccessItemRequester
|
||||
|
||||
access_item_requester = AccessItemRequester(
|
||||
type='IDENTITY',
|
||||
id='2c7180a46faadee4016fb4e018c20648',
|
||||
name='William Wilson'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
id: access-item-reviewed-by
|
||||
title: AccessItemReviewedBy
|
||||
pagination_label: AccessItemReviewedBy
|
||||
sidebar_label: AccessItemReviewedBy
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessItemReviewedBy', 'AccessItemReviewedBy']
|
||||
slug: /tools/sdk/python/v3/models/access-item-reviewed-by
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessItemReviewedBy', 'AccessItemReviewedBy']
|
||||
---
|
||||
|
||||
# AccessItemReviewedBy
|
||||
|
||||
Identity who reviewed the access item request.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity who reviewed the access item request. | [optional]
|
||||
**id** | **str** | ID of identity who reviewed the access item request. | [optional]
|
||||
**name** | **str** | Human-readable display name of identity who reviewed the access item request. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_item_reviewed_by import AccessItemReviewedBy
|
||||
|
||||
access_item_reviewed_by = AccessItemReviewedBy(
|
||||
type='IDENTITY',
|
||||
id='2c3780a46faadee4016fb4e018c20652',
|
||||
name='Allen Albertson'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
91
docs/tools/sdk/python/Reference/V3/Models/AccessProfile.md
Normal file
91
docs/tools/sdk/python/Reference/V3/Models/AccessProfile.md
Normal file
@@ -0,0 +1,91 @@
|
||||
---
|
||||
id: access-profile
|
||||
title: AccessProfile
|
||||
pagination_label: AccessProfile
|
||||
sidebar_label: AccessProfile
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessProfile', 'AccessProfile']
|
||||
slug: /tools/sdk/python/v3/models/access-profile
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'AccessProfile']
|
||||
---
|
||||
|
||||
# AccessProfile
|
||||
|
||||
Access Profile
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | The ID of the Access Profile | [optional] [readonly]
|
||||
**name** | **str** | Name of the Access Profile | [required]
|
||||
**description** | **str** | Information about the Access Profile | [optional]
|
||||
**created** | **datetime** | Date the Access Profile was created | [optional] [readonly]
|
||||
**modified** | **datetime** | Date the Access Profile was last modified. | [optional] [readonly]
|
||||
**enabled** | **bool** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to True]
|
||||
**owner** | [**OwnerReference**](owner-reference) | | [required]
|
||||
**source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required]
|
||||
**entitlements** | [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional]
|
||||
**requestable** | **bool** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to True]
|
||||
**access_request_config** | [**Requestability**](requestability) | | [optional]
|
||||
**revocation_request_config** | [**Revocability**](revocability) | | [optional]
|
||||
**segments** | **[]str** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional]
|
||||
**provisioning_criteria** | [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_profile import AccessProfile
|
||||
|
||||
access_profile = AccessProfile(
|
||||
id='2c91808a7190d06e01719938fcd20792',
|
||||
name='Employee-database-read-write',
|
||||
description='Collection of entitlements to read/write the employee database',
|
||||
created='2021-03-01T22:32:58.104Z',
|
||||
modified='2021-03-02T20:22:28.104Z',
|
||||
enabled=True,
|
||||
owner=sailpoint.v3.models.owner_reference.OwnerReference(
|
||||
type = 'IDENTITY',
|
||||
id = '2c9180a46faadee4016fb4e018c20639',
|
||||
name = 'support', ),
|
||||
source=sailpoint.v3.models.access_profile_source_ref.AccessProfileSourceRef(
|
||||
id = '2c91809773dee3610173fdb0b6061ef4',
|
||||
type = 'SOURCE',
|
||||
name = 'ODS-AD-SOURCE', ),
|
||||
entitlements=[
|
||||
sailpoint.v3.models.entitlement_ref.EntitlementRef(
|
||||
type = 'ENTITLEMENT',
|
||||
id = '2c91809773dee32014e13e122092014e',
|
||||
name = 'CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local', )
|
||||
],
|
||||
requestable=True,
|
||||
access_request_config=sailpoint.v3.models.requestability.Requestability(
|
||||
comments_required = True,
|
||||
denial_comments_required = True,
|
||||
approval_schemes = [
|
||||
sailpoint.v3.models.access_profile_approval_scheme.AccessProfileApprovalScheme(
|
||||
approver_type = 'GOVERNANCE_GROUP',
|
||||
approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', )
|
||||
], ),
|
||||
revocation_request_config=sailpoint.v3.models.revocability.Revocability(
|
||||
approval_schemes = [
|
||||
sailpoint.v3.models.access_profile_approval_scheme.AccessProfileApprovalScheme(
|
||||
approver_type = 'GOVERNANCE_GROUP',
|
||||
approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', )
|
||||
], ),
|
||||
segments=[f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a],
|
||||
provisioning_criteria=sailpoint.v3.models.provisioning_criteria_level1.ProvisioningCriteriaLevel1(
|
||||
operation = 'EQUALS',
|
||||
attribute = 'email',
|
||||
value = 'carlee.cert1c9f9b6fd@mailinator.com',
|
||||
children = [
|
||||
sailpoint.v3.models.provisioning_criteria_level2.ProvisioningCriteriaLevel2(
|
||||
attribute = 'email',
|
||||
value = 'carlee.cert1c9f9b6fd@mailinator.com', )
|
||||
], )
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: access-profile-approval-scheme
|
||||
title: AccessProfileApprovalScheme
|
||||
pagination_label: AccessProfileApprovalScheme
|
||||
sidebar_label: AccessProfileApprovalScheme
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessProfileApprovalScheme', 'AccessProfileApprovalScheme']
|
||||
slug: /tools/sdk/python/v3/models/access-profile-approval-scheme
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'AccessProfileApprovalScheme']
|
||||
---
|
||||
|
||||
# AccessProfileApprovalScheme
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**approver_type** | **Enum** [ 'APP_OWNER', 'OWNER', 'SOURCE_OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional]
|
||||
**approver_id** | **str** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_profile_approval_scheme import AccessProfileApprovalScheme
|
||||
|
||||
access_profile_approval_scheme = AccessProfileApprovalScheme(
|
||||
approver_type='GOVERNANCE_GROUP',
|
||||
approver_id='46c79819-a69f-49a2-becb-12c971ae66c6'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: access-profile-bulk-delete-request
|
||||
title: AccessProfileBulkDeleteRequest
|
||||
pagination_label: AccessProfileBulkDeleteRequest
|
||||
sidebar_label: AccessProfileBulkDeleteRequest
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessProfileBulkDeleteRequest', 'AccessProfileBulkDeleteRequest']
|
||||
slug: /tools/sdk/python/v3/models/access-profile-bulk-delete-request
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteRequest', 'AccessProfileBulkDeleteRequest']
|
||||
---
|
||||
|
||||
# AccessProfileBulkDeleteRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**access_profile_ids** | **[]str** | List of IDs of Access Profiles to be deleted. | [optional]
|
||||
**best_effort_only** | **bool** | If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_profile_bulk_delete_request import AccessProfileBulkDeleteRequest
|
||||
|
||||
access_profile_bulk_delete_request = AccessProfileBulkDeleteRequest(
|
||||
access_profile_ids=[2c9180847812e0b1017817051919ecca, 2c9180887812e0b201781e129f151816],
|
||||
best_effort_only=True
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
id: access-profile-bulk-delete-response
|
||||
title: AccessProfileBulkDeleteResponse
|
||||
pagination_label: AccessProfileBulkDeleteResponse
|
||||
sidebar_label: AccessProfileBulkDeleteResponse
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessProfileBulkDeleteResponse', 'AccessProfileBulkDeleteResponse']
|
||||
slug: /tools/sdk/python/v3/models/access-profile-bulk-delete-response
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteResponse', 'AccessProfileBulkDeleteResponse']
|
||||
---
|
||||
|
||||
# AccessProfileBulkDeleteResponse
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**task_id** | **str** | ID of the task which is executing the bulk deletion. This can be passed to the **/task-status** API to track status. | [optional]
|
||||
**pending** | **[]str** | List of IDs of Access Profiles which are pending deletion. | [optional]
|
||||
**in_use** | [**[]AccessProfileUsage**](access-profile-usage) | List of usages of Access Profiles targeted for deletion. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_profile_bulk_delete_response import AccessProfileBulkDeleteResponse
|
||||
|
||||
access_profile_bulk_delete_response = AccessProfileBulkDeleteResponse(
|
||||
task_id='2c9180867817ac4d017817c491119a20',
|
||||
pending=[2c91808876438bbb017668c21919ecca, 2c91808876438bb201766e129f151816],
|
||||
in_use=[
|
||||
sailpoint.v3.models.access_profile_usage.AccessProfileUsage(
|
||||
access_profile_id = '2c91808876438bbb017668c21919ecca',
|
||||
used_by = [
|
||||
sailpoint.v3.models.access_profile_usage_used_by_inner.AccessProfileUsage_usedBy_inner(
|
||||
type = 'ROLE',
|
||||
id = '2c8180857a9b3da0017aa03418480f9d',
|
||||
name = 'Manager Role', )
|
||||
], )
|
||||
]
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,78 @@
|
||||
---
|
||||
id: access-profile-document
|
||||
title: AccessProfileDocument
|
||||
pagination_label: AccessProfileDocument
|
||||
sidebar_label: AccessProfileDocument
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessProfileDocument', 'AccessProfileDocument']
|
||||
slug: /tools/sdk/python/v3/models/access-profile-document
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessProfileDocument', 'AccessProfileDocument']
|
||||
---
|
||||
|
||||
# AccessProfileDocument
|
||||
|
||||
More complete representation of an access profile.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | Access profile's ID. | [required]
|
||||
**name** | **str** | Access profile's name. | [required]
|
||||
**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** | [**BaseAccessAllOfOwner**](base-access-all-of-owner) | | [optional]
|
||||
**type** | **Enum** [ 'accessprofile', 'accountactivity', 'account', 'aggregation', 'entitlement', 'event', 'identity', 'role' ] | Access profile's document type. This enum represents the currently supported document types. Additional values may be added in the future without notice. | [required]
|
||||
**source** | [**AccessProfileDocumentAllOfSource**](access-profile-document-all-of-source) | | [optional]
|
||||
**entitlements** | [**[]BaseEntitlement**](base-entitlement) | Entitlements the access profile has access to. | [optional]
|
||||
**entitlement_count** | **int** | Number of entitlements. | [optional]
|
||||
**tags** | **[]str** | Tags that have been applied to the object. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_profile_document import AccessProfileDocument
|
||||
|
||||
access_profile_document = AccessProfileDocument(
|
||||
id='2c9180825a6c1adc015a71c9023f0818',
|
||||
name='Cloud Eng',
|
||||
description='The admin role',
|
||||
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.v3.models.base_access_all_of_owner.BaseAccess_allOf_owner(
|
||||
type = 'IDENTITY',
|
||||
id = '2c9180a46faadee4016fb4e018c20639',
|
||||
name = 'Support',
|
||||
email = 'cloud-support@sailpoint.com', ),
|
||||
type='accessprofile',
|
||||
source=sailpoint.v3.models.access_profile_document_all_of_source.AccessProfileDocument_allOf_source(
|
||||
id = 'ff8081815757d4fb0157588f3d9d008f',
|
||||
name = 'Employees', ),
|
||||
entitlements=[
|
||||
sailpoint.v3.models.base_entitlement.BaseEntitlement(
|
||||
has_permissions = False,
|
||||
description = 'Cloud engineering',
|
||||
attribute = 'memberOf',
|
||||
value = 'CN=Cloud Engineering,DC=sailpoint,DC=COM',
|
||||
schema = 'group',
|
||||
privileged = False,
|
||||
id = '2c918084575812550157589064f33b89',
|
||||
name = 'CN=Cloud Engineering,DC=sailpoint,DC=COM', )
|
||||
],
|
||||
entitlement_count=5,
|
||||
tags=[TAG_1, TAG_2]
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,36 @@
|
||||
---
|
||||
id: access-profile-document-all-of-source
|
||||
title: AccessProfileDocumentAllOfSource
|
||||
pagination_label: AccessProfileDocumentAllOfSource
|
||||
sidebar_label: AccessProfileDocumentAllOfSource
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessProfileDocumentAllOfSource', 'AccessProfileDocumentAllOfSource']
|
||||
slug: /tools/sdk/python/v3/models/access-profile-document-all-of-source
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessProfileDocumentAllOfSource', 'AccessProfileDocumentAllOfSource']
|
||||
---
|
||||
|
||||
# AccessProfileDocumentAllOfSource
|
||||
|
||||
Access profile's source.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | Source's ID. | [optional]
|
||||
**name** | **str** | Source's name. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_profile_document_all_of_source import AccessProfileDocumentAllOfSource
|
||||
|
||||
access_profile_document_all_of_source = AccessProfileDocumentAllOfSource(
|
||||
id='ff8081815757d4fb0157588f3d9d008f',
|
||||
name='Employees'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,54 @@
|
||||
---
|
||||
id: access-profile-entitlement
|
||||
title: AccessProfileEntitlement
|
||||
pagination_label: AccessProfileEntitlement
|
||||
sidebar_label: AccessProfileEntitlement
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessProfileEntitlement', 'AccessProfileEntitlement']
|
||||
slug: /tools/sdk/python/v3/models/access-profile-entitlement
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessProfileEntitlement', 'AccessProfileEntitlement']
|
||||
---
|
||||
|
||||
# AccessProfileEntitlement
|
||||
|
||||
EntitlementReference
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | The unique ID of the referenced object. | [optional]
|
||||
**name** | **str** | The human readable name of the referenced object. | [optional]
|
||||
**display_name** | **str** | | [optional]
|
||||
**type** | [**DtoType**](dto-type) | | [optional]
|
||||
**description** | **str** | | [optional]
|
||||
**source** | [**Reference**](reference) | | [optional]
|
||||
**privileged** | **bool** | | [optional]
|
||||
**attribute** | **str** | | [optional]
|
||||
**value** | **str** | | [optional]
|
||||
**standalone** | **bool** | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_profile_entitlement import AccessProfileEntitlement
|
||||
|
||||
access_profile_entitlement = AccessProfileEntitlement(
|
||||
id='2c91808568c529c60168cca6f90c1313',
|
||||
name='John Doe',
|
||||
display_name='John Q. Doe',
|
||||
type='IDENTITY',
|
||||
description='',
|
||||
source=sailpoint.v3.models.reference.Reference(
|
||||
id = '2c91808568c529c60168cca6f90c1313',
|
||||
name = 'John Doe', ),
|
||||
privileged=False,
|
||||
attribute='memberOf',
|
||||
value='CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com',
|
||||
standalone=False
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: access-profile-ref
|
||||
title: AccessProfileRef
|
||||
pagination_label: AccessProfileRef
|
||||
sidebar_label: AccessProfileRef
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessProfileRef', 'AccessProfileRef']
|
||||
slug: /tools/sdk/python/v3/models/access-profile-ref
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessProfileRef', 'AccessProfileRef']
|
||||
---
|
||||
|
||||
# AccessProfileRef
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | ID of the Access Profile | [optional]
|
||||
**type** | **Enum** [ 'ACCESS_PROFILE' ] | Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result. | [optional]
|
||||
**name** | **str** | Human-readable display name of the Access Profile. This field is ignored on input. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_profile_ref import AccessProfileRef
|
||||
|
||||
access_profile_ref = AccessProfileRef(
|
||||
id='ff808081751e6e129f1518161919ecca',
|
||||
type='ACCESS_PROFILE',
|
||||
name='Access Profile 2567'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
id: access-profile-role
|
||||
title: AccessProfileRole
|
||||
pagination_label: AccessProfileRole
|
||||
sidebar_label: AccessProfileRole
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessProfileRole', 'AccessProfileRole']
|
||||
slug: /tools/sdk/python/v3/models/access-profile-role
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessProfileRole', 'AccessProfileRole']
|
||||
---
|
||||
|
||||
# AccessProfileRole
|
||||
|
||||
Role
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | The unique ID of the referenced object. | [optional]
|
||||
**name** | **str** | The human readable name of the referenced object. | [optional]
|
||||
**display_name** | **str** | | [optional]
|
||||
**type** | [**DtoType**](dto-type) | | [optional]
|
||||
**description** | **str** | | [optional]
|
||||
**owner** | [**DisplayReference**](display-reference) | | [optional]
|
||||
**disabled** | **bool** | | [optional]
|
||||
**revocable** | **bool** | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_profile_role import AccessProfileRole
|
||||
|
||||
access_profile_role = AccessProfileRole(
|
||||
id='2c91808568c529c60168cca6f90c1313',
|
||||
name='John Doe',
|
||||
display_name='John Q. Doe',
|
||||
type='IDENTITY',
|
||||
description='',
|
||||
owner=,
|
||||
disabled=True,
|
||||
revocable=True
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: access-profile-source-ref
|
||||
title: AccessProfileSourceRef
|
||||
pagination_label: AccessProfileSourceRef
|
||||
sidebar_label: AccessProfileSourceRef
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessProfileSourceRef', 'AccessProfileSourceRef']
|
||||
slug: /tools/sdk/python/v3/models/access-profile-source-ref
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'AccessProfileSourceRef']
|
||||
---
|
||||
|
||||
# AccessProfileSourceRef
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | The ID of the Source with with which the Access Profile is associated | [optional]
|
||||
**type** | **Enum** [ 'SOURCE' ] | The type of the Source, will always be SOURCE | [optional]
|
||||
**name** | **str** | The display name of the associated Source | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_profile_source_ref import AccessProfileSourceRef
|
||||
|
||||
access_profile_source_ref = AccessProfileSourceRef(
|
||||
id='2c91809773dee3610173fdb0b6061ef4',
|
||||
type='SOURCE',
|
||||
name='ODS-AD-SOURCE'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
id: access-profile-summary
|
||||
title: AccessProfileSummary
|
||||
pagination_label: AccessProfileSummary
|
||||
sidebar_label: AccessProfileSummary
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessProfileSummary', 'AccessProfileSummary']
|
||||
slug: /tools/sdk/python/v3/models/access-profile-summary
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessProfileSummary', 'AccessProfileSummary']
|
||||
---
|
||||
|
||||
# AccessProfileSummary
|
||||
|
||||
This is a summary representation of an access profile.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | The unique ID of the referenced object. | [optional]
|
||||
**name** | **str** | The human readable name of the referenced object. | [optional]
|
||||
**display_name** | **str** | | [optional]
|
||||
**type** | [**DtoType**](dto-type) | | [optional]
|
||||
**description** | **str** | | [optional]
|
||||
**source** | [**Reference**](reference) | | [optional]
|
||||
**owner** | [**DisplayReference**](display-reference) | | [optional]
|
||||
**revocable** | **bool** | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_profile_summary import AccessProfileSummary
|
||||
|
||||
access_profile_summary = AccessProfileSummary(
|
||||
id='2c91808568c529c60168cca6f90c1313',
|
||||
name='John Doe',
|
||||
display_name='John Q. Doe',
|
||||
type='IDENTITY',
|
||||
description='',
|
||||
source=sailpoint.v3.models.reference.Reference(
|
||||
id = '2c91808568c529c60168cca6f90c1313',
|
||||
name = 'John Doe', ),
|
||||
owner=,
|
||||
revocable=True
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
id: access-profile-usage
|
||||
title: AccessProfileUsage
|
||||
pagination_label: AccessProfileUsage
|
||||
sidebar_label: AccessProfileUsage
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessProfileUsage', 'AccessProfileUsage']
|
||||
slug: /tools/sdk/python/v3/models/access-profile-usage
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessProfileUsage', 'AccessProfileUsage']
|
||||
---
|
||||
|
||||
# AccessProfileUsage
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**access_profile_id** | **str** | ID of the Access Profile that is in use | [optional]
|
||||
**used_by** | [**[]AccessProfileUsageUsedByInner**](access-profile-usage-used-by-inner) | List of references to objects which are using the indicated Access Profile | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_profile_usage import AccessProfileUsage
|
||||
|
||||
access_profile_usage = AccessProfileUsage(
|
||||
access_profile_id='2c91808876438bbb017668c21919ecca',
|
||||
used_by=[
|
||||
sailpoint.v3.models.access_profile_usage_used_by_inner.AccessProfileUsage_usedBy_inner(
|
||||
type = 'ROLE',
|
||||
id = '2c8180857a9b3da0017aa03418480f9d',
|
||||
name = 'Manager Role', )
|
||||
]
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
id: access-profile-usage-used-by-inner
|
||||
title: AccessProfileUsageUsedByInner
|
||||
pagination_label: AccessProfileUsageUsedByInner
|
||||
sidebar_label: AccessProfileUsageUsedByInner
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessProfileUsageUsedByInner', 'AccessProfileUsageUsedByInner']
|
||||
slug: /tools/sdk/python/v3/models/access-profile-usage-used-by-inner
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessProfileUsageUsedByInner', 'AccessProfileUsageUsedByInner']
|
||||
---
|
||||
|
||||
# AccessProfileUsageUsedByInner
|
||||
|
||||
Role using the access profile.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **Enum** [ 'ROLE' ] | DTO type of role using the access profile. | [optional]
|
||||
**id** | **str** | ID of role using the access profile. | [optional]
|
||||
**name** | **str** | Display name of role using the access profile. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_profile_usage_used_by_inner import AccessProfileUsageUsedByInner
|
||||
|
||||
access_profile_usage_used_by_inner = AccessProfileUsageUsedByInner(
|
||||
type='ROLE',
|
||||
id='2c8180857a9b3da0017aa03418480f9d',
|
||||
name='Manager Role'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
48
docs/tools/sdk/python/Reference/V3/Models/AccessRequest.md
Normal file
48
docs/tools/sdk/python/Reference/V3/Models/AccessRequest.md
Normal file
@@ -0,0 +1,48 @@
|
||||
---
|
||||
id: access-request
|
||||
title: AccessRequest
|
||||
pagination_label: AccessRequest
|
||||
sidebar_label: AccessRequest
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessRequest', 'AccessRequest']
|
||||
slug: /tools/sdk/python/v3/models/access-request
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessRequest', 'AccessRequest']
|
||||
---
|
||||
|
||||
# AccessRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**requested_for** | **[]str** | A list of Identity IDs for whom the Access is requested. If it's a Revoke request, there can only be one Identity ID. | [required]
|
||||
**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]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_request import AccessRequest
|
||||
|
||||
access_request = AccessRequest(
|
||||
requested_for=[
|
||||
'2c918084660f45d6016617daa9210584'
|
||||
],
|
||||
request_type='GRANT_ACCESS',
|
||||
requested_items=[
|
||||
sailpoint.v3.models.access_request_item.AccessRequestItem(
|
||||
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', )
|
||||
],
|
||||
client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app}
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,57 @@
|
||||
---
|
||||
id: access-request-config
|
||||
title: AccessRequestConfig
|
||||
pagination_label: AccessRequestConfig
|
||||
sidebar_label: AccessRequestConfig
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessRequestConfig', 'AccessRequestConfig']
|
||||
slug: /tools/sdk/python/v3/models/access-request-config
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessRequestConfig', 'AccessRequestConfig']
|
||||
---
|
||||
|
||||
# AccessRequestConfig
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**approvals_must_be_external** | **bool** | If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn't an org admin. | [optional] [default to False]
|
||||
**auto_approval_enabled** | **bool** | If this is true and the requester and reviewer are the same, the request is automatically approved. | [optional] [default to False]
|
||||
**reauthorization_enabled** | **bool** | If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. | [optional] [default to False]
|
||||
**request_on_behalf_of_config** | [**RequestOnBehalfOfConfig**](request-on-behalf-of-config) | | [optional]
|
||||
**approval_reminder_and_escalation_config** | [**ApprovalReminderAndEscalationConfig**](approval-reminder-and-escalation-config) | | [optional]
|
||||
**entitlement_request_config** | [**EntitlementRequestConfig**](entitlement-request-config) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_request_config import AccessRequestConfig
|
||||
|
||||
access_request_config = AccessRequestConfig(
|
||||
approvals_must_be_external=True,
|
||||
auto_approval_enabled=True,
|
||||
reauthorization_enabled=True,
|
||||
request_on_behalf_of_config=sailpoint.v3.models.request_on_behalf_of_config.RequestOnBehalfOfConfig(
|
||||
allow_request_on_behalf_of_anyone_by_anyone = True,
|
||||
allow_request_on_behalf_of_employee_by_manager = True, ),
|
||||
approval_reminder_and_escalation_config=sailpoint.v3.models.approval_reminder_and_escalation_config.ApprovalReminderAndEscalationConfig(
|
||||
days_until_escalation = 0,
|
||||
days_between_reminders = 0,
|
||||
max_reminders = 1,
|
||||
fallback_approver_ref = sailpoint.v3.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail(
|
||||
type = 'IDENTITY',
|
||||
id = '5168015d32f890ca15812c9180835d2e',
|
||||
name = 'Alison Ferguso',
|
||||
email = 'alison.ferguso@identitysoon.com', ), ),
|
||||
entitlement_request_config=sailpoint.v3.models.entitlement_request_config.EntitlementRequestConfig(
|
||||
allow_entitlement_request = True,
|
||||
request_comments_required = False,
|
||||
denied_comments_required = False,
|
||||
grant_request_approval_schemes = 'sourceOwner', )
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
id: access-request-item
|
||||
title: AccessRequestItem
|
||||
pagination_label: AccessRequestItem
|
||||
sidebar_label: AccessRequestItem
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessRequestItem', 'AccessRequestItem']
|
||||
slug: /tools/sdk/python/v3/models/access-request-item
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessRequestItem', 'AccessRequestItem']
|
||||
---
|
||||
|
||||
# AccessRequestItem
|
||||
|
||||
|
||||
## 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]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_request_item import AccessRequestItem
|
||||
|
||||
access_request_item = AccessRequestItem(
|
||||
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'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
id: access-request-phases
|
||||
title: AccessRequestPhases
|
||||
pagination_label: AccessRequestPhases
|
||||
sidebar_label: AccessRequestPhases
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessRequestPhases', 'AccessRequestPhases']
|
||||
slug: /tools/sdk/python/v3/models/access-request-phases
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessRequestPhases', 'AccessRequestPhases']
|
||||
---
|
||||
|
||||
# AccessRequestPhases
|
||||
|
||||
Provides additional details about this access request phase.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**started** | **datetime** | The time that this phase started. | [optional]
|
||||
**finished** | **datetime** | The time that this phase finished. | [optional]
|
||||
**name** | **str** | The name of this phase. | [optional]
|
||||
**state** | **Enum** [ 'PENDING', 'EXECUTING', 'COMPLETED', 'CANCELLED', 'NOT_EXECUTED' ] | The state of this phase. | [optional]
|
||||
**result** | **Enum** [ 'SUCCESSFUL', 'FAILED' ] | The state of this phase. | [optional]
|
||||
**phase_reference** | **str** | A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_request_phases import AccessRequestPhases
|
||||
|
||||
access_request_phases = AccessRequestPhases(
|
||||
started='2020-07-11T00:00Z',
|
||||
finished='2020-07-12T00:00Z',
|
||||
name='APPROVAL_PHASE',
|
||||
state='COMPLETED',
|
||||
result='SUCCESSFUL',
|
||||
phase_reference='approvalDetails'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: access-request-response
|
||||
title: AccessRequestResponse
|
||||
pagination_label: AccessRequestResponse
|
||||
sidebar_label: AccessRequestResponse
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessRequestResponse', 'AccessRequestResponse']
|
||||
slug: /tools/sdk/python/v3/models/access-request-response
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse', 'AccessRequestResponse']
|
||||
---
|
||||
|
||||
# AccessRequestResponse
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**new_requests** | [**[]AccessRequestTracking**](access-request-tracking) | A list of new access request tracking data mapped to the values requested. | [optional]
|
||||
**existing_requests** | [**[]AccessRequestTracking**](access-request-tracking) | A list of existing access request tracking data mapped to the values requested. This indicates access has already been requested for this item. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_request_response import AccessRequestResponse
|
||||
|
||||
access_request_response = AccessRequestResponse(
|
||||
new_requests=[{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ENTITLEMENT, id=779c6fd7171540bba1184e5946112c28}], attributesHash=-1928438224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdb]}],
|
||||
existing_requests=[{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ROLE, id=779c6fd7171540bbc1184e5946112c28}], attributesHash=2843118224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdc]}]
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
id: access-request-tracking
|
||||
title: AccessRequestTracking
|
||||
pagination_label: AccessRequestTracking
|
||||
sidebar_label: AccessRequestTracking
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessRequestTracking', 'AccessRequestTracking']
|
||||
slug: /tools/sdk/python/v3/models/access-request-tracking
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessRequestTracking', 'AccessRequestTracking']
|
||||
---
|
||||
|
||||
# AccessRequestTracking
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**requested_for** | **str** | The identity id in which the access request is for. | [optional]
|
||||
**requested_items_details** | [**[]RequestedItemDetails**](requested-item-details) | The details of the item requested. | [optional]
|
||||
**attributes_hash** | **str** | a hash representation of the access requested, useful for longer term tracking client side. | [optional]
|
||||
**access_request_ids** | **[]str** | a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_request_tracking import AccessRequestTracking
|
||||
|
||||
access_request_tracking = AccessRequestTracking(
|
||||
requested_for='2c918084660f45d6016617daa9210584',
|
||||
requested_items_details={
|
||||
"type": "ENTITLEMENT",
|
||||
"id": "779c6fd7171540bba1184e5946112c28"
|
||||
},
|
||||
attributes_hash='-1928438224',
|
||||
access_request_ids=[5d3118c518a44ec7805450d53479ccdb]
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
---
|
||||
id: access-request-type
|
||||
title: AccessRequestType
|
||||
pagination_label: AccessRequestType
|
||||
sidebar_label: AccessRequestType
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessRequestType', 'AccessRequestType']
|
||||
slug: /tools/sdk/python/v3/models/access-request-type
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessRequestType', 'AccessRequestType']
|
||||
---
|
||||
|
||||
# AccessRequestType
|
||||
|
||||
Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field.
|
||||
|
||||
## Enum
|
||||
|
||||
* `GRANT_ACCESS` (value: `'GRANT_ACCESS'`)
|
||||
|
||||
* `REVOKE_ACCESS` (value: `'REVOKE_ACCESS'`)
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
144
docs/tools/sdk/python/Reference/V3/Models/AccessReviewItem.md
Normal file
144
docs/tools/sdk/python/Reference/V3/Models/AccessReviewItem.md
Normal file
@@ -0,0 +1,144 @@
|
||||
---
|
||||
id: access-review-item
|
||||
title: AccessReviewItem
|
||||
pagination_label: AccessReviewItem
|
||||
sidebar_label: AccessReviewItem
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessReviewItem', 'AccessReviewItem']
|
||||
slug: /tools/sdk/python/v3/models/access-review-item
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessReviewItem', 'AccessReviewItem']
|
||||
---
|
||||
|
||||
# AccessReviewItem
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**access_summary** | [**AccessSummary**](access-summary) | | [optional]
|
||||
**identity_summary** | [**CertificationIdentitySummary**](certification-identity-summary) | | [optional]
|
||||
**id** | **str** | The review item's id | [optional]
|
||||
**completed** | **bool** | Whether the review item is complete | [optional]
|
||||
**new_access** | **bool** | Indicates whether the review item is for new access to a source | [optional]
|
||||
**decision** | [**CertificationDecision**](certification-decision) | | [optional]
|
||||
**comments** | **str** | Comments for this review item | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_review_item import AccessReviewItem
|
||||
|
||||
access_review_item = AccessReviewItem(
|
||||
access_summary=sailpoint.v3.models.access_summary.AccessSummary(
|
||||
access = sailpoint.v3.models.access_summary_access.AccessSummary_access(
|
||||
type = 'IDENTITY',
|
||||
id = '2c9180867160846801719932c5153fb7',
|
||||
name = 'Entitlement for Company Database', ),
|
||||
entitlement = sailpoint.v3.models.reviewable_entitlement.ReviewableEntitlement(
|
||||
id = '2c918085718230600171993742c63558',
|
||||
name = 'CN=entitlement.bbb7c650',
|
||||
description = 'Gives read/write access to the company database',
|
||||
privileged = False,
|
||||
owner = sailpoint.v3.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail(
|
||||
id = '5168015d32f890ca15812c9180835d2e',
|
||||
name = 'Alison Ferguso',
|
||||
email = 'alison.ferguso@identitysoon.com', ),
|
||||
attribute_name = 'memberOf',
|
||||
attribute_value = 'CN=entitlement.bbb7c650',
|
||||
source_schema_object_type = 'groups',
|
||||
source_name = 'ODS-AD-Source',
|
||||
source_type = 'Active Directory - Direct',
|
||||
source_id = '78ca6be511cb41fbb86dba2fcca7780c',
|
||||
has_permissions = False,
|
||||
is_permission = False,
|
||||
revocable = True,
|
||||
cloud_governed = False,
|
||||
contains_data_access = True,
|
||||
data_access = sailpoint.v3.models.data_access.DataAccess(
|
||||
policies = [
|
||||
sailpoint.v3.models.data_access_policies_inner.DataAccess_policies_inner(
|
||||
value = 'GDPR-20', )
|
||||
],
|
||||
categories = [
|
||||
sailpoint.v3.models.data_access_categories_inner.DataAccess_categories_inner(
|
||||
value = 'email-7',
|
||||
match_count = 10, )
|
||||
],
|
||||
impact_score = sailpoint.v3.models.data_access_impact_score.DataAccess_impactScore(
|
||||
value = 'Medium', ), ),
|
||||
account = sailpoint.v3.models.reviewable_entitlement_account.ReviewableEntitlement_account(
|
||||
native_identity = 'CN=Alison Ferguso',
|
||||
disabled = False,
|
||||
locked = False,
|
||||
id = '2c9180857182305e0171993737eb29e6',
|
||||
name = 'Alison Ferguso',
|
||||
created = '2020-04-20T20:11:05.067Z',
|
||||
modified = '2020-05-20T18:57:16.987Z',
|
||||
activity_insights = sailpoint.v3.models.activity_insights.ActivityInsights(
|
||||
account_id = 'c4ddd5421d8549f0abd309162cafd3b1',
|
||||
usage_days = 45,
|
||||
usage_days_state = 'COMPLETE', ),
|
||||
description = 'Account for Read/write to the company database',
|
||||
governance_group_id = '2c9180857182305e0171993737eb29e6', ), ),
|
||||
access_profile = sailpoint.v3.models.reviewable_access_profile.ReviewableAccessProfile(
|
||||
id = '2c91808a7190d06e01719938fcd20792',
|
||||
name = 'Employee-database-read-write',
|
||||
description = 'Collection of entitlements to read/write the employee database',
|
||||
privileged = False,
|
||||
cloud_governed = False,
|
||||
end_date = '2021-12-25T00:00Z',
|
||||
entitlements = [
|
||||
sailpoint.v3.models.reviewable_entitlement.ReviewableEntitlement(
|
||||
id = '2c918085718230600171993742c63558',
|
||||
name = 'CN=entitlement.bbb7c650',
|
||||
description = 'Gives read/write access to the company database',
|
||||
privileged = False,
|
||||
attribute_name = 'memberOf',
|
||||
attribute_value = 'CN=entitlement.bbb7c650',
|
||||
source_schema_object_type = 'groups',
|
||||
source_name = 'ODS-AD-Source',
|
||||
source_type = 'Active Directory - Direct',
|
||||
source_id = '78ca6be511cb41fbb86dba2fcca7780c',
|
||||
has_permissions = False,
|
||||
is_permission = False,
|
||||
revocable = True,
|
||||
cloud_governed = False,
|
||||
contains_data_access = True, )
|
||||
],
|
||||
created = '2021-01-01T22:32:58.104Z',
|
||||
modified = '2021-02-01T22:32:58.104Z', ),
|
||||
role = sailpoint.v3.models.reviewable_role.ReviewableRole(
|
||||
id = '2c91808a7190d06e0171993907fd0794',
|
||||
name = 'Accounting-Employees',
|
||||
description = 'Role for members of the accounting department with the necessary Access Profiles',
|
||||
privileged = False,
|
||||
revocable = False,
|
||||
end_date = '2021-12-25T00:00Z',
|
||||
access_profiles = [
|
||||
sailpoint.v3.models.reviewable_access_profile.ReviewableAccessProfile(
|
||||
id = '2c91808a7190d06e01719938fcd20792',
|
||||
name = 'Employee-database-read-write',
|
||||
description = 'Collection of entitlements to read/write the employee database',
|
||||
privileged = False,
|
||||
cloud_governed = False,
|
||||
end_date = '2021-12-25T00:00Z',
|
||||
created = '2021-01-01T22:32:58.104Z',
|
||||
modified = '2021-02-01T22:32:58.104Z', )
|
||||
], ), ),
|
||||
identity_summary=sailpoint.v3.models.certification_identity_summary.CertificationIdentitySummary(
|
||||
id = '2c91808772a504f50172a9540e501ba7',
|
||||
name = 'Alison Ferguso',
|
||||
identity_id = '2c9180857182306001719937377a33de',
|
||||
completed = True, ),
|
||||
id='ef38f94347e94562b5bb8424a56397d8',
|
||||
completed=False,
|
||||
new_access=False,
|
||||
decision='APPROVE',
|
||||
comments='This user still needs access to this source'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
id: access-review-reassignment
|
||||
title: AccessReviewReassignment
|
||||
pagination_label: AccessReviewReassignment
|
||||
sidebar_label: AccessReviewReassignment
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessReviewReassignment', 'AccessReviewReassignment']
|
||||
slug: /tools/sdk/python/v3/models/access-review-reassignment
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessReviewReassignment', 'AccessReviewReassignment']
|
||||
---
|
||||
|
||||
# AccessReviewReassignment
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**reassign** | [**[]ReassignReference**](reassign-reference) | | [required]
|
||||
**reassign_to** | **str** | The ID of the identity to which the certification is reassigned | [required]
|
||||
**reason** | **str** | The reason comment for why the reassign was made | [required]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_review_reassignment import AccessReviewReassignment
|
||||
|
||||
access_review_reassignment = AccessReviewReassignment(
|
||||
reassign=[
|
||||
sailpoint.v3.models.reassign_reference.ReassignReference(
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8',
|
||||
type = 'ITEM', )
|
||||
],
|
||||
reassign_to='ef38f94347e94562b5bb8424a56397d8',
|
||||
reason='reassigned for some reason'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
233
docs/tools/sdk/python/Reference/V3/Models/AccessSummary.md
Normal file
233
docs/tools/sdk/python/Reference/V3/Models/AccessSummary.md
Normal file
@@ -0,0 +1,233 @@
|
||||
---
|
||||
id: access-summary
|
||||
title: AccessSummary
|
||||
pagination_label: AccessSummary
|
||||
sidebar_label: AccessSummary
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessSummary', 'AccessSummary']
|
||||
slug: /tools/sdk/python/v3/models/access-summary
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessSummary', 'AccessSummary']
|
||||
---
|
||||
|
||||
# AccessSummary
|
||||
|
||||
An object holding the access that is being reviewed
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**access** | [**AccessSummaryAccess**](access-summary-access) | | [optional]
|
||||
**entitlement** | [**ReviewableEntitlement**](reviewable-entitlement) | | [optional]
|
||||
**access_profile** | [**ReviewableAccessProfile**](reviewable-access-profile) | | [optional]
|
||||
**role** | [**ReviewableRole**](reviewable-role) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_summary import AccessSummary
|
||||
|
||||
access_summary = AccessSummary(
|
||||
access=sailpoint.v3.models.access_summary_access.AccessSummary_access(
|
||||
type = 'IDENTITY',
|
||||
id = '2c9180867160846801719932c5153fb7',
|
||||
name = 'Entitlement for Company Database', ),
|
||||
entitlement=sailpoint.v3.models.reviewable_entitlement.ReviewableEntitlement(
|
||||
id = '2c918085718230600171993742c63558',
|
||||
name = 'CN=entitlement.bbb7c650',
|
||||
description = 'Gives read/write access to the company database',
|
||||
privileged = False,
|
||||
owner = sailpoint.v3.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail(
|
||||
type = 'IDENTITY',
|
||||
id = '5168015d32f890ca15812c9180835d2e',
|
||||
name = 'Alison Ferguso',
|
||||
email = 'alison.ferguso@identitysoon.com', ),
|
||||
attribute_name = 'memberOf',
|
||||
attribute_value = 'CN=entitlement.bbb7c650',
|
||||
source_schema_object_type = 'groups',
|
||||
source_name = 'ODS-AD-Source',
|
||||
source_type = 'Active Directory - Direct',
|
||||
source_id = '78ca6be511cb41fbb86dba2fcca7780c',
|
||||
has_permissions = False,
|
||||
is_permission = False,
|
||||
revocable = True,
|
||||
cloud_governed = False,
|
||||
contains_data_access = True,
|
||||
data_access = sailpoint.v3.models.data_access.DataAccess(
|
||||
policies = [
|
||||
sailpoint.v3.models.data_access_policies_inner.DataAccess_policies_inner(
|
||||
value = 'GDPR-20', )
|
||||
],
|
||||
categories = [
|
||||
sailpoint.v3.models.data_access_categories_inner.DataAccess_categories_inner(
|
||||
value = 'email-7',
|
||||
match_count = 10, )
|
||||
],
|
||||
impact_score = sailpoint.v3.models.data_access_impact_score.DataAccess_impactScore(
|
||||
value = 'Medium', ), ),
|
||||
account = sailpoint.v3.models.reviewable_entitlement_account.ReviewableEntitlement_account(
|
||||
native_identity = 'CN=Alison Ferguso',
|
||||
disabled = False,
|
||||
locked = False,
|
||||
type = 'IDENTITY',
|
||||
id = '2c9180857182305e0171993737eb29e6',
|
||||
name = 'Alison Ferguso',
|
||||
created = '2020-04-20T20:11:05.067Z',
|
||||
modified = '2020-05-20T18:57:16.987Z',
|
||||
activity_insights = sailpoint.v3.models.activity_insights.ActivityInsights(
|
||||
account_id = 'c4ddd5421d8549f0abd309162cafd3b1',
|
||||
usage_days = 45,
|
||||
usage_days_state = 'COMPLETE', ),
|
||||
description = 'Account for Read/write to the company database',
|
||||
governance_group_id = '2c9180857182305e0171993737eb29e6', ), ),
|
||||
access_profile=sailpoint.v3.models.reviewable_access_profile.ReviewableAccessProfile(
|
||||
id = '2c91808a7190d06e01719938fcd20792',
|
||||
name = 'Employee-database-read-write',
|
||||
description = 'Collection of entitlements to read/write the employee database',
|
||||
privileged = False,
|
||||
cloud_governed = False,
|
||||
end_date = '2021-12-25T00:00Z',
|
||||
owner = sailpoint.v3.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail(
|
||||
type = 'IDENTITY',
|
||||
id = '5168015d32f890ca15812c9180835d2e',
|
||||
name = 'Alison Ferguso',
|
||||
email = 'alison.ferguso@identitysoon.com', ),
|
||||
entitlements = [
|
||||
sailpoint.v3.models.reviewable_entitlement.ReviewableEntitlement(
|
||||
id = '2c918085718230600171993742c63558',
|
||||
name = 'CN=entitlement.bbb7c650',
|
||||
description = 'Gives read/write access to the company database',
|
||||
privileged = False,
|
||||
attribute_name = 'memberOf',
|
||||
attribute_value = 'CN=entitlement.bbb7c650',
|
||||
source_schema_object_type = 'groups',
|
||||
source_name = 'ODS-AD-Source',
|
||||
source_type = 'Active Directory - Direct',
|
||||
source_id = '78ca6be511cb41fbb86dba2fcca7780c',
|
||||
has_permissions = False,
|
||||
is_permission = False,
|
||||
revocable = True,
|
||||
cloud_governed = False,
|
||||
contains_data_access = True,
|
||||
data_access = sailpoint.v3.models.data_access.DataAccess(
|
||||
policies = [
|
||||
sailpoint.v3.models.data_access_policies_inner.DataAccess_policies_inner(
|
||||
value = 'GDPR-20', )
|
||||
],
|
||||
categories = [
|
||||
sailpoint.v3.models.data_access_categories_inner.DataAccess_categories_inner(
|
||||
value = 'email-7',
|
||||
match_count = 10, )
|
||||
],
|
||||
impact_score = sailpoint.v3.models.data_access_impact_score.DataAccess_impactScore(
|
||||
value = 'Medium', ), ),
|
||||
account = sailpoint.v3.models.reviewable_entitlement_account.ReviewableEntitlement_account(
|
||||
native_identity = 'CN=Alison Ferguso',
|
||||
disabled = False,
|
||||
locked = False,
|
||||
type = 'IDENTITY',
|
||||
id = '2c9180857182305e0171993737eb29e6',
|
||||
name = 'Alison Ferguso',
|
||||
created = '2020-04-20T20:11:05.067Z',
|
||||
modified = '2020-05-20T18:57:16.987Z',
|
||||
activity_insights = sailpoint.v3.models.activity_insights.ActivityInsights(
|
||||
account_id = 'c4ddd5421d8549f0abd309162cafd3b1',
|
||||
usage_days = 45,
|
||||
usage_days_state = 'COMPLETE', ),
|
||||
description = 'Account for Read/write to the company database',
|
||||
governance_group_id = '2c9180857182305e0171993737eb29e6', ), )
|
||||
],
|
||||
created = '2021-01-01T22:32:58.104Z',
|
||||
modified = '2021-02-01T22:32:58.104Z', ),
|
||||
role=sailpoint.v3.models.reviewable_role.ReviewableRole(
|
||||
id = '2c91808a7190d06e0171993907fd0794',
|
||||
name = 'Accounting-Employees',
|
||||
description = 'Role for members of the accounting department with the necessary Access Profiles',
|
||||
privileged = False,
|
||||
owner = sailpoint.v3.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail(
|
||||
type = 'IDENTITY',
|
||||
id = '5168015d32f890ca15812c9180835d2e',
|
||||
name = 'Alison Ferguso',
|
||||
email = 'alison.ferguso@identitysoon.com', ),
|
||||
revocable = False,
|
||||
end_date = '2021-12-25T00:00Z',
|
||||
access_profiles = [
|
||||
sailpoint.v3.models.reviewable_access_profile.ReviewableAccessProfile(
|
||||
id = '2c91808a7190d06e01719938fcd20792',
|
||||
name = 'Employee-database-read-write',
|
||||
description = 'Collection of entitlements to read/write the employee database',
|
||||
privileged = False,
|
||||
cloud_governed = False,
|
||||
end_date = '2021-12-25T00:00Z',
|
||||
entitlements = [
|
||||
sailpoint.v3.models.reviewable_entitlement.ReviewableEntitlement(
|
||||
id = '2c918085718230600171993742c63558',
|
||||
name = 'CN=entitlement.bbb7c650',
|
||||
description = 'Gives read/write access to the company database',
|
||||
privileged = False,
|
||||
attribute_name = 'memberOf',
|
||||
attribute_value = 'CN=entitlement.bbb7c650',
|
||||
source_schema_object_type = 'groups',
|
||||
source_name = 'ODS-AD-Source',
|
||||
source_type = 'Active Directory - Direct',
|
||||
source_id = '78ca6be511cb41fbb86dba2fcca7780c',
|
||||
has_permissions = False,
|
||||
is_permission = False,
|
||||
revocable = True,
|
||||
cloud_governed = False,
|
||||
contains_data_access = True,
|
||||
data_access = sailpoint.v3.models.data_access.DataAccess(
|
||||
policies = [
|
||||
sailpoint.v3.models.data_access_policies_inner.DataAccess_policies_inner(
|
||||
value = 'GDPR-20', )
|
||||
],
|
||||
categories = [
|
||||
sailpoint.v3.models.data_access_categories_inner.DataAccess_categories_inner(
|
||||
value = 'email-7',
|
||||
match_count = 10, )
|
||||
],
|
||||
impact_score = sailpoint.v3.models.data_access_impact_score.DataAccess_impactScore(
|
||||
value = 'Medium', ), ),
|
||||
account = sailpoint.v3.models.reviewable_entitlement_account.ReviewableEntitlement_account(
|
||||
native_identity = 'CN=Alison Ferguso',
|
||||
disabled = False,
|
||||
locked = False,
|
||||
type = 'IDENTITY',
|
||||
id = '2c9180857182305e0171993737eb29e6',
|
||||
name = 'Alison Ferguso',
|
||||
created = '2020-04-20T20:11:05.067Z',
|
||||
modified = '2020-05-20T18:57:16.987Z',
|
||||
activity_insights = sailpoint.v3.models.activity_insights.ActivityInsights(
|
||||
account_id = 'c4ddd5421d8549f0abd309162cafd3b1',
|
||||
usage_days = 45,
|
||||
usage_days_state = 'COMPLETE', ),
|
||||
description = 'Account for Read/write to the company database',
|
||||
governance_group_id = '2c9180857182305e0171993737eb29e6', ), )
|
||||
],
|
||||
created = '2021-01-01T22:32:58.104Z',
|
||||
modified = '2021-02-01T22:32:58.104Z', )
|
||||
],
|
||||
entitlements = [
|
||||
sailpoint.v3.models.reviewable_entitlement.ReviewableEntitlement(
|
||||
id = '2c918085718230600171993742c63558',
|
||||
name = 'CN=entitlement.bbb7c650',
|
||||
description = 'Gives read/write access to the company database',
|
||||
privileged = False,
|
||||
attribute_name = 'memberOf',
|
||||
attribute_value = 'CN=entitlement.bbb7c650',
|
||||
source_schema_object_type = 'groups',
|
||||
source_name = 'ODS-AD-Source',
|
||||
source_type = 'Active Directory - Direct',
|
||||
source_id = '78ca6be511cb41fbb86dba2fcca7780c',
|
||||
has_permissions = False,
|
||||
is_permission = False,
|
||||
revocable = True,
|
||||
cloud_governed = False,
|
||||
contains_data_access = True, )
|
||||
], )
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: access-summary-access
|
||||
title: AccessSummaryAccess
|
||||
pagination_label: AccessSummaryAccess
|
||||
sidebar_label: AccessSummaryAccess
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessSummaryAccess', 'AccessSummaryAccess']
|
||||
slug: /tools/sdk/python/v3/models/access-summary-access
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessSummaryAccess', 'AccessSummaryAccess']
|
||||
---
|
||||
|
||||
# AccessSummaryAccess
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | [**DtoType**](dto-type) | | [optional]
|
||||
**id** | **str** | The ID of the item being certified | [optional]
|
||||
**name** | **str** | The name of the item being certified | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.access_summary_access import AccessSummaryAccess
|
||||
|
||||
access_summary_access = AccessSummaryAccess(
|
||||
type='IDENTITY',
|
||||
id='2c9180867160846801719932c5153fb7',
|
||||
name='Entitlement for Company Database'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
23
docs/tools/sdk/python/Reference/V3/Models/AccessType.md
Normal file
23
docs/tools/sdk/python/Reference/V3/Models/AccessType.md
Normal file
@@ -0,0 +1,23 @@
|
||||
---
|
||||
id: access-type
|
||||
title: AccessType
|
||||
pagination_label: AccessType
|
||||
sidebar_label: AccessType
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessType', 'AccessType']
|
||||
slug: /tools/sdk/python/v3/models/access-type
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessType', 'AccessType']
|
||||
---
|
||||
|
||||
# AccessType
|
||||
|
||||
Access type of API Client indicating online or offline use
|
||||
|
||||
## Enum
|
||||
|
||||
* `ONLINE` (value: `'ONLINE'`)
|
||||
|
||||
* `OFFLINE` (value: `'OFFLINE'`)
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
98
docs/tools/sdk/python/Reference/V3/Models/Account.md
Normal file
98
docs/tools/sdk/python/Reference/V3/Models/Account.md
Normal file
@@ -0,0 +1,98 @@
|
||||
---
|
||||
id: account
|
||||
title: Account
|
||||
pagination_label: Account
|
||||
sidebar_label: Account
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'Account', 'Account']
|
||||
slug: /tools/sdk/python/v3/models/account
|
||||
tags: ['SDK', 'Software Development Kit', 'Account', 'Account']
|
||||
---
|
||||
|
||||
# Account
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | System-generated unique ID of the Object | [optional] [readonly]
|
||||
**name** | **str** | Name of the Object | [required]
|
||||
**created** | **datetime** | Creation date of the Object | [optional] [readonly]
|
||||
**modified** | **datetime** | Last modification date of the Object | [optional] [readonly]
|
||||
**source_id** | **str** | The unique ID of the source this account belongs to | [required]
|
||||
**source_name** | **str** | The display name of the source this account belongs to | [required]
|
||||
**identity_id** | **str** | The unique ID of the identity this account is correlated to | [optional]
|
||||
**cloud_lifecycle_state** | **str** | The lifecycle state of the identity this account is correlated to | [optional]
|
||||
**identity_state** | **str** | The identity state of the identity this account is correlated to | [optional]
|
||||
**connection_type** | **str** | The connection type of the source this account is from | [optional]
|
||||
**is_machine** | **bool** | Indicates if the account is of machine type | [optional] [default to False]
|
||||
**recommendation** | [**Recommendation**](recommendation) | | [optional]
|
||||
**attributes** | **map[string]object** | The account attributes that are aggregated | [required]
|
||||
**authoritative** | **bool** | Indicates if this account is from an authoritative source | [required]
|
||||
**description** | **str** | A description of the account | [optional]
|
||||
**disabled** | **bool** | Indicates if the account is currently disabled | [required]
|
||||
**locked** | **bool** | Indicates if the account is currently locked | [required]
|
||||
**native_identity** | **str** | The unique ID of the account generated by the source system | [required]
|
||||
**system_account** | **bool** | If true, this is a user account within IdentityNow. If false, this is an account from a source system. | [required]
|
||||
**uncorrelated** | **bool** | Indicates if this account is not correlated to an identity | [required]
|
||||
**uuid** | **str** | The unique ID of the account as determined by the account schema | [optional]
|
||||
**manually_correlated** | **bool** | Indicates if the account has been manually correlated to an identity | [required]
|
||||
**has_entitlements** | **bool** | Indicates if the account has entitlements | [required]
|
||||
**identity** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
|
||||
**source_owner** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
|
||||
**features** | **str** | A string list containing the owning source's features | [optional]
|
||||
**origin** | **Enum** [ 'AGGREGATED', 'PROVISIONED' ] | The origin of the account either aggregated or provisioned | [optional]
|
||||
**owner_identity** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.account import Account
|
||||
|
||||
account = Account(
|
||||
id='id12345',
|
||||
name='aName',
|
||||
created='2015-05-28T14:07:17Z',
|
||||
modified='2015-05-28T14:07:17Z',
|
||||
source_id='2c9180835d2e5168015d32f890ca1581',
|
||||
source_name='Employees',
|
||||
identity_id='2c9180835d2e5168015d32f890ca1581',
|
||||
cloud_lifecycle_state='active',
|
||||
identity_state='ACTIVE',
|
||||
connection_type='direct',
|
||||
is_machine=True,
|
||||
recommendation=sailpoint.v3.models.recommendation.Recommendation(
|
||||
type = 'MACHINE',
|
||||
method = 'DISCOVERY', ),
|
||||
attributes={firstName=SailPoint, lastName=Support, displayName=SailPoint Support},
|
||||
authoritative=False,
|
||||
description='',
|
||||
disabled=False,
|
||||
locked=False,
|
||||
native_identity='552775',
|
||||
system_account=False,
|
||||
uncorrelated=False,
|
||||
uuid='{b0dce506-d6d4-44d2-8a32-d9a5b21fb175}',
|
||||
manually_correlated=False,
|
||||
has_entitlements=True,
|
||||
identity=sailpoint.v3.models.base_reference_dto.BaseReferenceDto(
|
||||
type = 'IDENTITY',
|
||||
id = '2c91808568c529c60168cca6f90c1313',
|
||||
name = 'William Wilson', ),
|
||||
source_owner=sailpoint.v3.models.base_reference_dto.BaseReferenceDto(
|
||||
type = 'IDENTITY',
|
||||
id = '2c91808568c529c60168cca6f90c1313',
|
||||
name = 'William Wilson', ),
|
||||
features='ENABLE',
|
||||
origin='AGGREGATED',
|
||||
owner_identity=sailpoint.v3.models.base_reference_dto.BaseReferenceDto(
|
||||
type = 'IDENTITY',
|
||||
id = '2c91808568c529c60168cca6f90c1313',
|
||||
name = 'William Wilson', )
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
36
docs/tools/sdk/python/Reference/V3/Models/AccountAction.md
Normal file
36
docs/tools/sdk/python/Reference/V3/Models/AccountAction.md
Normal file
@@ -0,0 +1,36 @@
|
||||
---
|
||||
id: account-action
|
||||
title: AccountAction
|
||||
pagination_label: AccountAction
|
||||
sidebar_label: AccountAction
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccountAction', 'AccountAction']
|
||||
slug: /tools/sdk/python/v3/models/account-action
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountAction', 'AccountAction']
|
||||
---
|
||||
|
||||
# AccountAction
|
||||
|
||||
Object for specifying Actions to be performed on a specified list of sources' account.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**action** | **Enum** [ 'ENABLE', 'DISABLE' ] | Describes if action will be enabled or disabled | [optional]
|
||||
**source_ids** | **[]str** | List of unique source IDs. The sources must have the ENABLE feature or flat file source. See \"/sources\" endpoint for source features. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.account_action import AccountAction
|
||||
|
||||
account_action = AccountAction(
|
||||
action='ENABLE',
|
||||
source_ids=[2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500]
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
100
docs/tools/sdk/python/Reference/V3/Models/AccountActivity.md
Normal file
100
docs/tools/sdk/python/Reference/V3/Models/AccountActivity.md
Normal file
@@ -0,0 +1,100 @@
|
||||
---
|
||||
id: account-activity
|
||||
title: AccountActivity
|
||||
pagination_label: AccountActivity
|
||||
sidebar_label: AccountActivity
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccountActivity', 'AccountActivity']
|
||||
slug: /tools/sdk/python/v3/models/account-activity
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountActivity', 'AccountActivity']
|
||||
---
|
||||
|
||||
# AccountActivity
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | Id of the account activity | [optional]
|
||||
**name** | **str** | The name of the activity | [optional]
|
||||
**created** | **datetime** | When the activity was first created | [optional]
|
||||
**modified** | **datetime** | When the activity was last modified | [optional]
|
||||
**completed** | **datetime** | When the activity was completed | [optional]
|
||||
**completion_status** | [**CompletionStatus**](completion-status) | | [optional]
|
||||
**type** | **str** | The type of action the activity performed. Please see the following list of types. This list may grow over time. - CloudAutomated - IdentityAttributeUpdate - appRequest - LifecycleStateChange - AccountStateUpdate - AccountAttributeUpdate - CloudPasswordRequest - Attribute Synchronization Refresh - Certification - Identity Refresh - Lifecycle Change Refresh [Learn more here](https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data). | [optional]
|
||||
**requester_identity_summary** | [**IdentitySummary**](identity-summary) | | [optional]
|
||||
**target_identity_summary** | [**IdentitySummary**](identity-summary) | | [optional]
|
||||
**errors** | **[]str** | A list of error messages, if any, that were encountered. | [optional]
|
||||
**warnings** | **[]str** | A list of warning messages, if any, that were encountered. | [optional]
|
||||
**items** | [**[]AccountActivityItem**](account-activity-item) | Individual actions performed as part of this account activity | [optional]
|
||||
**execution_status** | [**ExecutionStatus**](execution-status) | | [optional]
|
||||
**client_metadata** | **map[string]str** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.account_activity import AccountActivity
|
||||
|
||||
account_activity = AccountActivity(
|
||||
id='2c9180835d2e5168015d32f890ca1581',
|
||||
name='2c9180835d2e5168015d32f890ca1581',
|
||||
created='2017-07-11T18:45:37.098Z',
|
||||
modified='2018-06-25T20:22:28.104Z',
|
||||
completed='2018-10-19T13:49:37.385Z',
|
||||
completion_status='SUCCESS',
|
||||
type='appRequest',
|
||||
requester_identity_summary=sailpoint.v3.models.identity_summary.IdentitySummary(
|
||||
id = 'ff80818155fe8c080155fe8d925b0316',
|
||||
name = 'SailPoint Services',
|
||||
identity_id = 'c15b9f5cca5a4e9599eaa0e64fa921bd',
|
||||
completed = True, ),
|
||||
target_identity_summary=sailpoint.v3.models.identity_summary.IdentitySummary(
|
||||
id = 'ff80818155fe8c080155fe8d925b0316',
|
||||
name = 'SailPoint Services',
|
||||
identity_id = 'c15b9f5cca5a4e9599eaa0e64fa921bd',
|
||||
completed = True, ),
|
||||
errors=[sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds.],
|
||||
warnings=[Some warning, another warning],
|
||||
items=[
|
||||
sailpoint.v3.models.account_activity_item.AccountActivityItem(
|
||||
id = '48c545831b264409a81befcabb0e3c5a',
|
||||
name = '48c545831b264409a81befcabb0e3c5a',
|
||||
requested = '2017-07-11T18:45:37.098Z',
|
||||
approval_status = 'PENDING',
|
||||
provisioning_status = 'PENDING',
|
||||
requester_comment = sailpoint.v3.models.comment.Comment(
|
||||
commenter_id = '2c918084660f45d6016617daa9210584',
|
||||
commenter_name = 'Adam Kennedy',
|
||||
body = 'Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.',
|
||||
date = '2017-07-11T18:45:37.098Z', ),
|
||||
reviewer_identity_summary = sailpoint.v3.models.identity_summary.IdentitySummary(
|
||||
id = 'ff80818155fe8c080155fe8d925b0316',
|
||||
name = 'SailPoint Services',
|
||||
identity_id = 'c15b9f5cca5a4e9599eaa0e64fa921bd',
|
||||
completed = True, ),
|
||||
reviewer_comment = sailpoint.v3.models.comment.Comment(
|
||||
commenter_id = '2c918084660f45d6016617daa9210584',
|
||||
commenter_name = 'Adam Kennedy',
|
||||
body = 'Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.',
|
||||
date = '2017-07-11T18:45:37.098Z', ),
|
||||
operation = 'ADD',
|
||||
attribute = 'detectedRoles',
|
||||
value = 'Treasury Analyst [AccessProfile-1529010191212]',
|
||||
native_identity = 'Sandie.Camero',
|
||||
source_id = '2c91808363ef85290164000587130c0c',
|
||||
account_request_info = sailpoint.v3.models.account_request_info.AccountRequestInfo(
|
||||
requested_object_id = '2c91808563ef85690164001c31140c0c',
|
||||
requested_object_name = 'Treasury Analyst',
|
||||
requested_object_type = 'ACCESS_PROFILE', ),
|
||||
client_metadata = {customKey1=custom value 1, customKey2=custom value 2},
|
||||
remove_date = '2020-07-11T00:00Z', )
|
||||
],
|
||||
execution_status='COMPLETED',
|
||||
client_metadata={customKey1=custom value 1, customKey2=custom value 2}
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: account-activity-approval-status
|
||||
title: AccountActivityApprovalStatus
|
||||
pagination_label: AccountActivityApprovalStatus
|
||||
sidebar_label: AccountActivityApprovalStatus
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccountActivityApprovalStatus', 'AccountActivityApprovalStatus']
|
||||
slug: /tools/sdk/python/v3/models/account-activity-approval-status
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountActivityApprovalStatus', 'AccountActivityApprovalStatus']
|
||||
---
|
||||
|
||||
# AccountActivityApprovalStatus
|
||||
|
||||
The state of an approval status
|
||||
|
||||
## Enum
|
||||
|
||||
* `FINISHED` (value: `'FINISHED'`)
|
||||
|
||||
* `REJECTED` (value: `'REJECTED'`)
|
||||
|
||||
* `RETURNED` (value: `'RETURNED'`)
|
||||
|
||||
* `EXPIRED` (value: `'EXPIRED'`)
|
||||
|
||||
* `PENDING` (value: `'PENDING'`)
|
||||
|
||||
* `CANCELED` (value: `'CANCELED'`)
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,137 @@
|
||||
---
|
||||
id: account-activity-document
|
||||
title: AccountActivityDocument
|
||||
pagination_label: AccountActivityDocument
|
||||
sidebar_label: AccountActivityDocument
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccountActivityDocument', 'AccountActivityDocument']
|
||||
slug: /tools/sdk/python/v3/models/account-activity-document
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountActivityDocument', 'AccountActivityDocument']
|
||||
---
|
||||
|
||||
# AccountActivityDocument
|
||||
|
||||
AccountActivity
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | | [required]
|
||||
**name** | **str** | | [required]
|
||||
**type** | [**DocumentType**](document-type) | | [required]
|
||||
**action** | **str** | Type of action performed in the activity. | [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]
|
||||
**stage** | **str** | Activity's current stage. | [optional]
|
||||
**origin** | **str** | Activity's origin. | [optional]
|
||||
**status** | **str** | Activity's current status. | [optional]
|
||||
**requester** | [**AccountSource**](account-source) | | [optional]
|
||||
**recipient** | [**AccountSource**](account-source) | | [optional]
|
||||
**tracking_number** | **str** | Account activity's tracking number. | [optional]
|
||||
**errors** | **[]str** | Errors provided by the source while completing account actions. | [optional]
|
||||
**warnings** | **[]str** | Warnings provided by the source while completing account actions. | [optional]
|
||||
**approvals** | [**[]Approval**](approval) | Approvals performed on an item during activity. | [optional]
|
||||
**original_requests** | [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional]
|
||||
**expansion_items** | [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional]
|
||||
**account_requests** | [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional]
|
||||
**sources** | **str** | Sources involved in the account activity. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.account_activity_document import AccountActivityDocument
|
||||
|
||||
account_activity_document = AccountActivityDocument(
|
||||
id='2c91808375d8e80a0175e1f88a575222',
|
||||
name='john.doe',
|
||||
type='identity',
|
||||
action='Identity Refresh.',
|
||||
created='2018-06-25T20:22:28.104Z',
|
||||
modified='2018-06-25T20:22:28.104Z',
|
||||
stage='Completed',
|
||||
origin='',
|
||||
status='Complete',
|
||||
requester=,
|
||||
recipient=,
|
||||
tracking_number='61aad0c9e8134eca89e76a35e0cabe3f',
|
||||
errors=[
|
||||
''
|
||||
],
|
||||
warnings=[
|
||||
''
|
||||
],
|
||||
approvals=[
|
||||
sailpoint.v3.models.approval.Approval(
|
||||
comments = [
|
||||
sailpoint.v3.models.approval_comment.ApprovalComment(
|
||||
comment = 'This request was autoapproved by our automated ETS subscriber.',
|
||||
commenter = 'Automated AR Approval',
|
||||
date = '2018-06-25T20:22:28.104Z', )
|
||||
],
|
||||
created = '2018-06-25T20:22:28.104Z',
|
||||
modified = '2018-06-25T20:22:28.104Z',
|
||||
owner = null,
|
||||
result = 'Finished',
|
||||
type = '', )
|
||||
],
|
||||
original_requests=[
|
||||
sailpoint.v3.models.original_request.OriginalRequest(
|
||||
account_id = 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com',
|
||||
attribute_requests = [
|
||||
sailpoint.v3.models.attribute_request.AttributeRequest(
|
||||
name = 'groups',
|
||||
op = 'Add',
|
||||
value = '3203537556531076', )
|
||||
],
|
||||
op = 'add',
|
||||
source = null, )
|
||||
],
|
||||
expansion_items=[
|
||||
sailpoint.v3.models.expansion_item.ExpansionItem(
|
||||
account_id = '2c91808981f58ea601821c3e93482e6f',
|
||||
cause = 'Role',
|
||||
name = 'smartsheet-role',
|
||||
attribute_requests = [
|
||||
sailpoint.v3.models.attribute_request.AttributeRequest(
|
||||
name = 'groups',
|
||||
op = 'Add',
|
||||
value = '3203537556531076', )
|
||||
],
|
||||
source = null, )
|
||||
],
|
||||
account_requests=[
|
||||
sailpoint.v3.models.account_request.AccountRequest(
|
||||
account_id = 'John.Doe',
|
||||
attribute_requests = [
|
||||
sailpoint.v3.models.attribute_request.AttributeRequest(
|
||||
name = 'groups',
|
||||
op = 'Add',
|
||||
value = '3203537556531076', )
|
||||
],
|
||||
op = 'Modify',
|
||||
provisioning_target = null,
|
||||
result = sailpoint.v3.models.account_request_result.AccountRequest_result(
|
||||
errors = [
|
||||
'[ConnectorError] [
|
||||
{
|
||||
"code": "unrecognized_keys",
|
||||
"keys": [
|
||||
"groups"
|
||||
],
|
||||
"path": [],
|
||||
"message": "Unrecognized key(s) in object: 'groups'"
|
||||
}
|
||||
] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e)'
|
||||
],
|
||||
status = 'failed',
|
||||
ticket_id = '', ),
|
||||
source = null, )
|
||||
],
|
||||
sources='smartsheet-test, airtable-v4, IdentityNow'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,78 @@
|
||||
---
|
||||
id: account-activity-item
|
||||
title: AccountActivityItem
|
||||
pagination_label: AccountActivityItem
|
||||
sidebar_label: AccountActivityItem
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccountActivityItem', 'AccountActivityItem']
|
||||
slug: /tools/sdk/python/v3/models/account-activity-item
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountActivityItem', 'AccountActivityItem']
|
||||
---
|
||||
|
||||
# AccountActivityItem
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | Item id | [optional]
|
||||
**name** | **str** | Human-readable display name of item | [optional]
|
||||
**requested** | **datetime** | Date and time item was requested | [optional]
|
||||
**approval_status** | [**AccountActivityApprovalStatus**](account-activity-approval-status) | | [optional]
|
||||
**provisioning_status** | [**ProvisioningState**](provisioning-state) | | [optional]
|
||||
**requester_comment** | [**Comment**](comment) | | [optional]
|
||||
**reviewer_identity_summary** | [**IdentitySummary**](identity-summary) | | [optional]
|
||||
**reviewer_comment** | [**Comment**](comment) | | [optional]
|
||||
**operation** | [**AccountActivityItemOperation**](account-activity-item-operation) | | [optional]
|
||||
**attribute** | **str** | Attribute to which account activity applies | [optional]
|
||||
**value** | **str** | Value of attribute | [optional]
|
||||
**native_identity** | **str** | Native identity in the target system to which the account activity applies | [optional]
|
||||
**source_id** | **str** | Id of Source to which account activity applies | [optional]
|
||||
**account_request_info** | [**AccountRequestInfo**](account-request-info) | | [optional]
|
||||
**client_metadata** | **map[string]str** | Arbitrary key-value pairs, if any were included in the corresponding access request item | [optional]
|
||||
**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.account_activity_item import AccountActivityItem
|
||||
|
||||
account_activity_item = AccountActivityItem(
|
||||
id='48c545831b264409a81befcabb0e3c5a',
|
||||
name='48c545831b264409a81befcabb0e3c5a',
|
||||
requested='2017-07-11T18:45:37.098Z',
|
||||
approval_status='PENDING',
|
||||
provisioning_status='PENDING',
|
||||
requester_comment=sailpoint.v3.models.comment.Comment(
|
||||
commenter_id = '2c918084660f45d6016617daa9210584',
|
||||
commenter_name = 'Adam Kennedy',
|
||||
body = 'Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.',
|
||||
date = '2017-07-11T18:45:37.098Z', ),
|
||||
reviewer_identity_summary=sailpoint.v3.models.identity_summary.IdentitySummary(
|
||||
id = 'ff80818155fe8c080155fe8d925b0316',
|
||||
name = 'SailPoint Services',
|
||||
identity_id = 'c15b9f5cca5a4e9599eaa0e64fa921bd',
|
||||
completed = True, ),
|
||||
reviewer_comment=sailpoint.v3.models.comment.Comment(
|
||||
commenter_id = '2c918084660f45d6016617daa9210584',
|
||||
commenter_name = 'Adam Kennedy',
|
||||
body = 'Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.',
|
||||
date = '2017-07-11T18:45:37.098Z', ),
|
||||
operation='ADD',
|
||||
attribute='detectedRoles',
|
||||
value='Treasury Analyst [AccessProfile-1529010191212]',
|
||||
native_identity='Sandie.Camero',
|
||||
source_id='2c91808363ef85290164000587130c0c',
|
||||
account_request_info=sailpoint.v3.models.account_request_info.AccountRequestInfo(
|
||||
requested_object_id = '2c91808563ef85690164001c31140c0c',
|
||||
requested_object_name = 'Treasury Analyst',
|
||||
requested_object_type = 'ACCESS_PROFILE', ),
|
||||
client_metadata={customKey1=custom value 1, customKey2=custom value 2},
|
||||
remove_date='2020-07-11T00:00Z'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: account-activity-item-operation
|
||||
title: AccountActivityItemOperation
|
||||
pagination_label: AccountActivityItemOperation
|
||||
sidebar_label: AccountActivityItemOperation
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccountActivityItemOperation', 'AccountActivityItemOperation']
|
||||
slug: /tools/sdk/python/v3/models/account-activity-item-operation
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountActivityItemOperation', 'AccountActivityItemOperation']
|
||||
---
|
||||
|
||||
# AccountActivityItemOperation
|
||||
|
||||
Represents an operation in an account activity item
|
||||
|
||||
## Enum
|
||||
|
||||
* `ADD` (value: `'ADD'`)
|
||||
|
||||
* `CREATE` (value: `'CREATE'`)
|
||||
|
||||
* `MODIFY` (value: `'MODIFY'`)
|
||||
|
||||
* `DELETE` (value: `'DELETE'`)
|
||||
|
||||
* `DISABLE` (value: `'DISABLE'`)
|
||||
|
||||
* `ENABLE` (value: `'ENABLE'`)
|
||||
|
||||
* `UNLOCK` (value: `'UNLOCK'`)
|
||||
|
||||
* `LOCK` (value: `'LOCK'`)
|
||||
|
||||
* `REMOVE` (value: `'REMOVE'`)
|
||||
|
||||
* `SET` (value: `'SET'`)
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,137 @@
|
||||
---
|
||||
id: account-activity-searched-item
|
||||
title: AccountActivitySearchedItem
|
||||
pagination_label: AccountActivitySearchedItem
|
||||
sidebar_label: AccountActivitySearchedItem
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccountActivitySearchedItem', 'AccountActivitySearchedItem']
|
||||
slug: /tools/sdk/python/v3/models/account-activity-searched-item
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountActivitySearchedItem', 'AccountActivitySearchedItem']
|
||||
---
|
||||
|
||||
# AccountActivitySearchedItem
|
||||
|
||||
AccountActivity
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | | [required]
|
||||
**name** | **str** | | [required]
|
||||
**type** | [**DocumentType**](document-type) | | [required]
|
||||
**action** | **str** | Type of action performed in the activity. | [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]
|
||||
**stage** | **str** | Activity's current stage. | [optional]
|
||||
**origin** | **str** | Activity's origin. | [optional]
|
||||
**status** | **str** | Activity's current status. | [optional]
|
||||
**requester** | [**AccountSource**](account-source) | | [optional]
|
||||
**recipient** | [**AccountSource**](account-source) | | [optional]
|
||||
**tracking_number** | **str** | Account activity's tracking number. | [optional]
|
||||
**errors** | **[]str** | Errors provided by the source while completing account actions. | [optional]
|
||||
**warnings** | **[]str** | Warnings provided by the source while completing account actions. | [optional]
|
||||
**approvals** | [**[]Approval**](approval) | Approvals performed on an item during activity. | [optional]
|
||||
**original_requests** | [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional]
|
||||
**expansion_items** | [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional]
|
||||
**account_requests** | [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional]
|
||||
**sources** | **str** | Sources involved in the account activity. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.account_activity_searched_item import AccountActivitySearchedItem
|
||||
|
||||
account_activity_searched_item = AccountActivitySearchedItem(
|
||||
id='2c91808375d8e80a0175e1f88a575222',
|
||||
name='john.doe',
|
||||
type='identity',
|
||||
action='Identity Refresh.',
|
||||
created='2018-06-25T20:22:28.104Z',
|
||||
modified='2018-06-25T20:22:28.104Z',
|
||||
stage='Completed',
|
||||
origin='',
|
||||
status='Complete',
|
||||
requester=,
|
||||
recipient=,
|
||||
tracking_number='61aad0c9e8134eca89e76a35e0cabe3f',
|
||||
errors=[
|
||||
''
|
||||
],
|
||||
warnings=[
|
||||
''
|
||||
],
|
||||
approvals=[
|
||||
sailpoint.v3.models.approval.Approval(
|
||||
comments = [
|
||||
sailpoint.v3.models.approval_comment.ApprovalComment(
|
||||
comment = 'This request was autoapproved by our automated ETS subscriber.',
|
||||
commenter = 'Automated AR Approval',
|
||||
date = '2018-06-25T20:22:28.104Z', )
|
||||
],
|
||||
created = '2018-06-25T20:22:28.104Z',
|
||||
modified = '2018-06-25T20:22:28.104Z',
|
||||
owner = null,
|
||||
result = 'Finished',
|
||||
type = '', )
|
||||
],
|
||||
original_requests=[
|
||||
sailpoint.v3.models.original_request.OriginalRequest(
|
||||
account_id = 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com',
|
||||
attribute_requests = [
|
||||
sailpoint.v3.models.attribute_request.AttributeRequest(
|
||||
name = 'groups',
|
||||
op = 'Add',
|
||||
value = '3203537556531076', )
|
||||
],
|
||||
op = 'add',
|
||||
source = null, )
|
||||
],
|
||||
expansion_items=[
|
||||
sailpoint.v3.models.expansion_item.ExpansionItem(
|
||||
account_id = '2c91808981f58ea601821c3e93482e6f',
|
||||
cause = 'Role',
|
||||
name = 'smartsheet-role',
|
||||
attribute_requests = [
|
||||
sailpoint.v3.models.attribute_request.AttributeRequest(
|
||||
name = 'groups',
|
||||
op = 'Add',
|
||||
value = '3203537556531076', )
|
||||
],
|
||||
source = null, )
|
||||
],
|
||||
account_requests=[
|
||||
sailpoint.v3.models.account_request.AccountRequest(
|
||||
account_id = 'John.Doe',
|
||||
attribute_requests = [
|
||||
sailpoint.v3.models.attribute_request.AttributeRequest(
|
||||
name = 'groups',
|
||||
op = 'Add',
|
||||
value = '3203537556531076', )
|
||||
],
|
||||
op = 'Modify',
|
||||
provisioning_target = null,
|
||||
result = sailpoint.v3.models.account_request_result.AccountRequest_result(
|
||||
errors = [
|
||||
'[ConnectorError] [
|
||||
{
|
||||
"code": "unrecognized_keys",
|
||||
"keys": [
|
||||
"groups"
|
||||
],
|
||||
"path": [],
|
||||
"message": "Unrecognized key(s) in object: 'groups'"
|
||||
}
|
||||
] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e)'
|
||||
],
|
||||
status = 'failed',
|
||||
ticket_id = '', ),
|
||||
source = null, )
|
||||
],
|
||||
sources='smartsheet-test, airtable-v4, IdentityNow'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
id: account-attributes
|
||||
title: AccountAttributes
|
||||
pagination_label: AccountAttributes
|
||||
sidebar_label: AccountAttributes
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccountAttributes', 'AccountAttributes']
|
||||
slug: /tools/sdk/python/v3/models/account-attributes
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountAttributes', 'AccountAttributes']
|
||||
---
|
||||
|
||||
# AccountAttributes
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**attributes** | **map[string]object** | The schema attribute values for the account | [required]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.account_attributes import AccountAttributes
|
||||
|
||||
account_attributes = AccountAttributes(
|
||||
attributes={city=Austin, displayName=John Doe, userName=jdoe, sAMAccountName=jDoe, mail=john.doe@sailpoint.com}
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
id: account-attributes-create
|
||||
title: AccountAttributesCreate
|
||||
pagination_label: AccountAttributesCreate
|
||||
sidebar_label: AccountAttributesCreate
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccountAttributesCreate', 'AccountAttributesCreate']
|
||||
slug: /tools/sdk/python/v3/models/account-attributes-create
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreate', 'AccountAttributesCreate']
|
||||
---
|
||||
|
||||
# AccountAttributesCreate
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**attributes** | [**AccountAttributesCreateAttributes**](account-attributes-create-attributes) | | [required]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.account_attributes_create import AccountAttributesCreate
|
||||
|
||||
account_attributes_create = AccountAttributesCreate(
|
||||
attributes={sourceId=34bfcbe116c9407464af37acbaf7a4dc, city=Austin, displayName=John Doe, userName=jdoe, sAMAccountName=jDoe, mail=john.doe@sailpoint.com}
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
id: account-attributes-create-attributes
|
||||
title: AccountAttributesCreateAttributes
|
||||
pagination_label: AccountAttributesCreateAttributes
|
||||
sidebar_label: AccountAttributesCreateAttributes
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccountAttributesCreateAttributes', 'AccountAttributesCreateAttributes']
|
||||
slug: /tools/sdk/python/v3/models/account-attributes-create-attributes
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreateAttributes', 'AccountAttributesCreateAttributes']
|
||||
---
|
||||
|
||||
# AccountAttributesCreateAttributes
|
||||
|
||||
The schema attribute values for the account
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**source_id** | **str** | Target source to create an account | [required]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.account_attributes_create_attributes import AccountAttributesCreateAttributes
|
||||
|
||||
account_attributes_create_attributes = AccountAttributesCreateAttributes(
|
||||
source_id='34bfcbe116c9407464af37acbaf7a4dc'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
62
docs/tools/sdk/python/Reference/V3/Models/AccountRequest.md
Normal file
62
docs/tools/sdk/python/Reference/V3/Models/AccountRequest.md
Normal file
@@ -0,0 +1,62 @@
|
||||
---
|
||||
id: account-request
|
||||
title: AccountRequest
|
||||
pagination_label: AccountRequest
|
||||
sidebar_label: AccountRequest
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccountRequest', 'AccountRequest']
|
||||
slug: /tools/sdk/python/v3/models/account-request
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountRequest', 'AccountRequest']
|
||||
---
|
||||
|
||||
# AccountRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**account_id** | **str** | Unique ID of the account | [optional]
|
||||
**attribute_requests** | [**[]AttributeRequest**](attribute-request) | | [optional]
|
||||
**op** | **str** | The operation that was performed | [optional]
|
||||
**provisioning_target** | [**AccountSource**](account-source) | | [optional]
|
||||
**result** | [**AccountRequestResult**](account-request-result) | | [optional]
|
||||
**source** | [**AccountSource**](account-source) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.account_request import AccountRequest
|
||||
|
||||
account_request = AccountRequest(
|
||||
account_id='John.Doe',
|
||||
attribute_requests=[
|
||||
sailpoint.v3.models.attribute_request.AttributeRequest(
|
||||
name = 'groups',
|
||||
op = 'Add',
|
||||
value = '3203537556531076', )
|
||||
],
|
||||
op='Modify',
|
||||
provisioning_target=,
|
||||
result=sailpoint.v3.models.account_request_result.AccountRequest_result(
|
||||
errors = [
|
||||
'[ConnectorError] [
|
||||
{
|
||||
"code": "unrecognized_keys",
|
||||
"keys": [
|
||||
"groups"
|
||||
],
|
||||
"path": [],
|
||||
"message": "Unrecognized key(s) in object: 'groups'"
|
||||
}
|
||||
] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e)'
|
||||
],
|
||||
status = 'failed',
|
||||
ticket_id = '', ),
|
||||
source=
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
id: account-request-info
|
||||
title: AccountRequestInfo
|
||||
pagination_label: AccountRequestInfo
|
||||
sidebar_label: AccountRequestInfo
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccountRequestInfo', 'AccountRequestInfo']
|
||||
slug: /tools/sdk/python/v3/models/account-request-info
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountRequestInfo', 'AccountRequestInfo']
|
||||
---
|
||||
|
||||
# AccountRequestInfo
|
||||
|
||||
If an account activity item is associated with an access request, captures details of that request.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**requested_object_id** | **str** | Id of requested object | [optional]
|
||||
**requested_object_name** | **str** | Human-readable name of requested object | [optional]
|
||||
**requested_object_type** | [**RequestableObjectType**](requestable-object-type) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.account_request_info import AccountRequestInfo
|
||||
|
||||
account_request_info = AccountRequestInfo(
|
||||
requested_object_id='2c91808563ef85690164001c31140c0c',
|
||||
requested_object_name='Treasury Analyst',
|
||||
requested_object_type='ACCESS_PROFILE'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
id: account-request-result
|
||||
title: AccountRequestResult
|
||||
pagination_label: AccountRequestResult
|
||||
sidebar_label: AccountRequestResult
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccountRequestResult', 'AccountRequestResult']
|
||||
slug: /tools/sdk/python/v3/models/account-request-result
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountRequestResult', 'AccountRequestResult']
|
||||
---
|
||||
|
||||
# AccountRequestResult
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**errors** | **[]str** | | [optional]
|
||||
**status** | **str** | The status of the account request | [optional]
|
||||
**ticket_id** | **str** | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.account_request_result import AccountRequestResult
|
||||
|
||||
account_request_result = AccountRequestResult(
|
||||
errors=[
|
||||
'[ConnectorError] [
|
||||
{
|
||||
"code": "unrecognized_keys",
|
||||
"keys": [
|
||||
"groups"
|
||||
],
|
||||
"path": [],
|
||||
"message": "Unrecognized key(s) in object: 'groups'"
|
||||
}
|
||||
] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e)'
|
||||
],
|
||||
status='failed',
|
||||
ticket_id=''
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
37
docs/tools/sdk/python/Reference/V3/Models/AccountSource.md
Normal file
37
docs/tools/sdk/python/Reference/V3/Models/AccountSource.md
Normal file
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: account-source
|
||||
title: AccountSource
|
||||
pagination_label: AccountSource
|
||||
sidebar_label: AccountSource
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccountSource', 'AccountSource']
|
||||
slug: /tools/sdk/python/v3/models/account-source
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountSource', 'AccountSource']
|
||||
---
|
||||
|
||||
# AccountSource
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | The unique ID of the referenced object. | [optional]
|
||||
**name** | **str** | The human readable name of the referenced object. | [optional]
|
||||
**type** | **str** | Type of source returned. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.account_source import AccountSource
|
||||
|
||||
account_source = AccountSource(
|
||||
id='2c91808568c529c60168cca6f90c1313',
|
||||
name='John Doe',
|
||||
type='Delimited File'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,36 @@
|
||||
---
|
||||
id: account-toggle-request
|
||||
title: AccountToggleRequest
|
||||
pagination_label: AccountToggleRequest
|
||||
sidebar_label: AccountToggleRequest
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccountToggleRequest', 'AccountToggleRequest']
|
||||
slug: /tools/sdk/python/v3/models/account-toggle-request
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountToggleRequest', 'AccountToggleRequest']
|
||||
---
|
||||
|
||||
# AccountToggleRequest
|
||||
|
||||
Request used for account enable/disable
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**external_verification_id** | **str** | If set, an external process validates that the user wants to proceed with this request. | [optional]
|
||||
**force_provisioning** | **bool** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. Providing 'true' for an unlocked account will add and process 'Unlock' operation by the workflow. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.account_toggle_request import AccountToggleRequest
|
||||
|
||||
account_toggle_request = AccountToggleRequest(
|
||||
external_verification_id='3f9180835d2e5168015d32f890ca1581',
|
||||
force_provisioning=False
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
id: account-unlock-request
|
||||
title: AccountUnlockRequest
|
||||
pagination_label: AccountUnlockRequest
|
||||
sidebar_label: AccountUnlockRequest
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccountUnlockRequest', 'AccountUnlockRequest']
|
||||
slug: /tools/sdk/python/v3/models/account-unlock-request
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountUnlockRequest', 'AccountUnlockRequest']
|
||||
---
|
||||
|
||||
# AccountUnlockRequest
|
||||
|
||||
Request used for account unlock
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**external_verification_id** | **str** | If set, an external process validates that the user wants to proceed with this request. | [optional]
|
||||
**unlock_idn_account** | **bool** | If set, the IDN account is unlocked after the workflow completes. | [optional]
|
||||
**force_provisioning** | **bool** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.account_unlock_request import AccountUnlockRequest
|
||||
|
||||
account_unlock_request = AccountUnlockRequest(
|
||||
external_verification_id='3f9180835d2e5168015d32f890ca1581',
|
||||
unlock_idn_account=False,
|
||||
force_provisioning=False
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
35
docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md
Normal file
35
docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: account-usage
|
||||
title: AccountUsage
|
||||
pagination_label: AccountUsage
|
||||
sidebar_label: AccountUsage
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccountUsage', 'AccountUsage']
|
||||
slug: /tools/sdk/python/v3/models/account-usage
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountUsage', 'AccountUsage']
|
||||
---
|
||||
|
||||
# AccountUsage
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**var_date** | **date** | The first day of the month for which activity is aggregated. | [optional]
|
||||
**count** | **int** | The number of days within the month that the account was active in a source. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.account_usage import AccountUsage
|
||||
|
||||
account_usage = AccountUsage(
|
||||
var_date='Thu Apr 20 20:00:00 EDT 2023',
|
||||
count=10
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
id: accounts-async-result
|
||||
title: AccountsAsyncResult
|
||||
pagination_label: AccountsAsyncResult
|
||||
sidebar_label: AccountsAsyncResult
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccountsAsyncResult', 'AccountsAsyncResult']
|
||||
slug: /tools/sdk/python/v3/models/accounts-async-result
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountsAsyncResult', 'AccountsAsyncResult']
|
||||
---
|
||||
|
||||
# AccountsAsyncResult
|
||||
|
||||
Accounts async response containing details on started async process
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | id of the task | [required]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.accounts_async_result import AccountsAsyncResult
|
||||
|
||||
accounts_async_result = AccountsAsyncResult(
|
||||
id='2c91808474683da6017468693c260195'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,36 @@
|
||||
---
|
||||
id: accounts-export-report-arguments
|
||||
title: AccountsExportReportArguments
|
||||
pagination_label: AccountsExportReportArguments
|
||||
sidebar_label: AccountsExportReportArguments
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccountsExportReportArguments', 'AccountsExportReportArguments']
|
||||
slug: /tools/sdk/python/v3/models/accounts-export-report-arguments
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountsExportReportArguments', 'AccountsExportReportArguments']
|
||||
---
|
||||
|
||||
# AccountsExportReportArguments
|
||||
|
||||
Arguments for Account Export report (ACCOUNTS)
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**application** | **str** | Source ID. | [required]
|
||||
**source_name** | **str** | Source name. | [required]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.accounts_export_report_arguments import AccountsExportReportArguments
|
||||
|
||||
accounts_export_report_arguments = AccountsExportReportArguments(
|
||||
application='2c9180897eSourceIde781782f705b9',
|
||||
source_name='Active Directory'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
id: activate-campaign-options
|
||||
title: ActivateCampaignOptions
|
||||
pagination_label: ActivateCampaignOptions
|
||||
sidebar_label: ActivateCampaignOptions
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ActivateCampaignOptions', 'ActivateCampaignOptions']
|
||||
slug: /tools/sdk/python/v3/models/activate-campaign-options
|
||||
tags: ['SDK', 'Software Development Kit', 'ActivateCampaignOptions', 'ActivateCampaignOptions']
|
||||
---
|
||||
|
||||
# ActivateCampaignOptions
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**time_zone** | **str** | The timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as 'Z') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh. | [optional] [default to 'Z']
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.activate_campaign_options import ActivateCampaignOptions
|
||||
|
||||
activate_campaign_options = ActivateCampaignOptions(
|
||||
time_zone='Z'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
id: activity-insights
|
||||
title: ActivityInsights
|
||||
pagination_label: ActivityInsights
|
||||
sidebar_label: ActivityInsights
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ActivityInsights', 'ActivityInsights']
|
||||
slug: /tools/sdk/python/v3/models/activity-insights
|
||||
tags: ['SDK', 'Software Development Kit', 'ActivityInsights', 'ActivityInsights']
|
||||
---
|
||||
|
||||
# ActivityInsights
|
||||
|
||||
Insights into account activity
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**account_id** | **str** | UUID of the account | [optional]
|
||||
**usage_days** | **int** | The number of days of activity | [optional]
|
||||
**usage_days_state** | **Enum** [ 'COMPLETE', 'UNKNOWN' ] | Status indicating if the activity is complete or unknown | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.activity_insights import ActivityInsights
|
||||
|
||||
activity_insights = ActivityInsights(
|
||||
account_id='c4ddd5421d8549f0abd309162cafd3b1',
|
||||
usage_days=45,
|
||||
usage_days_state='COMPLETE'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: admin-review-reassign
|
||||
title: AdminReviewReassign
|
||||
pagination_label: AdminReviewReassign
|
||||
sidebar_label: AdminReviewReassign
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AdminReviewReassign', 'AdminReviewReassign']
|
||||
slug: /tools/sdk/python/v3/models/admin-review-reassign
|
||||
tags: ['SDK', 'Software Development Kit', 'AdminReviewReassign', 'AdminReviewReassign']
|
||||
---
|
||||
|
||||
# AdminReviewReassign
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**certification_ids** | **[]str** | List of certification IDs to reassign | [optional]
|
||||
**reassign_to** | [**AdminReviewReassignReassignTo**](admin-review-reassign-reassign-to) | | [optional]
|
||||
**reason** | **str** | Comment to explain why the certification was reassigned | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.admin_review_reassign import AdminReviewReassign
|
||||
|
||||
admin_review_reassign = AdminReviewReassign(
|
||||
certification_ids=[af3859464779471211bb8424a563abc1, af3859464779471211bb8424a563abc2, af3859464779471211bb8424a563abc3],
|
||||
reassign_to=sailpoint.v3.models.admin_review_reassign_reassign_to.AdminReviewReassign_reassignTo(
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8',
|
||||
type = 'IDENTITY', ),
|
||||
reason='reassigned for some reason'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: admin-review-reassign-reassign-to
|
||||
title: AdminReviewReassignReassignTo
|
||||
pagination_label: AdminReviewReassignReassignTo
|
||||
sidebar_label: AdminReviewReassignReassignTo
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AdminReviewReassignReassignTo', 'AdminReviewReassignReassignTo']
|
||||
slug: /tools/sdk/python/v3/models/admin-review-reassign-reassign-to
|
||||
tags: ['SDK', 'Software Development Kit', 'AdminReviewReassignReassignTo', 'AdminReviewReassignReassignTo']
|
||||
---
|
||||
|
||||
# AdminReviewReassignReassignTo
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | The identity ID to which the review is being assigned. | [optional]
|
||||
**type** | **Enum** [ 'IDENTITY' ] | The type of the ID provided. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.admin_review_reassign_reassign_to import AdminReviewReassignReassignTo
|
||||
|
||||
admin_review_reassign_reassign_to = AdminReviewReassignReassignTo(
|
||||
id='ef38f94347e94562b5bb8424a56397d8',
|
||||
type='IDENTITY'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: aggregation-result
|
||||
title: AggregationResult
|
||||
pagination_label: AggregationResult
|
||||
sidebar_label: AggregationResult
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AggregationResult', 'AggregationResult']
|
||||
slug: /tools/sdk/python/v3/models/aggregation-result
|
||||
tags: ['SDK', 'Software Development Kit', 'AggregationResult', 'AggregationResult']
|
||||
---
|
||||
|
||||
# AggregationResult
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**aggregations** | **object** | The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run. See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information. | [optional]
|
||||
**hits** | **[]object** | The results of the aggregation search query. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.aggregation_result import AggregationResult
|
||||
|
||||
aggregation_result = AggregationResult(
|
||||
aggregations={Identity Locations={buckets=[{key=Austin, doc_count=109}, {key=London, doc_count=64}, {key=San Jose, doc_count=27}, {key=Brussels, doc_count=26}, {key=Sao Paulo, doc_count=24}, {key=Munich, doc_count=23}, {key=Singapore, doc_count=22}, {key=Tokyo, doc_count=20}, {key=Taipei, doc_count=16}]}},
|
||||
hits=[
|
||||
sailpoint.v3.models.search_document.SearchDocument()
|
||||
]
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
23
docs/tools/sdk/python/Reference/V3/Models/AggregationType.md
Normal file
23
docs/tools/sdk/python/Reference/V3/Models/AggregationType.md
Normal file
@@ -0,0 +1,23 @@
|
||||
---
|
||||
id: aggregation-type
|
||||
title: AggregationType
|
||||
pagination_label: AggregationType
|
||||
sidebar_label: AggregationType
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AggregationType', 'AggregationType']
|
||||
slug: /tools/sdk/python/v3/models/aggregation-type
|
||||
tags: ['SDK', 'Software Development Kit', 'AggregationType', 'AggregationType']
|
||||
---
|
||||
|
||||
# AggregationType
|
||||
|
||||
Enum representing the currently available query languages for aggregations, which are used to perform calculations or groupings on search results. Additional values may be added in the future without notice.
|
||||
|
||||
## Enum
|
||||
|
||||
* `DSL` (value: `'DSL'`)
|
||||
|
||||
* `SAILPOINT` (value: `'SAILPOINT'`)
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
53
docs/tools/sdk/python/Reference/V3/Models/Aggregations.md
Normal file
53
docs/tools/sdk/python/Reference/V3/Models/Aggregations.md
Normal file
@@ -0,0 +1,53 @@
|
||||
---
|
||||
id: aggregations
|
||||
title: Aggregations
|
||||
pagination_label: Aggregations
|
||||
sidebar_label: Aggregations
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'Aggregations', 'Aggregations']
|
||||
slug: /tools/sdk/python/v3/models/aggregations
|
||||
tags: ['SDK', 'Software Development Kit', 'Aggregations', 'Aggregations']
|
||||
---
|
||||
|
||||
# Aggregations
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**nested** | [**NestedAggregation**](nested-aggregation) | | [optional]
|
||||
**metric** | [**MetricAggregation**](metric-aggregation) | | [optional]
|
||||
**filter** | [**FilterAggregation**](filter-aggregation) | | [optional]
|
||||
**bucket** | [**BucketAggregation**](bucket-aggregation) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.aggregations import Aggregations
|
||||
|
||||
aggregations = Aggregations(
|
||||
nested=sailpoint.v3.models.nested_aggregation.NestedAggregation(
|
||||
name = 'id',
|
||||
type = 'access', ),
|
||||
metric=sailpoint.v3.models.metric_aggregation.MetricAggregation(
|
||||
name = 'Access Name Count',
|
||||
type = 'UNIQUE_COUNT',
|
||||
field = '@access.name', ),
|
||||
filter=sailpoint.v3.models.filter_aggregation.FilterAggregation(
|
||||
name = 'Entitlements',
|
||||
type = 'TERM',
|
||||
field = 'access.type',
|
||||
value = 'ENTITLEMENT', ),
|
||||
bucket=sailpoint.v3.models.bucket_aggregation.BucketAggregation(
|
||||
name = 'Identity Locations',
|
||||
type = 'TERMS',
|
||||
field = 'attributes.city',
|
||||
size = 100,
|
||||
min_doc_count = 2, )
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
43
docs/tools/sdk/python/Reference/V3/Models/App.md
Normal file
43
docs/tools/sdk/python/Reference/V3/Models/App.md
Normal file
@@ -0,0 +1,43 @@
|
||||
---
|
||||
id: app
|
||||
title: App
|
||||
pagination_label: App
|
||||
sidebar_label: App
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'App', 'App']
|
||||
slug: /tools/sdk/python/v3/models/app
|
||||
tags: ['SDK', 'Software Development Kit', 'App', 'App']
|
||||
---
|
||||
|
||||
# App
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | The unique ID of the referenced object. | [optional]
|
||||
**name** | **str** | The human readable name of the referenced object. | [optional]
|
||||
**source** | [**Reference**](reference) | | [optional]
|
||||
**account** | [**AppAllOfAccount**](app-all-of-account) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.app import App
|
||||
|
||||
app = App(
|
||||
id='2c91808568c529c60168cca6f90c1313',
|
||||
name='John Doe',
|
||||
source=sailpoint.v3.models.reference.Reference(
|
||||
id = '2c91808568c529c60168cca6f90c1313',
|
||||
name = 'John Doe', ),
|
||||
account=sailpoint.v3.models.app_all_of_account.App_allOf_account(
|
||||
id = '2c9180837dfe6949017e21f3d8cd6d49',
|
||||
account_id = 'CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com', )
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
35
docs/tools/sdk/python/Reference/V3/Models/AppAllOfAccount.md
Normal file
35
docs/tools/sdk/python/Reference/V3/Models/AppAllOfAccount.md
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: app-all-of-account
|
||||
title: AppAllOfAccount
|
||||
pagination_label: AppAllOfAccount
|
||||
sidebar_label: AppAllOfAccount
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AppAllOfAccount', 'AppAllOfAccount']
|
||||
slug: /tools/sdk/python/v3/models/app-all-of-account
|
||||
tags: ['SDK', 'Software Development Kit', 'AppAllOfAccount', 'AppAllOfAccount']
|
||||
---
|
||||
|
||||
# AppAllOfAccount
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | The SailPoint generated unique ID | [optional]
|
||||
**account_id** | **str** | The account ID generated by the source | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.app_all_of_account import AppAllOfAccount
|
||||
|
||||
app_all_of_account = AppAllOfAccount(
|
||||
id='2c9180837dfe6949017e21f3d8cd6d49',
|
||||
account_id='CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
48
docs/tools/sdk/python/Reference/V3/Models/Approval.md
Normal file
48
docs/tools/sdk/python/Reference/V3/Models/Approval.md
Normal file
@@ -0,0 +1,48 @@
|
||||
---
|
||||
id: approval
|
||||
title: Approval
|
||||
pagination_label: Approval
|
||||
sidebar_label: Approval
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'Approval', 'Approval']
|
||||
slug: /tools/sdk/python/v3/models/approval
|
||||
tags: ['SDK', 'Software Development Kit', 'Approval', 'Approval']
|
||||
---
|
||||
|
||||
# Approval
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**comments** | [**[]ApprovalComment**](approval-comment) | | [optional]
|
||||
**created** | **datetime** | A date-time in ISO-8601 format | [optional]
|
||||
**modified** | **datetime** | A date-time in ISO-8601 format | [optional]
|
||||
**owner** | [**AccountSource**](account-source) | | [optional]
|
||||
**result** | **str** | The result of the approval | [optional]
|
||||
**type** | **str** | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.approval import Approval
|
||||
|
||||
approval = Approval(
|
||||
comments=[
|
||||
sailpoint.v3.models.approval_comment.ApprovalComment(
|
||||
comment = 'This request was autoapproved by our automated ETS subscriber.',
|
||||
commenter = 'Automated AR Approval',
|
||||
date = '2018-06-25T20:22:28.104Z', )
|
||||
],
|
||||
created='2018-06-25T20:22:28.104Z',
|
||||
modified='2018-06-25T20:22:28.104Z',
|
||||
owner=,
|
||||
result='Finished',
|
||||
type=''
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
37
docs/tools/sdk/python/Reference/V3/Models/ApprovalComment.md
Normal file
37
docs/tools/sdk/python/Reference/V3/Models/ApprovalComment.md
Normal file
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: approval-comment
|
||||
title: ApprovalComment
|
||||
pagination_label: ApprovalComment
|
||||
sidebar_label: ApprovalComment
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ApprovalComment', 'ApprovalComment']
|
||||
slug: /tools/sdk/python/v3/models/approval-comment
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalComment', 'ApprovalComment']
|
||||
---
|
||||
|
||||
# ApprovalComment
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**comment** | **str** | The comment text | [optional]
|
||||
**commenter** | **str** | The name of the commenter | [optional]
|
||||
**var_date** | **datetime** | A date-time in ISO-8601 format | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.approval_comment import ApprovalComment
|
||||
|
||||
approval_comment = ApprovalComment(
|
||||
comment='This request was autoapproved by our automated ETS subscriber.',
|
||||
commenter='Automated AR Approval',
|
||||
var_date='2018-06-25T20:22:28.104Z'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
id: approval-forward-history
|
||||
title: ApprovalForwardHistory
|
||||
pagination_label: ApprovalForwardHistory
|
||||
sidebar_label: ApprovalForwardHistory
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ApprovalForwardHistory', 'ApprovalForwardHistory']
|
||||
slug: /tools/sdk/python/v3/models/approval-forward-history
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalForwardHistory', 'ApprovalForwardHistory']
|
||||
---
|
||||
|
||||
# ApprovalForwardHistory
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**old_approver_name** | **str** | Display name of approver from whom the approval was forwarded. | [optional]
|
||||
**new_approver_name** | **str** | Display name of approver to whom the approval was forwarded. | [optional]
|
||||
**comment** | **str** | Comment made while forwarding. | [optional]
|
||||
**modified** | **datetime** | Time at which approval was forwarded. | [optional]
|
||||
**forwarder_name** | **str** | Display name of forwarder who forwarded the approval. | [optional]
|
||||
**reassignment_type** | [**ReassignmentType**](reassignment-type) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.approval_forward_history import ApprovalForwardHistory
|
||||
|
||||
approval_forward_history = ApprovalForwardHistory(
|
||||
old_approver_name='Frank Mir',
|
||||
new_approver_name='Al Volta',
|
||||
comment='Forwarding from Frank to Al',
|
||||
modified='2019-08-23T18:52:57.398Z',
|
||||
forwarder_name='William Wilson',
|
||||
reassignment_type='AUTOMATIC_REASSIGNMENT'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
id: approval-item-details
|
||||
title: ApprovalItemDetails
|
||||
pagination_label: ApprovalItemDetails
|
||||
sidebar_label: ApprovalItemDetails
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ApprovalItemDetails', 'ApprovalItemDetails']
|
||||
slug: /tools/sdk/python/v3/models/approval-item-details
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalItemDetails', 'ApprovalItemDetails']
|
||||
---
|
||||
|
||||
# ApprovalItemDetails
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | The approval item's ID | [optional]
|
||||
**account** | **str** | The account referenced by the approval item | [optional]
|
||||
**application** | **str** | The name of the application/source | [optional]
|
||||
**name** | **str** | The attribute's name | [optional]
|
||||
**operation** | **str** | The attribute's operation | [optional]
|
||||
**value** | **str** | The attribute's value | [optional]
|
||||
**state** | [**WorkItemState**](work-item-state) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.approval_item_details import ApprovalItemDetails
|
||||
|
||||
approval_item_details = ApprovalItemDetails(
|
||||
id='2c9180835d2e5168015d32f890ca1581',
|
||||
account='john.smith',
|
||||
application='Active Directory',
|
||||
name='emailAddress',
|
||||
operation='update',
|
||||
value='a@b.com',
|
||||
state=
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
45
docs/tools/sdk/python/Reference/V3/Models/ApprovalItems.md
Normal file
45
docs/tools/sdk/python/Reference/V3/Models/ApprovalItems.md
Normal file
@@ -0,0 +1,45 @@
|
||||
---
|
||||
id: approval-items
|
||||
title: ApprovalItems
|
||||
pagination_label: ApprovalItems
|
||||
sidebar_label: ApprovalItems
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ApprovalItems', 'ApprovalItems']
|
||||
slug: /tools/sdk/python/v3/models/approval-items
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalItems', 'ApprovalItems']
|
||||
---
|
||||
|
||||
# ApprovalItems
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | The approval item's ID | [optional]
|
||||
**account** | **str** | The account referenced by the approval item | [optional]
|
||||
**application** | **str** | The name of the application/source | [optional]
|
||||
**name** | **str** | The attribute's name | [optional]
|
||||
**operation** | **str** | The attribute's operation | [optional]
|
||||
**value** | **str** | The attribute's value | [optional]
|
||||
**state** | [**WorkItemState**](work-item-state) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.approval_items import ApprovalItems
|
||||
|
||||
approval_items = ApprovalItems(
|
||||
id='2c9180835d2e5168015d32f890ca1581',
|
||||
account='john.smith',
|
||||
application='Active Directory',
|
||||
name='emailAddress',
|
||||
operation='update',
|
||||
value='a@b.com',
|
||||
state=
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
id: approval-reminder-and-escalation-config
|
||||
title: ApprovalReminderAndEscalationConfig
|
||||
pagination_label: ApprovalReminderAndEscalationConfig
|
||||
sidebar_label: ApprovalReminderAndEscalationConfig
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ApprovalReminderAndEscalationConfig', 'ApprovalReminderAndEscalationConfig']
|
||||
slug: /tools/sdk/python/v3/models/approval-reminder-and-escalation-config
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalReminderAndEscalationConfig', 'ApprovalReminderAndEscalationConfig']
|
||||
---
|
||||
|
||||
# ApprovalReminderAndEscalationConfig
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**days_until_escalation** | **int** | Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation. | [optional]
|
||||
**days_between_reminders** | **int** | Number of days to wait between reminder notifications. | [optional]
|
||||
**max_reminders** | **int** | Maximum number of reminder notification to send to the reviewer before approval escalation. | [optional]
|
||||
**fallback_approver_ref** | [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.approval_reminder_and_escalation_config import ApprovalReminderAndEscalationConfig
|
||||
|
||||
approval_reminder_and_escalation_config = ApprovalReminderAndEscalationConfig(
|
||||
days_until_escalation=0,
|
||||
days_between_reminders=0,
|
||||
max_reminders=1,
|
||||
fallback_approver_ref=sailpoint.v3.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail(
|
||||
type = 'IDENTITY',
|
||||
id = '5168015d32f890ca15812c9180835d2e',
|
||||
name = 'Alison Ferguso',
|
||||
email = 'alison.ferguso@identitysoon.com', )
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
33
docs/tools/sdk/python/Reference/V3/Models/ApprovalScheme.md
Normal file
33
docs/tools/sdk/python/Reference/V3/Models/ApprovalScheme.md
Normal file
@@ -0,0 +1,33 @@
|
||||
---
|
||||
id: approval-scheme
|
||||
title: ApprovalScheme
|
||||
pagination_label: ApprovalScheme
|
||||
sidebar_label: ApprovalScheme
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ApprovalScheme', 'ApprovalScheme']
|
||||
slug: /tools/sdk/python/v3/models/approval-scheme
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalScheme', 'ApprovalScheme']
|
||||
---
|
||||
|
||||
# ApprovalScheme
|
||||
|
||||
Describes the individual or group that is responsible for an approval step.
|
||||
|
||||
## Enum
|
||||
|
||||
* `APP_OWNER` (value: `'APP_OWNER'`)
|
||||
|
||||
* `SOURCE_OWNER` (value: `'SOURCE_OWNER'`)
|
||||
|
||||
* `MANAGER` (value: `'MANAGER'`)
|
||||
|
||||
* `ROLE_OWNER` (value: `'ROLE_OWNER'`)
|
||||
|
||||
* `ACCESS_PROFILE_OWNER` (value: `'ACCESS_PROFILE_OWNER'`)
|
||||
|
||||
* `ENTITLEMENT_OWNER` (value: `'ENTITLEMENT_OWNER'`)
|
||||
|
||||
* `GOVERNANCE_GROUP` (value: `'GOVERNANCE_GROUP'`)
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: approval-scheme-for-role
|
||||
title: ApprovalSchemeForRole
|
||||
pagination_label: ApprovalSchemeForRole
|
||||
sidebar_label: ApprovalSchemeForRole
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ApprovalSchemeForRole', 'ApprovalSchemeForRole']
|
||||
slug: /tools/sdk/python/v3/models/approval-scheme-for-role
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalSchemeForRole', 'ApprovalSchemeForRole']
|
||||
---
|
||||
|
||||
# ApprovalSchemeForRole
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**approver_type** | **Enum** [ 'OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **OWNER**: Owner of the associated Role **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional]
|
||||
**approver_id** | **str** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.approval_scheme_for_role import ApprovalSchemeForRole
|
||||
|
||||
approval_scheme_for_role = ApprovalSchemeForRole(
|
||||
approver_type='GOVERNANCE_GROUP',
|
||||
approver_id='46c79819-a69f-49a2-becb-12c971ae66c6'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
29
docs/tools/sdk/python/Reference/V3/Models/ApprovalStatus.md
Normal file
29
docs/tools/sdk/python/Reference/V3/Models/ApprovalStatus.md
Normal file
@@ -0,0 +1,29 @@
|
||||
---
|
||||
id: approval-status
|
||||
title: ApprovalStatus
|
||||
pagination_label: ApprovalStatus
|
||||
sidebar_label: ApprovalStatus
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ApprovalStatus', 'ApprovalStatus']
|
||||
slug: /tools/sdk/python/v3/models/approval-status
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalStatus', 'ApprovalStatus']
|
||||
---
|
||||
|
||||
# ApprovalStatus
|
||||
|
||||
Enum representing the non-employee request approval status
|
||||
|
||||
## Enum
|
||||
|
||||
* `APPROVED` (value: `'APPROVED'`)
|
||||
|
||||
* `REJECTED` (value: `'REJECTED'`)
|
||||
|
||||
* `PENDING` (value: `'PENDING'`)
|
||||
|
||||
* `NOT_READY` (value: `'NOT_READY'`)
|
||||
|
||||
* `CANCELLED` (value: `'CANCELLED'`)
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,59 @@
|
||||
---
|
||||
id: approval-status-dto
|
||||
title: ApprovalStatusDto
|
||||
pagination_label: ApprovalStatusDto
|
||||
sidebar_label: ApprovalStatusDto
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ApprovalStatusDto', 'ApprovalStatusDto']
|
||||
slug: /tools/sdk/python/v3/models/approval-status-dto
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDto', 'ApprovalStatusDto']
|
||||
---
|
||||
|
||||
# ApprovalStatusDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**approval_id** | **str** | Unique identifier for the approval. | [optional]
|
||||
**forwarded** | **bool** | True if the request for this item was forwarded from one owner to another. | [optional] [default to False]
|
||||
**original_owner** | [**ApprovalStatusDtoOriginalOwner**](approval-status-dto-original-owner) | | [optional]
|
||||
**current_owner** | [**ApprovalStatusDtoCurrentOwner**](approval-status-dto-current-owner) | | [optional]
|
||||
**modified** | **datetime** | Time at which item was modified. | [optional]
|
||||
**status** | [**ManualWorkItemState**](manual-work-item-state) | | [optional]
|
||||
**scheme** | [**ApprovalScheme**](approval-scheme) | | [optional]
|
||||
**error_messages** | [**[]ErrorMessageDto**](error-message-dto) | If the request failed, includes any error messages that were generated. | [optional]
|
||||
**comment** | **str** | Comment, if any, provided by the approver. | [optional]
|
||||
**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.approval_status_dto import ApprovalStatusDto
|
||||
|
||||
approval_status_dto = ApprovalStatusDto(
|
||||
approval_id='2c9180877b2b6ea4017b2c545f971429',
|
||||
forwarded=False,
|
||||
original_owner=sailpoint.v3.models.approval_status_dto_original_owner.ApprovalStatusDto_originalOwner(
|
||||
type = 'IDENTITY',
|
||||
id = '2c7180a46faadee4016fb4e018c20642',
|
||||
name = 'Michael Michaels', ),
|
||||
current_owner=,
|
||||
modified='2019-08-23T18:52:57.398Z',
|
||||
status='PENDING',
|
||||
scheme='MANAGER',
|
||||
error_messages=[
|
||||
sailpoint.v3.models.error_message_dto.ErrorMessageDto(
|
||||
locale = 'en-US',
|
||||
locale_origin = 'DEFAULT',
|
||||
text = 'The request was syntactically correct but its content is semantically invalid.', )
|
||||
],
|
||||
comment='I approve this request',
|
||||
remove_date='2020-07-11T00:00Z'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: approval-status-dto-current-owner
|
||||
title: ApprovalStatusDtoCurrentOwner
|
||||
pagination_label: ApprovalStatusDtoCurrentOwner
|
||||
sidebar_label: ApprovalStatusDtoCurrentOwner
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ApprovalStatusDtoCurrentOwner', 'ApprovalStatusDtoCurrentOwner']
|
||||
slug: /tools/sdk/python/v3/models/approval-status-dto-current-owner
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoCurrentOwner', 'ApprovalStatusDtoCurrentOwner']
|
||||
---
|
||||
|
||||
# ApprovalStatusDtoCurrentOwner
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity who reviewed the access item request. | [optional]
|
||||
**id** | **str** | ID of identity who reviewed the access item request. | [optional]
|
||||
**name** | **str** | Human-readable display name of identity who reviewed the access item request. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.approval_status_dto_current_owner import ApprovalStatusDtoCurrentOwner
|
||||
|
||||
approval_status_dto_current_owner = ApprovalStatusDtoCurrentOwner(
|
||||
type='IDENTITY',
|
||||
id='2c3780a46faadee4016fb4e018c20652',
|
||||
name='Allen Albertson'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
id: approval-status-dto-original-owner
|
||||
title: ApprovalStatusDtoOriginalOwner
|
||||
pagination_label: ApprovalStatusDtoOriginalOwner
|
||||
sidebar_label: ApprovalStatusDtoOriginalOwner
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ApprovalStatusDtoOriginalOwner', 'ApprovalStatusDtoOriginalOwner']
|
||||
slug: /tools/sdk/python/v3/models/approval-status-dto-original-owner
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoOriginalOwner', 'ApprovalStatusDtoOriginalOwner']
|
||||
---
|
||||
|
||||
# ApprovalStatusDtoOriginalOwner
|
||||
|
||||
Identity of orginal approval owner.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **Enum** [ 'GOVERNANCE_GROUP', 'IDENTITY' ] | DTO type of original approval owner's identity. | [optional]
|
||||
**id** | **str** | ID of original approval owner's identity. | [optional]
|
||||
**name** | **str** | Display name of original approval owner. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.approval_status_dto_original_owner import ApprovalStatusDtoOriginalOwner
|
||||
|
||||
approval_status_dto_original_owner = ApprovalStatusDtoOriginalOwner(
|
||||
type='IDENTITY',
|
||||
id='2c7180a46faadee4016fb4e018c20642',
|
||||
name='Michael Michaels'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
37
docs/tools/sdk/python/Reference/V3/Models/ApprovalSummary.md
Normal file
37
docs/tools/sdk/python/Reference/V3/Models/ApprovalSummary.md
Normal file
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: approval-summary
|
||||
title: ApprovalSummary
|
||||
pagination_label: ApprovalSummary
|
||||
sidebar_label: ApprovalSummary
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ApprovalSummary', 'ApprovalSummary']
|
||||
slug: /tools/sdk/python/v3/models/approval-summary
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalSummary', 'ApprovalSummary']
|
||||
---
|
||||
|
||||
# ApprovalSummary
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**pending** | **int** | The number of pending access requests approvals. | [optional]
|
||||
**approved** | **int** | The number of approved access requests approvals. | [optional]
|
||||
**rejected** | **int** | The number of rejected access requests approvals. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.approval_summary import ApprovalSummary
|
||||
|
||||
approval_summary = ApprovalSummary(
|
||||
pending=0,
|
||||
approved=0,
|
||||
rejected=0
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
31
docs/tools/sdk/python/Reference/V3/Models/ArrayInner.md
Normal file
31
docs/tools/sdk/python/Reference/V3/Models/ArrayInner.md
Normal file
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: array-inner
|
||||
title: ArrayInner
|
||||
pagination_label: ArrayInner
|
||||
sidebar_label: ArrayInner
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ArrayInner', 'ArrayInner']
|
||||
slug: /tools/sdk/python/v3/models/array-inner
|
||||
tags: ['SDK', 'Software Development Kit', 'ArrayInner', 'ArrayInner']
|
||||
---
|
||||
|
||||
# ArrayInner
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.array_inner import ArrayInner
|
||||
|
||||
array_inner = ArrayInner(
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
52
docs/tools/sdk/python/Reference/V3/Models/AttributeDTO.md
Normal file
52
docs/tools/sdk/python/Reference/V3/Models/AttributeDTO.md
Normal file
@@ -0,0 +1,52 @@
|
||||
---
|
||||
id: attribute-dto
|
||||
title: AttributeDTO
|
||||
pagination_label: AttributeDTO
|
||||
sidebar_label: AttributeDTO
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AttributeDTO', 'AttributeDTO']
|
||||
slug: /tools/sdk/python/v3/models/attribute-dto
|
||||
tags: ['SDK', 'Software Development Kit', 'AttributeDTO', 'AttributeDTO']
|
||||
---
|
||||
|
||||
# AttributeDTO
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**key** | **str** | Technical name of the Attribute. This is unique and cannot be changed after creation. | [optional]
|
||||
**name** | **str** | The display name of the key. | [optional]
|
||||
**multiselect** | **bool** | Indicates whether the attribute can have multiple values. | [optional] [default to False]
|
||||
**status** | **str** | The status of the Attribute. | [optional]
|
||||
**type** | **str** | The type of the Attribute. This can be either \"custom\" or \"governance\". | [optional]
|
||||
**object_types** | **[]str** | An array of object types this attributes values can be applied to. Possible values are \"all\" or \"entitlement\". Value \"all\" means this attribute can be used with all object types that are supported. | [optional]
|
||||
**description** | **str** | The description of the Attribute. | [optional]
|
||||
**values** | [**[]AttributeValueDTO**](attribute-value-dto) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.attribute_dto import AttributeDTO
|
||||
|
||||
attribute_dto = AttributeDTO(
|
||||
key='iscPrivacy',
|
||||
name='Privacy',
|
||||
multiselect=False,
|
||||
status='active',
|
||||
type='governance',
|
||||
object_types=[entitlement],
|
||||
description='Specifies the level of privacy associated with an access item.',
|
||||
values=[
|
||||
sailpoint.v3.models.attribute_value_dto.AttributeValueDTO(
|
||||
value = 'public',
|
||||
name = 'Public',
|
||||
status = 'active', )
|
||||
]
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
id: attribute-dto-list
|
||||
title: AttributeDTOList
|
||||
pagination_label: AttributeDTOList
|
||||
sidebar_label: AttributeDTOList
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AttributeDTOList', 'AttributeDTOList']
|
||||
slug: /tools/sdk/python/v3/models/attribute-dto-list
|
||||
tags: ['SDK', 'Software Development Kit', 'AttributeDTOList', 'AttributeDTOList']
|
||||
---
|
||||
|
||||
# AttributeDTOList
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**attributes** | [**[]AttributeDTO**](attribute-dto) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.attribute_dto_list import AttributeDTOList
|
||||
|
||||
attribute_dto_list = AttributeDTOList(
|
||||
attributes=[{key=iscPrivacy, name=Privacy, multiselect=false, status=active, type=governance, objectTypes=[all], description=Specifies the level of privacy associated with an access item., values=[{value=public, name=Public, status=active}]}]
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
id: attribute-definition
|
||||
title: AttributeDefinition
|
||||
pagination_label: AttributeDefinition
|
||||
sidebar_label: AttributeDefinition
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AttributeDefinition', 'AttributeDefinition']
|
||||
slug: /tools/sdk/python/v3/models/attribute-definition
|
||||
tags: ['SDK', 'Software Development Kit', 'AttributeDefinition', 'AttributeDefinition']
|
||||
---
|
||||
|
||||
# AttributeDefinition
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | The name of the attribute. | [optional]
|
||||
**type** | [**AttributeDefinitionType**](attribute-definition-type) | | [optional]
|
||||
**var_schema** | [**AttributeDefinitionSchema**](attribute-definition-schema) | | [optional]
|
||||
**description** | **str** | A human-readable description of the attribute. | [optional]
|
||||
**is_multi** | **bool** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to False]
|
||||
**is_entitlement** | **bool** | Flag indicating whether or not the attribute is an entitlement. | [optional] [default to False]
|
||||
**is_group** | **bool** | Flag indicating whether or not the attribute represents a group. This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. | [optional] [default to False]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.attribute_definition import AttributeDefinition
|
||||
|
||||
attribute_definition = AttributeDefinition(
|
||||
name='sAMAccountName',
|
||||
type='STRING',
|
||||
var_schema=sailpoint.v3.models.attribute_definition_schema.AttributeDefinition_schema(
|
||||
type = 'CONNECTOR_SCHEMA',
|
||||
id = '2c91808568c529c60168cca6f90c1313',
|
||||
name = 'group', ),
|
||||
description='SAM Account Name',
|
||||
is_multi=False,
|
||||
is_entitlement=False,
|
||||
is_group=False
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
id: attribute-definition-schema
|
||||
title: AttributeDefinitionSchema
|
||||
pagination_label: AttributeDefinitionSchema
|
||||
sidebar_label: AttributeDefinitionSchema
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AttributeDefinitionSchema', 'AttributeDefinitionSchema']
|
||||
slug: /tools/sdk/python/v3/models/attribute-definition-schema
|
||||
tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionSchema', 'AttributeDefinitionSchema']
|
||||
---
|
||||
|
||||
# AttributeDefinitionSchema
|
||||
|
||||
A reference to the schema on the source to the attribute values map to.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **Enum** [ 'CONNECTOR_SCHEMA' ] | The type of object being referenced | [optional]
|
||||
**id** | **str** | The object ID this reference applies to. | [optional]
|
||||
**name** | **str** | The human-readable display name of the object. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.attribute_definition_schema import AttributeDefinitionSchema
|
||||
|
||||
attribute_definition_schema = AttributeDefinitionSchema(
|
||||
type='CONNECTOR_SCHEMA',
|
||||
id='2c91808568c529c60168cca6f90c1313',
|
||||
name='group'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
---
|
||||
id: attribute-definition-type
|
||||
title: AttributeDefinitionType
|
||||
pagination_label: AttributeDefinitionType
|
||||
sidebar_label: AttributeDefinitionType
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AttributeDefinitionType', 'AttributeDefinitionType']
|
||||
slug: /tools/sdk/python/v3/models/attribute-definition-type
|
||||
tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionType', 'AttributeDefinitionType']
|
||||
---
|
||||
|
||||
# AttributeDefinitionType
|
||||
|
||||
The underlying type of the value which an AttributeDefinition represents.
|
||||
|
||||
## Enum
|
||||
|
||||
* `STRING` (value: `'STRING'`)
|
||||
|
||||
* `LONG` (value: `'LONG'`)
|
||||
|
||||
* `INT` (value: `'INT'`)
|
||||
|
||||
* `BOOLEAN` (value: `'BOOLEAN'`)
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: attribute-request
|
||||
title: AttributeRequest
|
||||
pagination_label: AttributeRequest
|
||||
sidebar_label: AttributeRequest
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AttributeRequest', 'AttributeRequest']
|
||||
slug: /tools/sdk/python/v3/models/attribute-request
|
||||
tags: ['SDK', 'Software Development Kit', 'AttributeRequest', 'AttributeRequest']
|
||||
---
|
||||
|
||||
# AttributeRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | Attribute name. | [optional]
|
||||
**op** | **str** | Operation to perform on attribute. | [optional]
|
||||
**value** | **str** | Value of attribute. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.attribute_request import AttributeRequest
|
||||
|
||||
attribute_request = AttributeRequest(
|
||||
name='groups',
|
||||
op='Add',
|
||||
value='3203537556531076'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: attribute-value-dto
|
||||
title: AttributeValueDTO
|
||||
pagination_label: AttributeValueDTO
|
||||
sidebar_label: AttributeValueDTO
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AttributeValueDTO', 'AttributeValueDTO']
|
||||
slug: /tools/sdk/python/v3/models/attribute-value-dto
|
||||
tags: ['SDK', 'Software Development Kit', 'AttributeValueDTO', 'AttributeValueDTO']
|
||||
---
|
||||
|
||||
# AttributeValueDTO
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**value** | **str** | Technical name of the Attribute value. This is unique and cannot be changed after creation. | [optional]
|
||||
**name** | **str** | The display name of the Attribute value. | [optional]
|
||||
**status** | **str** | The status of the Attribute value. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.attribute_value_dto import AttributeValueDTO
|
||||
|
||||
attribute_value_dto = AttributeValueDTO(
|
||||
value='public',
|
||||
name='Public',
|
||||
status='active'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
67
docs/tools/sdk/python/Reference/V3/Models/AuthUser.md
Normal file
67
docs/tools/sdk/python/Reference/V3/Models/AuthUser.md
Normal file
@@ -0,0 +1,67 @@
|
||||
---
|
||||
id: auth-user
|
||||
title: AuthUser
|
||||
pagination_label: AuthUser
|
||||
sidebar_label: AuthUser
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AuthUser', 'AuthUser']
|
||||
slug: /tools/sdk/python/v3/models/auth-user
|
||||
tags: ['SDK', 'Software Development Kit', 'AuthUser', 'AuthUser']
|
||||
---
|
||||
|
||||
# AuthUser
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**tenant** | **str** | Tenant name. | [optional]
|
||||
**id** | **str** | Identity ID. | [optional]
|
||||
**uid** | **str** | Identity's unique identitifier. | [optional]
|
||||
**profile** | **str** | ID of the auth profile associated with the auth user. | [optional]
|
||||
**identification_number** | **str** | Auth user's employee number. | [optional]
|
||||
**email** | **str** | Auth user's email. | [optional]
|
||||
**phone** | **str** | Auth user's phone number. | [optional]
|
||||
**work_phone** | **str** | Auth user's work phone number. | [optional]
|
||||
**personal_email** | **str** | Auth user's personal email. | [optional]
|
||||
**firstname** | **str** | Auth user's first name. | [optional]
|
||||
**lastname** | **str** | Auth user's last name. | [optional]
|
||||
**display_name** | **str** | Auth user's name in displayed format. | [optional]
|
||||
**alias** | **str** | Auth user's alias. | [optional]
|
||||
**last_password_change_date** | **str** | Date of last password change. | [optional]
|
||||
**last_login_timestamp** | **int** | Timestamp of the last login (long type value). | [optional]
|
||||
**current_login_timestamp** | **int** | Timestamp of the current login (long type value). | [optional]
|
||||
**capabilities** | **[]str** | Array of the auth user's capabilities. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.auth_user import AuthUser
|
||||
|
||||
auth_user = AuthUser(
|
||||
tenant='test-tenant',
|
||||
id='2c91808458ae7a4f0158b1bbf8af0628',
|
||||
uid='will.smith',
|
||||
profile='2c91808458ae7a4f0158b1bbf8af0756',
|
||||
identification_number='19-5588452',
|
||||
email='william.smith@example.com',
|
||||
phone='5555555555',
|
||||
work_phone='5555555555',
|
||||
personal_email='william.smith@example.com',
|
||||
firstname='Will',
|
||||
lastname='Smith',
|
||||
display_name='Will Smith',
|
||||
alias='will.smith',
|
||||
last_password_change_date='2021-03-08T22:37:33.901Z',
|
||||
last_login_timestamp=1656327185832,
|
||||
current_login_timestamp=1656327185832,
|
||||
capabilities=[
|
||||
'ORG_ADMIN'
|
||||
]
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
38
docs/tools/sdk/python/Reference/V3/Models/BackupOptions.md
Normal file
38
docs/tools/sdk/python/Reference/V3/Models/BackupOptions.md
Normal file
@@ -0,0 +1,38 @@
|
||||
---
|
||||
id: backup-options
|
||||
title: BackupOptions
|
||||
pagination_label: BackupOptions
|
||||
sidebar_label: BackupOptions
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'BackupOptions', 'BackupOptions']
|
||||
slug: /tools/sdk/python/v3/models/backup-options
|
||||
tags: ['SDK', 'Software Development Kit', 'BackupOptions', 'BackupOptions']
|
||||
---
|
||||
|
||||
# BackupOptions
|
||||
|
||||
Backup options control what will be included in the backup.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**include_types** | **[]str** | Object type names to be included in a Configuration Hub backup command. | [optional]
|
||||
**object_options** | [**map[string]ObjectExportImportNames**](object-export-import-names) | Additional options targeting specific objects related to each item in the includeTypes field. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.backup_options import BackupOptions
|
||||
|
||||
backup_options = BackupOptions(
|
||||
include_types=[
|
||||
'TRIGGER_SUBSCRIPTION'
|
||||
],
|
||||
object_options={TRIGGER_SUBSCRIPTION={includedNames=[Trigger Subscription name]}}
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
69
docs/tools/sdk/python/Reference/V3/Models/BackupResponse.md
Normal file
69
docs/tools/sdk/python/Reference/V3/Models/BackupResponse.md
Normal file
@@ -0,0 +1,69 @@
|
||||
---
|
||||
id: backup-response
|
||||
title: BackupResponse
|
||||
pagination_label: BackupResponse
|
||||
sidebar_label: BackupResponse
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'BackupResponse', 'BackupResponse']
|
||||
slug: /tools/sdk/python/v3/models/backup-response
|
||||
tags: ['SDK', 'Software Development Kit', 'BackupResponse', 'BackupResponse']
|
||||
---
|
||||
|
||||
# BackupResponse
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**job_id** | **str** | Unique id assigned to this backup. | [optional]
|
||||
**status** | **Enum** [ 'NOT_STARTED', 'IN_PROGRESS', 'COMPLETE', 'CANCELLED', 'FAILED' ] | Status of the backup. | [optional]
|
||||
**type** | **Enum** [ 'BACKUP' ] | Type of the job, will always be BACKUP for this type of job. | [optional]
|
||||
**tenant** | **str** | The name of the tenant performing the upload | [optional]
|
||||
**requester_name** | **str** | The name of the requester. | [optional]
|
||||
**file_exists** | **bool** | Whether or not a file was created and stored for this backup. | [optional] [default to True]
|
||||
**created** | **datetime** | The time the job was started. | [optional]
|
||||
**modified** | **datetime** | The time of the last update to the job. | [optional]
|
||||
**completed** | **datetime** | The time the job was completed. | [optional]
|
||||
**name** | **str** | The name assigned to the upload file in the request body. | [optional]
|
||||
**user_can_delete** | **bool** | Whether this backup can be deleted by a regular user. | [optional] [default to True]
|
||||
**is_partial** | **bool** | Whether this backup contains all supported object types or only some of them. | [optional] [default to False]
|
||||
**backup_type** | **Enum** [ 'UPLOADED', 'AUTOMATED', 'MANUAL' ] | Denotes how this backup was created. - MANUAL - The backup was created by a user. - AUTOMATED - The backup was created by devops. - AUTOMATED_DRAFT - The backup was created during a draft process. - UPLOADED - The backup was created by uploading an existing configuration file. | [optional]
|
||||
**options** | [**BackupOptions**](backup-options) | | [optional]
|
||||
**hydration_status** | **Enum** [ 'HYDRATED', 'NOT_HYDRATED' ] | Whether the object details of this backup are ready. | [optional]
|
||||
**total_object_count** | **int** | Number of objects contained in this backup. | [optional]
|
||||
**cloud_storage_status** | **Enum** [ 'SYNCED', 'NOT_SYNCED', 'SYNC_FAILED' ] | Whether this backup has been transferred to a customer storage location. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.backup_response import BackupResponse
|
||||
|
||||
backup_response = BackupResponse(
|
||||
job_id='3469b87d-48ca-439a-868f-2160001da8c1',
|
||||
status='COMPLETE',
|
||||
type='BACKUP',
|
||||
tenant='tenant-name',
|
||||
requester_name='Requester Name',
|
||||
file_exists=True,
|
||||
created='2021-05-11T22:23:16Z',
|
||||
modified='2021-05-11T22:23:16Z',
|
||||
completed='2021-05-11T22:23:16Z',
|
||||
name='Backup Name',
|
||||
user_can_delete=False,
|
||||
is_partial=False,
|
||||
backup_type='MANUAL',
|
||||
options=sailpoint.v3.models.backup_options.BackupOptions(
|
||||
include_types = [
|
||||
'TRIGGER_SUBSCRIPTION'
|
||||
],
|
||||
object_options = {TRIGGER_SUBSCRIPTION={includedNames=[Trigger Subscription name]}}, ),
|
||||
hydration_status='NOT_HYDRATED',
|
||||
total_object_count=10,
|
||||
cloud_storage_status='SYNCED'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
55
docs/tools/sdk/python/Reference/V3/Models/BaseAccess.md
Normal file
55
docs/tools/sdk/python/Reference/V3/Models/BaseAccess.md
Normal file
@@ -0,0 +1,55 @@
|
||||
---
|
||||
id: base-access
|
||||
title: BaseAccess
|
||||
pagination_label: BaseAccess
|
||||
sidebar_label: BaseAccess
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'BaseAccess', 'BaseAccess']
|
||||
slug: /tools/sdk/python/v3/models/base-access
|
||||
tags: ['SDK', 'Software Development Kit', 'BaseAccess', 'BaseAccess']
|
||||
---
|
||||
|
||||
# BaseAccess
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | The unique ID of the referenced object. | [optional]
|
||||
**name** | **str** | The human readable name of the referenced object. | [optional]
|
||||
**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** | [**BaseAccessAllOfOwner**](base-access-all-of-owner) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.base_access import BaseAccess
|
||||
|
||||
base_access = BaseAccess(
|
||||
id='2c91808568c529c60168cca6f90c1313',
|
||||
name='John Doe',
|
||||
description='The admin role',
|
||||
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.v3.models.base_access_all_of_owner.BaseAccess_allOf_owner(
|
||||
type = 'IDENTITY',
|
||||
id = '2c9180a46faadee4016fb4e018c20639',
|
||||
name = 'Support',
|
||||
email = 'cloud-support@sailpoint.com', )
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
id: base-access-all-of-owner
|
||||
title: BaseAccessAllOfOwner
|
||||
pagination_label: BaseAccessAllOfOwner
|
||||
sidebar_label: BaseAccessAllOfOwner
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'BaseAccessAllOfOwner', 'BaseAccessAllOfOwner']
|
||||
slug: /tools/sdk/python/v3/models/base-access-all-of-owner
|
||||
tags: ['SDK', 'Software Development Kit', 'BaseAccessAllOfOwner', 'BaseAccessAllOfOwner']
|
||||
---
|
||||
|
||||
# BaseAccessAllOfOwner
|
||||
|
||||
Owner's identity.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **Enum** [ 'IDENTITY' ] | Owner's DTO type. | [optional]
|
||||
**id** | **str** | Owner's identity ID. | [optional]
|
||||
**name** | **str** | Owner's display name. | [optional]
|
||||
**email** | **str** | Owner's email. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.base_access_all_of_owner import BaseAccessAllOfOwner
|
||||
|
||||
base_access_all_of_owner = BaseAccessAllOfOwner(
|
||||
type='IDENTITY',
|
||||
id='2c9180a46faadee4016fb4e018c20639',
|
||||
name='Support',
|
||||
email='cloud-support@sailpoint.com'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: base-access-profile
|
||||
title: BaseAccessProfile
|
||||
pagination_label: BaseAccessProfile
|
||||
sidebar_label: BaseAccessProfile
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'BaseAccessProfile', 'BaseAccessProfile']
|
||||
slug: /tools/sdk/python/v3/models/base-access-profile
|
||||
tags: ['SDK', 'Software Development Kit', 'BaseAccessProfile', 'BaseAccessProfile']
|
||||
---
|
||||
|
||||
# BaseAccessProfile
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | Access profile's unique ID. | [optional]
|
||||
**name** | **str** | Access profile's display name. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.base_access_profile import BaseAccessProfile
|
||||
|
||||
base_access_profile = BaseAccessProfile(
|
||||
id='2c91809c6faade77016fb4f0b63407ae',
|
||||
name='Admin Access'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
53
docs/tools/sdk/python/Reference/V3/Models/BaseAccount.md
Normal file
53
docs/tools/sdk/python/Reference/V3/Models/BaseAccount.md
Normal file
@@ -0,0 +1,53 @@
|
||||
---
|
||||
id: base-account
|
||||
title: BaseAccount
|
||||
pagination_label: BaseAccount
|
||||
sidebar_label: BaseAccount
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'BaseAccount', 'BaseAccount']
|
||||
slug: /tools/sdk/python/v3/models/base-account
|
||||
tags: ['SDK', 'Software Development Kit', 'BaseAccount', 'BaseAccount']
|
||||
---
|
||||
|
||||
# BaseAccount
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | The unique ID of the referenced object. | [optional]
|
||||
**name** | **str** | The human readable name of the referenced object. | [optional]
|
||||
**account_id** | **str** | Account ID. | [optional]
|
||||
**source** | [**AccountSource**](account-source) | | [optional]
|
||||
**disabled** | **bool** | Indicates whether the account is disabled. | [optional] [default to False]
|
||||
**locked** | **bool** | Indicates whether the account is locked. | [optional] [default to False]
|
||||
**privileged** | **bool** | Indicates whether the account is privileged. | [optional] [default to False]
|
||||
**manually_correlated** | **bool** | Indicates whether the account has been manually correlated to an identity. | [optional] [default to False]
|
||||
**password_last_set** | **datetime** | A date-time in ISO-8601 format | [optional]
|
||||
**entitlement_attributes** | **map[string]object** | Map or dictionary of key/value pairs. | [optional]
|
||||
**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.base_account import BaseAccount
|
||||
|
||||
base_account = BaseAccount(
|
||||
id='2c91808568c529c60168cca6f90c1313',
|
||||
name='John Doe',
|
||||
account_id='John.Doe',
|
||||
source=,
|
||||
disabled=False,
|
||||
locked=False,
|
||||
privileged=False,
|
||||
manually_correlated=False,
|
||||
password_last_set='2018-06-25T20:22:28.104Z',
|
||||
entitlement_attributes={moderator=true, admin=true, trust_level=4},
|
||||
created='2018-06-25T20:22:28.104Z'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
39
docs/tools/sdk/python/Reference/V3/Models/BaseCommonDto.md
Normal file
39
docs/tools/sdk/python/Reference/V3/Models/BaseCommonDto.md
Normal file
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: base-common-dto
|
||||
title: BaseCommonDto
|
||||
pagination_label: BaseCommonDto
|
||||
sidebar_label: BaseCommonDto
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'BaseCommonDto', 'BaseCommonDto']
|
||||
slug: /tools/sdk/python/v3/models/base-common-dto
|
||||
tags: ['SDK', 'Software Development Kit', 'BaseCommonDto', 'BaseCommonDto']
|
||||
---
|
||||
|
||||
# BaseCommonDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | System-generated unique ID of the Object | [optional] [readonly]
|
||||
**name** | **str** | Name of the Object | [required]
|
||||
**created** | **datetime** | Creation date of the Object | [optional] [readonly]
|
||||
**modified** | **datetime** | Last modification date of the Object | [optional] [readonly]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.base_common_dto import BaseCommonDto
|
||||
|
||||
base_common_dto = BaseCommonDto(
|
||||
id='id12345',
|
||||
name='aName',
|
||||
created='2015-05-28T14:07:17Z',
|
||||
modified='2015-05-28T14:07:17Z'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
37
docs/tools/sdk/python/Reference/V3/Models/BaseDocument.md
Normal file
37
docs/tools/sdk/python/Reference/V3/Models/BaseDocument.md
Normal file
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: base-document
|
||||
title: BaseDocument
|
||||
pagination_label: BaseDocument
|
||||
sidebar_label: BaseDocument
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'BaseDocument', 'BaseDocument']
|
||||
slug: /tools/sdk/python/v3/models/base-document
|
||||
tags: ['SDK', 'Software Development Kit', 'BaseDocument', 'BaseDocument']
|
||||
---
|
||||
|
||||
# BaseDocument
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | | [required]
|
||||
**name** | **str** | | [required]
|
||||
**type** | [**DocumentType**](document-type) | | [required]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.base_document import BaseDocument
|
||||
|
||||
base_document = BaseDocument(
|
||||
id='2c91808375d8e80a0175e1f88a575222',
|
||||
name='john.doe',
|
||||
type='identity'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
47
docs/tools/sdk/python/Reference/V3/Models/BaseEntitlement.md
Normal file
47
docs/tools/sdk/python/Reference/V3/Models/BaseEntitlement.md
Normal file
@@ -0,0 +1,47 @@
|
||||
---
|
||||
id: base-entitlement
|
||||
title: BaseEntitlement
|
||||
pagination_label: BaseEntitlement
|
||||
sidebar_label: BaseEntitlement
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'BaseEntitlement', 'BaseEntitlement']
|
||||
slug: /tools/sdk/python/v3/models/base-entitlement
|
||||
tags: ['SDK', 'Software Development Kit', 'BaseEntitlement', 'BaseEntitlement']
|
||||
---
|
||||
|
||||
# BaseEntitlement
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**has_permissions** | **bool** | Indicates whether the entitlement has permissions. | [optional] [default to False]
|
||||
**description** | **str** | Entitlement's description. | [optional]
|
||||
**attribute** | **str** | Entitlement attribute's name. | [optional]
|
||||
**value** | **str** | Entitlement's value. | [optional]
|
||||
**var_schema** | **str** | Entitlement's schema. | [optional]
|
||||
**privileged** | **bool** | Indicates whether the entitlement is privileged. | [optional] [default to False]
|
||||
**id** | **str** | Entitlement's ID. | [optional]
|
||||
**name** | **str** | Entitlement's name. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.base_entitlement import BaseEntitlement
|
||||
|
||||
base_entitlement = BaseEntitlement(
|
||||
has_permissions=False,
|
||||
description='Cloud engineering',
|
||||
attribute='memberOf',
|
||||
value='CN=Cloud Engineering,DC=sailpoint,DC=COM',
|
||||
var_schema='group',
|
||||
privileged=False,
|
||||
id='2c918084575812550157589064f33b89',
|
||||
name='CN=Cloud Engineering,DC=sailpoint,DC=COM'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: base-reference-dto
|
||||
title: BaseReferenceDto
|
||||
pagination_label: BaseReferenceDto
|
||||
sidebar_label: BaseReferenceDto
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'BaseReferenceDto', 'BaseReferenceDto']
|
||||
slug: /tools/sdk/python/v3/models/base-reference-dto
|
||||
tags: ['SDK', 'Software Development Kit', 'BaseReferenceDto', 'BaseReferenceDto']
|
||||
---
|
||||
|
||||
# BaseReferenceDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | [**DtoType**](dto-type) | | [optional]
|
||||
**id** | **str** | ID of the object to which this reference applies | [optional]
|
||||
**name** | **str** | Human-readable display name of the object to which this reference applies | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.base_reference_dto import BaseReferenceDto
|
||||
|
||||
base_reference_dto = BaseReferenceDto(
|
||||
type='IDENTITY',
|
||||
id='2c91808568c529c60168cca6f90c1313',
|
||||
name='William Wilson'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
35
docs/tools/sdk/python/Reference/V3/Models/BaseSegment.md
Normal file
35
docs/tools/sdk/python/Reference/V3/Models/BaseSegment.md
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: base-segment
|
||||
title: BaseSegment
|
||||
pagination_label: BaseSegment
|
||||
sidebar_label: BaseSegment
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'BaseSegment', 'BaseSegment']
|
||||
slug: /tools/sdk/python/v3/models/base-segment
|
||||
tags: ['SDK', 'Software Development Kit', 'BaseSegment', 'BaseSegment']
|
||||
---
|
||||
|
||||
# BaseSegment
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | Segment's unique ID. | [optional]
|
||||
**name** | **str** | Segment's display name. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.base_segment import BaseSegment
|
||||
|
||||
base_segment = BaseSegment(
|
||||
id='b009b6e3-b56d-41d9-8735-cb532ea0b017',
|
||||
name='Test Segment'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
id: before-provisioning-rule-dto
|
||||
title: BeforeProvisioningRuleDto
|
||||
pagination_label: BeforeProvisioningRuleDto
|
||||
sidebar_label: BeforeProvisioningRuleDto
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'BeforeProvisioningRuleDto', 'BeforeProvisioningRuleDto']
|
||||
slug: /tools/sdk/python/v3/models/before-provisioning-rule-dto
|
||||
tags: ['SDK', 'Software Development Kit', 'BeforeProvisioningRuleDto', 'BeforeProvisioningRuleDto']
|
||||
---
|
||||
|
||||
# BeforeProvisioningRuleDto
|
||||
|
||||
Before Provisioning Rule.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **Enum** [ 'RULE' ] | Before Provisioning Rule DTO type. | [optional]
|
||||
**id** | **str** | Before Provisioning Rule ID. | [optional]
|
||||
**name** | **str** | Rule display name. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.before_provisioning_rule_dto import BeforeProvisioningRuleDto
|
||||
|
||||
before_provisioning_rule_dto = BeforeProvisioningRuleDto(
|
||||
type='RULE',
|
||||
id='048eb3d55c5a4758bd07dccb87741c78',
|
||||
name='Before Provisioning Airtable Rule'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
35
docs/tools/sdk/python/Reference/V3/Models/Bound.md
Normal file
35
docs/tools/sdk/python/Reference/V3/Models/Bound.md
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: bound
|
||||
title: Bound
|
||||
pagination_label: Bound
|
||||
sidebar_label: Bound
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'Bound', 'Bound']
|
||||
slug: /tools/sdk/python/v3/models/bound
|
||||
tags: ['SDK', 'Software Development Kit', 'Bound', 'Bound']
|
||||
---
|
||||
|
||||
# Bound
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**value** | **str** | The value of the range's endpoint. | [required]
|
||||
**inclusive** | **bool** | Indicates if the endpoint is included in the range. | [optional] [default to False]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.bound import Bound
|
||||
|
||||
bound = Bound(
|
||||
value='1',
|
||||
inclusive=False
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
47
docs/tools/sdk/python/Reference/V3/Models/BrandingItem.md
Normal file
47
docs/tools/sdk/python/Reference/V3/Models/BrandingItem.md
Normal file
@@ -0,0 +1,47 @@
|
||||
---
|
||||
id: branding-item
|
||||
title: BrandingItem
|
||||
pagination_label: BrandingItem
|
||||
sidebar_label: BrandingItem
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'BrandingItem', 'BrandingItem']
|
||||
slug: /tools/sdk/python/v3/models/branding-item
|
||||
tags: ['SDK', 'Software Development Kit', 'BrandingItem', 'BrandingItem']
|
||||
---
|
||||
|
||||
# BrandingItem
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | name of branding item | [optional]
|
||||
**product_name** | **str** | product name | [optional]
|
||||
**action_button_color** | **str** | hex value of color for action button | [optional]
|
||||
**active_link_color** | **str** | hex value of color for link | [optional]
|
||||
**navigation_color** | **str** | hex value of color for navigation bar | [optional]
|
||||
**email_from_address** | **str** | email from address | [optional]
|
||||
**standard_logo_url** | **str** | url to standard logo | [optional]
|
||||
**login_informational_message** | **str** | login information message | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.branding_item import BrandingItem
|
||||
|
||||
branding_item = BrandingItem(
|
||||
name='default',
|
||||
product_name='product name',
|
||||
action_button_color='0074D9',
|
||||
active_link_color='011E69',
|
||||
navigation_color='011E69',
|
||||
email_from_address='no-reply@sailpoint.com',
|
||||
standard_logo_url='',
|
||||
login_informational_message=''
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
id: branding-item-create
|
||||
title: BrandingItemCreate
|
||||
pagination_label: BrandingItemCreate
|
||||
sidebar_label: BrandingItemCreate
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'BrandingItemCreate', 'BrandingItemCreate']
|
||||
slug: /tools/sdk/python/v3/models/branding-item-create
|
||||
tags: ['SDK', 'Software Development Kit', 'BrandingItemCreate', 'BrandingItemCreate']
|
||||
---
|
||||
|
||||
# BrandingItemCreate
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | name of branding item | [required]
|
||||
**product_name** | **str** | product name | [required]
|
||||
**action_button_color** | **str** | hex value of color for action button | [optional]
|
||||
**active_link_color** | **str** | hex value of color for link | [optional]
|
||||
**navigation_color** | **str** | hex value of color for navigation bar | [optional]
|
||||
**email_from_address** | **str** | email from address | [optional]
|
||||
**login_informational_message** | **str** | login information message | [optional]
|
||||
**file_standard** | **bytearray** | png file with logo | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.branding_item_create import BrandingItemCreate
|
||||
|
||||
branding_item_create = BrandingItemCreate(
|
||||
name='custom-branding-item',
|
||||
product_name='product name',
|
||||
action_button_color='0074D9',
|
||||
active_link_color='011E69',
|
||||
navigation_color='011E69',
|
||||
email_from_address='no-reply@sailpoint.com',
|
||||
login_informational_message='',
|
||||
file_standard='\x00\x00\x00\x02'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
id: bucket-aggregation
|
||||
title: BucketAggregation
|
||||
pagination_label: BucketAggregation
|
||||
sidebar_label: BucketAggregation
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'BucketAggregation', 'BucketAggregation']
|
||||
slug: /tools/sdk/python/v3/models/bucket-aggregation
|
||||
tags: ['SDK', 'Software Development Kit', 'BucketAggregation', 'BucketAggregation']
|
||||
---
|
||||
|
||||
# BucketAggregation
|
||||
|
||||
The bucket to group the results of the aggregation query by.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | The name of the bucket aggregate to be included in the result. | [required]
|
||||
**type** | [**BucketType**](bucket-type) | | [optional] [default to BucketType.TERMS]
|
||||
**var_field** | **str** | The field to bucket on. Prefix the field name with '@' to reference a nested object. | [required]
|
||||
**size** | **int** | Maximum number of buckets to include. | [optional]
|
||||
**min_doc_count** | **int** | Minimum number of documents a bucket should have. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.bucket_aggregation import BucketAggregation
|
||||
|
||||
bucket_aggregation = BucketAggregation(
|
||||
name='Identity Locations',
|
||||
type='TERMS',
|
||||
var_field='attributes.city',
|
||||
size=100,
|
||||
min_doc_count=2
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
21
docs/tools/sdk/python/Reference/V3/Models/BucketType.md
Normal file
21
docs/tools/sdk/python/Reference/V3/Models/BucketType.md
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
id: bucket-type
|
||||
title: BucketType
|
||||
pagination_label: BucketType
|
||||
sidebar_label: BucketType
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'BucketType', 'BucketType']
|
||||
slug: /tools/sdk/python/v3/models/bucket-type
|
||||
tags: ['SDK', 'Software Development Kit', 'BucketType', 'BucketType']
|
||||
---
|
||||
|
||||
# BucketType
|
||||
|
||||
Enum representing the currently supported bucket aggregation types. Additional values may be added in the future without notice.
|
||||
|
||||
## Enum
|
||||
|
||||
* `TERMS` (value: `'TERMS'`)
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user