mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 12:27:47 +00:00
Update PowerShell SDK docs: 15781241582
This commit is contained in:
@@ -0,0 +1,69 @@
|
||||
---
|
||||
id: v2025-machine-account-classify
|
||||
title: MachineAccountClassify
|
||||
pagination_label: MachineAccountClassify
|
||||
sidebar_label: MachineAccountClassify
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'MachineAccountClassify', 'V2025MachineAccountClassify']
|
||||
slug: /tools/sdk/powershell/v2025/methods/machine-account-classify
|
||||
tags: ['SDK', 'Software Development Kit', 'MachineAccountClassify', 'V2025MachineAccountClassify']
|
||||
---
|
||||
|
||||
# MachineAccountClassify
|
||||
|
||||
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2025*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**Send-V2025ClassifyMachineAccount**](#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/v2025/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-V2025ClassifyMachineAccount -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Send-V2025ClassifyMachineAccount -Id $Id -ClassificationMode $ClassificationMode
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ClassifyMachineAccount"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
Reference in New Issue
Block a user