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

starting point for adding python sdk docs

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

98
docs/tools/sdk/python/Reference/Beta/Models/Account.md Normal file
View File

@@ -0,0 +1,98 @@
---
id: beta-account
title: Account
pagination_label: Account
sidebar_label: Account
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'Account', 'BetaAccount']
slug: /tools/sdk/python/beta/models/account
tags: ['SDK', 'Software Development Kit', 'Account', 'BetaAccount']
---
# Account
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | System-generated unique ID of the Object | [optional] [readonly]
**name** | **str** | Name of the Object | [required]
**created** | **datetime** | Creation date of the Object | [optional] [readonly]
**modified** | **datetime** | Last modification date of the Object | [optional] [readonly]
**source_id** | **str** | The unique ID of the source this account belongs to | [required]
**source_name** | **str** | The display name of the source this account belongs to | [required]
**identity_id** | **str** | The unique ID of the identity this account is correlated to | [optional]
**cloud_lifecycle_state** | **str** | The lifecycle state of the identity this account is correlated to | [optional]
**identity_state** | **str** | The identity state of the identity this account is correlated to | [optional]
**connection_type** | **str** | The connection type of the source this account is from | [optional]
**is_machine** | **bool** | Indicates if the account is of machine type | [optional] [default to False]
**recommendation** | [**Recommendation**](recommendation) | | [optional]
**attributes** | **map[string]object** | The account attributes that are aggregated | [required]
**authoritative** | **bool** | Indicates if this account is from an authoritative source | [required]
**description** | **str** | A description of the account | [optional]
**disabled** | **bool** | Indicates if the account is currently disabled | [required]
**locked** | **bool** | Indicates if the account is currently locked | [required]
**native_identity** | **str** | The unique ID of the account generated by the source system | [required]
**system_account** | **bool** | If true, this is a user account within IdentityNow. If false, this is an account from a source system. | [required]
**uncorrelated** | **bool** | Indicates if this account is not correlated to an identity | [required]
**uuid** | **str** | The unique ID of the account as determined by the account schema | [optional]
**manually_correlated** | **bool** | Indicates if the account has been manually correlated to an identity | [required]
**has_entitlements** | **bool** | Indicates if the account has entitlements | [required]
**identity** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
**source_owner** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
**features** | **str** | A string list containing the owning source's features | [optional]
**origin** | **Enum** [ 'AGGREGATED', 'PROVISIONED' ] | The origin of the account either aggregated or provisioned | [optional]
**owner_identity** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
}
## Example
```python
from sailpoint.beta.models.account import Account
account = Account(
id='id12345',
name='aName',
created='2023-01-03T21:16:22.432Z',
modified='2023-01-03T21:16:22.432Z',
source_id='2c9180835d2e5168015d32f890ca1581',
source_name='Employees',
identity_id='2c9180835d2e5168015d32f890ca1581',
cloud_lifecycle_state='active',
identity_state='ACTIVE',
connection_type='direct',
is_machine=True,
recommendation=sailpoint.beta.models.recommendation.Recommendation(
type = 'MACHINE',
method = 'DISCOVERY', ),
attributes={firstName=SailPoint, lastName=Support, displayName=SailPoint Support},
authoritative=False,
description='',
disabled=False,
locked=False,
native_identity='552775',
system_account=False,
uncorrelated=False,
uuid='{b0dce506-d6d4-44d2-8a32-d9a5b21fb175}',
manually_correlated=False,
has_entitlements=True,
identity=sailpoint.beta.models.base_reference_dto.BaseReferenceDto(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'William Wilson', ),
source_owner=sailpoint.beta.models.base_reference_dto.BaseReferenceDto(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'William Wilson', ),
features='ENABLE',
origin='AGGREGATED',
owner_identity=sailpoint.beta.models.base_reference_dto.BaseReferenceDto(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'William Wilson', )
)
```
[[Back to top]](#)