Update a Managed Cluster

PATCH 
/managed-clusters/:id

Update an existing Managed Cluster.

Request

Path Parameters

id stringrequired
Managed Cluster ID.
Example: 2c9180897de347a2017de8859e8c5039

application/json-patch+json

Body

array

required

The JSONPatch payload used to update the object.

• Array [

op stringrequired

Possible values: [add, remove, replace, move, copy, test]

The operation to be performed

path stringrequired

A string JSON Pointer representing the target path to an element to be affected by the operation

value

object

The value to be used for the operation, required for "add" and "replace" operations

oneOf

string

string

boolean

boolean

integer

integer

object

object

array

Array [

anyOf

MOD1

string

MOD2

integer

MOD3

object

]

• ]

Responses

200

The updated Managed Cluster

application/json

Schema

Schema

id stringrequired

ManagedCluster ID

name string

ManagedCluster name

pod string

ManagedCluster pod

org string

ManagedCluster org

type ManagedClusterTypes (string)

Possible values: [idn, iai]

Default value: idn

The Type of Cluster

configuration

object

ManagedProcess configuration map

property name* stringnullable

keyPair

object

key pair for the ManagedCluster

publicKey stringnullable

ManagedCluster publicKey

publicKeyThumbprint stringnullable

ManagedCluster publicKeyThumbprint

publicKeyCertificate stringnullable

ManagedCluster publicKeyCertificate

attributes

object

Specific Attributes for Configuring a ManagedCluster by Type

queue

object

ManagedCluster keystore for sqsCluster type

name string

ManagedCluster queue name

region string

ManagedCluster queue aws region

keystore stringnullable

ManagedCluster keystore for spConnectCluster type

description string

Default value: q

ManagedCluster description

redis

object

Redis configuration for the ManagedCluster

redisHost string

ManagedCluster redisHost

redisPort int32

ManagedCluster redisPort

clientType ManagedClientType (string)nullablerequired

Possible values: [CCG, VA, INTERNAL, IIQ_HARVESTER, null]

type of client for the ManagedCluster

ccgVersion stringrequired

CCG version used by the ManagedCluster

pinnedConfig boolean

boolean flag indiacting whether or not the cluster configuration is pinned

logConfiguration

object

nullable

client log configuration for the cluster

clientId string

Log configuration's client ID

durationMinutes int32

Possible values: >= 5 and <= 1440

Default value: 240

Duration in minutes for log configuration to remain in effect before resetting to defaults.

expiration date-time

Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time.

rootLevel StandardLevel (string)required

Possible values: [OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE]

Default value: INFO

Root log level to apply, the default level for all logs. For more information about logging levels, refer to the "Logging Levels" table in Enabling Connector Logging in IdentityNow.

logLevels

object

Map of log level by key. The keys are logging classes, and the values are logging levels. To see the available connectors and their logging classes, refer to the "Logging Classes" table in Enabling Connector Logging in IdentityNow.

property name* StandardLevel (string)

Default value: INFO

Standard Log4j log level

operational boolean

Whether or not the cluster is operational or not

status string

Cluster status

publicKeyCertificate stringnullable

Public key certificate

publicKeyThumbprint stringnullable

Public key thumbprint

publicKey stringnullable

Public key

alertKey string

Key describing any immediate cluster alerts

clientIds string[]

List of clients in a cluster

serviceCount int32

Default value: 0

Number of services bound to a cluster

ccId string

Default value: 0

CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished

createdAt date-timenullable

The date/time this cluster was created

updatedAt date-timenullable

The date/time this cluster was last updated

Example (from schema)

{
  "id": "e1ff7bb24c934240bbf55e1aa39e41c5",
  "name": "Managed Cluster Name",
  "pod": "megapod-useast1",
  "org": "denali",
  "type": "idn",
  "configuration": {
    "clusterExternalId": "e1ff7bb24c934240bbf55e1aa39e41c5",
    "clusterType": "sqsCluster",
    "gmtOffset": "-5"
  },
  "keyPair": {
    "publicKey": "-----BEGIN PUBLIC KEY-----******-----END PUBLIC KEY-----",
    "publicKeyThumbprint": "6CMlaJIV44-xJxcB3CJBjDUUn54",
    "publicKeyCertificate": "-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----"
  },
  "attributes": {
    "queue": {
      "name": "megapod-useast1-denali-lwt-cluster-1533",
      "region": "us-east-1"
    },
    "keystore": "/u3+7QAAAAIAAAABAAAAAQAvL3Byb3h5LWNsdXN0ZXIvMmM5MTgwODc3Yjg3MW"
  },
  "description": "A short description of the managed cluster.",
  "redis": {
    "redisHost": "megapod-useast1-shared-redis.cloud.sailpoint.com",
    "redisPort": 6379
  },
  "clientType": "CCG",
  "ccgVersion": "v01",
  "pinnedConfig": false,
  "logConfiguration": "{ \"rootLevel\": \"WARN\", \"logLevels\": { \"foobar\": \"WARN\" } }",
  "operational": false,
  "status": "NORMAL",
  "publicKeyCertificate": "-----BEGIN CERTIFICATE-----TCCAb2gAwIBAgIBADANBgkqhkiG9w0BAQsFADAuMQ0wCwYDVQQD-----END CERTIFICATE-----",
  "publicKeyThumbprint": "obc6pLiulGbtZ",
  "publicKey": "-----BEGIN PUBLIC KEY-----jANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3WgnsxP52MDgBTfHR+5n4-----END PUBLIC KEY-----",
  "alertKey": "LIMITED_RESOURCES",
  "clientIds": [
    "1244",
    "1245"
  ],
  "serviceCount": 6,
  "ccId": "1533",
  "createdAt": "2023-08-04T20:48:01.865Z",
  "updatedAt": "2023-08-04T20:48:01.865Z"
}

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

An example of a 403 response object

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

404

Not Found - returned if the request URL refers to a resource or object that does not exist

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

404

An example of a 404 response object

{
  "detailCode": "404 Not found",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server did not find a current representation for the target resource."
    }
  ]
}

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.

application/json

Schema

Schema

message

A message describing the error

Example (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

500

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Loading...