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

fixing more linking issues

Browse Source
This commit is contained in:
darrell-thobe-sp
2025-02-20 16:17:08 -05:00
parent 48ec90cff6
commit c0b2076737
11 changed files with 822 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

143
docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatus.md
View File

@@ -1 +1,142 @@
**error_messages** | [**[]List[ErrorMessageDto]**](error-message-dto) | List of list of localized error messages, if any, encountered during the approval/provisioning process. | [optional]
---
id: beta-requested-item-status
title: RequestedItemStatus
pagination_label: RequestedItemStatus
sidebar_label: RequestedItemStatus
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'RequestedItemStatus', 'BetaRequestedItemStatus']
slug: /tools/sdk/python/beta/models/requested-item-status
tags: ['SDK', 'Software Development Kit', 'RequestedItemStatus', 'BetaRequestedItemStatus']
---
# RequestedItemStatus
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Human-readable display name of the item being requested. | [optional]
**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | Type of requested object. | [optional]
**cancelled_request_details** | [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional]
**error_messages** | [**[]List[ErrorMessageDto]**](error-message-dto) | List of list of localized error messages, if any, encountered during the approval/provisioning process. | [optional]
**state** | [**RequestedItemStatusRequestState**](requested-item-status-request-state) | | [optional]
**approval_details** | [**[]ApprovalStatusDto**](approval-status-dto) | Approval details for each item. | [optional]
**approval_ids** | **[]str** | List of approval IDs associated with the request. | [optional]
**manual_work_item_details** | [**[]ManualWorkItemDetails**](manual-work-item-details) | Manual work items created for provisioning the item. | [optional]
**account_activity_item_id** | **str** | Id of associated account activity item. | [optional]
**request_type** | [**AccessRequestType**](access-request-type) | | [optional]
**modified** | **datetime** | When the request was last modified. | [optional]
**created** | **datetime** | When the request was created. | [optional]
**requester** | [**AccessItemRequester**](access-item-requester) | | [optional]
**requested_for** | [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional]
**requester_comment** | [**RequestedItemStatusRequesterComment**](requested-item-status-requester-comment) | | [optional]
**sod_violation_context** | [**RequestedItemStatusSodViolationContext**](requested-item-status-sod-violation-context) | | [optional]
**provisioning_details** | [**RequestedItemStatusProvisioningDetails**](requested-item-status-provisioning-details) | | [optional]
**pre_approval_trigger_details** | [**RequestedItemStatusPreApprovalTriggerDetails**](requested-item-status-pre-approval-trigger-details) | | [optional]
**access_request_phases** | [**[]AccessRequestPhases**](access-request-phases) | A list of Phases that the Access Request has gone through in order, to help determine the status of the request. | [optional]
**description** | **str** | Description associated to the requested object. | [optional]
**remove_date** | **datetime** | When the role access is scheduled for removal. | [optional]
**cancelable** | **bool** | True if the request can be canceled. | [optional] [default to False]
**access_request_id** | **str** | This is the account activity id. | [optional]
**client_metadata** | **map[string]str** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional]
}
## Example
```python
from sailpoint.beta.models.requested_item_status import RequestedItemStatus
requested_item_status = RequestedItemStatus(
name='AccessProfile1',
type='ACCESS_PROFILE',
cancelled_request_details=,
error_messages=[
[
sailpoint.beta.models.error_message_dto.ErrorMessageDto(
locale = 'en-US',
locale_origin = 'DEFAULT',
text = 'The request was syntactically correct but its content is semantically invalid.', )
]
],
state='EXECUTING',
approval_details=[
sailpoint.beta.models.approval_status_dto.ApprovalStatusDto(
approval_id = '2c9180877b2b6ea4017b2c545f971429',
forwarded = False,
original_owner = sailpoint.beta.models.approval_status_dto_original_owner.ApprovalStatusDto_originalOwner(
type = 'IDENTITY',
id = '2c7180a46faadee4016fb4e018c20642',
name = 'Michael Michaels', ),
current_owner = null,
modified = '2019-08-23T18:52:57.398Z',
status = 'PENDING',
scheme = 'MANAGER',
error_messages = [
sailpoint.beta.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', )
],
approval_ids=[85f0cf482dd44327b593624c07906c21, fa57e1bfa36f41ee85e33ee59fcbeac5],
manual_work_item_details=[
sailpoint.beta.models.manual_work_item_details.ManualWorkItemDetails(
forwarded = True,
original_owner = sailpoint.beta.models.manual_work_item_details_original_owner.ManualWorkItemDetails_originalOwner(
type = 'IDENTITY',
id = '2c7180a46faadee4016fb4e018c20642',
name = 'Michael Michaels', ),
current_owner = sailpoint.beta.models.manual_work_item_details_current_owner.ManualWorkItemDetails_currentOwner(
type = 'IDENTITY',
id = '2c3780a46faadee4016fb4e018c20652',
name = 'Allen Albertson', ),
modified = '2019-08-23T18:52:57.398Z',
status = 'PENDING',
forward_history = [
sailpoint.beta.models.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', )
], )
],
account_activity_item_id='2c9180926cbfbddd016cbfc7c3b10010',
request_type='GRANT_ACCESS',
modified='2019-08-23T18:52:59.162Z',
created='2019-08-23T18:40:35.772Z',
requester=sailpoint.beta.models.access_item_requester.AccessItemRequester(
type = 'IDENTITY',
id = '2c7180a46faadee4016fb4e018c20648',
name = 'William Wilson', ),
requested_for=sailpoint.beta.models.requested_item_status_requested_for.RequestedItemStatus_requestedFor(
type = 'IDENTITY',
id = '2c9180835d191a86015d28455b4b232a',
name = 'William Wilson', ),
requester_comment=,
sod_violation_context=,
provisioning_details=,
pre_approval_trigger_details=,
access_request_phases=[
sailpoint.beta.models.access_request_phases.AccessRequestPhases(
started = '2020-07-11T00:00Z',
finished = '2020-07-12T00:00Z',
name = 'APPROVAL_PHASE',
state = 'COMPLETED',
result = 'SUCCESSFUL',
phase_reference = 'approvalDetails', )
],
description='This is the Engineering role that engineers are granted.',
remove_date='2019-10-23T00:00Z',
cancelable=True,
access_request_id='2b838de9-db9b-abcf-e646-d4f274ad4238',
client_metadata={key1=value1, key2=value2}
)
```
[[Back to top]](#)

54
docs/tools/sdk/python/Reference/V2024/Models/CreateSavedSearchRequest.md
View File

@@ -1 +1,53 @@
**columns** | [**map[string]List[Column]**](https://docs.python.org/3/tutorial/datastructures.html#more-on-lists) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional]
---
id: v2024-create-saved-search-request
title: CreateSavedSearchRequest
pagination_label: CreateSavedSearchRequest
sidebar_label: CreateSavedSearchRequest
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'CreateSavedSearchRequest', 'V2024CreateSavedSearchRequest']
slug: /tools/sdk/python/v2024/models/create-saved-search-request
tags: ['SDK', 'Software Development Kit', 'CreateSavedSearchRequest', 'V2024CreateSavedSearchRequest']
---
# CreateSavedSearchRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | The name of the saved search. | [optional]
**description** | **str** | The description of the saved search. | [optional]
**created** | **datetime** | A date-time in ISO-8601 format | [optional]
**modified** | **datetime** | A date-time in ISO-8601 format | [optional]
**indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required]
**columns** | [**map[string]List[Column]**](https://docs.python.org/3/tutorial/datastructures.html#more-on-lists) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional]
**query** | **str** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required]
**fields** | **[]str** | The fields to be searched against in a multi-field query. | [optional]
**order_by** | **map[string]List[str]** | Sort by index. This takes precedence over the `sort` property. | [optional]
**sort** | **[]str** | The fields to be used to sort the search results. | [optional]
**filters** | [**SavedSearchDetailFilters**](saved-search-detail-filters) | | [optional]
}
## Example
```python
from sailpoint.v2024.models.create_saved_search_request import CreateSavedSearchRequest
create_saved_search_request = CreateSavedSearchRequest(
name='Disabled accounts',
description='Disabled accounts',
created='2018-06-25T20:22:28.104Z',
modified='2018-06-25T20:22:28.104Z',
indices=[identities],
columns={identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]},
query='@accounts(disabled:true)',
fields=[disabled],
order_by={identity=[lastName, firstName], role=[name]},
sort=[displayName],
filters=
)
```
[[Back to top]](#)

34
docs/tools/sdk/python/Reference/V2024/Models/ObjectMappingBulkPatchRequest.md
View File

@@ -1 +1,33 @@
**patches** | [**map[string]List[JsonPatchOperation]**](https://docs.python.org/3/tutorial/datastructures.html#more-on-lists) | Map of id of the object mapping to a JsonPatchOperation describing what to patch on that object mapping. | [required]
---
id: v2024-object-mapping-bulk-patch-request
title: ObjectMappingBulkPatchRequest
pagination_label: ObjectMappingBulkPatchRequest
sidebar_label: ObjectMappingBulkPatchRequest
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ObjectMappingBulkPatchRequest', 'V2024ObjectMappingBulkPatchRequest']
slug: /tools/sdk/python/v2024/models/object-mapping-bulk-patch-request
tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkPatchRequest', 'V2024ObjectMappingBulkPatchRequest']
---
# ObjectMappingBulkPatchRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**patches** | [**map[string]List[JsonPatchOperation]**](https://docs.python.org/3/tutorial/datastructures.html#more-on-lists) | Map of id of the object mapping to a JsonPatchOperation describing what to patch on that object mapping. | [required]
}
## Example
```python
from sailpoint.v2024.models.object_mapping_bulk_patch_request import ObjectMappingBulkPatchRequest
object_mapping_bulk_patch_request = ObjectMappingBulkPatchRequest(
patches={603b1a61-d03d-4ed1-864f-a508fbd1995d=[{op=replace, path=/enabled, value=true}], 00bece34-f50d-4227-8878-76f620b5a971=[{op=replace, path=/targetValue, value=New Target Value}]}
)
```
[[Back to top]](#)

143
docs/tools/sdk/python/Reference/V2024/Models/RequestedItemStatus.md
View File

@@ -1 +1,142 @@
**error_messages** | [**[]List[ErrorMessageDto]**](error-message-dto) | List of list of localized error messages, if any, encountered during the approval/provisioning process. | [optional]
---
id: v2024-requested-item-status
title: RequestedItemStatus
pagination_label: RequestedItemStatus
sidebar_label: RequestedItemStatus
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'RequestedItemStatus', 'V2024RequestedItemStatus']
slug: /tools/sdk/python/v2024/models/requested-item-status
tags: ['SDK', 'Software Development Kit', 'RequestedItemStatus', 'V2024RequestedItemStatus']
---
# RequestedItemStatus
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Human-readable display name of the item being requested. | [optional]
**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | Type of requested object. | [optional]
**cancelled_request_details** | [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional]
**error_messages** | [**[]List[ErrorMessageDto]**](error-message-dto) | List of list of localized error messages, if any, encountered during the approval/provisioning process. | [optional]
**state** | [**RequestedItemStatusRequestState**](requested-item-status-request-state) | | [optional]
**approval_details** | [**[]ApprovalStatusDto**](approval-status-dto) | Approval details for each item. | [optional]
**approval_ids** | **[]str** | List of approval IDs associated with the request. | [optional]
**manual_work_item_details** | [**[]ManualWorkItemDetails**](manual-work-item-details) | Manual work items created for provisioning the item. | [optional]
**account_activity_item_id** | **str** | Id of associated account activity item. | [optional]
**request_type** | [**AccessRequestType**](access-request-type) | | [optional]
**modified** | **datetime** | When the request was last modified. | [optional]
**created** | **datetime** | When the request was created. | [optional]
**requester** | [**AccessItemRequester**](access-item-requester) | | [optional]
**requested_for** | [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional]
**requester_comment** | [**RequestedItemStatusRequesterComment**](requested-item-status-requester-comment) | | [optional]
**sod_violation_context** | [**RequestedItemStatusSodViolationContext**](requested-item-status-sod-violation-context) | | [optional]
**provisioning_details** | [**RequestedItemStatusProvisioningDetails**](requested-item-status-provisioning-details) | | [optional]
**pre_approval_trigger_details** | [**RequestedItemStatusPreApprovalTriggerDetails**](requested-item-status-pre-approval-trigger-details) | | [optional]
**access_request_phases** | [**[]AccessRequestPhases**](access-request-phases) | A list of Phases that the Access Request has gone through in order, to help determine the status of the request. | [optional]
**description** | **str** | Description associated to the requested object. | [optional]
**remove_date** | **datetime** | When the role access is scheduled for removal. | [optional]
**cancelable** | **bool** | True if the request can be canceled. | [optional] [default to False]
**access_request_id** | **str** | This is the account activity id. | [optional]
**client_metadata** | **map[string]str** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional]
}
## Example
```python
from sailpoint.v2024.models.requested_item_status import RequestedItemStatus
requested_item_status = RequestedItemStatus(
name='AccessProfile1',
type='ACCESS_PROFILE',
cancelled_request_details=,
error_messages=[
[
sailpoint.v2024.models.error_message_dto.ErrorMessageDto(
locale = 'en-US',
locale_origin = 'DEFAULT',
text = 'The request was syntactically correct but its content is semantically invalid.', )
]
],
state='EXECUTING',
approval_details=[
sailpoint.v2024.models.approval_status_dto.ApprovalStatusDto(
approval_id = '2c9180877b2b6ea4017b2c545f971429',
forwarded = False,
original_owner = sailpoint.v2024.models.approval_status_dto_original_owner.ApprovalStatusDto_originalOwner(
type = 'IDENTITY',
id = '2c7180a46faadee4016fb4e018c20642',
name = 'Michael Michaels', ),
current_owner = null,
modified = '2019-08-23T18:52:57.398Z',
status = 'PENDING',
scheme = 'MANAGER',
error_messages = [
sailpoint.v2024.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', )
],
approval_ids=[85f0cf482dd44327b593624c07906c21, fa57e1bfa36f41ee85e33ee59fcbeac5],
manual_work_item_details=[
sailpoint.v2024.models.manual_work_item_details.ManualWorkItemDetails(
forwarded = True,
original_owner = sailpoint.v2024.models.manual_work_item_details_original_owner.ManualWorkItemDetails_originalOwner(
type = 'IDENTITY',
id = '2c7180a46faadee4016fb4e018c20642',
name = 'Michael Michaels', ),
current_owner = sailpoint.v2024.models.manual_work_item_details_current_owner.ManualWorkItemDetails_currentOwner(
type = 'IDENTITY',
id = '2c3780a46faadee4016fb4e018c20652',
name = 'Allen Albertson', ),
modified = '2019-08-23T18:52:57.398Z',
status = 'PENDING',
forward_history = [
sailpoint.v2024.models.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', )
], )
],
account_activity_item_id='2c9180926cbfbddd016cbfc7c3b10010',
request_type='GRANT_ACCESS',
modified='2019-08-23T18:52:59.162Z',
created='2019-08-23T18:40:35.772Z',
requester=sailpoint.v2024.models.access_item_requester.AccessItemRequester(
type = 'IDENTITY',
id = '2c7180a46faadee4016fb4e018c20648',
name = 'William Wilson', ),
requested_for=sailpoint.v2024.models.requested_item_status_requested_for.RequestedItemStatus_requestedFor(
type = 'IDENTITY',
id = '2c9180835d191a86015d28455b4b232a',
name = 'William Wilson', ),
requester_comment=,
sod_violation_context=,
provisioning_details=,
pre_approval_trigger_details=,
access_request_phases=[
sailpoint.v2024.models.access_request_phases.AccessRequestPhases(
started = '2020-07-11T00:00Z',
finished = '2020-07-12T00:00Z',
name = 'APPROVAL_PHASE',
state = 'COMPLETED',
result = 'SUCCESSFUL',
phase_reference = 'approvalDetails', )
],
description='This is the Engineering role that engineers are granted.',
remove_date='2019-10-23T00:00Z',
cancelable=True,
access_request_id='2b838de9-db9b-abcf-e646-d4f274ad4238',
client_metadata={key1=value1, key2=value2}
)
```
[[Back to top]](#)

64
docs/tools/sdk/python/Reference/V2024/Models/SavedSearch.md
View File

@@ -1 +1,63 @@
**columns** | [**map[string]List[Column]**](https://docs.python.org/3/tutorial/datastructures.html#more-on-lists) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional]
---
id: v2024-saved-search
title: SavedSearch
pagination_label: SavedSearch
sidebar_label: SavedSearch
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'SavedSearch', 'V2024SavedSearch']
slug: /tools/sdk/python/v2024/models/saved-search
tags: ['SDK', 'Software Development Kit', 'SavedSearch', 'V2024SavedSearch']
---
# SavedSearch
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | The name of the saved search. | [optional]
**description** | **str** | The description of the saved search. | [optional]
**created** | **datetime** | A date-time in ISO-8601 format | [optional]
**modified** | **datetime** | A date-time in ISO-8601 format | [optional]
**indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required]
**columns** | [**map[string]List[Column]**](https://docs.python.org/3/tutorial/datastructures.html#more-on-lists) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional]
**query** | **str** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required]
**fields** | **[]str** | The fields to be searched against in a multi-field query. | [optional]
**order_by** | **map[string]List[str]** | Sort by index. This takes precedence over the `sort` property. | [optional]
**sort** | **[]str** | The fields to be used to sort the search results. | [optional]
**filters** | [**SavedSearchDetailFilters**](saved-search-detail-filters) | | [optional]
**id** | **str** | The saved search ID. | [optional]
**owner** | [**TypedReference**](typed-reference) | | [optional]
**owner_id** | **str** | The ID of the identity that owns this saved search. | [optional]
**public** | **bool** | Whether this saved search is visible to anyone but the owner. This field will always be false as there is no way to set a saved search as public at this time. | [optional] [default to False]
}
## Example
```python
from sailpoint.v2024.models.saved_search import SavedSearch
saved_search = SavedSearch(
name='Disabled accounts',
description='Disabled accounts',
created='2018-06-25T20:22:28.104Z',
modified='2018-06-25T20:22:28.104Z',
indices=[identities],
columns={identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]},
query='@accounts(disabled:true)',
fields=[disabled],
order_by={identity=[lastName, firstName], role=[name]},
sort=[displayName],
filters=,
id='0de46054-fe90-434a-b84e-c6b3359d0c64',
owner=sailpoint.v2024.models.typed_reference.TypedReference(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313', ),
owner_id='2c91808568c529c60168cca6f90c1313',
public=False
)
```
[[Back to top]](#)

50
docs/tools/sdk/python/Reference/V2024/Models/SavedSearchDetail.md
View File

@@ -1 +1,49 @@
**columns** | [**map[string]List[Column]**](https://docs.python.org/3/tutorial/datastructures.html#more-on-lists) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional]
---
id: v2024-saved-search-detail
title: SavedSearchDetail
pagination_label: SavedSearchDetail
sidebar_label: SavedSearchDetail
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'SavedSearchDetail', 'V2024SavedSearchDetail']
slug: /tools/sdk/python/v2024/models/saved-search-detail
tags: ['SDK', 'Software Development Kit', 'SavedSearchDetail', 'V2024SavedSearchDetail']
---
# SavedSearchDetail
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created** | **datetime** | A date-time in ISO-8601 format | [optional]
**modified** | **datetime** | A date-time in ISO-8601 format | [optional]
**indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required]
**columns** | [**map[string]List[Column]**](https://docs.python.org/3/tutorial/datastructures.html#more-on-lists) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional]
**query** | **str** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required]
**fields** | **[]str** | The fields to be searched against in a multi-field query. | [optional]
**order_by** | **map[string]List[str]** | Sort by index. This takes precedence over the `sort` property. | [optional]
**sort** | **[]str** | The fields to be used to sort the search results. | [optional]
**filters** | [**SavedSearchDetailFilters**](saved-search-detail-filters) | | [optional]
}
## Example
```python
from sailpoint.v2024.models.saved_search_detail import SavedSearchDetail
saved_search_detail = SavedSearchDetail(
created='2018-06-25T20:22:28.104Z',
modified='2018-06-25T20:22:28.104Z',
indices=[identities],
columns={identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]},
query='@accounts(disabled:true)',
fields=[disabled],
order_by={identity=[lastName, firstName], role=[name]},
sort=[displayName],
filters=
)
```
[[Back to top]](#)

54
docs/tools/sdk/python/Reference/V3/Models/CreateSavedSearchRequest.md
View File

@@ -1 +1,53 @@
**columns** | [**map[string]List[Column]**](https://docs.python.org/3/tutorial/datastructures.html#more-on-lists) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional]
---
id: create-saved-search-request
title: CreateSavedSearchRequest
pagination_label: CreateSavedSearchRequest
sidebar_label: CreateSavedSearchRequest
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'CreateSavedSearchRequest', 'CreateSavedSearchRequest']
slug: /tools/sdk/python/v3/models/create-saved-search-request
tags: ['SDK', 'Software Development Kit', 'CreateSavedSearchRequest', 'CreateSavedSearchRequest']
---
# CreateSavedSearchRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | The name of the saved search. | [optional]
**description** | **str** | The description of the saved search. | [optional]
**created** | **datetime** | A date-time in ISO-8601 format | [optional]
**modified** | **datetime** | A date-time in ISO-8601 format | [optional]
**indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required]
**columns** | [**map[string]List[Column]**](https://docs.python.org/3/tutorial/datastructures.html#more-on-lists) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional]
**query** | **str** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required]
**fields** | **[]str** | The fields to be searched against in a multi-field query. | [optional]
**order_by** | **map[string]List[str]** | Sort by index. This takes precedence over the `sort` property. | [optional]
**sort** | **[]str** | The fields to be used to sort the search results. | [optional]
**filters** | [**SavedSearchDetailFilters**](saved-search-detail-filters) | | [optional]
}
## Example
```python
from sailpoint.v3.models.create_saved_search_request import CreateSavedSearchRequest
create_saved_search_request = CreateSavedSearchRequest(
name='Disabled accounts',
description='Disabled accounts',
created='2018-06-25T20:22:28.104Z',
modified='2018-06-25T20:22:28.104Z',
indices=[identities],
columns={identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]},
query='@accounts(disabled:true)',
fields=[disabled],
order_by={identity=[lastName, firstName], role=[name]},
sort=[displayName],
filters=
)
```
[[Back to top]](#)

34
docs/tools/sdk/python/Reference/V3/Models/ObjectMappingBulkPatchRequest.md
View File

@@ -1 +1,33 @@
**patches** | [**map[string]List[JsonPatchOperation]**](https://docs.python.org/3/tutorial/datastructures.html#more-on-lists) | Map of id of the object mapping to a JsonPatchOperation describing what to patch on that object mapping. | [required]
---
id: object-mapping-bulk-patch-request
title: ObjectMappingBulkPatchRequest
pagination_label: ObjectMappingBulkPatchRequest
sidebar_label: ObjectMappingBulkPatchRequest
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ObjectMappingBulkPatchRequest', 'ObjectMappingBulkPatchRequest']
slug: /tools/sdk/python/v3/models/object-mapping-bulk-patch-request
tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkPatchRequest', 'ObjectMappingBulkPatchRequest']
---
# ObjectMappingBulkPatchRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**patches** | [**map[string]List[JsonPatchOperation]**](https://docs.python.org/3/tutorial/datastructures.html#more-on-lists) | Map of id of the object mapping to a JsonPatchOperation describing what to patch on that object mapping. | [required]
}
## Example
```python
from sailpoint.v3.models.object_mapping_bulk_patch_request import ObjectMappingBulkPatchRequest
object_mapping_bulk_patch_request = ObjectMappingBulkPatchRequest(
patches={603b1a61-d03d-4ed1-864f-a508fbd1995d=[{op=replace, path=/enabled, value=true}], 00bece34-f50d-4227-8878-76f620b5a971=[{op=replace, path=/targetValue, value=New Target Value}]}
)
```
[[Back to top]](#)

143
docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatus.md
View File

@@ -1 +1,142 @@
**error_messages** | [**[]List[ErrorMessageDto]**](error-message-dto) | List of list of localized error messages, if any, encountered during the approval/provisioning process. | [optional]
---
id: requested-item-status
title: RequestedItemStatus
pagination_label: RequestedItemStatus
sidebar_label: RequestedItemStatus
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'RequestedItemStatus', 'RequestedItemStatus']
slug: /tools/sdk/python/v3/models/requested-item-status
tags: ['SDK', 'Software Development Kit', 'RequestedItemStatus', 'RequestedItemStatus']
---
# RequestedItemStatus
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Human-readable display name of the item being requested. | [optional]
**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | Type of requested object. | [optional]
**cancelled_request_details** | [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional]
**error_messages** | [**[]List[ErrorMessageDto]**](error-message-dto) | List of list of localized error messages, if any, encountered during the approval/provisioning process. | [optional]
**state** | [**RequestedItemStatusRequestState**](requested-item-status-request-state) | | [optional]
**approval_details** | [**[]ApprovalStatusDto**](approval-status-dto) | Approval details for each item. | [optional]
**approval_ids** | **[]str** | List of approval IDs associated with the request. | [optional]
**manual_work_item_details** | [**[]ManualWorkItemDetails**](manual-work-item-details) | Manual work items created for provisioning the item. | [optional]
**account_activity_item_id** | **str** | Id of associated account activity item. | [optional]
**request_type** | [**AccessRequestType**](access-request-type) | | [optional]
**modified** | **datetime** | When the request was last modified. | [optional]
**created** | **datetime** | When the request was created. | [optional]
**requester** | [**AccessItemRequester**](access-item-requester) | | [optional]
**requested_for** | [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional]
**requester_comment** | [**RequestedItemStatusRequesterComment**](requested-item-status-requester-comment) | | [optional]
**sod_violation_context** | [**RequestedItemStatusSodViolationContext**](requested-item-status-sod-violation-context) | | [optional]
**provisioning_details** | [**RequestedItemStatusProvisioningDetails**](requested-item-status-provisioning-details) | | [optional]
**pre_approval_trigger_details** | [**RequestedItemStatusPreApprovalTriggerDetails**](requested-item-status-pre-approval-trigger-details) | | [optional]
**access_request_phases** | [**[]AccessRequestPhases**](access-request-phases) | A list of Phases that the Access Request has gone through in order, to help determine the status of the request. | [optional]
**description** | **str** | Description associated to the requested object. | [optional]
**remove_date** | **datetime** | When the role access is scheduled for removal. | [optional]
**cancelable** | **bool** | True if the request can be canceled. | [optional] [default to False]
**access_request_id** | **str** | This is the account activity id. | [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.requested_item_status import RequestedItemStatus
requested_item_status = RequestedItemStatus(
name='AccessProfile1',
type='ACCESS_PROFILE',
cancelled_request_details=,
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.', )
]
],
state='EXECUTING',
approval_details=[
sailpoint.v3.models.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 = null,
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', )
],
approval_ids=[85f0cf482dd44327b593624c07906c21, fa57e1bfa36f41ee85e33ee59fcbeac5],
manual_work_item_details=[
sailpoint.v3.models.manual_work_item_details.ManualWorkItemDetails(
forwarded = True,
original_owner = sailpoint.v3.models.manual_work_item_details_original_owner.ManualWorkItemDetails_originalOwner(
type = 'IDENTITY',
id = '2c7180a46faadee4016fb4e018c20642',
name = 'Michael Michaels', ),
current_owner = sailpoint.v3.models.manual_work_item_details_current_owner.ManualWorkItemDetails_currentOwner(
type = 'IDENTITY',
id = '2c3780a46faadee4016fb4e018c20652',
name = 'Allen Albertson', ),
modified = '2019-08-23T18:52:57.398Z',
status = 'PENDING',
forward_history = [
sailpoint.v3.models.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', )
], )
],
account_activity_item_id='2c9180926cbfbddd016cbfc7c3b10010',
request_type='GRANT_ACCESS',
modified='2019-08-23T18:52:59.162Z',
created='2019-08-23T18:40:35.772Z',
requester=sailpoint.v3.models.access_item_requester.AccessItemRequester(
type = 'IDENTITY',
id = '2c7180a46faadee4016fb4e018c20648',
name = 'William Wilson', ),
requested_for=sailpoint.v3.models.requested_item_status_requested_for.RequestedItemStatus_requestedFor(
type = 'IDENTITY',
id = '2c9180835d191a86015d28455b4b232a',
name = 'William Wilson', ),
requester_comment=,
sod_violation_context=,
provisioning_details=,
pre_approval_trigger_details=,
access_request_phases=[
sailpoint.v3.models.access_request_phases.AccessRequestPhases(
started = '2020-07-11T00:00Z',
finished = '2020-07-12T00:00Z',
name = 'APPROVAL_PHASE',
state = 'COMPLETED',
result = 'SUCCESSFUL',
phase_reference = 'approvalDetails', )
],
description='This is the Engineering role that engineers are granted.',
remove_date='2019-10-23T00:00Z',
cancelable=True,
access_request_id='2b838de9-db9b-abcf-e646-d4f274ad4238',
client_metadata={key1=value1, key2=value2}
)
```
[[Back to top]](#)

64
docs/tools/sdk/python/Reference/V3/Models/SavedSearch.md
View File

@@ -1 +1,63 @@
**columns** | [**map[string]List[Column]**](https://docs.python.org/3/tutorial/datastructures.html#more-on-lists) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional]
---
id: saved-search
title: SavedSearch
pagination_label: SavedSearch
sidebar_label: SavedSearch
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'SavedSearch', 'SavedSearch']
slug: /tools/sdk/python/v3/models/saved-search
tags: ['SDK', 'Software Development Kit', 'SavedSearch', 'SavedSearch']
---
# SavedSearch
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | The name of the saved search. | [optional]
**description** | **str** | The description of the saved search. | [optional]
**created** | **datetime** | A date-time in ISO-8601 format | [optional]
**modified** | **datetime** | A date-time in ISO-8601 format | [optional]
**indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required]
**columns** | [**map[string]List[Column]**](https://docs.python.org/3/tutorial/datastructures.html#more-on-lists) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional]
**query** | **str** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required]
**fields** | **[]str** | The fields to be searched against in a multi-field query. | [optional]
**order_by** | **map[string]List[str]** | Sort by index. This takes precedence over the `sort` property. | [optional]
**sort** | **[]str** | The fields to be used to sort the search results. | [optional]
**filters** | [**SavedSearchDetailFilters**](saved-search-detail-filters) | | [optional]
**id** | **str** | The saved search ID. | [optional]
**owner** | [**TypedReference**](typed-reference) | | [optional]
**owner_id** | **str** | The ID of the identity that owns this saved search. | [optional]
**public** | **bool** | Whether this saved search is visible to anyone but the owner. This field will always be false as there is no way to set a saved search as public at this time. | [optional] [default to False]
}
## Example
```python
from sailpoint.v3.models.saved_search import SavedSearch
saved_search = SavedSearch(
name='Disabled accounts',
description='Disabled accounts',
created='2018-06-25T20:22:28.104Z',
modified='2018-06-25T20:22:28.104Z',
indices=[identities],
columns={identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]},
query='@accounts(disabled:true)',
fields=[disabled],
order_by={identity=[lastName, firstName], role=[name]},
sort=[displayName],
filters=,
id='0de46054-fe90-434a-b84e-c6b3359d0c64',
owner=sailpoint.v3.models.typed_reference.TypedReference(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313', ),
owner_id='2c91808568c529c60168cca6f90c1313',
public=False
)
```
[[Back to top]](#)

50
docs/tools/sdk/python/Reference/V3/Models/SavedSearchDetail.md
View File

@@ -1 +1,49 @@
**columns** | [**map[string]List[Column]**](https://docs.python.org/3/tutorial/datastructures.html#more-on-lists) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional]
---
id: saved-search-detail
title: SavedSearchDetail
pagination_label: SavedSearchDetail
sidebar_label: SavedSearchDetail
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'SavedSearchDetail', 'SavedSearchDetail']
slug: /tools/sdk/python/v3/models/saved-search-detail
tags: ['SDK', 'Software Development Kit', 'SavedSearchDetail', 'SavedSearchDetail']
---
# SavedSearchDetail
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created** | **datetime** | A date-time in ISO-8601 format | [optional]
**modified** | **datetime** | A date-time in ISO-8601 format | [optional]
**indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required]
**columns** | [**map[string]List[Column]**](https://docs.python.org/3/tutorial/datastructures.html#more-on-lists) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional]
**query** | **str** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required]
**fields** | **[]str** | The fields to be searched against in a multi-field query. | [optional]
**order_by** | **map[string]List[str]** | Sort by index. This takes precedence over the `sort` property. | [optional]
**sort** | **[]str** | The fields to be used to sort the search results. | [optional]
**filters** | [**SavedSearchDetailFilters**](saved-search-detail-filters) | | [optional]
}
## Example
```python
from sailpoint.v3.models.saved_search_detail import SavedSearchDetail
saved_search_detail = SavedSearchDetail(
created='2018-06-25T20:22:28.104Z',
modified='2018-06-25T20:22:28.104Z',
indices=[identities],
columns={identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]},
query='@accounts(disabled:true)',
fields=[disabled],
order_by={identity=[lastName, firstName], role=[name]},
sort=[displayName],
filters=
)
```
[[Back to top]](#)