Skip to main content

sailpoint.v2024.MachineClassificationConfigApi

All URIs are relative to https://sailpoint.api.identitynow.com/v2024

MethodHTTP requestDescription
delete-machine-classification-configDELETE /sources/{sourceId}/machine-classification-configDelete Source's Classification Config
get-machine-classification-configGET /sources/{sourceId}/machine-classification-configMachine Classification Config for Source
set-machine-classification-configPUT /sources/{sourceId}/machine-classification-configUpdate Source's Classification Config

delete-machine-classification-config

Delete Source's 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

Parameters

Param TypeNameData TypeRequiredDescription
PathidstrTrueSource ID.

Return type

(empty response body)

Responses

CodeDescriptionData TypeResponse headers
200No content - indicates the request was successful but there is no content to be returned in the response.-
400Client Error - Returned if the request body is invalid.ErrorResponseDto-
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessProfiles401Response-
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto-
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto-
429Too 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-
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto-

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

from sailpoint.v2024.api.machine_classification_config_api import MachineClassificationConfigApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID. # str | Source ID.

try:
# Delete Source's Classification Config

MachineClassificationConfigApi(api_client).delete_machine_classification_config(id=id)
# Below is a request that includes all optional parameters
# MachineClassificationConfigApi(api_client).delete_machine_classification_config(id)
except Exception as e:
print("Exception when calling MachineClassificationConfigApi->delete_machine_classification_config: %s\n" % e)

[Back to top]

get-machine-classification-config

Machine Classification Config for Source This API returns a Machine Classification Config for a Source using Source ID.

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
PathidstrTrueSource ID

Return type

MachineClassificationConfig

Responses

CodeDescriptionData TypeResponse headers
200A Config ObjectMachineClassificationConfig-
400Client Error - Returned if the request body is invalid.ErrorResponseDto-
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessProfiles401Response-
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto-
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto-
429Too 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-
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto-

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

from sailpoint.v2024.api.machine_classification_config_api import MachineClassificationConfigApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.machine_classification_config import MachineClassificationConfig
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID # str | Source ID

try:
# Machine Classification Config for Source

results = MachineClassificationConfigApi(api_client).get_machine_classification_config(id=id)
# Below is a request that includes all optional parameters
# results = MachineClassificationConfigApi(api_client).get_machine_classification_config(id)
print("The response of MachineClassificationConfigApi->get_machine_classification_config:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MachineClassificationConfigApi->get_machine_classification_config: %s\n" % e)

[Back to top]

set-machine-classification-config

Update Source's 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

Parameters

Param TypeNameData TypeRequiredDescription
PathidstrTrueSource ID.
Bodymachine_classification_configMachineClassificationConfigTrue

Return type

MachineClassificationConfig

Responses

CodeDescriptionData TypeResponse headers
200Updated Machine Classification Config Object.MachineClassificationConfig-
400Client Error - Returned if the request body is invalid.ErrorResponseDto-
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessProfiles401Response-
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto-
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto-
429Too 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-
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto-

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

from sailpoint.v2024.api.machine_classification_config_api import MachineClassificationConfigApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.machine_classification_config import MachineClassificationConfig
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID. # str | Source ID.
machine_classification_config = '''{
"criteria" : "criteria",
"created" : "2017-07-11T18:45:37.098Z",
"modified" : "2018-06-25T20:22:28.104Z",
"classificationMethod" : "SOURCE",
"enabled" : true
}''' # MachineClassificationConfig |

try:
# Update Source's Classification Config
new_machine_classification_config = MachineClassificationConfig.from_json(machine_classification_config)
results = MachineClassificationConfigApi(api_client).set_machine_classification_config(id=id, machine_classification_config=new_machine_classification_config)
# Below is a request that includes all optional parameters
# results = MachineClassificationConfigApi(api_client).set_machine_classification_config(id, new_machine_classification_config)
print("The response of MachineClassificationConfigApi->set_machine_classification_config:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MachineClassificationConfigApi->set_machine_classification_config: %s\n" % e)

[Back to top]