Get trust relationship

GET /platform/configuration/trust-relationships/{trust_relationship_id}

Retrieves information about a trust relationship.

Path parameters

Query parameters

  • Whether to include the public CA certificates in the response.

    Default value is false.

Responses

  • The trust relationship info response

    Hide headers attributes Show headers attributes
    Hide response attributes Show response attributes object
    • id string Required

      The id of the trust relationship

    • name string Required

      The name of the trust relationship

    • trust_by_default boolean Required

      If this relationship is trusted by default by all deployments in the current environment.

    • account_ids array[string]

      The ID of the accounts trusted by this relationship.

    • The public CA certificate of the environment to trust

    • local boolean Required

      If this is the trust relationship for the local environment

    • The installation ID of the environment to trust

    • last_modified string(date-time) Required

      The most recent time the trust relationship was changed (ISO format in UTC)

  • You are not authorized to perform this action.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

  • The trust relationship specified by {trust_relationship_id} cannot be found. (code: trust_relationships.not_found)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is trust_relationships.not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

GET /platform/configuration/trust-relationships/{trust_relationship_id}
curl \
 -X GET https://{{hostname}}/api/v1/platform/configuration/trust-relationships/{trust_relationship_id}
Response examples (200)
# Headers
x-cloud-resource-version: string
x-cloud-resource-created: string
x-cloud-resource-last-modified: string

# Payload
{
  "id": "string",
  "name": "string",
  "trust_by_default": true,
  "account_ids": [
    "string"
  ],
  "public_ca_cert": "string",
  "local": true,
  "installation_id": "string",
  "last_modified": "2024-05-04T09:42:00+00:00"
}
Response examples (401)
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (404)
# Headers
x-cloud-error-codes: trust_relationships.not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}