mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 20:37:47 +00:00
Update python SDK docs: 16633304233
This commit is contained in:
developer-relations-sp
@@ -1,101 +0,0 @@
|
||||
---
|
||||
id: beta-approval
|
||||
title: Approval
|
||||
pagination_label: Approval
|
||||
sidebar_label: Approval
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'Approval', 'BetaApproval']
|
||||
slug: /tools/sdk/python/beta/models/approval
|
||||
tags: ['SDK', 'Software Development Kit', 'Approval', 'BetaApproval']
|
||||
---
|
||||
|
||||
# Approval
|
||||
|
||||
Approval Object
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**approval_id** | **str** | The Approval ID | [optional]
|
||||
**approvers** | [**[]ApprovalIdentity**](approval-identity) | Object representation of an approver of an approval | [optional]
|
||||
**created_date** | **str** | Date the approval was created | [optional]
|
||||
**type** | **str** | Type of approval | [optional]
|
||||
**name** | [**[]ApprovalName**](approval-name) | The name of the approval for a given locale | [optional]
|
||||
**batch_request** | [**ApprovalBatch**](approval-batch) | The name of the approval for a given locale | [optional]
|
||||
**description** | [**[]ApprovalDescription**](approval-description) | The description of the approval for a given locale | [optional]
|
||||
**priority** | **Enum** [ 'HIGH', 'MEDIUM', 'LOW' ] | The priority of the approval | [optional]
|
||||
**requester** | [**ApprovalIdentity**](approval-identity) | Object representation of the requester of the approval | [optional]
|
||||
**comments** | [**[]ApprovalComment**](approval-comment) | Object representation of a comment on the approval | [optional]
|
||||
**approved_by** | [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have approved the approval | [optional]
|
||||
**rejected_by** | [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have rejected the approval | [optional]
|
||||
**completed_date** | **str** | Date the approval was completed | [optional]
|
||||
**approval_criteria** | **Enum** [ 'SINGLE', 'DOUBLE', 'TRIPLE', 'QUARTER', 'HALF', 'ALL' ] | Criteria that needs to be met for an approval to be marked as approved | [optional]
|
||||
**status** | **Enum** [ 'PENDING', 'APPROVED', 'REJECTED' ] | The current status of the approval | [optional]
|
||||
**additional_attributes** | **str** | Json string representing additional attributes known about the object to be approved. | [optional]
|
||||
**reference_data** | [**[]ApprovalReference**](approval-reference) | Reference data related to the approval | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.beta.models.approval import Approval
|
||||
|
||||
approval = Approval(
|
||||
approval_id='38453251-6be2-5f8f-df93-5ce19e295837',
|
||||
approvers=[
|
||||
sailpoint.beta.models.approval_identity.Approval Identity(
|
||||
id = '85d173e7d57e496569df763231d6deb6a',
|
||||
type = 'IDENTITY',
|
||||
name = 'John Doe', )
|
||||
],
|
||||
created_date='2023-04-12T23:20:50.52Z',
|
||||
type='ENTITLEMENT_DESCRIPTIONS',
|
||||
name=[
|
||||
sailpoint.beta.models.approval_name.Approval Name(
|
||||
value = 'Audit DB Access',
|
||||
locale = 'en_US', )
|
||||
],
|
||||
batch_request={batchId=38453251-6be2-5f8f-df93-5ce19e295837, batchSize=100},
|
||||
description=[
|
||||
sailpoint.beta.models.approval_description.Approval Description(
|
||||
value = 'This access allows viewing and editing of workflow resource',
|
||||
locale = 'en_US', )
|
||||
],
|
||||
priority='HIGH',
|
||||
requester={id=85d173e7d57e496569df763231d6deb6a, type=IDENTITY, name=John Doe},
|
||||
comments=[
|
||||
sailpoint.beta.models.approval_comment.Approval Comment(
|
||||
author = sailpoint.beta.models.approval_identity.Approval Identity(
|
||||
id = '85d173e7d57e496569df763231d6deb6a',
|
||||
type = 'IDENTITY',
|
||||
name = 'John Doe', ),
|
||||
comment = 'Looks good',
|
||||
created_date = '2023-04-12T23:20:50.52Z', )
|
||||
],
|
||||
approved_by=[
|
||||
sailpoint.beta.models.approval_identity.Approval Identity(
|
||||
id = '85d173e7d57e496569df763231d6deb6a',
|
||||
type = 'IDENTITY',
|
||||
name = 'John Doe', )
|
||||
],
|
||||
rejected_by=[
|
||||
sailpoint.beta.models.approval_identity.Approval Identity(
|
||||
id = '85d173e7d57e496569df763231d6deb6a',
|
||||
type = 'IDENTITY',
|
||||
name = 'John Doe', )
|
||||
],
|
||||
completed_date='2023-04-12T23:20:50.52Z',
|
||||
approval_criteria='SINGLE',
|
||||
status='PENDING',
|
||||
additional_attributes='{ "llm_description": "generated description" }',
|
||||
reference_data=[
|
||||
sailpoint.beta.models.approval_reference.Approval Reference(
|
||||
id = '64012350-8fd9-4f6c-a170-1fe123683899',
|
||||
type = 'AccessRequestId', )
|
||||
]
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,36 +0,0 @@
|
||||
---
|
||||
id: beta-approval-batch
|
||||
title: ApprovalBatch
|
||||
pagination_label: ApprovalBatch
|
||||
sidebar_label: ApprovalBatch
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ApprovalBatch', 'BetaApprovalBatch']
|
||||
slug: /tools/sdk/python/beta/models/approval-batch
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalBatch', 'BetaApprovalBatch']
|
||||
---
|
||||
|
||||
# ApprovalBatch
|
||||
|
||||
Batch properties if an approval is sent via batching.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**batch_id** | **str** | ID of the batch | [optional]
|
||||
**batch_size** | **int** | How many approvals are going to be in this batch. Defaults to 1 if not provided. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.beta.models.approval_batch import ApprovalBatch
|
||||
|
||||
approval_batch = ApprovalBatch(
|
||||
batch_id='38453251-6be2-5f8f-df93-5ce19e295837',
|
||||
batch_size=100
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
id: beta-approval-comment
|
||||
title: ApprovalComment
|
||||
pagination_label: ApprovalComment
|
||||
sidebar_label: ApprovalComment
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ApprovalComment', 'BetaApprovalComment']
|
||||
slug: /tools/sdk/python/beta/models/approval-comment
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalComment', 'BetaApprovalComment']
|
||||
---
|
||||
|
||||
# ApprovalComment
|
||||
|
||||
Comments Object
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**author** | [**ApprovalIdentity**](approval-identity) | | [optional]
|
||||
**comment** | **str** | Comment to be left on an approval | [optional]
|
||||
**created_date** | **str** | Date the comment was created | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.beta.models.approval_comment import ApprovalComment
|
||||
|
||||
approval_comment = ApprovalComment(
|
||||
author=sailpoint.beta.models.approval_identity.Approval Identity(
|
||||
id = '85d173e7d57e496569df763231d6deb6a',
|
||||
type = 'IDENTITY',
|
||||
name = 'John Doe', ),
|
||||
comment='Looks good',
|
||||
created_date='2023-04-12T23:20:50.52Z'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,36 +0,0 @@
|
||||
---
|
||||
id: beta-approval-description
|
||||
title: ApprovalDescription
|
||||
pagination_label: ApprovalDescription
|
||||
sidebar_label: ApprovalDescription
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ApprovalDescription', 'BetaApprovalDescription']
|
||||
slug: /tools/sdk/python/beta/models/approval-description
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalDescription', 'BetaApprovalDescription']
|
||||
---
|
||||
|
||||
# ApprovalDescription
|
||||
|
||||
The description of what the approval is asking for
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**value** | **str** | The description of what the approval is asking for | [optional]
|
||||
**locale** | **str** | What locale the description of the approval is using | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.beta.models.approval_description import ApprovalDescription
|
||||
|
||||
approval_description = ApprovalDescription(
|
||||
value='This access allows viewing and editing of workflow resource',
|
||||
locale='en_US'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,38 +0,0 @@
|
||||
---
|
||||
id: beta-approval-identity
|
||||
title: ApprovalIdentity
|
||||
pagination_label: ApprovalIdentity
|
||||
sidebar_label: ApprovalIdentity
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ApprovalIdentity', 'BetaApprovalIdentity']
|
||||
slug: /tools/sdk/python/beta/models/approval-identity
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalIdentity', 'BetaApprovalIdentity']
|
||||
---
|
||||
|
||||
# ApprovalIdentity
|
||||
|
||||
Identity Object
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | The identity ID | [optional]
|
||||
**type** | **Enum** [ 'IDENTITY' ] | Indication of what group the identity belongs to. Ie, IDENTITY, GOVERNANCE_GROUP, etc | [optional]
|
||||
**name** | **str** | Name of the identity | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.beta.models.approval_identity import ApprovalIdentity
|
||||
|
||||
approval_identity = ApprovalIdentity(
|
||||
id='85d173e7d57e496569df763231d6deb6a',
|
||||
type='IDENTITY',
|
||||
name='John Doe'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,36 +0,0 @@
|
||||
---
|
||||
id: beta-approval-name
|
||||
title: ApprovalName
|
||||
pagination_label: ApprovalName
|
||||
sidebar_label: ApprovalName
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ApprovalName', 'BetaApprovalName']
|
||||
slug: /tools/sdk/python/beta/models/approval-name
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalName', 'BetaApprovalName']
|
||||
---
|
||||
|
||||
# ApprovalName
|
||||
|
||||
Approval Name Object
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**value** | **str** | Name of the approval | [optional]
|
||||
**locale** | **str** | What locale the name of the approval is using | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.beta.models.approval_name import ApprovalName
|
||||
|
||||
approval_name = ApprovalName(
|
||||
value='Audit DB Access',
|
||||
locale='en_US'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,36 +0,0 @@
|
||||
---
|
||||
id: beta-approval-reference
|
||||
title: ApprovalReference
|
||||
pagination_label: ApprovalReference
|
||||
sidebar_label: ApprovalReference
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ApprovalReference', 'BetaApprovalReference']
|
||||
slug: /tools/sdk/python/beta/models/approval-reference
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalReference', 'BetaApprovalReference']
|
||||
---
|
||||
|
||||
# ApprovalReference
|
||||
|
||||
Reference objects related to the approval
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | Id of the reference object | [optional]
|
||||
**type** | **str** | What reference object does this ID correspond to | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.beta.models.approval_reference import ApprovalReference
|
||||
|
||||
approval_reference = ApprovalReference(
|
||||
id='64012350-8fd9-4f6c-a170-1fe123683899',
|
||||
type='AccessRequestId'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
Reference in New Issue
Block a user