starting point for adding python sdk docs

This commit is contained in:
darrell-thobe-sp
2025-02-20 12:59:19 -05:00
parent 3b9e39ca19
commit c18583ede4
2726 changed files with 370294 additions and 5 deletions

View File

@@ -0,0 +1,58 @@
---
id: beta-resource-object
title: ResourceObject
pagination_label: ResourceObject
sidebar_label: ResourceObject
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ResourceObject', 'BetaResourceObject']
slug: /tools/sdk/python/beta/models/resource-object
tags: ['SDK', 'Software Development Kit', 'ResourceObject', 'BetaResourceObject']
---
# ResourceObject
Representation of the object which is returned from source connectors.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**instance** | **str** | Identifier of the specific instance where this object resides. | [optional] [readonly]
**identity** | **str** | Native identity of the object in the Source. | [optional] [readonly]
**uuid** | **str** | Universal unique identifier of the object in the Source. | [optional] [readonly]
**previous_identity** | **str** | Native identity that the object has previously. | [optional] [readonly]
**name** | **str** | Display name for this object. | [optional] [readonly]
**object_type** | **str** | Type of object. | [optional] [readonly]
**incomplete** | **bool** | A flag indicating that this is an incomplete object. Used in special cases where the connector has to return account information in several phases and the objects might not have a complete set of all account attributes. The attributes in this object will replace the corresponding attributes in the Link, but no other Link attributes will be changed. | [optional] [readonly]
**incremental** | **bool** | A flag indicating that this is an incremental change object. This is similar to incomplete but it also means that the values of any multi-valued attributes in this object should be merged with the existing values in the Link rather than replacing the existing Link value. | [optional] [readonly]
**delete** | **bool** | A flag indicating that this object has been deleted. This is set only when doing delta aggregation and the connector supports detection of native deletes. | [optional] [readonly]
**remove** | **bool** | A flag set indicating that the values in the attributes represent things to remove rather than things to add. Setting this implies incremental. The values which are always for multi-valued attributes are removed from the current values. | [optional] [readonly]
**missing** | **[]str** | A list of attribute names that are not included in this object. This is only used with SMConnector and will only contain \"groups\". | [optional] [readonly]
**attributes** | **object** | Attributes of this ResourceObject. | [optional] [readonly]
**final_update** | **bool** | In Aggregation, for sparse object the count for total accounts scanned identities updated is not incremented. | [optional] [readonly]
}
## Example
```python
from sailpoint.beta.models.resource_object import ResourceObject
resource_object = ResourceObject(
instance='',
identity='CN=Aaron Carr,OU=test1,DC=test2,DC=test',
uuid='{abf7bd9b-68b4-4d21-9b70-870c58ebf844}',
previous_identity='',
name='Aaron Carr',
object_type='account',
incomplete=False,
incremental=False,
delete=False,
remove=False,
missing=[missFieldOne, missFieldTwo],
attributes={telephoneNumber=12-(345)678-9012, mail=example@test.com, displayName=Aaron Carr},
final_update=False
)
```
[[Back to top]](#)