sailpoint.machine_accounts.MachineAccountsApi

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

Method	HTTP request	Description
create-machine-account-subtype-v1	POST `/sources/v1/{sourceId}/subtypes`	Create subtype
delete-machine-account-subtype-by-technical-name-v1	DELETE `/sources/v1/{sourceId}/subtypes/{technicalName}`	Delete subtype
get-machine-account-subtype-by-id-v1	GET `/sources/v1/subtypes/{subtypeId}`	Retrieve subtype by subtype id
get-machine-account-subtype-by-technical-name-v1	GET `/sources/v1/{sourceId}/subtypes/{technicalName}`	Retrieve subtype by source and technicalName
get-machine-account-v1	GET `/machine-accounts/v1/{id}`	Get machine account details
list-machine-account-subtypes-v1	GET `/sources/v1/{sourceId}/subtypes`	Retrieve all subtypes by source
list-machine-accounts-v1	GET `/machine-accounts/v1`	List machine accounts
patch-machine-account-subtype-by-technical-name-v1	PATCH `/sources/v1/{sourceId}/subtypes/{technicalName}`	Patch subtype
update-machine-account-v1	PATCH `/machine-accounts/v1/{id}`	Update machine account details

create-machine-account-subtype-v1

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

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 for a source.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	source_id	str	True	The ID of the source.
Body	create_machine_account_subtype_v1_request	CreateMachineAccountSubtypeV1Request	True
x_sail_point_experimental	str	(optional) (default to 'true')	Use this header to enable this experimental API.

Return type

SourceSubtype

Responses

Code	Description	Data Type	Response headers
201	Created machine account subtype.	SourceSubtype	-
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.	ListMachineAccountsV1401Response	-
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.	ListMachineAccountsV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

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

Example

from sailpoint.machine_accounts.api.machine_accounts_api import MachineAccountsApi
from sailpoint.machine_accounts.api_client import ApiClient
from sailpoint.machine_accounts.models.create_machine_account_subtype_v1_request import CreateMachineAccountSubtypeV1Request
from sailpoint.machine_accounts.models.source_subtype import SourceSubtype
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = True

with ApiClient(configuration) as api_client:
    source_id = '6d0458373bec4b4b80460992b76016da' # str | The ID of the source. # str | The ID of the source.
    create_machine_account_subtype_v1_request = '''{"technicalName":"foo","displayName":"Mr Foo","description":"fighters","type":"MACHINE"}''' # CreateMachineAccountSubtypeV1Request | 
    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_machine_account_subtype_v1_request = CreateMachineAccountSubtypeV1Request.from_json(create_machine_account_subtype_v1_request)
        results = MachineAccountsApi(api_client).create_machine_account_subtype_v1(source_id=source_id, create_machine_account_subtype_v1_request=new_create_machine_account_subtype_v1_request)
        # Below is a request that includes all optional parameters
        # results = MachineAccountsApi(api_client).create_machine_account_subtype_v1(source_id, new_create_machine_account_subtype_v1_request, x_sail_point_experimental)
        print("The response of MachineAccountsApi->create_machine_account_subtype_v1:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling MachineAccountsApi->create_machine_account_subtype_v1: %s\n" % e)

[Back to top]

delete-machine-account-subtype-by-technical-name-v1

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

experimental

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 Delete a machine account subtype by source ID and technical name.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	source_id	str	True	The ID of the source.
Path	technical_name	str	True	The technical name of the subtype.
x_sail_point_experimental	str	(optional) (default to 'true')	Use this header to enable this experimental API.

Return type

(empty response body)

Responses

Code	Description	Data Type	Response headers
204	Subtype deleted successfully.		-
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.	ListMachineAccountsV1401Response	-
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.	ListMachineAccountsV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

from sailpoint.machine_accounts.api.machine_accounts_api import MachineAccountsApi
from sailpoint.machine_accounts.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = True

with ApiClient(configuration) as api_client:
    source_id = '6d0458373bec4b4b80460992b76016da' # str | The ID of the source. # str | The ID of the source.
    technical_name = 'foo' # str | The technical name of the subtype. # str | The technical name 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
        
        MachineAccountsApi(api_client).delete_machine_account_subtype_by_technical_name_v1(source_id=source_id, technical_name=technical_name)
        # Below is a request that includes all optional parameters
        # MachineAccountsApi(api_client).delete_machine_account_subtype_by_technical_name_v1(source_id, technical_name, x_sail_point_experimental)
    except Exception as e:
        print("Exception when calling MachineAccountsApi->delete_machine_account_subtype_by_technical_name_v1: %s\n" % e)

[Back to top]

get-machine-account-subtype-by-id-v1

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

experimental

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 subtype by subtype id Get a machine account subtype by its unique ID.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	subtype_id	str	True	The ID of the machine account subtype.
x_sail_point_experimental	str	(optional) (default to 'true')	Use this header to enable this experimental API.

Return type

SourceSubtype

Responses

Code	Description	Data Type	Response headers
200	Machine account subtype object.	SourceSubtype	-
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.	ListMachineAccountsV1401Response	-
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.	ListMachineAccountsV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

from sailpoint.machine_accounts.api.machine_accounts_api import MachineAccountsApi
from sailpoint.machine_accounts.api_client import ApiClient
from sailpoint.machine_accounts.models.source_subtype import SourceSubtype
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = True

with ApiClient(configuration) as api_client:
    subtype_id = '43bdd144-4b17-4fce-a744-17c7fd3e717b' # str | The ID of the machine account subtype. # str | The ID of the machine account 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:
        # Retrieve subtype by subtype id
        
        results = MachineAccountsApi(api_client).get_machine_account_subtype_by_id_v1(subtype_id=subtype_id)
        # Below is a request that includes all optional parameters
        # results = MachineAccountsApi(api_client).get_machine_account_subtype_by_id_v1(subtype_id, x_sail_point_experimental)
        print("The response of MachineAccountsApi->get_machine_account_subtype_by_id_v1:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling MachineAccountsApi->get_machine_account_subtype_by_id_v1: %s\n" % e)

[Back to top]

get-machine-account-subtype-by-technical-name-v1

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

experimental

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 subtype by source and technicalName Get a machine account subtype by source ID and technical name.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	source_id	str	True	The ID of the source.
Path	technical_name	str	True	The technical name of the subtype.
x_sail_point_experimental	str	(optional) (default to 'true')	Use this header to enable this experimental API.

Return type

SourceSubtype

Responses

Code	Description	Data Type	Response headers
200	Machine account subtype object.	SourceSubtype	-
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.	ListMachineAccountsV1401Response	-
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.	ListMachineAccountsV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

from sailpoint.machine_accounts.api.machine_accounts_api import MachineAccountsApi
from sailpoint.machine_accounts.api_client import ApiClient
from sailpoint.machine_accounts.models.source_subtype import SourceSubtype
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = True

with ApiClient(configuration) as api_client:
    source_id = '6d0458373bec4b4b80460992b76016da' # str | The ID of the source. # str | The ID of the source.
    technical_name = 'foo' # str | The technical name of the subtype. # str | The technical name 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:
        # Retrieve subtype by source and technicalName
        
        results = MachineAccountsApi(api_client).get_machine_account_subtype_by_technical_name_v1(source_id=source_id, technical_name=technical_name)
        # Below is a request that includes all optional parameters
        # results = MachineAccountsApi(api_client).get_machine_account_subtype_by_technical_name_v1(source_id, technical_name, x_sail_point_experimental)
        print("The response of MachineAccountsApi->get_machine_account_subtype_by_technical_name_v1:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling MachineAccountsApi->get_machine_account_subtype_by_technical_name_v1: %s\n" % e)

[Back to top]

get-machine-account-v1

experimental

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 machine account details Use this API to return the details for a single machine account by its ID.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	id	str	True	Machine Account ID.
x_sail_point_experimental	str	(optional) (default to 'true')	Use this header to enable this experimental API.

Return type

MachineAccount

Responses

Code	Description	Data Type	Response headers
200	Machine Account object.	MachineAccount	-
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.	ListMachineAccountsV1401Response	-
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.	ListMachineAccountsV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

from sailpoint.machine_accounts.api.machine_accounts_api import MachineAccountsApi
from sailpoint.machine_accounts.api_client import ApiClient
from sailpoint.machine_accounts.models.machine_account import MachineAccount
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = True

with ApiClient(configuration) as api_client:
    id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID.
    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 machine account details
        
        results = MachineAccountsApi(api_client).get_machine_account_v1(id=id)
        # Below is a request that includes all optional parameters
        # results = MachineAccountsApi(api_client).get_machine_account_v1(id, x_sail_point_experimental)
        print("The response of MachineAccountsApi->get_machine_account_v1:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling MachineAccountsApi->get_machine_account_v1: %s\n" % e)

[Back to top]

list-machine-account-subtypes-v1

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

experimental

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 by source Get all machine account subtypes for a given source.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	source_id	str	True	The ID of the source.
Query	filters	str	(optional)	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: displayName: eq, sw technicalName: eq, sw
Query	sorters	str	(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_experimental	str	(optional) (default to 'true')	Use this header to enable this experimental API.
Query	count	bool	(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.
Query	limit	int	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query	offset	int	(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[SourceSubtype]

Responses

Code	Description	Data Type	Response headers
200	List of machine account subtypes.	List[SourceSubtype]	-
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.	ListMachineAccountsV1401Response	-
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.	ListMachineAccountsV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

from sailpoint.machine_accounts.api.machine_accounts_api import MachineAccountsApi
from sailpoint.machine_accounts.api_client import ApiClient
from sailpoint.machine_accounts.models.source_subtype import SourceSubtype
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = True

with ApiClient(configuration) as api_client:
    source_id = '6d0458373bec4b4b80460992b76016da' # str | The ID of the source. # str | The ID of the source.
    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:  **displayName**: *eq, sw*  **technicalName**: *eq, sw* (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:  **displayName**: *eq, sw*  **technicalName**: *eq, sw* (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 by source
        
        results = MachineAccountsApi(api_client).list_machine_account_subtypes_v1(source_id=source_id)
        # Below is a request that includes all optional parameters
        # results = MachineAccountsApi(api_client).list_machine_account_subtypes_v1(source_id, filters, sorters, x_sail_point_experimental, count, limit, offset)
        print("The response of MachineAccountsApi->list_machine_account_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 MachineAccountsApi->list_machine_account_subtypes_v1: %s\n" % e)

[Back to top]

list-machine-accounts-v1

experimental

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

List machine accounts This returns a list of machine accounts.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Query	limit	int	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query	offset	int	(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.
Query	count	bool	(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.
Query	filters	str	(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 name: eq, in, sw nativeIdentity: eq, in, sw uuid: eq, in description: eq, in, sw machineIdentity.id: eq, in machineIdentity.name: eq, in, sw subtype.technicalName: eq, in, sw subtype.displayName: eq, in, sw accessType: eq, in, sw environment: eq, in, sw ownerIdentity: eq, in ownerIdentity.id: eq, in ownerIdentity.name: eq, in, sw manuallyCorrelated: eq enabled: eq locked: eq hasEntitlements: eq attributes: eq source.id: eq, in source.name: eq, in, sw created: eq, gt, lt, ge, le modified: eq, gt, lt, ge, le
Query	sorters	str	(optional)	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: id, name, nativeIdentity, ownerIdentity, uuid, description, machineIdentity.id, machineIdentity.name, subtype.technicalName, subtype.displayName, accessType, environment, manuallyCorrelated, enabled, locked, hasEntitlements, ownerIdentity.id, ownerIdentity.name, attributes, source.id, source.name, created, modified
x_sail_point_experimental	str	(optional) (default to 'true')	Use this header to enable this experimental API.

Return type

List[MachineAccount]

Responses

Code	Description	Data Type	Response headers
200	List of machine account objects	List[MachineAccount]	-
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.	ListMachineAccountsV1401Response	-
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.	ListMachineAccountsV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

from sailpoint.machine_accounts.api.machine_accounts_api import MachineAccountsApi
from sailpoint.machine_accounts.api_client import ApiClient
from sailpoint.machine_accounts.models.machine_account import MachineAccount
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = True

with ApiClient(configuration) as api_client:
    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)
    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)
    filters = 'hasEntitlements eq true' # 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*  **name**: *eq, in, sw*  **nativeIdentity**: *eq, in, sw*  **uuid**: *eq, in*  **description**: *eq, in, sw*  **machineIdentity.id**: *eq, in*  **machineIdentity.name**: *eq, in, sw*  **subtype.technicalName**: *eq, in, sw*  **subtype.displayName**: *eq, in, sw*  **accessType**: *eq, in, sw*  **environment**: *eq, in, sw*  **ownerIdentity**: *eq, in*  **ownerIdentity.id**: *eq, in*  **ownerIdentity.name**: *eq, in, sw*  **manuallyCorrelated**: *eq*  **enabled**: *eq*  **locked**: *eq*  **hasEntitlements**: *eq*  **attributes**: *eq*  **source.id**: *eq, in*  **source.name**: *eq, in, sw*  **created**: *eq, gt, lt, ge, le*  **modified**: *eq, gt, lt, ge, le* (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*  **name**: *eq, in, sw*  **nativeIdentity**: *eq, in, sw*  **uuid**: *eq, in*  **description**: *eq, in, sw*  **machineIdentity.id**: *eq, in*  **machineIdentity.name**: *eq, in, sw*  **subtype.technicalName**: *eq, in, sw*  **subtype.displayName**: *eq, in, sw*  **accessType**: *eq, in, sw*  **environment**: *eq, in, sw*  **ownerIdentity**: *eq, in*  **ownerIdentity.id**: *eq, in*  **ownerIdentity.name**: *eq, in, sw*  **manuallyCorrelated**: *eq*  **enabled**: *eq*  **locked**: *eq*  **hasEntitlements**: *eq*  **attributes**: *eq*  **source.id**: *eq, in*  **source.name**: *eq, in, sw*  **created**: *eq, gt, lt, ge, le*  **modified**: *eq, gt, lt, ge, le* (optional)
    sorters = 'id,name' # 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: **id, name, nativeIdentity, ownerIdentity, uuid, description, machineIdentity.id, machineIdentity.name, subtype.technicalName, subtype.displayName, accessType, environment, manuallyCorrelated, enabled, locked, hasEntitlements, ownerIdentity.id, ownerIdentity.name, attributes, source.id, source.name, created, modified** (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: **id, name, nativeIdentity, ownerIdentity, uuid, description, machineIdentity.id, machineIdentity.name, subtype.technicalName, subtype.displayName, accessType, environment, manuallyCorrelated, enabled, locked, hasEntitlements, ownerIdentity.id, ownerIdentity.name, attributes, source.id, source.name, created, modified** (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')

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

[Back to top]

patch-machine-account-subtype-by-technical-name-v1

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

experimental

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 Update fields of a machine account subtype by source ID and technical name. Patchable fields include: displayName, description.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	source_id	str	True	The ID of the source.
Path	technical_name	str	True	The technical name of the subtype.
Body	request_body	[]object	True	A JSON of updated values JSON Patch standard.
x_sail_point_experimental	str	(optional) (default to 'true')	Use this header to enable this experimental API.

Return type

SourceSubtype

Responses

Code	Description	Data Type	Response headers
200	Updated machine account subtype.	SourceSubtype	-
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.	ListMachineAccountsV1401Response	-
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.	ListMachineAccountsV1429Response	-
500	Internal 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_accounts.api.machine_accounts_api import MachineAccountsApi
from sailpoint.machine_accounts.api_client import ApiClient
from sailpoint.machine_accounts.models.source_subtype import SourceSubtype
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = True

with ApiClient(configuration) as api_client:
    source_id = '6d0458373bec4b4b80460992b76016da' # str | The ID of the source. # str | The ID of the source.
    technical_name = 'foo' # str | The technical name of the subtype. # str | The technical name 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
        new_request_body = RequestBody.from_json(request_body)
        results = MachineAccountsApi(api_client).patch_machine_account_subtype_by_technical_name_v1(source_id=source_id, technical_name=technical_name, request_body=new_request_body)
        # Below is a request that includes all optional parameters
        # results = MachineAccountsApi(api_client).patch_machine_account_subtype_by_technical_name_v1(source_id, technical_name, new_request_body, x_sail_point_experimental)
        print("The response of MachineAccountsApi->patch_machine_account_subtype_by_technical_name_v1:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling MachineAccountsApi->patch_machine_account_subtype_by_technical_name_v1: %s\n" % e)

[Back to top]

update-machine-account-v1

experimental

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

Update machine account details Use this API to update machine accounts details.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	id	str	True	Machine Account ID.
Body	request_body	[]object	True	A JSON of updated values JSON Patch standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes
x_sail_point_experimental	str	(optional) (default to 'true')	Use this header to enable this experimental API.

Return type

MachineAccount

Responses

Code	Description	Data Type	Response headers
200	Updated Machine Account object.	MachineAccount	-
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.	ListMachineAccountsV1401Response	-
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.	ListMachineAccountsV1429Response	-
500	Internal 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_accounts.api.machine_accounts_api import MachineAccountsApi
from sailpoint.machine_accounts.api_client import ApiClient
from sailpoint.machine_accounts.models.machine_account import MachineAccount
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = True

with ApiClient(configuration) as api_client:
    id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID.
    request_body = '''[{"op":"add","path":"/environment","value":"test"}]''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable:           * description           * ownerIdentity           * subType           * accessType           * environment           * attributes           * classificationMethod           * manuallyEdited           * nativeIdentity           * uuid           * source           * manuallyCorrelated           * enabled           * locked           * hasEntitlements           * connectorAttributes
    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:
        # Update machine account details
        new_request_body = RequestBody.from_json(request_body)
        results = MachineAccountsApi(api_client).update_machine_account_v1(id=id, request_body=new_request_body)
        # Below is a request that includes all optional parameters
        # results = MachineAccountsApi(api_client).update_machine_account_v1(id, new_request_body, x_sail_point_experimental)
        print("The response of MachineAccountsApi->update_machine_account_v1:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling MachineAccountsApi->update_machine_account_v1: %s\n" % e)

[Back to top]

create-machine-account-subtype-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

delete-machine-account-subtype-by-technical-name-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-machine-account-subtype-by-id-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-machine-account-subtype-by-technical-name-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-machine-account-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

list-machine-account-subtypes-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

list-machine-accounts-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

patch-machine-account-subtype-by-technical-name-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

update-machine-account-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

create-machine-account-subtype-v1

Parameters

Return type

Responses

HTTP request headers

Example

delete-machine-account-subtype-by-technical-name-v1

Parameters

Return type

Responses

HTTP request headers

Example

get-machine-account-subtype-by-id-v1

Parameters

Return type

Responses

HTTP request headers

Example

get-machine-account-subtype-by-technical-name-v1

Parameters

Return type

Responses

HTTP request headers

Example

get-machine-account-v1

Parameters

Return type

Responses

HTTP request headers

Example

list-machine-account-subtypes-v1

Parameters

Return type

Responses

HTTP request headers

Example

list-machine-accounts-v1

Parameters

Return type

Responses

HTTP request headers

Example

patch-machine-account-subtype-by-technical-name-v1

Parameters

Return type

Responses

HTTP request headers

Example

update-machine-account-v1

Parameters

Return type

Responses

HTTP request headers

Example