Retrieve all Managed Clusters.

Retrieve all Managed Clusters for the current Org, based on request context.

Query Parameters

• offset int32

  Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

• limit int32

  Possible values: <= 250

  Default value: 250

  Max number of results to return. See V3 API Standard Collection Parameters for more information.

  Example: 250
• count 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 for more information.

  Example: true
• filters string

  Filtering is supported for the following fields and operators:

  operational: eq

  Example: operational eq operation

Responses

• 200
• 400
• 401
• 403
• 429
• 500

---

Responds with a list of ManagedCluster.

application/json

• Schema
• Example (from schema)

---

Schema array

• id string

  ManagedCluster ID

• name string

  ManagedCluster name

• pod string

  ManagedCluster pod

• org string

  ManagedCluster org

• type string

  Possible values: [idn, iai]

  The Type of Cluster

• configuration object

  ManagedProcess configuration map

  property name* string
• keyPair object

  key pair for the ManagedCluster

  publicKey string

  ManagedCluster publicKey

  publicKeyThumbprint string

  ManagedCluster publicKeyThumbprint

  publicKeyCertificate string

  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 string

  ManagedCluster keystore for spConnectCluster type

• description string

  ManagedCluster description

• redis object

  Redis configuration for the ManagedCluster

  redisHost string

  ManagedCluster redisHost

  redisPort int32

  ManagedCluster redisPort

• clientType string

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

  type of client for the ManagedCluster

• ccgVersion string

  CCG version used by the ManagedCluster

• pinnedConfig boolean

  Default value: false

  boolean flag indiacting whether or not the cluster configuration is pinned

• logConfiguration object

  client log configuration for the cluster

  clientId string

  Log configuration's client ID

  durationMinutes int32

  Possible values: >= 5 and <= 1440

  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

  rootLevel string

  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* string

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

• operational boolean

  Default value: false

  Whether or not the cluster is operational or not

• status string

  Cluster status

• publicKeyCertificate string

  Public key certificate

• publicKeyThumbprint string

  Public key thumbprint

• publicKey string

  Public key

• alertKey string

  Key describing any immediate cluster alerts

• clientIds string[]

  List of clients in a cluster

• serviceCount int32

  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

[
  {
    "id": "aClusterId",
    "name": "Managed Cluster Name",
    "pod": "megapod-useast1",
    "org": "denali",
    "type": "idn",
    "configuration": {
      "clusterExternalId": "externalId",
      "ccgVersion": "77.0.0"
    },
    "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"
  }
]

Client Error - Returned if the request body is invalid.

application/json

• Schema
• Example (from 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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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.

{
  "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."
    }
  ]
}

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

application/json

• Schema
• Example (from schema)

---

Schema

• error

  A message describing the error

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

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

application/json

• Schema
• Example (from schema)
• 403

---

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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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.

{
  "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."
    }
  ]
}

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."
    }
  ]
}

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
• Example (from schema)

---

Schema

• message

  A message describing the error

{
  "message": " Rate Limit Exceeded "
}

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

application/json

• Schema
• Example (from schema)
• 500

---

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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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.

{
  "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."
    }
  ]
}

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...