Update trust relationship

PUT /platform/configuration/trust-relationships/{trust_relationship_id}
Basic auth Api key

Updates a trust relationship.

Path parameters

application/json

Body Required

The trust relationship definition

  • name string

    A name for the trust relationship

  • trust_by_default boolean

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

  • account_ids array[string]

    The ID of the accounts to trust by this relationship.

  • public_ca_cert string

    The public CA certificate of the environment to trust

  • installation_id string

    The installation ID of the environment to trust

Responses

  • 200 application/json

    The request was valid and the trust relationship was updated.

    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.

    • local boolean Required

      If this is the trust relationship for the local environment

    • installation_id string

      The installation ID of the environment to trust
  • 400 application/json

    The trust relationship request had errors.

    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
  • 401 application/json

    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
  • 404 application/json

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

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      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
PUT /platform/configuration/trust-relationships/{trust_relationship_id} 
curl \
 --request PUT 'https://{{hostname}}/api/v1/platform/configuration/trust-relationships/{trust_relationship_id}' \
 --user "username:password" \
 --header "Content-Type: application/json" \
 --data '{"name":"string","trust_by_default":true,"account_ids":["string"],"public_ca_cert":"string","installation_id":"string"}'
OSZAR »