LukeParke/developer.sailpoint.com

Fork 0

mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 04:19:34 +00:00

Files

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

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

19 KiB

Raw Blame History

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

ManagedClusters

Use this API to implement managed cluster functionality. With this functionality in place, administrators can modify and delete existing managed clients, get their statuses, and create new ones.

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

Method	HTTP request	Description
New-V2024ManagedCluster	POST `/managed-clusters`	Create Create Managed Cluster
Remove-V2024ManagedCluster	DELETE `/managed-clusters/{id}`	Delete Managed Cluster
Get-V2024ClientLogConfiguration	GET `/managed-clusters/{id}/log-config`	Get Managed Cluster Log Configuration
Get-V2024ManagedCluster	GET `/managed-clusters/{id}`	Get Managed Cluster
Get-V2024ManagedClusters	GET `/managed-clusters`	Get Managed Clusters
Send-V2024ClientLogConfiguration	PUT `/managed-clusters/{id}/log-config`	Update Managed Cluster Log Configuration
Update-V2024ManagedCluster	PATCH `/managed-clusters/{id}`	Update Managed Cluster

create-managed-cluster

Create a new Managed Cluster. The API returns a result that includes the managed cluster ID.

Parameters

Param Type	Name	Data Type	Required	Description
Body	ManagedClusterRequest	ManagedClusterRequest	True

Return type

ManagedCluster

Responses

Code	Description	Data Type
200	Created managed cluster.	ManagedCluster
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

$ManagedClusterRequest = @"{
  "configuration" : {
    "clusterExternalId" : "externalId",
    "ccgVersion" : "77.0.0"
  },
  "name" : "Managed Cluster Name",
  "description" : "A short description of the managed cluster.",
  "type" : "idn"
}"@

# Create Create Managed Cluster

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

[Back to top]

delete-managed-cluster

Delete an existing managed cluster.

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	Managed cluster ID.
Query	RemoveClients	Boolean	(optional) (default to $false)	Flag to determine the need to delete a cluster with clients.

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 = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID.
$RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false)

# Delete Managed Cluster

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

[Back to top]

get-client-log-configuration

Get a managed cluster's log configuration.

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	ID of managed cluster to get log configuration for.

Return type

ClientLogConfiguration

Responses

Code	Description	Data Type
200	Log configuration of managed cluster for given cluster ID.	ClientLogConfiguration
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
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 = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for.

# Get Managed Cluster Log Configuration

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

[Back to top]

get-managed-cluster

Get a managed cluster by ID.

Parameters

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

Return type

ManagedCluster

Responses

Code	Description	Data Type
200	Response with managed cluster for the given ID.	ManagedCluster
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 = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID.

# Get Managed Cluster

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

[Back to top]

get-managed-clusters

List current organization's managed clusters, based on request context.

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: operational: eq

Return type

ManagedCluster[]

Responses

Code	Description	Data Type
200	Response with a list of managed clusters.	ManagedCluster[]
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 = 'operational eq "operation"' # 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:  **operational**: *eq* (optional)

# Get Managed Clusters

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

[Back to top]

put-client-log-configuration

Update a managed cluster's log configuration. You may only specify one of durationMinutes or expiration, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for durationMinutes is 240.

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	ID of the managed cluster to update the log configuration for.
Body	PutClientLogConfigurationRequest	PutClientLogConfigurationRequest	True	Client log configuration for the given managed cluster.

Return type

ClientLogConfiguration

Responses

Code	Description	Data Type
200	Response with updated client log configuration for the given managed cluster.	ClientLogConfiguration
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
Accept: application/json

Example

$Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for.
$PutClientLogConfigurationRequest = @""@

# Update Managed Cluster Log Configuration

try {
    $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest
    Send-V2024ClientLogConfiguration-V2024Id $Id -V2024PutClientLogConfigurationRequest $Result
    
    # Below is a request that includes all optional parameters
    # Send-V2024ClientLogConfiguration -V2024Id $Id -V2024PutClientLogConfigurationRequest $PutClientLogConfigurationRequest  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ClientLogConfiguration"
    Write-Host $_.ErrorDetails
}

[Back to top]

update-managed-cluster

Update an existing managed cluster.

Parameters

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

Return type

ManagedCluster

Responses

Code	Description	Data Type
200	Updated managed cluster.	ManagedCluster
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 = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID.
 $JsonPatchOperation = @"{
  "op" : "replace",
  "path" : "/description",
  "value" : "New description"
}"@ # JsonPatchOperation[] | JSONPatch payload used to update the object.
 

# Update Managed Cluster

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

[Back to top]

19 KiB Raw Blame History

ManagedClusters

create-managed-cluster

Parameters

Return type

Responses

HTTP request headers

Example

delete-managed-cluster

Parameters

Return type

Responses

HTTP request headers

Example

get-client-log-configuration

Parameters

Return type

Responses

HTTP request headers

Example

get-managed-cluster

Parameters

Return type

Responses

HTTP request headers

Example

get-managed-clusters

Parameters

Return type

Responses

HTTP request headers

Example

put-client-log-configuration

Parameters

Return type

Responses

HTTP request headers

Example

update-managed-cluster

Parameters

Return type

Responses

HTTP request headers

Example

19 KiB

Raw Blame History