mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 12:27:47 +00:00
Update PowerShell SDK docs: 17161070549
This commit is contained in:
developer-relations-sp
@@ -37,15 +37,15 @@ The maximum supported length for the description field is 2000 characters.
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Body | MachineIdentity | [**MachineIdentity**](../models/machine-identity) | True |
|
||||
Body | MachineIdentityRequest | [**MachineIdentityRequest**](../models/machine-identity-request) | True |
|
||||
|
||||
### Return type
|
||||
[**MachineIdentity**](../models/machine-identity)
|
||||
[**MachineIdentityResponse**](../models/machine-identity-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Machine Identity created. | MachineIdentity
|
||||
200 | Machine Identity created. | MachineIdentityResponse
|
||||
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
|
||||
@@ -60,14 +60,10 @@ Code | Description | Data Type
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$MachineIdentity = @"{
|
||||
"subtype" : "Application",
|
||||
$MachineIdentityRequest = @"{
|
||||
"sourceId" : "6d28b7c1-620c-49c6-b6d5-cbf81eb4b5fa",
|
||||
"created" : "2015-05-28T14:07:17Z",
|
||||
"businessApplication" : "ADService",
|
||||
"name" : "aName",
|
||||
"modified" : "2015-05-28T14:07:17Z",
|
||||
"description" : "",
|
||||
"attributes" : "{\"Region\":\"EU\"}",
|
||||
"owners" : {
|
||||
"primaryIdentity" : "{}",
|
||||
"secondaryIdentities" : [ {
|
||||
@@ -80,18 +76,31 @@ $MachineIdentity = @"{
|
||||
"type" : "IDENTITY"
|
||||
} ]
|
||||
},
|
||||
"id" : "id12345",
|
||||
"manuallyEdited" : true
|
||||
"uuid" : "f5dd23fe-3414-42b7-bb1c-869400ad7a10",
|
||||
"nativeIdentity" : "abc:123:dddd",
|
||||
"subtype" : "Application",
|
||||
"businessApplication" : "ADService",
|
||||
"userEntitlements" : [ {
|
||||
"sourceId" : "5898b7c1-620c-49c6-cccc-cbf81eb4bddd",
|
||||
"entitlementId" : "6d28b7c1-620c-49c6-b6d5-cbf81eb4b5fa"
|
||||
}, {
|
||||
"sourceId" : "5898b7c1-620c-49c6-cccc-cbf81eb4bddd",
|
||||
"entitlementId" : "6d28b7c1-620c-49c6-b6d5-cbf81eb4b5fa"
|
||||
} ],
|
||||
"name" : "aName",
|
||||
"modified" : "2015-05-28T14:07:17Z",
|
||||
"attributes" : "{\"Region\":\"EU\"}",
|
||||
"id" : "id12345"
|
||||
}"@
|
||||
|
||||
# Create machine identities
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToMachineIdentity -Json $MachineIdentity
|
||||
New-V2025MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result
|
||||
$Result = ConvertFrom-JsonToMachineIdentityRequest -Json $MachineIdentityRequest
|
||||
New-V2025MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentityRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-V2025MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result
|
||||
# New-V2025MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentityRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025MachineIdentity"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -165,12 +174,12 @@ Path | Id | **String** | True | Machine Identity ID
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**MachineIdentity**](../models/machine-identity)
|
||||
[**MachineIdentityResponse**](../models/machine-identity-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | A machine identity object | MachineIdentity
|
||||
200 | A machine identity object | MachineIdentityResponse
|
||||
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
|
||||
@@ -213,19 +222,19 @@ This API returns a list of machine identities.
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr*
|
||||
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **businessApplication, name**
|
||||
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **source.name**: *eq, in, sw* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw*
|
||||
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **businessApplication, name, source.name**
|
||||
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.
|
||||
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
|
||||
### Return type
|
||||
[**MachineIdentity[]**](../models/machine-identity)
|
||||
[**MachineIdentityResponse[]**](../models/machine-identity-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | List of machine identities. | MachineIdentity[]
|
||||
200 | List of machine identities. | MachineIdentityResponse[]
|
||||
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
|
||||
@@ -240,8 +249,8 @@ Code | Description | Data Type
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* (optional)
|
||||
$Sorters = "businessApplication" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **businessApplication, name** (optional)
|
||||
$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **source.name**: *eq, in, sw* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* (optional)
|
||||
$Sorters = "businessApplication" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **businessApplication, name, source.name** (optional)
|
||||
$Count = $true # Boolean | 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. (optional) (default to $false)
|
||||
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
||||
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
||||
@@ -277,12 +286,12 @@ Path | Id | **String** | True | Machine Identity ID.
|
||||
Body | RequestBody | [**[]SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | True | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
||||
|
||||
### Return type
|
||||
[**MachineIdentity**](../models/machine-identity)
|
||||
[**MachineIdentityResponse**](../models/machine-identity-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Updated Machine Identity object. | MachineIdentity
|
||||
200 | Updated Machine Identity object. | MachineIdentityResponse
|
||||
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
|
||||
|
||||
@@ -22,10 +22,12 @@ Name | Type | Description | Notes
|
||||
**Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly]
|
||||
**BusinessApplication** | **String** | The business application that the identity represents | [required]
|
||||
**Description** | **String** | Description of machine identity | [optional]
|
||||
**ManuallyEdited** | **Boolean** | Indicates if the machine identity has been manually edited | [optional] [default to $false]
|
||||
**Attributes** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A map of custom machine identity attributes | [optional]
|
||||
**Subtype** | **String** | The subtype value associated to the machine identity | [required]
|
||||
**Owners** | [**MachineIdentityDtoOwners**](machine-identity-dto-owners) | | [optional]
|
||||
**SourceId** | **String** | The source id associated to the machine identity | [optional]
|
||||
**Uuid** | **String** | The UUID associated to the machine identity directly aggregated from a source | [optional]
|
||||
**NativeIdentity** | **String** | The native identity associated to the machine identity directly aggregated from a source | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -37,10 +39,12 @@ $MachineIdentity = Initialize-V2025MachineIdentity -Id id12345 `
|
||||
-Modified 2015-05-28T14:07:17Z `
|
||||
-BusinessApplication ADService `
|
||||
-Description `
|
||||
-ManuallyEdited true `
|
||||
-Attributes {"Region":"EU"} `
|
||||
-Subtype Application `
|
||||
-Owners null
|
||||
-Owners null `
|
||||
-SourceId 6d28b7c1-620c-49c6-b6d5-cbf81eb4b5fa `
|
||||
-Uuid f5dd23fe-3414-42b7-bb1c-869400ad7a10 `
|
||||
-NativeIdentity abc:123:dddd
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -0,0 +1,59 @@
|
||||
---
|
||||
id: v2025-machine-identity-request
|
||||
title: MachineIdentityRequest
|
||||
pagination_label: MachineIdentityRequest
|
||||
sidebar_label: MachineIdentityRequest
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'MachineIdentityRequest', 'V2025MachineIdentityRequest']
|
||||
slug: /tools/sdk/powershell/v2025/models/machine-identity-request
|
||||
tags: ['SDK', 'Software Development Kit', 'MachineIdentityRequest', 'V2025MachineIdentityRequest']
|
||||
---
|
||||
|
||||
|
||||
# MachineIdentityRequest
|
||||
|
||||
## 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]
|
||||
**BusinessApplication** | **String** | The business application that the identity represents | [required]
|
||||
**Description** | **String** | Description of machine identity | [optional]
|
||||
**Attributes** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A map of custom machine identity attributes | [optional]
|
||||
**Subtype** | **String** | The subtype value associated to the machine identity | [required]
|
||||
**Owners** | [**MachineIdentityDtoOwners**](machine-identity-dto-owners) | | [optional]
|
||||
**SourceId** | **String** | The source id associated to the machine identity | [optional]
|
||||
**Uuid** | **String** | The UUID associated to the machine identity directly aggregated from a source | [optional]
|
||||
**NativeIdentity** | **String** | The native identity associated to the machine identity directly aggregated from a source | [optional]
|
||||
**UserEntitlements** | [**[]MachineIdentityRequestUserEntitlements**](machine-identity-request-user-entitlements) | The user entitlements associated to the machine identity | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$MachineIdentityRequest = Initialize-V2025MachineIdentityRequest -Id id12345 `
|
||||
-Name aName `
|
||||
-Created 2015-05-28T14:07:17Z `
|
||||
-Modified 2015-05-28T14:07:17Z `
|
||||
-BusinessApplication ADService `
|
||||
-Description `
|
||||
-Attributes {"Region":"EU"} `
|
||||
-Subtype Application `
|
||||
-Owners null `
|
||||
-SourceId 6d28b7c1-620c-49c6-b6d5-cbf81eb4b5fa `
|
||||
-Uuid f5dd23fe-3414-42b7-bb1c-869400ad7a10 `
|
||||
-NativeIdentity abc:123:dddd `
|
||||
-UserEntitlements null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$MachineIdentityRequest | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2025-machine-identity-request-user-entitlements
|
||||
title: MachineIdentityRequestUserEntitlements
|
||||
pagination_label: MachineIdentityRequestUserEntitlements
|
||||
sidebar_label: MachineIdentityRequestUserEntitlements
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'MachineIdentityRequestUserEntitlements', 'V2025MachineIdentityRequestUserEntitlements']
|
||||
slug: /tools/sdk/powershell/v2025/models/machine-identity-request-user-entitlements
|
||||
tags: ['SDK', 'Software Development Kit', 'MachineIdentityRequestUserEntitlements', 'V2025MachineIdentityRequestUserEntitlements']
|
||||
---
|
||||
|
||||
|
||||
# MachineIdentityRequestUserEntitlements
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**EntitlementId** | **String** | The ID of the entitlement | [required]
|
||||
**SourceId** | **String** | The source ID of the entitlement | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$MachineIdentityRequestUserEntitlements = Initialize-V2025MachineIdentityRequestUserEntitlements -EntitlementId 6d28b7c1-620c-49c6-b6d5-cbf81eb4b5fa `
|
||||
-SourceId 5898b7c1-620c-49c6-cccc-cbf81eb4bddd
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$MachineIdentityRequestUserEntitlements | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,67 @@
|
||||
---
|
||||
id: v2025-machine-identity-response
|
||||
title: MachineIdentityResponse
|
||||
pagination_label: MachineIdentityResponse
|
||||
sidebar_label: MachineIdentityResponse
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'MachineIdentityResponse', 'V2025MachineIdentityResponse']
|
||||
slug: /tools/sdk/powershell/v2025/models/machine-identity-response
|
||||
tags: ['SDK', 'Software Development Kit', 'MachineIdentityResponse', 'V2025MachineIdentityResponse']
|
||||
---
|
||||
|
||||
|
||||
# MachineIdentityResponse
|
||||
|
||||
## 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]
|
||||
**BusinessApplication** | **String** | The business application that the identity represents | [required]
|
||||
**Description** | **String** | Description of machine identity | [optional]
|
||||
**Attributes** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A map of custom machine identity attributes | [optional]
|
||||
**Subtype** | **String** | The subtype value associated to the machine identity | [required]
|
||||
**Owners** | [**MachineIdentityDtoOwners**](machine-identity-dto-owners) | | [optional]
|
||||
**SourceId** | **String** | The source id associated to the machine identity | [optional]
|
||||
**Uuid** | **String** | The UUID associated to the machine identity directly aggregated from a source | [optional]
|
||||
**NativeIdentity** | **String** | The native identity associated to the machine identity directly aggregated from a source | [optional]
|
||||
**ManuallyEdited** | **Boolean** | Indicates if the machine identity has been manually edited | [optional] [default to $false]
|
||||
**ManuallyCreated** | **Boolean** | Indicates if the machine identity has been manually created | [optional] [default to $false]
|
||||
**Source** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The source of the machine identity | [optional]
|
||||
**DatasetId** | **String** | The dataset id associated to the source in which the identity was retrieved from | [optional]
|
||||
**UserEntitlements** | [**[]MachineIdentityResponseUserEntitlements**](machine-identity-response-user-entitlements) | The user entitlements associated to the machine identity | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$MachineIdentityResponse = Initialize-V2025MachineIdentityResponse -Id id12345 `
|
||||
-Name aName `
|
||||
-Created 2015-05-28T14:07:17Z `
|
||||
-Modified 2015-05-28T14:07:17Z `
|
||||
-BusinessApplication ADService `
|
||||
-Description `
|
||||
-Attributes {"Region":"EU"} `
|
||||
-Subtype Application `
|
||||
-Owners null `
|
||||
-SourceId 6d28b7c1-620c-49c6-b6d5-cbf81eb4b5fa `
|
||||
-Uuid f5dd23fe-3414-42b7-bb1c-869400ad7a10 `
|
||||
-NativeIdentity abc:123:dddd `
|
||||
-ManuallyEdited true `
|
||||
-ManuallyCreated true `
|
||||
-Source null `
|
||||
-DatasetId 8886e5e3-63d0-462f-a195-d98da885b8dc `
|
||||
-UserEntitlements null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$MachineIdentityResponse | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
id: v2025-machine-identity-response-user-entitlements
|
||||
title: MachineIdentityResponseUserEntitlements
|
||||
pagination_label: MachineIdentityResponseUserEntitlements
|
||||
sidebar_label: MachineIdentityResponseUserEntitlements
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'MachineIdentityResponseUserEntitlements', 'V2025MachineIdentityResponseUserEntitlements']
|
||||
slug: /tools/sdk/powershell/v2025/models/machine-identity-response-user-entitlements
|
||||
tags: ['SDK', 'Software Development Kit', 'MachineIdentityResponseUserEntitlements', 'V2025MachineIdentityResponseUserEntitlements']
|
||||
---
|
||||
|
||||
|
||||
# MachineIdentityResponseUserEntitlements
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**SourceId** | **String** | The source ID of the entitlement | [optional]
|
||||
**EntitlementId** | **String** | The ID of the entitlement | [optional]
|
||||
**DisplayName** | **String** | The display name of the entitlement | [optional]
|
||||
**Source** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The source of the entitlement | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$MachineIdentityResponseUserEntitlements = Initialize-V2025MachineIdentityResponseUserEntitlements -SourceId 5898b7c1-620c-49c6-cccc-cbf81eb4bddd `
|
||||
-EntitlementId 6d28b7c1-620c-49c6-b6d5-cbf81eb4b5fa `
|
||||
-DisplayName Entitlement Name `
|
||||
-Source null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$MachineIdentityResponseUserEntitlements | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -10222,15 +10222,11 @@
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#create-machine-identity
|
||||
source: |
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$MachineIdentity = @"
|
||||
$MachineIdentityRequest = @"
|
||||
{
|
||||
"subtype" : "Application",
|
||||
"sourceId" : "6d28b7c1-620c-49c6-b6d5-cbf81eb4b5fa",
|
||||
"created" : "2015-05-28T14:07:17Z",
|
||||
"businessApplication" : "ADService",
|
||||
"name" : "aName",
|
||||
"modified" : "2015-05-28T14:07:17Z",
|
||||
"description" : "",
|
||||
"attributes" : "{\"Region\":\"EU\"}",
|
||||
"owners" : {
|
||||
"primaryIdentity" : "{}",
|
||||
"secondaryIdentities" : [ {
|
||||
@@ -10243,19 +10239,32 @@
|
||||
"type" : "IDENTITY"
|
||||
} ]
|
||||
},
|
||||
"id" : "id12345",
|
||||
"manuallyEdited" : true
|
||||
"uuid" : "f5dd23fe-3414-42b7-bb1c-869400ad7a10",
|
||||
"nativeIdentity" : "abc:123:dddd",
|
||||
"subtype" : "Application",
|
||||
"businessApplication" : "ADService",
|
||||
"userEntitlements" : [ {
|
||||
"sourceId" : "5898b7c1-620c-49c6-cccc-cbf81eb4bddd",
|
||||
"entitlementId" : "6d28b7c1-620c-49c6-b6d5-cbf81eb4b5fa"
|
||||
}, {
|
||||
"sourceId" : "5898b7c1-620c-49c6-cccc-cbf81eb4bddd",
|
||||
"entitlementId" : "6d28b7c1-620c-49c6-b6d5-cbf81eb4b5fa"
|
||||
} ],
|
||||
"name" : "aName",
|
||||
"modified" : "2015-05-28T14:07:17Z",
|
||||
"attributes" : "{\"Region\":\"EU\"}",
|
||||
"id" : "id12345"
|
||||
}
|
||||
"@
|
||||
|
||||
# Create machine identities
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToMachineIdentity -Json $MachineIdentity
|
||||
New-V2025MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result
|
||||
$Result = ConvertFrom-JsonToMachineIdentityRequest -Json $MachineIdentityRequest
|
||||
New-V2025MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentityRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-V2025MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result
|
||||
# New-V2025MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentityRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025MachineIdentity"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -10307,8 +10316,8 @@
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#list-machine-identities
|
||||
source: |
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* (optional)
|
||||
$Sorters = "businessApplication" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **businessApplication, name** (optional)
|
||||
$Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **source.name**: *eq, in, sw* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* (optional)
|
||||
$Sorters = "businessApplication" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **businessApplication, name, source.name** (optional)
|
||||
$Count = $true # Boolean | 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. (optional) (default to $false)
|
||||
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
||||
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
||||
|
||||
Reference in New Issue
Block a user