mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 04:19:34 +00:00
Update to powershell SDK docs: 13685764589
This commit is contained in:
developer-relations-sp
@@ -16,6 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'RequestedItemStatus', 'BetaRequestedI
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | The ID of the access request. | [optional]
|
||||
**Name** | **String** | Human-readable display name of the item being requested. | [optional]
|
||||
**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | Type of requested object. | [optional]
|
||||
**CancelledRequestDetails** | [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional]
|
||||
@@ -45,7 +46,8 @@ Name | Type | Description | Notes
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$RequestedItemStatus = Initialize-PSSailpoint.BetaRequestedItemStatus -Name AccessProfile1 `
|
||||
$RequestedItemStatus = Initialize-PSSailpoint.BetaRequestedItemStatus -Id 2c9180926cbfbddd016cbfc7c3b10010 `
|
||||
-Name AccessProfile1 `
|
||||
-Type ACCESS_PROFILE `
|
||||
-CancelledRequestDetails null `
|
||||
-ErrorMessages null `
|
||||
|
||||
@@ -605,12 +605,12 @@ Path | Id | **String** | True | The account id
|
||||
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
|
||||
### Return type
|
||||
[**EntitlementDto[]**](../models/entitlement-dto)
|
||||
[**Entitlement[]**](../models/entitlement)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | An array of account entitlements | EntitlementDto[]
|
||||
200 | An array of account entitlements | Entitlement[]
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
|
||||
@@ -666,12 +666,12 @@ Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
|
||||
### Return type
|
||||
[**DeployResponse[]**](../models/deploy-response)
|
||||
[**ListDeploys200Response**](../models/list-deploys200-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | List of existing deploys. | DeployResponse[]
|
||||
200 | List of existing deploys. | ListDeploys200Response
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
id: v2024-access-model-metadata
|
||||
title: AccessModelMetadata
|
||||
pagination_label: AccessModelMetadata
|
||||
sidebar_label: AccessModelMetadata
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessModelMetadata', 'V2024AccessModelMetadata']
|
||||
slug: /tools/sdk/powershell/v2024/models/access-model-metadata
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessModelMetadata', 'V2024AccessModelMetadata']
|
||||
---
|
||||
|
||||
|
||||
# AccessModelMetadata
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Key** | **String** | Unique identifier for the metadata type | [optional]
|
||||
**Name** | **String** | Human readable name of the metadata type | [optional]
|
||||
**Multiselect** | **Boolean** | Allows selecting multiple values | [optional] [default to $false]
|
||||
**Status** | **String** | The state of the metadata item | [optional]
|
||||
**Type** | **String** | The type of the metadata item | [optional]
|
||||
**ObjectTypes** | **[]String** | The types of objects | [optional]
|
||||
**Description** | **String** | Describes the metadata item | [optional]
|
||||
**Values** | [**[]AccessModelMetadataValuesInner**](access-model-metadata-values-inner) | The value to assign to the metadata item | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccessModelMetadata = Initialize-PSSailpoint.V2024AccessModelMetadata -Key iscCsp `
|
||||
-Name CSP `
|
||||
-Multiselect true `
|
||||
-Status active `
|
||||
-Type governance `
|
||||
-ObjectTypes null `
|
||||
-Description Indicates the type of deployment environment of an access item. `
|
||||
-Values null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AccessModelMetadata | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2024-access-model-metadata-values-inner
|
||||
title: AccessModelMetadataValuesInner
|
||||
pagination_label: AccessModelMetadataValuesInner
|
||||
sidebar_label: AccessModelMetadataValuesInner
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessModelMetadataValuesInner', 'V2024AccessModelMetadataValuesInner']
|
||||
slug: /tools/sdk/powershell/v2024/models/access-model-metadata-values-inner
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessModelMetadataValuesInner', 'V2024AccessModelMetadataValuesInner']
|
||||
---
|
||||
|
||||
|
||||
# AccessModelMetadataValuesInner
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Value** | **String** | The value to assign to the metdata item | [optional]
|
||||
**Name** | **String** | Display name of the value | [optional]
|
||||
**Status** | **String** | The status of the individual value | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccessModelMetadataValuesInner = Initialize-PSSailpoint.V2024AccessModelMetadataValuesInner -Value development `
|
||||
-Name Development `
|
||||
-Status active
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AccessModelMetadataValuesInner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -16,6 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestAdminItemStatus', 'V2024
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | ID of the access request | [optional]
|
||||
**Name** | **String** | Human-readable display name of the item being requested. | [optional]
|
||||
**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | Type of requested object. | [optional]
|
||||
**CancelledRequestDetails** | [**AccessRequestAdminItemStatusCancelledRequestDetails**](access-request-admin-item-status-cancelled-request-details) | | [optional]
|
||||
@@ -45,7 +46,8 @@ Name | Type | Description | Notes
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccessRequestAdminItemStatus = Initialize-PSSailpoint.V2024AccessRequestAdminItemStatus -Name AccessProfile1 `
|
||||
$AccessRequestAdminItemStatus = Initialize-PSSailpoint.V2024AccessRequestAdminItemStatus -Id 2c9180926cbfbddd016cbfc7c3b10010 `
|
||||
-Name AccessProfile1 `
|
||||
-Type ACCESS_PROFILE `
|
||||
-CancelledRequestDetails null `
|
||||
-ErrorMessages null `
|
||||
|
||||
@@ -27,7 +27,7 @@ Name | Type | Description | Notes
|
||||
**IdentityState** | **String** | The identity state of the identity this account is correlated to | [optional]
|
||||
**ConnectionType** | **String** | The connection type of the source this account is from | [optional]
|
||||
**IsMachine** | **Boolean** | Indicates if the account is of machine type | [optional] [default to $false]
|
||||
**Recommendation** | [**Recommendation**](recommendation) | | [optional]
|
||||
**Recommendation** | [**AccountAllOfRecommendation**](account-all-of-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** | **String** | A description of the account | [optional]
|
||||
@@ -39,11 +39,11 @@ Name | Type | Description | Notes
|
||||
**Uuid** | **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** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
|
||||
**SourceOwner** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
|
||||
**Identity** | [**AccountAllOfIdentity**](account-all-of-identity) | | [optional]
|
||||
**SourceOwner** | [**AccountAllOfSourceOwner**](account-all-of-source-owner) | | [optional]
|
||||
**Features** | **String** | A string list containing the owning source's features | [optional]
|
||||
**Origin** | **Enum** [ "AGGREGATED", "PROVISIONED" ] | The origin of the account either aggregated or provisioned | [optional]
|
||||
**OwnerIdentity** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
|
||||
**OwnerIdentity** | [**AccountAllOfOwnerIdentity**](account-all-of-owner-identity) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2024-account-all-of-identity
|
||||
title: AccountAllOfIdentity
|
||||
pagination_label: AccountAllOfIdentity
|
||||
sidebar_label: AccountAllOfIdentity
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAllOfIdentity', 'V2024AccountAllOfIdentity']
|
||||
slug: /tools/sdk/powershell/v2024/models/account-all-of-identity
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountAllOfIdentity', 'V2024AccountAllOfIdentity']
|
||||
---
|
||||
|
||||
|
||||
# AccountAllOfIdentity
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | The ID of the identity | [optional]
|
||||
**Type** | **Enum** [ "IDENTITY" ] | The type of object being referenced | [optional]
|
||||
**Name** | **String** | display name of identity | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccountAllOfIdentity = Initialize-PSSailpoint.V2024AccountAllOfIdentity -Id 2c918084660f45d6016617daa9210584 `
|
||||
-Type IDENTITY `
|
||||
-Name John Doe
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AccountAllOfIdentity | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2024-account-all-of-owner-identity
|
||||
title: AccountAllOfOwnerIdentity
|
||||
pagination_label: AccountAllOfOwnerIdentity
|
||||
sidebar_label: AccountAllOfOwnerIdentity
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAllOfOwnerIdentity', 'V2024AccountAllOfOwnerIdentity']
|
||||
slug: /tools/sdk/powershell/v2024/models/account-all-of-owner-identity
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountAllOfOwnerIdentity', 'V2024AccountAllOfOwnerIdentity']
|
||||
---
|
||||
|
||||
|
||||
# AccountAllOfOwnerIdentity
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | [**DtoType**](dto-type) | | [optional]
|
||||
**Id** | **String** | ID of the object to which this reference applies | [optional]
|
||||
**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccountAllOfOwnerIdentity = Initialize-PSSailpoint.V2024AccountAllOfOwnerIdentity -Type null `
|
||||
-Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name William Wilson
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AccountAllOfOwnerIdentity | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2024-account-all-of-recommendation
|
||||
title: AccountAllOfRecommendation
|
||||
pagination_label: AccountAllOfRecommendation
|
||||
sidebar_label: AccountAllOfRecommendation
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAllOfRecommendation', 'V2024AccountAllOfRecommendation']
|
||||
slug: /tools/sdk/powershell/v2024/models/account-all-of-recommendation
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountAllOfRecommendation', 'V2024AccountAllOfRecommendation']
|
||||
---
|
||||
|
||||
|
||||
# AccountAllOfRecommendation
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **Enum** [ "HUMAN", "MACHINE" ] | Recommended type of account. | [required]
|
||||
**Method** | **Enum** [ "DISCOVERY", "SOURCE", "CRITERIA" ] | Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccountAllOfRecommendation = Initialize-PSSailpoint.V2024AccountAllOfRecommendation -Type MACHINE `
|
||||
-Method DISCOVERY
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AccountAllOfRecommendation | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2024-account-all-of-source-owner
|
||||
title: AccountAllOfSourceOwner
|
||||
pagination_label: AccountAllOfSourceOwner
|
||||
sidebar_label: AccountAllOfSourceOwner
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAllOfSourceOwner', 'V2024AccountAllOfSourceOwner']
|
||||
slug: /tools/sdk/powershell/v2024/models/account-all-of-source-owner
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountAllOfSourceOwner', 'V2024AccountAllOfSourceOwner']
|
||||
---
|
||||
|
||||
|
||||
# AccountAllOfSourceOwner
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | The ID of the identity | [optional]
|
||||
**Type** | **Enum** [ "IDENTITY" ] | The type of object being referenced | [optional]
|
||||
**Name** | **String** | display name of identity | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccountAllOfSourceOwner = Initialize-PSSailpoint.V2024AccountAllOfSourceOwner -Id 2c918084660f45d6016617daa9210584 `
|
||||
-Type IDENTITY `
|
||||
-Name Adam Kennedy
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AccountAllOfSourceOwner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -29,9 +29,10 @@ Name | Type | Description | Notes
|
||||
**Lastname** | **String** | Auth user's last name. | [optional]
|
||||
**DisplayName** | **String** | Auth user's name in displayed format. | [optional]
|
||||
**Alias** | **String** | Auth user's alias. | [optional]
|
||||
**LastPasswordChangeDate** | **String** | Date of last password change. | [optional]
|
||||
**LastPasswordChangeDate** | **System.DateTime** | Date of last password change. | [optional]
|
||||
**LastLoginTimestamp** | **Int64** | Timestamp of the last login (long type value). | [optional]
|
||||
**CurrentLoginTimestamp** | **Int64** | Timestamp of the current login (long type value). | [optional]
|
||||
**LastUnlockTimestamp** | **System.DateTime** | The date and time when the user was last unlocked. | [optional]
|
||||
**Capabilities** | **[]String** | Array of the auth user's capabilities. | [optional]
|
||||
|
||||
## Examples
|
||||
@@ -54,6 +55,7 @@ $AuthUser = Initialize-PSSailpoint.V2024AuthUser -Tenant test-tenant `
|
||||
-LastPasswordChangeDate 2021-03-08T22:37:33.901Z `
|
||||
-LastLoginTimestamp 1656327185832 `
|
||||
-CurrentLoginTimestamp 1656327185832 `
|
||||
-LastUnlockTimestamp 2021-03-08T22:37:33.901Z `
|
||||
-Capabilities null
|
||||
```
|
||||
|
||||
|
||||
@@ -24,6 +24,10 @@ Name | Type | Description | Notes
|
||||
**Description** | **String** | The description of the entitlement | [optional]
|
||||
**Privileged** | **Boolean** | True if the entitlement is privileged | [optional]
|
||||
**CloudGoverned** | **Boolean** | True if the entitlement is cloud governed | [optional]
|
||||
**Requestable** | **Boolean** | True if the entitlement is able to be directly requested | [optional] [default to $false]
|
||||
**Owner** | [**EntitlementOwner**](entitlement-owner) | | [optional]
|
||||
**ManuallyUpdatedFields** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. | [optional]
|
||||
**AccessModelMetadata** | [**EntitlementAccessModelMetadata**](entitlement-access-model-metadata) | | [optional]
|
||||
**Created** | **System.DateTime** | Time when the entitlement was created | [optional]
|
||||
**Modified** | **System.DateTime** | Time when the entitlement was last modified | [optional]
|
||||
**Source** | [**EntitlementSource**](entitlement-source) | | [optional]
|
||||
@@ -43,6 +47,10 @@ $Entitlement = Initialize-PSSailpoint.V2024Entitlement -Id 2c91808874ff91550175
|
||||
-Description CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local `
|
||||
-Privileged true `
|
||||
-CloudGoverned true `
|
||||
-Requestable true `
|
||||
-Owner null `
|
||||
-ManuallyUpdatedFields {DISPLAY_NAME=true, DESCRIPTION=true} `
|
||||
-AccessModelMetadata null `
|
||||
-Created 2020-10-08T18:33:52.029Z `
|
||||
-Modified 2020-10-08T18:33:52.029Z `
|
||||
-Source null `
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: v2024-entitlement-access-model-metadata
|
||||
title: EntitlementAccessModelMetadata
|
||||
pagination_label: EntitlementAccessModelMetadata
|
||||
sidebar_label: EntitlementAccessModelMetadata
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementAccessModelMetadata', 'V2024EntitlementAccessModelMetadata']
|
||||
slug: /tools/sdk/powershell/v2024/models/entitlement-access-model-metadata
|
||||
tags: ['SDK', 'Software Development Kit', 'EntitlementAccessModelMetadata', 'V2024EntitlementAccessModelMetadata']
|
||||
---
|
||||
|
||||
|
||||
# EntitlementAccessModelMetadata
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Attributes** | [**[]AccessModelMetadata**](access-model-metadata) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$EntitlementAccessModelMetadata = Initialize-PSSailpoint.V2024EntitlementAccessModelMetadata -Attributes null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$EntitlementAccessModelMetadata | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,57 +0,0 @@
|
||||
---
|
||||
id: v2024-entitlement-dto
|
||||
title: EntitlementDto
|
||||
pagination_label: EntitlementDto
|
||||
sidebar_label: EntitlementDto
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementDto', 'V2024EntitlementDto']
|
||||
slug: /tools/sdk/powershell/v2024/models/entitlement-dto
|
||||
tags: ['SDK', 'Software Development Kit', 'EntitlementDto', 'V2024EntitlementDto']
|
||||
---
|
||||
|
||||
|
||||
# EntitlementDto
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | System-generated unique ID of the Object | [optional] [readonly]
|
||||
**Name** | **String** | Name of the Object | [required]
|
||||
**Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly]
|
||||
**Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly]
|
||||
**Attribute** | **String** | Name of the entitlement attribute | [optional]
|
||||
**Value** | **String** | Raw value of the entitlement | [optional]
|
||||
**Description** | **String** | Entitlment description | [optional]
|
||||
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Entitlement attributes | [optional]
|
||||
**SourceSchemaObjectType** | **String** | Schema objectType on the given application that maps to an Account Group | [optional]
|
||||
**Privileged** | **Boolean** | Determines if this Entitlement is privileged. | [optional]
|
||||
**CloudGoverned** | **Boolean** | Determines if this Entitlement is goverened in the cloud. | [optional]
|
||||
**Source** | [**EntitlementSource**](entitlement-source) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$EntitlementDto = Initialize-PSSailpoint.V2024EntitlementDto -Id id12345 `
|
||||
-Name aName `
|
||||
-Created 2015-05-28T14:07:17Z `
|
||||
-Modified 2015-05-28T14:07:17Z `
|
||||
-Attribute authorizationType `
|
||||
-Value CN=Users,dc=sailpoint,dc=com `
|
||||
-Description Active Directory DC `
|
||||
-Attributes {GroupType=Security, sAMAccountName=Buyer} `
|
||||
-SourceSchemaObjectType group `
|
||||
-Privileged false `
|
||||
-CloudGoverned false `
|
||||
-Source null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$EntitlementDto | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2024-entitlement-owner
|
||||
title: EntitlementOwner
|
||||
pagination_label: EntitlementOwner
|
||||
sidebar_label: EntitlementOwner
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementOwner', 'V2024EntitlementOwner']
|
||||
slug: /tools/sdk/powershell/v2024/models/entitlement-owner
|
||||
tags: ['SDK', 'Software Development Kit', 'EntitlementOwner', 'V2024EntitlementOwner']
|
||||
---
|
||||
|
||||
|
||||
# EntitlementOwner
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | The identity ID | [optional]
|
||||
**Type** | **Enum** [ "IDENTITY" ] | The type of object | [optional]
|
||||
**Name** | **String** | The display name of the identity | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$EntitlementOwner = Initialize-PSSailpoint.V2024EntitlementOwner -Id 2c9180827ca885d7017ca8ce28a000eb `
|
||||
-Type IDENTITY `
|
||||
-Name john.doe
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$EntitlementOwner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: v2024-list-deploys200-response
|
||||
title: ListDeploys200Response
|
||||
pagination_label: ListDeploys200Response
|
||||
sidebar_label: ListDeploys200Response
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ListDeploys200Response', 'V2024ListDeploys200Response']
|
||||
slug: /tools/sdk/powershell/v2024/models/list-deploys200-response
|
||||
tags: ['SDK', 'Software Development Kit', 'ListDeploys200Response', 'V2024ListDeploys200Response']
|
||||
---
|
||||
|
||||
|
||||
# ListDeploys200Response
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Items** | [**[]DeployResponse**](deploy-response) | list of deployments | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ListDeploys200Response = Initialize-PSSailpoint.V2024ListDeploys200Response -Items null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ListDeploys200Response | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -16,6 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'RequestedItemStatus', 'V2024Requested
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | The ID of the access request. | [optional]
|
||||
**Name** | **String** | Human-readable display name of the item being requested. | [optional]
|
||||
**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | Type of requested object. | [optional]
|
||||
**CancelledRequestDetails** | [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional]
|
||||
@@ -45,7 +46,8 @@ Name | Type | Description | Notes
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$RequestedItemStatus = Initialize-PSSailpoint.V2024RequestedItemStatus -Name AccessProfile1 `
|
||||
$RequestedItemStatus = Initialize-PSSailpoint.V2024RequestedItemStatus -Id 2c9180926cbfbddd016cbfc7c3b10010 `
|
||||
-Name AccessProfile1 `
|
||||
-Type ACCESS_PROFILE `
|
||||
-CancelledRequestDetails null `
|
||||
-ErrorMessages null `
|
||||
|
||||
@@ -336,12 +336,12 @@ Path | Id | **String** | True | The account id
|
||||
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
|
||||
### Return type
|
||||
[**EntitlementDto[]**](../models/entitlement-dto)
|
||||
[**Entitlement[]**](../models/entitlement)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | An array of account entitlements | EntitlementDto[]
|
||||
200 | An array of account entitlements | Entitlement[]
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
id: access-model-metadata
|
||||
title: AccessModelMetadata
|
||||
pagination_label: AccessModelMetadata
|
||||
sidebar_label: AccessModelMetadata
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessModelMetadata', 'AccessModelMetadata']
|
||||
slug: /tools/sdk/powershell/v3/models/access-model-metadata
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessModelMetadata', 'AccessModelMetadata']
|
||||
---
|
||||
|
||||
|
||||
# AccessModelMetadata
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Key** | **String** | Unique identifier for the metadata type | [optional]
|
||||
**Name** | **String** | Human readable name of the metadata type | [optional]
|
||||
**Multiselect** | **Boolean** | Allows selecting multiple values | [optional] [default to $false]
|
||||
**Status** | **String** | The state of the metadata item | [optional]
|
||||
**Type** | **String** | The type of the metadata item | [optional]
|
||||
**ObjectTypes** | **[]String** | The types of objects | [optional]
|
||||
**Description** | **String** | Describes the metadata item | [optional]
|
||||
**Values** | [**[]AccessModelMetadataValuesInner**](access-model-metadata-values-inner) | The value to assign to the metadata item | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccessModelMetadata = Initialize-PSSailpoint.V3AccessModelMetadata -Key iscCsp `
|
||||
-Name CSP `
|
||||
-Multiselect true `
|
||||
-Status active `
|
||||
-Type governance `
|
||||
-ObjectTypes null `
|
||||
-Description Indicates the type of deployment environment of an access item. `
|
||||
-Values null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AccessModelMetadata | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: access-model-metadata-values-inner
|
||||
title: AccessModelMetadataValuesInner
|
||||
pagination_label: AccessModelMetadataValuesInner
|
||||
sidebar_label: AccessModelMetadataValuesInner
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessModelMetadataValuesInner', 'AccessModelMetadataValuesInner']
|
||||
slug: /tools/sdk/powershell/v3/models/access-model-metadata-values-inner
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessModelMetadataValuesInner', 'AccessModelMetadataValuesInner']
|
||||
---
|
||||
|
||||
|
||||
# AccessModelMetadataValuesInner
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Value** | **String** | The value to assign to the metdata item | [optional]
|
||||
**Name** | **String** | Display name of the value | [optional]
|
||||
**Status** | **String** | The status of the individual value | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccessModelMetadataValuesInner = Initialize-PSSailpoint.V3AccessModelMetadataValuesInner -Value development `
|
||||
-Name Development `
|
||||
-Status active
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AccessModelMetadataValuesInner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -27,7 +27,7 @@ Name | Type | Description | Notes
|
||||
**IdentityState** | **String** | The identity state of the identity this account is correlated to | [optional]
|
||||
**ConnectionType** | **String** | The connection type of the source this account is from | [optional]
|
||||
**IsMachine** | **Boolean** | Indicates if the account is of machine type | [optional] [default to $false]
|
||||
**Recommendation** | [**Recommendation**](recommendation) | | [optional]
|
||||
**Recommendation** | [**AccountAllOfRecommendation**](account-all-of-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** | **String** | A description of the account | [optional]
|
||||
@@ -39,11 +39,11 @@ Name | Type | Description | Notes
|
||||
**Uuid** | **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** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
|
||||
**SourceOwner** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
|
||||
**Identity** | [**AccountAllOfIdentity**](account-all-of-identity) | | [optional]
|
||||
**SourceOwner** | [**AccountAllOfSourceOwner**](account-all-of-source-owner) | | [optional]
|
||||
**Features** | **String** | A string list containing the owning source's features | [optional]
|
||||
**Origin** | **Enum** [ "AGGREGATED", "PROVISIONED" ] | The origin of the account either aggregated or provisioned | [optional]
|
||||
**OwnerIdentity** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
|
||||
**OwnerIdentity** | [**AccountAllOfOwnerIdentity**](account-all-of-owner-identity) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: account-all-of-identity
|
||||
title: AccountAllOfIdentity
|
||||
pagination_label: AccountAllOfIdentity
|
||||
sidebar_label: AccountAllOfIdentity
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAllOfIdentity', 'AccountAllOfIdentity']
|
||||
slug: /tools/sdk/powershell/v3/models/account-all-of-identity
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountAllOfIdentity', 'AccountAllOfIdentity']
|
||||
---
|
||||
|
||||
|
||||
# AccountAllOfIdentity
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | The ID of the identity | [optional]
|
||||
**Type** | **Enum** [ "IDENTITY" ] | The type of object being referenced | [optional]
|
||||
**Name** | **String** | display name of identity | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccountAllOfIdentity = Initialize-PSSailpoint.V3AccountAllOfIdentity -Id 2c918084660f45d6016617daa9210584 `
|
||||
-Type IDENTITY `
|
||||
-Name John Doe
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AccountAllOfIdentity | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: account-all-of-owner-identity
|
||||
title: AccountAllOfOwnerIdentity
|
||||
pagination_label: AccountAllOfOwnerIdentity
|
||||
sidebar_label: AccountAllOfOwnerIdentity
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAllOfOwnerIdentity', 'AccountAllOfOwnerIdentity']
|
||||
slug: /tools/sdk/powershell/v3/models/account-all-of-owner-identity
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountAllOfOwnerIdentity', 'AccountAllOfOwnerIdentity']
|
||||
---
|
||||
|
||||
|
||||
# AccountAllOfOwnerIdentity
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | [**DtoType**](dto-type) | | [optional]
|
||||
**Id** | **String** | ID of the object to which this reference applies | [optional]
|
||||
**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccountAllOfOwnerIdentity = Initialize-PSSailpoint.V3AccountAllOfOwnerIdentity -Type null `
|
||||
-Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name William Wilson
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AccountAllOfOwnerIdentity | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: account-all-of-recommendation
|
||||
title: AccountAllOfRecommendation
|
||||
pagination_label: AccountAllOfRecommendation
|
||||
sidebar_label: AccountAllOfRecommendation
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAllOfRecommendation', 'AccountAllOfRecommendation']
|
||||
slug: /tools/sdk/powershell/v3/models/account-all-of-recommendation
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountAllOfRecommendation', 'AccountAllOfRecommendation']
|
||||
---
|
||||
|
||||
|
||||
# AccountAllOfRecommendation
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **Enum** [ "HUMAN", "MACHINE" ] | Recommended type of account. | [required]
|
||||
**Method** | **Enum** [ "DISCOVERY", "SOURCE", "CRITERIA" ] | Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccountAllOfRecommendation = Initialize-PSSailpoint.V3AccountAllOfRecommendation -Type MACHINE `
|
||||
-Method DISCOVERY
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AccountAllOfRecommendation | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: account-all-of-source-owner
|
||||
title: AccountAllOfSourceOwner
|
||||
pagination_label: AccountAllOfSourceOwner
|
||||
sidebar_label: AccountAllOfSourceOwner
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAllOfSourceOwner', 'AccountAllOfSourceOwner']
|
||||
slug: /tools/sdk/powershell/v3/models/account-all-of-source-owner
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountAllOfSourceOwner', 'AccountAllOfSourceOwner']
|
||||
---
|
||||
|
||||
|
||||
# AccountAllOfSourceOwner
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | The ID of the identity | [optional]
|
||||
**Type** | **Enum** [ "IDENTITY" ] | The type of object being referenced | [optional]
|
||||
**Name** | **String** | display name of identity | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccountAllOfSourceOwner = Initialize-PSSailpoint.V3AccountAllOfSourceOwner -Id 2c918084660f45d6016617daa9210584 `
|
||||
-Type IDENTITY `
|
||||
-Name Adam Kennedy
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AccountAllOfSourceOwner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -29,9 +29,10 @@ Name | Type | Description | Notes
|
||||
**Lastname** | **String** | Auth user's last name. | [optional]
|
||||
**DisplayName** | **String** | Auth user's name in displayed format. | [optional]
|
||||
**Alias** | **String** | Auth user's alias. | [optional]
|
||||
**LastPasswordChangeDate** | **String** | Date of last password change. | [optional]
|
||||
**LastPasswordChangeDate** | **System.DateTime** | Date of last password change. | [optional]
|
||||
**LastLoginTimestamp** | **Int64** | Timestamp of the last login (long type value). | [optional]
|
||||
**CurrentLoginTimestamp** | **Int64** | Timestamp of the current login (long type value). | [optional]
|
||||
**LastUnlockTimestamp** | **System.DateTime** | The date and time when the user was last unlocked. | [optional]
|
||||
**Capabilities** | **[]String** | Array of the auth user's capabilities. | [optional]
|
||||
|
||||
## Examples
|
||||
@@ -54,6 +55,7 @@ $AuthUser = Initialize-PSSailpoint.V3AuthUser -Tenant test-tenant `
|
||||
-LastPasswordChangeDate 2021-03-08T22:37:33.901Z `
|
||||
-LastLoginTimestamp 1656327185832 `
|
||||
-CurrentLoginTimestamp 1656327185832 `
|
||||
-LastUnlockTimestamp 2021-03-08T22:37:33.901Z `
|
||||
-Capabilities null
|
||||
```
|
||||
|
||||
|
||||
@@ -24,6 +24,10 @@ Name | Type | Description | Notes
|
||||
**Description** | **String** | The description of the entitlement | [optional]
|
||||
**Privileged** | **Boolean** | True if the entitlement is privileged | [optional]
|
||||
**CloudGoverned** | **Boolean** | True if the entitlement is cloud governed | [optional]
|
||||
**Requestable** | **Boolean** | True if the entitlement is able to be directly requested | [optional] [default to $false]
|
||||
**Owner** | [**EntitlementOwner**](entitlement-owner) | | [optional]
|
||||
**ManuallyUpdatedFields** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. | [optional]
|
||||
**AccessModelMetadata** | [**EntitlementAccessModelMetadata**](entitlement-access-model-metadata) | | [optional]
|
||||
**Created** | **System.DateTime** | Time when the entitlement was created | [optional]
|
||||
**Modified** | **System.DateTime** | Time when the entitlement was last modified | [optional]
|
||||
**Source** | [**EntitlementSource**](entitlement-source) | | [optional]
|
||||
@@ -43,6 +47,10 @@ $Entitlement = Initialize-PSSailpoint.V3Entitlement -Id 2c91808874ff91550175097
|
||||
-Description CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local `
|
||||
-Privileged true `
|
||||
-CloudGoverned true `
|
||||
-Requestable true `
|
||||
-Owner null `
|
||||
-ManuallyUpdatedFields {DISPLAY_NAME=true, DESCRIPTION=true} `
|
||||
-AccessModelMetadata null `
|
||||
-Created 2020-10-08T18:33:52.029Z `
|
||||
-Modified 2020-10-08T18:33:52.029Z `
|
||||
-Source null `
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: entitlement-access-model-metadata
|
||||
title: EntitlementAccessModelMetadata
|
||||
pagination_label: EntitlementAccessModelMetadata
|
||||
sidebar_label: EntitlementAccessModelMetadata
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementAccessModelMetadata', 'EntitlementAccessModelMetadata']
|
||||
slug: /tools/sdk/powershell/v3/models/entitlement-access-model-metadata
|
||||
tags: ['SDK', 'Software Development Kit', 'EntitlementAccessModelMetadata', 'EntitlementAccessModelMetadata']
|
||||
---
|
||||
|
||||
|
||||
# EntitlementAccessModelMetadata
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Attributes** | [**[]AccessModelMetadata**](access-model-metadata) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$EntitlementAccessModelMetadata = Initialize-PSSailpoint.V3EntitlementAccessModelMetadata -Attributes null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$EntitlementAccessModelMetadata | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,57 +0,0 @@
|
||||
---
|
||||
id: entitlement-dto
|
||||
title: EntitlementDto
|
||||
pagination_label: EntitlementDto
|
||||
sidebar_label: EntitlementDto
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementDto', 'EntitlementDto']
|
||||
slug: /tools/sdk/powershell/v3/models/entitlement-dto
|
||||
tags: ['SDK', 'Software Development Kit', 'EntitlementDto', 'EntitlementDto']
|
||||
---
|
||||
|
||||
|
||||
# EntitlementDto
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | System-generated unique ID of the Object | [optional] [readonly]
|
||||
**Name** | **String** | Name of the Object | [required]
|
||||
**Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly]
|
||||
**Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly]
|
||||
**Attribute** | **String** | Name of the entitlement attribute | [optional]
|
||||
**Value** | **String** | Raw value of the entitlement | [optional]
|
||||
**Description** | **String** | Entitlment description | [optional]
|
||||
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Entitlement attributes | [optional]
|
||||
**SourceSchemaObjectType** | **String** | Schema objectType on the given application that maps to an Account Group | [optional]
|
||||
**Privileged** | **Boolean** | Determines if this Entitlement is privileged. | [optional]
|
||||
**CloudGoverned** | **Boolean** | Determines if this Entitlement is goverened in the cloud. | [optional]
|
||||
**Source** | [**EntitlementSource**](entitlement-source) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$EntitlementDto = Initialize-PSSailpoint.V3EntitlementDto -Id id12345 `
|
||||
-Name aName `
|
||||
-Created 2015-05-28T14:07:17Z `
|
||||
-Modified 2015-05-28T14:07:17Z `
|
||||
-Attribute authorizationType `
|
||||
-Value CN=Users,dc=sailpoint,dc=com `
|
||||
-Description Active Directory DC `
|
||||
-Attributes {GroupType=Security, sAMAccountName=Buyer} `
|
||||
-SourceSchemaObjectType group `
|
||||
-Privileged false `
|
||||
-CloudGoverned false `
|
||||
-Source null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$EntitlementDto | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: entitlement-owner
|
||||
title: EntitlementOwner
|
||||
pagination_label: EntitlementOwner
|
||||
sidebar_label: EntitlementOwner
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementOwner', 'EntitlementOwner']
|
||||
slug: /tools/sdk/powershell/v3/models/entitlement-owner
|
||||
tags: ['SDK', 'Software Development Kit', 'EntitlementOwner', 'EntitlementOwner']
|
||||
---
|
||||
|
||||
|
||||
# EntitlementOwner
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | The identity ID | [optional]
|
||||
**Type** | **Enum** [ "IDENTITY" ] | The type of object | [optional]
|
||||
**Name** | **String** | The display name of the identity | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$EntitlementOwner = Initialize-PSSailpoint.V3EntitlementOwner -Id 2c9180827ca885d7017ca8ce28a000eb `
|
||||
-Type IDENTITY `
|
||||
-Name john.doe
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$EntitlementOwner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -16,6 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'RequestedItemStatus', 'RequestedItemS
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | The ID of the access request. | [optional]
|
||||
**Name** | **String** | Human-readable display name of the item being requested. | [optional]
|
||||
**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | Type of requested object. | [optional]
|
||||
**CancelledRequestDetails** | [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional]
|
||||
@@ -45,7 +46,8 @@ Name | Type | Description | Notes
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$RequestedItemStatus = Initialize-PSSailpoint.V3RequestedItemStatus -Name AccessProfile1 `
|
||||
$RequestedItemStatus = Initialize-PSSailpoint.V3RequestedItemStatus -Id 2c9180926cbfbddd016cbfc7c3b10010 `
|
||||
-Name AccessProfile1 `
|
||||
-Type ACCESS_PROFILE `
|
||||
-CancelledRequestDetails null `
|
||||
-ErrorMessages null `
|
||||
|
||||
Reference in New Issue
Block a user