LukeParke/developer.sailpoint.com

Fork 0

mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 12:27:47 +00:00

Files

developer-relations-sp bdb088c15d Update to powershell SDK docs: 13122455471

2025-02-03 20:42:04 +00:00

16 KiB

Raw Blame History

id: v2024-managed-clients title: ManagedClients pagination_label: ManagedClients sidebar_label: ManagedClients sidebar_class_name: powershellsdk keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClients', 'V2024ManagedClients'] slug: /tools/sdk/powershell/v2024/methods/managed-clients tags: ['SDK', 'Software Development Kit', 'ManagedClients', 'V2024ManagedClients']

ManagedClients

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/v2024

Method	HTTP request	Description
New-V2024ManagedClient	POST `/managed-clients`	Create Managed Client
Remove-V2024ManagedClient	DELETE `/managed-clients/{id}`	Delete Managed Client
Get-V2024ManagedClient	GET `/managed-clients/{id}`	Get Managed Client
Get-V2024ManagedClientStatus	GET `/managed-clients/{id}/status`	Get Managed Client Status
Get-V2024ManagedClients	GET `/managed-clients`	Get Managed Clients
Update-V2024ManagedClient	PATCH `/managed-clients/{id}`	Update Managed Client

create-managed-client

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

Parameters

Param Type	Name	Data Type	Required	Description
Body	ManagedClientRequest	ManagedClientRequest	True

Return type

ManagedClient

Responses

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

$ManagedClientRequest = @"{
  "name" : "aName",
  "description" : "A short description of the ManagedClient",
  "clusterId" : "aClusterId",
  "type" : "VA"
}"@

# Create Managed Client

try {
    $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest
    New-V2024ManagedClient-V2024ManagedClientRequest $Result
    
    # Below is a request that includes all optional parameters
    # New-V2024ManagedClient -V2024ManagedClientRequest $ManagedClientRequest  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClient"
    Write-Host $_.ErrorDetails
}

[Back to top]

delete-managed-client

Delete an existing managed client.

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	Managed client ID.

Return type

(empty response body)

Responses

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

$Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID.

# Delete Managed Client

try {
    Remove-V2024ManagedClient-V2024Id $Id 
    
    # Below is a request that includes all optional parameters
    # Remove-V2024ManagedClient -V2024Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedClient"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-managed-client

Get managed client by ID.

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	Managed client ID.

Return type

ManagedClient

Responses

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

$Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID.

# Get Managed Client

try {
    Get-V2024ManagedClient-V2024Id $Id 
    
    # Below is a request that includes all optional parameters
    # Get-V2024ManagedClient -V2024Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClient"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-managed-client-status

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

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	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
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

$Id = "aClientId" # String | Managed client ID to get status for.
$Type = "CCG" # ManagedClientType | Managed client type to get status for.

# Get Managed Client Status

try {
    Get-V2024ManagedClientStatus-V2024Id $Id -V2024Type $Type 
    
    # Below is a request that includes all optional parameters
    # Get-V2024ManagedClientStatus -V2024Id $Id -V2024Type $Type  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClientStatus"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-managed-clients

List managed clients.

Parameters

Param Type	Name	Data Type	Required	Description
Query	Offset	Int32	(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	Int32	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query	Count	Boolean	(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	String	(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

ManagedClient[]

Responses

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

$Offset = 0 # Int32 | 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 # Int32 | 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 = $true # Boolean | 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"' # String | 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)

# Get Managed Clients

try {
    Get-V2024ManagedClients
    
    # Below is a request that includes all optional parameters
    # Get-V2024ManagedClients -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClients"
    Write-Host $_.ErrorDetails
}

[Back to top]

update-managed-client

Update an existing managed client.

Parameters

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

Return type

ManagedClient

Responses

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

$Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID.
 $JsonPatchOperation = @"{
  "op" : "replace",
  "path" : "/description",
  "value" : "New description"
}"@ # JsonPatchOperation[] | JSONPatch payload used to update the object.
 

# Update Managed Client

try {
    $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
    Update-V2024ManagedClient-V2024Id $Id -V2024JsonPatchOperation $Result
    
    # Below is a request that includes all optional parameters
    # Update-V2024ManagedClient -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClient"
    Write-Host $_.ErrorDetails
}

[Back to top]

16 KiB Raw Blame History

ManagedClients

create-managed-client

Parameters

Return type

Responses

HTTP request headers

Example

delete-managed-client

Parameters

Return type

Responses

HTTP request headers

Example

get-managed-client

Parameters

Return type

Responses

HTTP request headers

Example

get-managed-client-status

Parameters

Return type

Responses

HTTP request headers

Example

get-managed-clients

Parameters

Return type

Responses

HTTP request headers

Example

update-managed-client

Parameters

Return type

Responses

HTTP request headers

Example

16 KiB

Raw Blame History