mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 20:37:46 +00:00
Update to powershell SDK docs: 14864324692
This commit is contained in:
developer-relations-sp
@@ -0,0 +1,69 @@
|
||||
---
|
||||
id: v2024-machine-account-classify
|
||||
title: MachineAccountClassify
|
||||
pagination_label: MachineAccountClassify
|
||||
sidebar_label: MachineAccountClassify
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'MachineAccountClassify', 'V2024MachineAccountClassify']
|
||||
slug: /tools/sdk/powershell/v2024/methods/machine-account-classify
|
||||
tags: ['SDK', 'Software Development Kit', 'MachineAccountClassify', 'V2024MachineAccountClassify']
|
||||
---
|
||||
|
||||
# MachineAccountClassify
|
||||
|
||||
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**Send-V2024ClassifyMachineAccount**](#send-classify-machine-account) | **POST** `/accounts/{id}/classify` | Classify a Single Machine Account
|
||||
|
||||
|
||||
## send-classify-machine-account
|
||||
Use this API to classify a single machine account.
|
||||
A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/send-classify-machine-account)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | Account ID.
|
||||
Query | ClassificationMode | **String** | (optional) (default to "default") | Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human.
|
||||
|
||||
### Return type
|
||||
[**SendClassifyMachineAccount200Response**](../models/send-classify-machine-account200-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Account classified as Machine. | SendClassifyMachineAccount200Response
|
||||
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
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
|
||||
$ClassificationMode = "default" # String | Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. (optional) (default to "default")
|
||||
|
||||
# Classify a Single Machine Account
|
||||
|
||||
try {
|
||||
Send-V2024ClassifyMachineAccount -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Send-V2024ClassifyMachineAccount -Id $Id -ClassificationMode $ClassificationMode
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ClassifyMachineAccount"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
@@ -0,0 +1,259 @@
|
||||
---
|
||||
id: v2024-machine-account-mappings
|
||||
title: MachineAccountMappings
|
||||
pagination_label: MachineAccountMappings
|
||||
sidebar_label: MachineAccountMappings
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'MachineAccountMappings', 'V2024MachineAccountMappings']
|
||||
slug: /tools/sdk/powershell/v2024/methods/machine-account-mappings
|
||||
tags: ['SDK', 'Software Development Kit', 'MachineAccountMappings', 'V2024MachineAccountMappings']
|
||||
---
|
||||
|
||||
# MachineAccountMappings
|
||||
|
||||
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**New-V2024MachineAccountMappings**](#create-machine-account-mappings) | **POST** `/sources/{sourceId}/machine-account-mappings` | Create Machine Account Mappings
|
||||
[**Remove-V2024MachineAccountMappings**](#delete-machine-account-mappings) | **DELETE** `/sources/{sourceId}/machine-account-mappings` | Delete Source's Machine Account Mappings
|
||||
[**Get-V2024MachineAccountMappings**](#list-machine-account-mappings) | **GET** `/sources/{sourceId}/machine-account-mappings` | Machine Account Mapping for Source
|
||||
[**Set-V2024MachineAccountMappings**](#set-machine-account-mappings) | **PUT** `/sources/{sourceId}/machine-mappings` | Update Source's Machine Account Mappings
|
||||
|
||||
|
||||
## create-machine-account-mappings
|
||||
Creates Machine Account Mappings for both identities and accounts for a source.
|
||||
A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-machine-account-mappings)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | Source ID.
|
||||
Body | AttributeMappings | [**AttributeMappings**](../models/attribute-mappings) | True |
|
||||
|
||||
### Return type
|
||||
[**AttributeMappings[]**](../models/attribute-mappings)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Newly created Attribute Mapping Object | AttributeMappings[]
|
||||
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
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source ID.
|
||||
$AttributeMappings = @"{
|
||||
"transformDefinition" : {
|
||||
"attributes" : {
|
||||
"input" : {
|
||||
"attributes" : {
|
||||
"name" : "8d3e0094e99445de98eef6c75e25jc04",
|
||||
"attributeName" : "givenName",
|
||||
"sourceName" : "delimited-src"
|
||||
},
|
||||
"type" : "accountAttribute"
|
||||
}
|
||||
},
|
||||
"id" : "ToUpper",
|
||||
"type" : "reference"
|
||||
},
|
||||
"target" : {
|
||||
"sourceId" : "2c9180835d2e5168015d32f890ca1581",
|
||||
"attributeName" : "businessApplication",
|
||||
"type" : "IDENTITY"
|
||||
}
|
||||
}"@
|
||||
|
||||
# Create Machine Account Mappings
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToAttributeMappings -Json $AttributeMappings
|
||||
New-V2024MachineAccountMappings -Id $Id -AttributeMappings $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-V2024MachineAccountMappings -Id $Id -AttributeMappings $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024MachineAccountMappings"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-machine-account-mappings
|
||||
Use this API to remove machine account attribute mappings for a Source.
|
||||
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-machine-account-mappings)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | source ID.
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | No content - indicates the request was successful but there is no content to be returned in the response. |
|
||||
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
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | source ID.
|
||||
|
||||
# Delete Source's Machine Account Mappings
|
||||
|
||||
try {
|
||||
Remove-V2024MachineAccountMappings -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Remove-V2024MachineAccountMappings -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MachineAccountMappings"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-machine-account-mappings
|
||||
Retrieves Machine account mappings for a specified source using Source ID.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-machine-account-mappings)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | Source ID
|
||||
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
|
||||
[**AttributeMappings[]**](../models/attribute-mappings)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | An array of Attribute Mapping Objects | AttributeMappings[]
|
||||
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
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source ID
|
||||
$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)
|
||||
|
||||
# Machine Account Mapping for Source
|
||||
|
||||
try {
|
||||
Get-V2024MachineAccountMappings -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024MachineAccountMappings -Id $Id -Limit $Limit -Offset $Offset
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccountMappings"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## set-machine-account-mappings
|
||||
Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-machine-account-mappings)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | Source ID.
|
||||
Body | AttributeMappings | [**AttributeMappings**](../models/attribute-mappings) | True |
|
||||
|
||||
### Return type
|
||||
[**AttributeMappings[]**](../models/attribute-mappings)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Updated Machine Account Attributes for a Source. | AttributeMappings[]
|
||||
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
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source ID.
|
||||
$AttributeMappings = @"{
|
||||
"transformDefinition" : {
|
||||
"attributes" : {
|
||||
"input" : {
|
||||
"attributes" : {
|
||||
"name" : "8d3e0094e99445de98eef6c75e25jc04",
|
||||
"attributeName" : "givenName",
|
||||
"sourceName" : "delimited-src"
|
||||
},
|
||||
"type" : "accountAttribute"
|
||||
}
|
||||
},
|
||||
"id" : "ToUpper",
|
||||
"type" : "reference"
|
||||
},
|
||||
"target" : {
|
||||
"sourceId" : "2c9180835d2e5168015d32f890ca1581",
|
||||
"attributeName" : "businessApplication",
|
||||
"type" : "IDENTITY"
|
||||
}
|
||||
}"@
|
||||
|
||||
# Update Source's Machine Account Mappings
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToAttributeMappings -Json $AttributeMappings
|
||||
Set-V2024MachineAccountMappings -Id $Id -AttributeMappings $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Set-V2024MachineAccountMappings -Id $Id -AttributeMappings $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MachineAccountMappings"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
@@ -0,0 +1,171 @@
|
||||
---
|
||||
id: v2024-machine-classification-config
|
||||
title: MachineClassificationConfig
|
||||
pagination_label: MachineClassificationConfig
|
||||
sidebar_label: MachineClassificationConfig
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'MachineClassificationConfig', 'V2024MachineClassificationConfig']
|
||||
slug: /tools/sdk/powershell/v2024/methods/machine-classification-config
|
||||
tags: ['SDK', 'Software Development Kit', 'MachineClassificationConfig', 'V2024MachineClassificationConfig']
|
||||
---
|
||||
|
||||
# MachineClassificationConfig
|
||||
|
||||
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**Remove-V2024MachineClassificationConfig**](#delete-machine-classification-config) | **DELETE** `/sources/{sourceId}/machine-classification-config` | Delete Source's Classification Config
|
||||
[**Get-V2024MachineClassificationConfig**](#get-machine-classification-config) | **GET** `/sources/{sourceId}/machine-classification-config` | Machine Classification Config for Source
|
||||
[**Set-V2024MachineClassificationConfig**](#set-machine-classification-config) | **PUT** `/sources/{sourceId}/machine-classification-config` | Update Source's Classification Config
|
||||
|
||||
|
||||
## delete-machine-classification-config
|
||||
Use this API to remove Classification Config for a Source.
|
||||
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-machine-classification-config)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | Source ID.
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | No content - indicates the request was successful but there is no content to be returned in the response. |
|
||||
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
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source ID.
|
||||
|
||||
# Delete Source's Classification Config
|
||||
|
||||
try {
|
||||
Remove-V2024MachineClassificationConfig -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Remove-V2024MachineClassificationConfig -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MachineClassificationConfig"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-machine-classification-config
|
||||
This API returns a Machine Classification Config for a Source using Source ID.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-machine-classification-config)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | Source ID
|
||||
|
||||
### Return type
|
||||
[**MachineClassificationConfig**](../models/machine-classification-config)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | A Config Object | MachineClassificationConfig
|
||||
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
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source ID
|
||||
|
||||
# Machine Classification Config for Source
|
||||
|
||||
try {
|
||||
Get-V2024MachineClassificationConfig -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024MachineClassificationConfig -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineClassificationConfig"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## set-machine-classification-config
|
||||
Use this API to update Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-machine-classification-config)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | Source ID.
|
||||
Body | MachineClassificationConfig | [**MachineClassificationConfig**](../models/machine-classification-config) | True |
|
||||
|
||||
### Return type
|
||||
[**MachineClassificationConfig**](../models/machine-classification-config)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Updated Machine Classification Config Object. | MachineClassificationConfig
|
||||
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
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source ID.
|
||||
$MachineClassificationConfig = @"{
|
||||
"criteria" : "criteria",
|
||||
"created" : "2017-07-11T18:45:37.098Z",
|
||||
"modified" : "2018-06-25T20:22:28.104Z",
|
||||
"classificationMethod" : "SOURCE",
|
||||
"enabled" : true
|
||||
}"@
|
||||
|
||||
# Update Source's Classification Config
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToMachineClassificationConfig -Json $MachineClassificationConfig
|
||||
Set-V2024MachineClassificationConfig -Id $Id -MachineClassificationConfig $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Set-V2024MachineClassificationConfig -Id $Id -MachineClassificationConfig $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MachineClassificationConfig"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
@@ -887,7 +887,7 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## test-workflow
|
||||
::: info
|
||||
:::info
|
||||
|
||||
Workflow must be disabled in order to use this endpoint.
|
||||
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2024-attribute-mappings
|
||||
title: AttributeMappings
|
||||
pagination_label: AttributeMappings
|
||||
sidebar_label: AttributeMappings
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeMappings', 'V2024AttributeMappings']
|
||||
slug: /tools/sdk/powershell/v2024/models/attribute-mappings
|
||||
tags: ['SDK', 'Software Development Kit', 'AttributeMappings', 'V2024AttributeMappings']
|
||||
---
|
||||
|
||||
|
||||
# AttributeMappings
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Target** | [**AttributeMappingsAllOfTarget**](attribute-mappings-all-of-target) | | [optional]
|
||||
**TransformDefinition** | [**AttributeMappingsAllOfTransformDefinition**](attribute-mappings-all-of-transform-definition) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AttributeMappings = Initialize-PSSailpoint.V2024AttributeMappings -Target null `
|
||||
-TransformDefinition null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AttributeMappings | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2024-attribute-mappings-all-of-target
|
||||
title: AttributeMappingsAllOfTarget
|
||||
pagination_label: AttributeMappingsAllOfTarget
|
||||
sidebar_label: AttributeMappingsAllOfTarget
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeMappingsAllOfTarget', 'V2024AttributeMappingsAllOfTarget']
|
||||
slug: /tools/sdk/powershell/v2024/models/attribute-mappings-all-of-target
|
||||
tags: ['SDK', 'Software Development Kit', 'AttributeMappingsAllOfTarget', 'V2024AttributeMappingsAllOfTarget']
|
||||
---
|
||||
|
||||
|
||||
# AttributeMappingsAllOfTarget
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **Enum** [ "IDENTITY" ] | The type of target entity | [optional]
|
||||
**AttributeName** | **String** | Name of the targeted attribute | [optional]
|
||||
**SourceId** | **String** | The ID of Source | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AttributeMappingsAllOfTarget = Initialize-PSSailpoint.V2024AttributeMappingsAllOfTarget -Type IDENTITY `
|
||||
-AttributeName businessApplication `
|
||||
-SourceId 2c9180835d2e5168015d32f890ca1581
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AttributeMappingsAllOfTarget | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2024-attribute-mappings-all-of-transform-definition
|
||||
title: AttributeMappingsAllOfTransformDefinition
|
||||
pagination_label: AttributeMappingsAllOfTransformDefinition
|
||||
sidebar_label: AttributeMappingsAllOfTransformDefinition
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeMappingsAllOfTransformDefinition', 'V2024AttributeMappingsAllOfTransformDefinition']
|
||||
slug: /tools/sdk/powershell/v2024/models/attribute-mappings-all-of-transform-definition
|
||||
tags: ['SDK', 'Software Development Kit', 'AttributeMappingsAllOfTransformDefinition', 'V2024AttributeMappingsAllOfTransformDefinition']
|
||||
---
|
||||
|
||||
|
||||
# AttributeMappingsAllOfTransformDefinition
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **String** | The type of transform | [optional]
|
||||
**Attributes** | [**AttributeMappingsAllOfTransformDefinitionAttributes**](attribute-mappings-all-of-transform-definition-attributes) | | [optional]
|
||||
**Id** | **String** | Transform Operation | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AttributeMappingsAllOfTransformDefinition = Initialize-PSSailpoint.V2024AttributeMappingsAllOfTransformDefinition -Type reference `
|
||||
-Attributes null `
|
||||
-Id ToUpper
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AttributeMappingsAllOfTransformDefinition | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: v2024-attribute-mappings-all-of-transform-definition-attributes
|
||||
title: AttributeMappingsAllOfTransformDefinitionAttributes
|
||||
pagination_label: AttributeMappingsAllOfTransformDefinitionAttributes
|
||||
sidebar_label: AttributeMappingsAllOfTransformDefinitionAttributes
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeMappingsAllOfTransformDefinitionAttributes', 'V2024AttributeMappingsAllOfTransformDefinitionAttributes']
|
||||
slug: /tools/sdk/powershell/v2024/models/attribute-mappings-all-of-transform-definition-attributes
|
||||
tags: ['SDK', 'Software Development Kit', 'AttributeMappingsAllOfTransformDefinitionAttributes', 'V2024AttributeMappingsAllOfTransformDefinitionAttributes']
|
||||
---
|
||||
|
||||
|
||||
# AttributeMappingsAllOfTransformDefinitionAttributes
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**VarInput** | [**AttributeMappingsAllOfTransformDefinitionAttributesInput**](attribute-mappings-all-of-transform-definition-attributes-input) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AttributeMappingsAllOfTransformDefinitionAttributes = Initialize-PSSailpoint.V2024AttributeMappingsAllOfTransformDefinitionAttributes -VarInput null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AttributeMappingsAllOfTransformDefinitionAttributes | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2024-attribute-mappings-all-of-transform-definition-attributes-input
|
||||
title: AttributeMappingsAllOfTransformDefinitionAttributesInput
|
||||
pagination_label: AttributeMappingsAllOfTransformDefinitionAttributesInput
|
||||
sidebar_label: AttributeMappingsAllOfTransformDefinitionAttributesInput
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeMappingsAllOfTransformDefinitionAttributesInput', 'V2024AttributeMappingsAllOfTransformDefinitionAttributesInput']
|
||||
slug: /tools/sdk/powershell/v2024/models/attribute-mappings-all-of-transform-definition-attributes-input
|
||||
tags: ['SDK', 'Software Development Kit', 'AttributeMappingsAllOfTransformDefinitionAttributesInput', 'V2024AttributeMappingsAllOfTransformDefinitionAttributesInput']
|
||||
---
|
||||
|
||||
|
||||
# AttributeMappingsAllOfTransformDefinitionAttributesInput
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **String** | The Type of Attribute | [optional]
|
||||
**Attributes** | [**AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes**](attribute-mappings-all-of-transform-definition-attributes-input-attributes) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AttributeMappingsAllOfTransformDefinitionAttributesInput = Initialize-PSSailpoint.V2024AttributeMappingsAllOfTransformDefinitionAttributesInput -Type accountAttribute `
|
||||
-Attributes null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AttributeMappingsAllOfTransformDefinitionAttributesInput | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2024-attribute-mappings-all-of-transform-definition-attributes-input-attributes
|
||||
title: AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes
|
||||
pagination_label: AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes
|
||||
sidebar_label: AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes', 'V2024AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes']
|
||||
slug: /tools/sdk/powershell/v2024/models/attribute-mappings-all-of-transform-definition-attributes-input-attributes
|
||||
tags: ['SDK', 'Software Development Kit', 'AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes', 'V2024AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes']
|
||||
---
|
||||
|
||||
|
||||
# AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AttributeName** | **String** | The name of attribute | [optional]
|
||||
**SourceName** | **String** | Name of the Source | [optional]
|
||||
**Name** | **String** | ID of the Source | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes = Initialize-PSSailpoint.V2024AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes -AttributeName givenName `
|
||||
-SourceName delimited-src `
|
||||
-Name 8d3e0094e99445de98eef6c75e25jc04
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
id: v2024-machine-classification-config
|
||||
title: MachineClassificationConfig
|
||||
pagination_label: MachineClassificationConfig
|
||||
sidebar_label: MachineClassificationConfig
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'MachineClassificationConfig', 'V2024MachineClassificationConfig']
|
||||
slug: /tools/sdk/powershell/v2024/models/machine-classification-config
|
||||
tags: ['SDK', 'Software Development Kit', 'MachineClassificationConfig', 'V2024MachineClassificationConfig']
|
||||
---
|
||||
|
||||
|
||||
# MachineClassificationConfig
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Enabled** | **Boolean** | Indicates if the Classification is enabled for a Source | [optional] [default to $false]
|
||||
**ClassificationMethod** | **Enum** [ "SOURCE" ] | Classification Method | [optional]
|
||||
**Criteria** | **String** | A classification criteria object | [optional]
|
||||
**Created** | **System.DateTime** | Time when the config was created | [optional]
|
||||
**Modified** | **System.DateTime** | Time when the config was last updated | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$MachineClassificationConfig = Initialize-PSSailpoint.V2024MachineClassificationConfig -Enabled true `
|
||||
-ClassificationMethod SOURCE `
|
||||
-Criteria null `
|
||||
-Created 2017-07-11T18:45:37.098Z `
|
||||
-Modified 2018-06-25T20:22:28.104Z
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$MachineClassificationConfig | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: v2024-send-classify-machine-account200-response
|
||||
title: SendClassifyMachineAccount200Response
|
||||
pagination_label: SendClassifyMachineAccount200Response
|
||||
sidebar_label: SendClassifyMachineAccount200Response
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'SendClassifyMachineAccount200Response', 'V2024SendClassifyMachineAccount200Response']
|
||||
slug: /tools/sdk/powershell/v2024/models/send-classify-machine-account200-response
|
||||
tags: ['SDK', 'Software Development Kit', 'SendClassifyMachineAccount200Response', 'V2024SendClassifyMachineAccount200Response']
|
||||
---
|
||||
|
||||
|
||||
# SendClassifyMachineAccount200Response
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**IsMachine** | **Boolean** | Indicates if account is classified as machine | [optional] [default to $false]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$SendClassifyMachineAccount200Response = Initialize-PSSailpoint.V2024SendClassifyMachineAccount200Response -IsMachine true
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$SendClassifyMachineAccount200Response | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -887,7 +887,7 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## test-workflow
|
||||
::: info
|
||||
:::info
|
||||
|
||||
Workflow must be disabled in order to use this endpoint.
|
||||
|
||||
|
||||
@@ -897,7 +897,7 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## test-workflow
|
||||
::: info
|
||||
:::info
|
||||
|
||||
Workflow must be disabled in order to use this endpoint.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user