Skip to main content

sailpoint.machine_account_subtypes.MachineAccountSubtypesApi

Use this API to get, update, and delete machine account subtype for sources.

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

MethodHTTP requestDescription
create-source-subtype-v1POST /source-subtypes/v1Create subtype
delete-machine-account-subtype-v1DELETE /source-subtypes/v1/{subtypeId}Delete subtype by ID
get-machine-account-subtype-approval-config-v1GET /source-subtypes/v1/{subtypeId}/machine-configMachine Subtype Approval Config
get-source-subtype-by-id-v1GET /source-subtypes/v1/{subtypeId}Get subtype by ID
list-source-subtypes-v1GET /source-subtypes/v1Retrieve all subtypes
load-bulk-source-subtypes-v1POST /source-subtypes/v1/bulk-retrieveBulk Retrieve of Source Subtypes
patch-machine-account-subtype-v1PATCH /source-subtypes/v1/{subtypeId}Patch subtype by ID
update-machine-account-subtype-approval-config-v1PATCH /source-subtypes/v1/{subtypeId}/machine-configMachine Subtype Approval Config

create-source-subtype-v1

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

setting x-sailpoint-experimental header

on the configuration object you can set the x-sailpoint-experimental header to `true' to enable all experimantl endpoints within the SDK. Example:

  configuration = Configuration()
configuration.experimental = True

Create subtype Create a new machine account subtype.

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
Bodycreate_source_subtype_v1_requestCreateSourceSubtypeV1RequestTrue
x_sail_point_experimentalstr(optional) (default to 'true')Use this header to enable this experimental API.

Return type

SourceSubtypeWithSource

Responses

CodeDescriptionData TypeResponse headers
201Created machine account subtype.SourceSubtypeWithSource-
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.LoadBulkSourceSubtypesV1401Response-
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto-
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.LoadBulkSourceSubtypesV1429Response-
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto-

HTTP request headers

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

Example

from sailpoint.machine_account_subtypes.api.machine_account_subtypes_api import MachineAccountSubtypesApi
from sailpoint.machine_account_subtypes.api_client import ApiClient
from sailpoint.machine_account_subtypes.models.create_source_subtype_v1_request import CreateSourceSubtypeV1Request
from sailpoint.machine_account_subtypes.models.source_subtype_with_source import SourceSubtypeWithSource
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = True

with ApiClient(configuration) as api_client:
create_source_subtype_v1_request = '''{"sourceId":"6d0458373bec4b4b80460992b76016da","technicalName":"foo","displayName":"Mr Foo","description":"fighters","type":"MACHINE"}''' # CreateSourceSubtypeV1Request |
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (optional) (default to 'true') # str | Use this header to enable this experimental API. (optional) (default to 'true')

try:
# Create subtype
new_create_source_subtype_v1_request = CreateSourceSubtypeV1Request.from_json(create_source_subtype_v1_request)
results = MachineAccountSubtypesApi(api_client).create_source_subtype_v1(create_source_subtype_v1_request=new_create_source_subtype_v1_request)
# Below is a request that includes all optional parameters
# results = MachineAccountSubtypesApi(api_client).create_source_subtype_v1(new_create_source_subtype_v1_request, x_sail_point_experimental)
print("The response of MachineAccountSubtypesApi->create_source_subtype_v1:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MachineAccountSubtypesApi->create_source_subtype_v1: %s\n" % e)

[Back to top]

delete-machine-account-subtype-v1

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

setting x-sailpoint-experimental header

on the configuration object you can set the x-sailpoint-experimental header to `true' to enable all experimantl endpoints within the SDK. Example:

  configuration = Configuration()
configuration.experimental = True

Delete subtype by ID Delete a machine account subtype by subtype ID.

Note: If subtype has approval settings or entitlement for machine account creation enablement then it'll be also deleted.

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
Pathsubtype_idstrTrueThe ID of the subtype.
x_sail_point_experimentalstr(optional) (default to 'true')Use this header to enable this experimental API.

Return type

(empty response body)

Responses

CodeDescriptionData TypeResponse headers
204Subtype deleted successfully.-
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.LoadBulkSourceSubtypesV1401Response-
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto-
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.LoadBulkSourceSubtypesV1429Response-
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto-

HTTP request headers

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

Example

from sailpoint.machine_account_subtypes.api.machine_account_subtypes_api import MachineAccountSubtypesApi
from sailpoint.machine_account_subtypes.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = True

with ApiClient(configuration) as api_client:
subtype_id = '6d28b7c1-620c-49c6-b6d5-cbf81eb4b5fa' # str | The ID of the subtype. # str | The ID of the subtype.
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (optional) (default to 'true') # str | Use this header to enable this experimental API. (optional) (default to 'true')

try:
# Delete subtype by ID

MachineAccountSubtypesApi(api_client).delete_machine_account_subtype_v1(subtype_id=subtype_id)
# Below is a request that includes all optional parameters
# MachineAccountSubtypesApi(api_client).delete_machine_account_subtype_v1(subtype_id, x_sail_point_experimental)
except Exception as e:
print("Exception when calling MachineAccountSubtypesApi->delete_machine_account_subtype_v1: %s\n" % e)

[Back to top]

get-machine-account-subtype-approval-config-v1

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

setting x-sailpoint-experimental header

on the configuration object you can set the x-sailpoint-experimental header to `true' to enable all experimantl endpoints within the SDK. Example:

  configuration = Configuration()
configuration.experimental = True

Machine Subtype Approval Config This endpoint retrieves the approval configuration for machine account creation and deletion at the machine subtype level. By providing a specific subtypeId in the path, clients can fetch the approval rules and settings (such as required approvers and comments policy) that govern account creation and deletion for that particular machine subtype. The response includes a MachineAccountSubtypeConfigDto object detailing these configurations, enabling clients to understand or display the approval workflow required for creating and deleting machine accounts of the given subtype. Use this endpoint to get machine subtype level approval config for account creation and deletion.

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
x_sail_point_experimentalstrTrue (default to 'true')Use this header to enable this experimental API.
Pathsubtype_idstrTruemachine subtype id.

Return type

MachineAccountSubtypeConfigDto

Responses

CodeDescriptionData TypeResponse headers
200Responds with a MachineAccountSubtypeConfigDto for machine account creation and deletion approval config by subtypeId.MachineAccountSubtypeConfigDto-
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.LoadBulkSourceSubtypesV1401Response-
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.LoadBulkSourceSubtypesV1429Response-
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto-

HTTP request headers

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

Example

from sailpoint.machine_account_subtypes.api.machine_account_subtypes_api import MachineAccountSubtypesApi
from sailpoint.machine_account_subtypes.api_client import ApiClient
from sailpoint.machine_account_subtypes.models.machine_account_subtype_config_dto import MachineAccountSubtypeConfigDto
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = True

with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
subtype_id = 'ef38f94347e94562b5bb8424a56498d8' # str | machine subtype id. # str | machine subtype id.

try:
# Machine Subtype Approval Config

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

[Back to top]

get-source-subtype-by-id-v1

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

setting x-sailpoint-experimental header

on the configuration object you can set the x-sailpoint-experimental header to `true' to enable all experimantl endpoints within the SDK. Example:

  configuration = Configuration()
configuration.experimental = True

Get subtype by ID Get a machine account subtype by subtype ID.

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
Pathsubtype_idstrTrueThe ID of the subtype.
x_sail_point_experimentalstr(optional) (default to 'true')Use this header to enable this experimental API.

Return type

SourceSubtypeWithSource

Responses

CodeDescriptionData TypeResponse headers
200Machine account subtype object.SourceSubtypeWithSource-
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.LoadBulkSourceSubtypesV1401Response-
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.LoadBulkSourceSubtypesV1429Response-
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto-

HTTP request headers

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

Example

from sailpoint.machine_account_subtypes.api.machine_account_subtypes_api import MachineAccountSubtypesApi
from sailpoint.machine_account_subtypes.api_client import ApiClient
from sailpoint.machine_account_subtypes.models.source_subtype_with_source import SourceSubtypeWithSource
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = True

with ApiClient(configuration) as api_client:
subtype_id = '6d28b7c1-620c-49c6-b6d5-cbf81eb4b5fa' # str | The ID of the subtype. # str | The ID of the subtype.
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (optional) (default to 'true') # str | Use this header to enable this experimental API. (optional) (default to 'true')

try:
# Get subtype by ID

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

[Back to top]

list-source-subtypes-v1

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

setting x-sailpoint-experimental header

on the configuration object you can set the x-sailpoint-experimental header to `true' to enable all experimantl endpoints within the SDK. Example:

  configuration = Configuration()
configuration.experimental = True

Retrieve all subtypes Get all machine account subtypes.

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
Queryfiltersstr(optional)Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: id: eq, in, sw displayName: eq, sw technicalName: eq, sw source.id: eq, in
Querysortersstr(optional)Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: displayName, technicalName
x_sail_point_experimentalstr(optional) (default to 'true')Use this header to enable this experimental API.
Querycountbool(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 for more information.
Querylimitint(optional) (default to 250)Max number of results to return. See V3 API Standard Collection Parameters for more information.
Queryoffsetint(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 for more information.

Return type

List[SourceSubtypeWithSource]

Responses

CodeDescriptionData TypeResponse headers
200List of machine account subtypes.List[SourceSubtypeWithSource]-
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.LoadBulkSourceSubtypesV1401Response-
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto-
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.LoadBulkSourceSubtypesV1429Response-
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto-

HTTP request headers

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

Example

from sailpoint.machine_account_subtypes.api.machine_account_subtypes_api import MachineAccountSubtypesApi
from sailpoint.machine_account_subtypes.api_client import ApiClient
from sailpoint.machine_account_subtypes.models.source_subtype_with_source import SourceSubtypeWithSource
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = True

with ApiClient(configuration) as api_client:
filters = 'displayName eq \"sail\"' # str | 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, sw* **technicalName**: *eq, sw* **source.id**: *eq, in* (optional) # str | 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, sw* **technicalName**: *eq, sw* **source.id**: *eq, in* (optional)
sorters = 'displayName' # str | 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: **displayName, technicalName** (optional) # str | 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: **displayName, technicalName** (optional)
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (optional) (default to 'true') # str | Use this header to enable this experimental API. (optional) (default to 'true')
count = False # bool | 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) # bool | 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 # int | 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) # int | 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 # int | 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) # int | 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)

try:
# Retrieve all subtypes

results = MachineAccountSubtypesApi(api_client).list_source_subtypes_v1()
# Below is a request that includes all optional parameters
# results = MachineAccountSubtypesApi(api_client).list_source_subtypes_v1(filters, sorters, x_sail_point_experimental, count, limit, offset)
print("The response of MachineAccountSubtypesApi->list_source_subtypes_v1:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MachineAccountSubtypesApi->list_source_subtypes_v1: %s\n" % e)

[Back to top]

load-bulk-source-subtypes-v1

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

setting x-sailpoint-experimental header

on the configuration object you can set the x-sailpoint-experimental header to `true' to enable all experimantl endpoints within the SDK. Example:

  configuration = Configuration()
configuration.experimental = True

Bulk Retrieve of Source Subtypes This endpoint retrieves the subtypes for given subtypeIds.

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
x_sail_point_experimentalstrTrue (default to 'true')Use this header to enable this experimental API.
Bodyrequest_body[]strTrue

Return type

List[SourceSubtypeWithSource]

Responses

CodeDescriptionData TypeResponse headers
200List of source subtypes.List[SourceSubtypeWithSource]-
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.LoadBulkSourceSubtypesV1401Response-
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.LoadBulkSourceSubtypesV1429Response-
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto-

HTTP request headers

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

Example

from sailpoint.machine_account_subtypes.api.machine_account_subtypes_api import MachineAccountSubtypesApi
from sailpoint.machine_account_subtypes.api_client import ApiClient
from sailpoint.machine_account_subtypes.models.source_subtype_with_source import SourceSubtypeWithSource
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = True

with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
request_body = '''['request_body_example']''' # List[str] |

try:
# Bulk Retrieve of Source Subtypes
new_request_body = RequestBody.from_json(request_body)
results = MachineAccountSubtypesApi(api_client).load_bulk_source_subtypes_v1(x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body)
# Below is a request that includes all optional parameters
# results = MachineAccountSubtypesApi(api_client).load_bulk_source_subtypes_v1(x_sail_point_experimental, new_request_body)
print("The response of MachineAccountSubtypesApi->load_bulk_source_subtypes_v1:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MachineAccountSubtypesApi->load_bulk_source_subtypes_v1: %s\n" % e)

[Back to top]

patch-machine-account-subtype-v1

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

setting x-sailpoint-experimental header

on the configuration object you can set the x-sailpoint-experimental header to `true' to enable all experimantl endpoints within the SDK. Example:

  configuration = Configuration()
configuration.experimental = True

Patch subtype by ID Update fields of a machine account subtype by subtype ID. Patchable fields only include: displayName, description.

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
Pathsubtype_idstrTrueThe ID of the subtype.
Bodyrequest_body[]objectTrueA JSON of updated values JSON Patch standard.
x_sail_point_experimentalstr(optional) (default to 'true')Use this header to enable this experimental API.

Return type

SourceSubtypeWithSource

Responses

CodeDescriptionData TypeResponse headers
200Updated machine account subtype.SourceSubtypeWithSource-
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.LoadBulkSourceSubtypesV1401Response-
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto-
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.LoadBulkSourceSubtypesV1429Response-
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto-

HTTP request headers

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

Example

from sailpoint.machine_account_subtypes.api.machine_account_subtypes_api import MachineAccountSubtypesApi
from sailpoint.machine_account_subtypes.api_client import ApiClient
from sailpoint.machine_account_subtypes.models.source_subtype_with_source import SourceSubtypeWithSource
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = True

with ApiClient(configuration) as api_client:
subtype_id = '6d28b7c1-620c-49c6-b6d5-cbf81eb4b5fa' # str | The ID of the subtype. # str | The ID of the subtype.
request_body = '''[{"op":"replace","path":"/displayName","value":"Test New DisplayName"}]''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (optional) (default to 'true') # str | Use this header to enable this experimental API. (optional) (default to 'true')

try:
# Patch subtype by ID
new_request_body = RequestBody.from_json(request_body)
results = MachineAccountSubtypesApi(api_client).patch_machine_account_subtype_v1(subtype_id=subtype_id, request_body=new_request_body)
# Below is a request that includes all optional parameters
# results = MachineAccountSubtypesApi(api_client).patch_machine_account_subtype_v1(subtype_id, new_request_body, x_sail_point_experimental)
print("The response of MachineAccountSubtypesApi->patch_machine_account_subtype_v1:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MachineAccountSubtypesApi->patch_machine_account_subtype_v1: %s\n" % e)

[Back to top]

update-machine-account-subtype-approval-config-v1

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

setting x-sailpoint-experimental header

on the configuration object you can set the x-sailpoint-experimental header to `true' to enable all experimantl endpoints within the SDK. Example:

  configuration = Configuration()
configuration.experimental = True

Machine Subtype Approval Config Updates the approval configuration for machine account deletion at the specified machine subtype level. This endpoint allows clients to modify approval rules and settings (such as required approvers and comments policy) for account creation and deletion workflows associated with a given subtypeId. Use this to customize or enforce approval requirements for creating and deleting machine accounts of a particular subtype.

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
x_sail_point_experimentalstrTrue (default to 'true')Use this header to enable this experimental API.
Pathsubtype_idstrTruemachine account subtype ID.
Bodyjson_patch_operation[]JsonPatchOperationTrueThe JSONPatch payload used to update the object.

Return type

MachineAccountSubtypeConfigDto

Responses

CodeDescriptionData TypeResponse headers
200This response indicates the PATCH operation succeeded and the API returns the updated MachineAccountSubtypeConfigDto object.MachineAccountSubtypeConfigDto-
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.LoadBulkSourceSubtypesV1401Response-
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.LoadBulkSourceSubtypesV1429Response-
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto-

HTTP request headers

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

Example

from sailpoint.machine_account_subtypes.api.machine_account_subtypes_api import MachineAccountSubtypesApi
from sailpoint.machine_account_subtypes.api_client import ApiClient
from sailpoint.machine_account_subtypes.models.json_patch_operation import JsonPatchOperation
from sailpoint.machine_account_subtypes.models.machine_account_subtype_config_dto import MachineAccountSubtypeConfigDto
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = True

with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
subtype_id = '00eebcf881994e419d72e757fd30dc0e' # str | machine account subtype ID. # str | machine account subtype ID.
json_patch_operation = '''[sailpoint.machine_account_subtypes.JsonPatchOperation()]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the object.

try:
# Machine Subtype Approval Config
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = MachineAccountSubtypesApi(api_client).update_machine_account_subtype_approval_config_v1(x_sail_point_experimental=x_sail_point_experimental, subtype_id=subtype_id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = MachineAccountSubtypesApi(api_client).update_machine_account_subtype_approval_config_v1(x_sail_point_experimental, subtype_id, new_json_patch_operation)
print("The response of MachineAccountSubtypesApi->update_machine_account_subtype_approval_config_v1:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MachineAccountSubtypesApi->update_machine_account_subtype_approval_config_v1: %s\n" % e)

[Back to top]