Update python SDK docs: 15116515953

This commit is contained in:
developer-relations-sp
2025-05-19 15:05:01 +00:00
parent d73e77c393
commit c8938e0862
279 changed files with 7276 additions and 7276 deletions

View File

@@ -15,9 +15,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-machine-account**](#get-machine-account) | **GET** `/machine-accounts/{id}` | Machine Account Details
[**list-machine-accounts**](#list-machine-accounts) | **GET** `/machine-accounts` | Machine Accounts List
[**update-machine-account**](#update-machine-account) | **PATCH** `/machine-accounts/{id}` | Update a Machine Account
[**get-machine-account**](#get-machine-account) | **GET** `/machine-accounts/{id}` | Machine account details
[**list-machine-accounts**](#list-machine-accounts) | **GET** `/machine-accounts` | Machine accounts list
[**update-machine-account**](#update-machine-account) | **PATCH** `/machine-accounts/{id}` | Update a machine account
## get-machine-account
@@ -32,7 +32,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Machine Account Details
Machine account details
Use this API to return the details for a single machine account by its ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-machine-account)
@@ -78,7 +78,7 @@ 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')
try:
# Machine Account Details
# Machine account details
results = MachineAccountsApi(api_client).get_machine_account(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -105,7 +105,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Machine Accounts List
Machine accounts list
This returns a list of machine accounts.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-machine-accounts)
@@ -159,7 +159,7 @@ with ApiClient(configuration) as api_client:
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, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (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, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional)
try:
# Machine Accounts List
# Machine accounts list
results = MachineAccountsApi(api_client).list_machine_accounts(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -187,7 +187,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Update a Machine Account
Update a machine account
Use this API to update machine accounts details.
@@ -236,7 +236,7 @@ with ApiClient(configuration) as api_client:
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
try:
# Update a Machine Account
# Update a machine account
new_request_body = RequestBody.from_json(request_body)
results = MachineAccountsApi(api_client).update_machine_account(id=id, x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body)
# Below is a request that includes all optional parameters