adding v3 docs back in

This commit is contained in:
darrell-thobe-sp
2025-01-23 20:41:57 -05:00
parent f36c734ca4
commit 7194b934e8
658 changed files with 47533 additions and 0 deletions

View File

@@ -0,0 +1,89 @@
---
id: account
title: Account
pagination_label: Account
sidebar_label: Account
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'Account']
slug: /tools/sdk/powershell/v3/models/account
tags: ['SDK', 'Software Development Kit', 'Account']
---
# Account
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | System-generated unique ID of the Object | [optional] [readonly]
**Name** | **String** | Name of the Object | [required]
**Created** | Pointer to **System.DateTime** | Creation date of the Object | [optional] [readonly]
**Modified** | Pointer to **System.DateTime** | Last modification date of the Object | [optional] [readonly]
**SourceId** | **String** | The unique ID of the source this account belongs to | [required]
**SourceName** | **String** | The display name of the source this account belongs to | [required]
**IdentityId** | Pointer to **String** | The unique ID of the identity this account is correlated to | [optional]
**CloudLifecycleState** | Pointer to **String** | The lifecycle state of the identity this account is correlated to | [optional]
**IdentityState** | Pointer to **String** | The identity state of the identity this account is correlated to | [optional]
**ConnectionType** | Pointer to **String** | The connection type of the source this account is from | [optional]
**IsMachine** | Pointer to **Boolean** | Indicates if the account is of machine type | [optional] [default to $false]
**Recommendation** | Pointer to [**Recommendation**](recommendation) | | [optional]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The account attributes that are aggregated | [required]
**Authoritative** | **Boolean** | Indicates if this account is from an authoritative source | [required]
**Description** | Pointer to **String** | A description of the account | [optional]
**Disabled** | **Boolean** | Indicates if the account is currently disabled | [required]
**Locked** | **Boolean** | Indicates if the account is currently locked | [required]
**NativeIdentity** | **String** | The unique ID of the account generated by the source system | [required]
**SystemAccount** | **Boolean** | If true, this is a user account within IdentityNow. If false, this is an account from a source system. | [required]
**Uncorrelated** | **Boolean** | Indicates if this account is not correlated to an identity | [required]
**Uuid** | Pointer to **String** | The unique ID of the account as determined by the account schema | [optional]
**ManuallyCorrelated** | **Boolean** | Indicates if the account has been manually correlated to an identity | [required]
**HasEntitlements** | **Boolean** | Indicates if the account has entitlements | [required]
**Identity** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional]
**SourceOwner** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional]
**Features** | Pointer to **String** | A string list containing the owning source's features | [optional]
**Origin** | Pointer to **Enum** [ "AGGREGATED", "PROVISIONED" ] | The origin of the account either aggregated or provisioned | [optional]
**OwnerIdentity** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional]
## Examples
- Prepare the resource
```powershell
$Account = Initialize-PSSailpoint.V3Account -Id id12345 `
-Name aName `
-Created 2015-05-28T14:07:17Z `
-Modified 2015-05-28T14:07:17Z `
-SourceId 2c9180835d2e5168015d32f890ca1581 `
-SourceName Employees `
-IdentityId 2c9180835d2e5168015d32f890ca1581 `
-CloudLifecycleState active `
-IdentityState ACTIVE `
-ConnectionType direct `
-IsMachine true `
-Recommendation null `
-Attributes {firstName=SailPoint, lastName=Support, displayName=SailPoint Support} `
-Authoritative false `
-Description null `
-Disabled false `
-Locked false `
-NativeIdentity 552775 `
-SystemAccount false `
-Uncorrelated false `
-Uuid {b0dce506-d6d4-44d2-8a32-d9a5b21fb175} `
-ManuallyCorrelated false `
-HasEntitlements true `
-Identity null `
-SourceOwner null `
-Features ENABLE `
-Origin AGGREGATED `
-OwnerIdentity null
```
- Convert the resource to JSON
```powershell
$Account | ConvertTo-JSON
```
[[Back to top]](#)