MachineClassificationConfig
All URIs are relative to https://sailpoint.api.identitynow.com/v2024
Method | HTTP request | Description |
---|---|---|
Remove-V2024MachineClassificationConfig | DELETE /sources/{sourceId}/machine-classification-config | Delete Source's Classification Config |
Get-V2024MachineClassificationConfig | GET /sources/{sourceId}/machine-classification-config | Machine Classification Config for Source |
Set-V2024MachineClassificationConfig | 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.
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
$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
}
get-machine-classification-config
This API returns a Machine Classification Config for a Source using Source ID.
Parameters
Param Type | Name | Data Type | Required | Description |
---|---|---|---|---|
Path | Id | String | True | Source ID |
Return type
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
$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
}
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.
Parameters
Param Type | Name | Data Type | Required | Description |
---|---|---|---|---|
Path | Id | String | True | Source ID. |
Body | MachineClassificationConfig | MachineClassificationConfig | True |
Return type
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
$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
}