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

Update to python SDK docs: 14623604263

Browse Source
This commit is contained in:
developer-relations-sp
2025-04-23 16:48:54 +00:00
parent 1baa42b58a
commit e25d7361eb
46 changed files with 7462 additions and 7442 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/tools/sdk/python/Reference/Beta/Models/AccessProfile.md
View File

@@ -11,25 +11,25 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'BetaAccessProfile']
# AccessProfile
Access Profile
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 False]
**id** | **str** | Access profile ID. | [optional] [readonly]
**name** | **str** | Access profile name. | [required]
**description** | **str** | Access profile description. | [optional]
**created** | **datetime** | Date and time when the access profile was created. | [optional] [readonly]
**modified** | **datetime** | Date and time when the access profile was last modified. | [optional] [readonly]
**enabled** | **bool** | Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. | [optional] [default to False]
**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]
**entitlements** | [**[]EntitlementRef**](entitlement-ref) | List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. | [optional]
**requestable** | **bool** | Indicates whether the access profile is requestable by 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]
**segments** | **[]str** | List of segment IDs, if any, that the access profile is assigned to. | [optional]
**provisioning_criteria** | [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional]
}
@@ -63,6 +63,7 @@ requestable=True,
access_request_config=sailpoint.beta.models.requestability.Requestability(
comments_required = True,
denial_comments_required = True,
reauthorization_required = True,
approval_schemes = [
sailpoint.beta.models.access_profile_approval_scheme.AccessProfileApprovalScheme(
approver_type = 'GOVERNANCE_GROUP',

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

@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'BetaAc
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]
**approver_type** | **Enum** [ 'APP_OWNER', 'OWNER', 'SOURCE_OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | Describes the individual or group that is responsible for an approval step. These are the possible values: **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** | Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. | [optional]
}
## Example

6
docs/tools/sdk/python/Reference/Beta/Models/AccessProfileSourceRef.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'BetaAccessP
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]
**id** | **str** | ID of the source the access profile is associated with. | [optional]
**type** | **Enum** [ 'SOURCE' ] | Source's DTO type. | [optional]
**name** | **str** | Source name. | [optional]
}
## Example

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

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

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

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

6
docs/tools/sdk/python/Reference/Beta/Models/OwnerReference.md
View File

@@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'BetaOwnerReference'
# OwnerReference
The owner of this object.
Owner of the object.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional]
**id** | **str** | Identity id | [optional]
**name** | **str** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional]
**id** | **str** | Owner's identity ID. | [optional]
**name** | **str** | Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional]
}
## Example

8
docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel1.md
View File

@@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'BetaPro
# ProvisioningCriteriaLevel1
Defines matching criteria for an Account to be provisioned with a specific Access Profile
Defines matching criteria for an account to be provisioned with a specific access profile.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional]
**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional]
**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional]
**children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional]
**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional]
**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional]
**children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional]
}
## Example

8
docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel2.md
View File

@@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'BetaPro
# ProvisioningCriteriaLevel2
Defines matching criteria for an Account to be provisioned with a specific Access Profile
Defines matching criteria for an account to be provisioned with a specific access profile.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional]
**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional]
**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional]
**children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional]
**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional]
**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional]
**children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional]
}
## Example

8
docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel3.md
View File

@@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'BetaPro
# ProvisioningCriteriaLevel3
Defines matching criteria for an Account to be provisioned with a specific Access Profile
Defines matching criteria for an account to be provisioned with a specific access profile.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional]
**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional]
**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional]
**children** | **str** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional]
**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional]
**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional]
**children** | **str** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional]
}
## Example

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

@@ -11,7 +11,7 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaOperation', 'Beta
# ProvisioningCriteriaOperation
Supported operations on ProvisioningCriteria
Supported operations on `ProvisioningCriteria`.
## Enum

8
docs/tools/sdk/python/Reference/Beta/Models/Requestability.md
View File

@@ -16,9 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'Requestability', 'BetaRequestability'
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False]
**denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False]
**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional]
**comments_required** | **bool** | Indicates whether the requester of the containing object must provide comments justifying the request. | [optional] [default to False]
**denial_comments_required** | **bool** | Indicates whether an approver must provide comments when denying the request. | [optional] [default to False]
**reauthorization_required** | **bool** | Indicates whether reauthorization is required for the request. | [optional] [default to False]
**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the request. | [optional]
}
## Example
@@ -29,6 +30,7 @@ from sailpoint.beta.models.requestability import Requestability
requestability = Requestability(
comments_required=True,
denial_comments_required=True,
reauthorization_required=True,
approval_schemes=[
sailpoint.beta.models.access_profile_approval_scheme.AccessProfileApprovalScheme(
approver_type = 'GOVERNANCE_GROUP',

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

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False]
**denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False]
**reauthorization_required** | **bool** | Indicates whether reauthorization is required for the request. | [optional] [default to False]
**approval_schemes** | [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional]
}
@@ -29,6 +30,7 @@ from sailpoint.beta.models.requestability_for_role import RequestabilityForRole
requestability_for_role = RequestabilityForRole(
comments_required=True,
denial_comments_required=True,
reauthorization_required=True,
approval_schemes=[
sailpoint.beta.models.approval_scheme_for_role.ApprovalSchemeForRole(
approver_type = 'GOVERNANCE_GROUP',

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

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'Revocability', 'BetaRevocability']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional]
**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the revocation request. | [optional]
}
## Example

1
docs/tools/sdk/python/Reference/Beta/Models/Role.md
View File

@@ -89,6 +89,7 @@ requestable=True,
access_request_config=sailpoint.beta.models.requestability_for_role.RequestabilityForRole(
comments_required = True,
denial_comments_required = True,
reauthorization_required = True,
approval_schemes = [
sailpoint.beta.models.approval_scheme_for_role.ApprovalSchemeForRole(
approver_type = 'GOVERNANCE_GROUP',

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

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