Skip to content

Commit c0b2076

Browse files
darrell-thobe-spdarrell-thobe-sp
committed
fixing more linking issues
1 parent 48ec90c commit c0b2076

11 files changed

+822
-11
lines changed

‎docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatus.md

Lines changed: 142 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,142 @@
1-
**error_messages** | [**[]List[ErrorMessageDto]**](error-message-dto) | List of list of localized error messages, if any, encountered during the approval/provisioning process. | [optional]
1+
---
2+
id: beta-requested-item-status
3+
title: RequestedItemStatus
4+
pagination_label: RequestedItemStatus
5+
sidebar_label: RequestedItemStatus
6+
sidebar_class_name: pythonsdk
7+
keywords: ['python', 'Python', 'sdk', 'RequestedItemStatus', 'BetaRequestedItemStatus']
8+
slug: /tools/sdk/python/beta/models/requested-item-status
9+
tags: ['SDK', 'Software Development Kit', 'RequestedItemStatus', 'BetaRequestedItemStatus']
10+
---
11+
12+
# RequestedItemStatus
13+
14+
15+
## Properties
16+
17+
Name | Type | Description | Notes
18+
------------ | ------------- | ------------- | -------------
19+
**name** | **str** | Human-readable display name of the item being requested. | [optional]
20+
**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | Type of requested object. | [optional]
21+
**cancelled_request_details** | [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional]
22+
**error_messages** | [**[]List[ErrorMessageDto]**](error-message-dto) | List of list of localized error messages, if any, encountered during the approval/provisioning process. | [optional]
23+
**state** | [**RequestedItemStatusRequestState**](requested-item-status-request-state) | | [optional]
24+
**approval_details** | [**[]ApprovalStatusDto**](approval-status-dto) | Approval details for each item. | [optional]
25+
**approval_ids** | **[]str** | List of approval IDs associated with the request. | [optional]
26+
**manual_work_item_details** | [**[]ManualWorkItemDetails**](manual-work-item-details) | Manual work items created for provisioning the item. | [optional]
27+
**account_activity_item_id** | **str** | Id of associated account activity item. | [optional]
28+
**request_type** | [**AccessRequestType**](access-request-type) | | [optional]
29+
**modified** | **datetime** | When the request was last modified. | [optional]
30+
**created** | **datetime** | When the request was created. | [optional]
31+
**requester** | [**AccessItemRequester**](access-item-requester) | | [optional]
32+
**requested_for** | [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional]
33+
**requester_comment** | [**RequestedItemStatusRequesterComment**](requested-item-status-requester-comment) | | [optional]
34+
**sod_violation_context** | [**RequestedItemStatusSodViolationContext**](requested-item-status-sod-violation-context) | | [optional]
35+
**provisioning_details** | [**RequestedItemStatusProvisioningDetails**](requested-item-status-provisioning-details) | | [optional]
36+
**pre_approval_trigger_details** | [**RequestedItemStatusPreApprovalTriggerDetails**](requested-item-status-pre-approval-trigger-details) | | [optional]
37+
**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]
38+
**description** | **str** | Description associated to the requested object. | [optional]
39+
**remove_date** | **datetime** | When the role access is scheduled for removal. | [optional]
40+
**cancelable** | **bool** | True if the request can be canceled. | [optional] [default to False]
41+
**access_request_id** | **str** | This is the account activity id. | [optional]
42+
**client_metadata** | **map[string]str** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional]
43+
}
44+
45+
## Example
46+
47+
```python
48+
from sailpoint.beta.models.requested_item_status import RequestedItemStatus
49+
50+
requested_item_status = RequestedItemStatus(
51+
name='AccessProfile1',
52+
type='ACCESS_PROFILE',
53+
cancelled_request_details=,
54+
error_messages=[
55+
[
56+
sailpoint.beta.models.error_message_dto.ErrorMessageDto(
57+
locale = 'en-US',
58+
locale_origin = 'DEFAULT',
59+
text = 'The request was syntactically correct but its content is semantically invalid.', )
60+
]
61+
],
62+
state='EXECUTING',
63+
approval_details=[
64+
sailpoint.beta.models.approval_status_dto.ApprovalStatusDto(
65+
approval_id = '2c9180877b2b6ea4017b2c545f971429',
66+
forwarded = False,
67+
original_owner = sailpoint.beta.models.approval_status_dto_original_owner.ApprovalStatusDto_originalOwner(
68+
type = 'IDENTITY',
69+
id = '2c7180a46faadee4016fb4e018c20642',
70+
name = 'Michael Michaels', ),
71+
current_owner = null,
72+
modified = '2019-08-23T18:52:57.398Z',
73+
status = 'PENDING',
74+
scheme = 'MANAGER',
75+
error_messages = [
76+
sailpoint.beta.models.error_message_dto.ErrorMessageDto(
77+
locale = 'en-US',
78+
locale_origin = 'DEFAULT',
79+
text = 'The request was syntactically correct but its content is semantically invalid.', )
80+
],
81+
comment = 'I approve this request',
82+
remove_date = '2020-07-11T00:00Z', )
83+
],
84+
approval_ids=[85f0cf482dd44327b593624c07906c21, fa57e1bfa36f41ee85e33ee59fcbeac5],
85+
manual_work_item_details=[
86+
sailpoint.beta.models.manual_work_item_details.ManualWorkItemDetails(
87+
forwarded = True,
88+
original_owner = sailpoint.beta.models.manual_work_item_details_original_owner.ManualWorkItemDetails_originalOwner(
89+
type = 'IDENTITY',
90+
id = '2c7180a46faadee4016fb4e018c20642',
91+
name = 'Michael Michaels', ),
92+
current_owner = sailpoint.beta.models.manual_work_item_details_current_owner.ManualWorkItemDetails_currentOwner(
93+
type = 'IDENTITY',
94+
id = '2c3780a46faadee4016fb4e018c20652',
95+
name = 'Allen Albertson', ),
96+
modified = '2019-08-23T18:52:57.398Z',
97+
status = 'PENDING',
98+
forward_history = [
99+
sailpoint.beta.models.approval_forward_history.ApprovalForwardHistory(
100+
old_approver_name = 'Frank Mir',
101+
new_approver_name = 'Al Volta',
102+
comment = 'Forwarding from Frank to Al',
103+
modified = '2019-08-23T18:52:57.398Z',
104+
forwarder_name = 'William Wilson',
105+
reassignment_type = 'AUTOMATIC_REASSIGNMENT', )
106+
], )
107+
],
108+
account_activity_item_id='2c9180926cbfbddd016cbfc7c3b10010',
109+
request_type='GRANT_ACCESS',
110+
modified='2019-08-23T18:52:59.162Z',
111+
created='2019-08-23T18:40:35.772Z',
112+
requester=sailpoint.beta.models.access_item_requester.AccessItemRequester(
113+
type = 'IDENTITY',
114+
id = '2c7180a46faadee4016fb4e018c20648',
115+
name = 'William Wilson', ),
116+
requested_for=sailpoint.beta.models.requested_item_status_requested_for.RequestedItemStatus_requestedFor(
117+
type = 'IDENTITY',
118+
id = '2c9180835d191a86015d28455b4b232a',
119+
name = 'William Wilson', ),
120+
requester_comment=,
121+
sod_violation_context=,
122+
provisioning_details=,
123+
pre_approval_trigger_details=,
124+
access_request_phases=[
125+
sailpoint.beta.models.access_request_phases.AccessRequestPhases(
126+
started = '2020-07-11T00:00Z',
127+
finished = '2020-07-12T00:00Z',
128+
name = 'APPROVAL_PHASE',
129+
state = 'COMPLETED',
130+
result = 'SUCCESSFUL',
131+
phase_reference = 'approvalDetails', )
132+
],
133+
description='This is the Engineering role that engineers are granted.',
134+
remove_date='2019-10-23T00:00Z',
135+
cancelable=True,
136+
access_request_id='2b838de9-db9b-abcf-e646-d4f274ad4238',
137+
client_metadata={key1=value1, key2=value2}
138+
)
139+
140+
```
141+
[[Back to top]](#)
142+

‎docs/tools/sdk/python/Reference/V2024/Models/CreateSavedSearchRequest.md

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,53 @@
1-
**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]
1+
---
2+
id: v2024-create-saved-search-request
3+
title: CreateSavedSearchRequest
4+
pagination_label: CreateSavedSearchRequest
5+
sidebar_label: CreateSavedSearchRequest
6+
sidebar_class_name: pythonsdk
7+
keywords: ['python', 'Python', 'sdk', 'CreateSavedSearchRequest', 'V2024CreateSavedSearchRequest']
8+
slug: /tools/sdk/python/v2024/models/create-saved-search-request
9+
tags: ['SDK', 'Software Development Kit', 'CreateSavedSearchRequest', 'V2024CreateSavedSearchRequest']
10+
---
11+
12+
# CreateSavedSearchRequest
13+
14+
15+
## Properties
16+
17+
Name | Type | Description | Notes
18+
------------ | ------------- | ------------- | -------------
19+
**name** | **str** | The name of the saved search. | [optional]
20+
**description** | **str** | The description of the saved search. | [optional]
21+
**created** | **datetime** | A date-time in ISO-8601 format | [optional]
22+
**modified** | **datetime** | A date-time in ISO-8601 format | [optional]
23+
**indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required]
24+
**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]
25+
**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]
26+
**fields** | **[]str** | The fields to be searched against in a multi-field query. | [optional]
27+
**order_by** | **map[string]List[str]** | Sort by index. This takes precedence over the `sort` property. | [optional]
28+
**sort** | **[]str** | The fields to be used to sort the search results. | [optional]
29+
**filters** | [**SavedSearchDetailFilters**](saved-search-detail-filters) | | [optional]
30+
}
31+
32+
## Example
33+
34+
```python
35+
from sailpoint.v2024.models.create_saved_search_request import CreateSavedSearchRequest
36+
37+
create_saved_search_request = CreateSavedSearchRequest(
38+
name='Disabled accounts',
39+
description='Disabled accounts',
40+
created='2018-06-25T20:22:28.104Z',
41+
modified='2018-06-25T20:22:28.104Z',
42+
indices=[identities],
43+
columns={identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]},
44+
query='@accounts(disabled:true)',
45+
fields=[disabled],
46+
order_by={identity=[lastName, firstName], role=[name]},
47+
sort=[displayName],
48+
filters=
49+
)
50+
51+
```
52+
[[Back to top]](#)
53+

‎docs/tools/sdk/python/Reference/V2024/Models/ObjectMappingBulkPatchRequest.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,33 @@
1-
**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]
1+
---
2+
id: v2024-object-mapping-bulk-patch-request
3+
title: ObjectMappingBulkPatchRequest
4+
pagination_label: ObjectMappingBulkPatchRequest
5+
sidebar_label: ObjectMappingBulkPatchRequest
6+
sidebar_class_name: pythonsdk
7+
keywords: ['python', 'Python', 'sdk', 'ObjectMappingBulkPatchRequest', 'V2024ObjectMappingBulkPatchRequest']
8+
slug: /tools/sdk/python/v2024/models/object-mapping-bulk-patch-request
9+
tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkPatchRequest', 'V2024ObjectMappingBulkPatchRequest']
10+
---
11+
12+
# ObjectMappingBulkPatchRequest
13+
14+
15+
## Properties
16+
17+
Name | Type | Description | Notes
18+
------------ | ------------- | ------------- | -------------
19+
**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]
20+
}
21+
22+
## Example
23+
24+
```python
25+
from sailpoint.v2024.models.object_mapping_bulk_patch_request import ObjectMappingBulkPatchRequest
26+
27+
object_mapping_bulk_patch_request = ObjectMappingBulkPatchRequest(
28+
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}]}
29+
)
30+
31+
```
32+
[[Back to top]](#)
33+

0 commit comments

Comments
 (0)