LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 20:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
aa76768244a5330a95ccd590194f4a2a94a5711a
developer.sailpoint.com/docs/tools/sdk/python/Reference/V3/Methods/ManagedClientsApi.md
darrell-thobe-sp aa76768244 update layout for method examples
2025-02-25 11:46:14 -05:00

21 KiB
Raw Blame History

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags
id title pagination_label sidebar_label sidebar_class_name keywords slug tags
managed-clients Managed_Clients Managed_Clients Managed_Clients pythonsdk
python
Python
sdk
Managed_Clients
Managed_Clients
/tools/sdk/python/v3/methods/managed-clients
SDK
Software Development Kit
Managed_Clients
Managed_Clients

sailpoint.v3.ManagedClientsApi

Use this API to implement managed client functionality. With this functionality in place, administrators can modify and delete existing managed clients, create new ones, and view and make changes to their log configurations.

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

Method HTTP request Description
create-managed-client POST /managed-clients Create Managed Client
delete-managed-client DELETE /managed-clients/{id} Delete Managed Client
get-managed-client GET /managed-clients/{id} Get Managed Client
get-managed-client-status GET /managed-clients/{id}/status Get Managed Client Status
get-managed-clients GET /managed-clients Get Managed Clients
update-managed-client PATCH /managed-clients/{id} Update Managed Client

create-managed-client

Create Managed Client Create a new managed client. The API returns a result that includes the managed client ID.

API Spec

Parameters

Param Type Name Data Type Required Description
Body managed_client_request ManagedClientRequest True

Return type

ManagedClient

Responses

Code Description Data Type Response headers
200 Created managed client. ManagedClient -
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 -
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

import sailpoint.v3
from sailpoint.v3.api.managed_clients_api import ManagedClientsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.managed_client import ManagedClient
from sailpoint.v3.models.managed_client_request import ManagedClientRequest
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()

with ApiClient(configuration) as api_client:
    managed_client_request = {
          "name" : "aName",
          "description" : "A short description of the ManagedClient",
          "clusterId" : "aClusterId",
          "type" : "VA"
        } # ManagedClientRequest | 

    try:
        # Create Managed Client
        new_managed_client_request = ManagedClientRequest()
        new_managed_client_request.from_json(managed_client_request)
        results =ManagedClientsApi(api_client).create_managed_client(new_managed_client_request)
        # Below is a request that includes all optional parameters
        # results = ManagedClientsApi(api_client).create_managed_client(new_managed_client_request)
        print("The response of ManagedClientsApi->create_managed_client:\n")
        pprint(results)
        except Exception as e:
        print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e)

[Back to top]

delete-managed-client

Delete Managed Client Delete an existing managed client.

API Spec

Parameters

Param Type Name Data Type Required Description
Path id str True Managed client ID.

Return type

(empty response body)

Responses

Code Description Data Type Response headers
204 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 -
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

import sailpoint.v3
from sailpoint.v3.api.managed_clients_api import ManagedClientsApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()

with ApiClient(configuration) as api_client:
    id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID.

    try:
        # Delete Managed Client
        
        ManagedClientsApi(api_client).delete_managed_client(id)
        # Below is a request that includes all optional parameters
        # ManagedClientsApi(api_client).delete_managed_client(id)
        except Exception as e:
        print("Exception when calling ManagedClientsApi->delete_managed_client: %s\n" % e)

[Back to top]

get-managed-client

Get Managed Client Get managed client by ID.

API Spec

Parameters

Param Type Name Data Type Required Description
Path id str True Managed client ID.

Return type

ManagedClient

Responses

Code Description Data Type Response headers
200 Managed client response. ManagedClient -
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

import sailpoint.v3
from sailpoint.v3.api.managed_clients_api import ManagedClientsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.managed_client import ManagedClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()

with ApiClient(configuration) as api_client:
    id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID.

    try:
        # Get Managed Client
        
        results =ManagedClientsApi(api_client).get_managed_client(id)
        # Below is a request that includes all optional parameters
        # results = ManagedClientsApi(api_client).get_managed_client(id)
        print("The response of ManagedClientsApi->get_managed_client:\n")
        pprint(results)
        except Exception as e:
        print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e)

[Back to top]

get-managed-client-status

Get Managed Client Status Get a managed client's status, using its ID.

API Spec

Parameters

Param Type Name Data Type Required Description
Path id str True Managed client ID to get status for.
Query type ManagedClientType True Managed client type to get status for.

Return type

ManagedClientStatus

Responses

Code Description Data Type Response headers
200 Response with the managed client status, with the given ID and type. ManagedClientStatus -
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

import sailpoint.v3
from sailpoint.v3.api.managed_clients_api import ManagedClientsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.managed_client_status import ManagedClientStatus
from sailpoint.v3.models.managed_client_type import ManagedClientType
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()

with ApiClient(configuration) as api_client:
    id = 'aClientId' # str | Managed client ID to get status for. # str | Managed client ID to get status for.
    type = sailpoint.v3.ManagedClientType() # ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for.

    try:
        # Get Managed Client Status
        
        results =ManagedClientsApi(api_client).get_managed_client_status(id, type)
        # Below is a request that includes all optional parameters
        # results = ManagedClientsApi(api_client).get_managed_client_status(id, type)
        print("The response of ManagedClientsApi->get_managed_client_status:\n")
        pprint(results)
        except Exception as e:
        print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e)

[Back to top]

get-managed-clients

Get Managed Clients List managed clients.

API Spec

Parameters

Param Type Name Data Type Required Description
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 limit int (optional) (default to 250) Max number of results to return. 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 name: eq clientId: eq clusterId: eq

Return type

List[ManagedClient]

Responses

Code Description Data Type Response headers
200 Response with a list of managed clients, based on the specified query parameters. List[ManagedClient] -
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 -
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

import sailpoint.v3
from sailpoint.v3.api.managed_clients_api import ManagedClientsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.managed_client import ManagedClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()

with ApiClient(configuration) as api_client:
    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)
    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)
    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 = 'name eq \"client name\"' # 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*  **name**: *eq*  **clientId**: *eq*  **clusterId**: *eq* (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*  **name**: *eq*  **clientId**: *eq*  **clusterId**: *eq* (optional)

    try:
        # Get Managed Clients
        
        results =ManagedClientsApi(api_client).get_managed_clients()
        # Below is a request that includes all optional parameters
        # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters)
        print("The response of ManagedClientsApi->get_managed_clients:\n")
        pprint(results)
        except Exception as e:
        print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e)

[Back to top]

update-managed-client

Update Managed Client Update an existing managed client.

API Spec

Parameters

Param Type Name Data Type Required Description
Path id str True Managed client ID.
Body json_patch_operation []JsonPatchOperation True JSONPatch payload used to update the object.

Return type

ManagedClient

Responses

Code Description Data Type Response headers
200 Updated managed client. ManagedClient -
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-patch+json
  • Accept: application/json

Example

import sailpoint.v3
from sailpoint.v3.api.managed_clients_api import ManagedClientsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
from sailpoint.v3.models.managed_client import ManagedClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()

with ApiClient(configuration) as api_client:
    id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID.
    [sailpoint.v3.JsonPatchOperation()] # List[JsonPatchOperation] | JSONPatch payload used to update the object.
     json_patch_operation = {
          "op" : "replace",
          "path" : "/description",
          "value" : "New description"
        } # List[JsonPatchOperation] | JSONPatch payload used to update the object.
    

    try:
        # Update Managed Client
        new_json_patch_operation = JsonPatchOperation()
        new_json_patch_operation.from_json(json_patch_operation)
        results =ManagedClientsApi(api_client).update_managed_client(id, new_json_patch_operation)
        # Below is a request that includes all optional parameters
        # results = ManagedClientsApi(api_client).update_managed_client(id, new_json_patch_operation)
        print("The response of ManagedClientsApi->update_managed_client:\n")
        pprint(results)
        except Exception as e:
        print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e)

[Back to top]