Create trust relationship

POST /platform/configuration/trust-relationships

Creates a trust relationship.

application/json

Body Required

The trust relationship definition

  • name string Required

    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 Required

    The public CA certificate of the environment to trust

  • installation_id string

    The installation ID of the environment to trust

Responses

  • 201 application/json

    The request was valid and a new trust relationship was created

    Hide headers attributes Show headers attributes
    • x-cloud-resource-version string

      The resource version, which is used to avoid update conflicts with concurrent operations

    • x-cloud-resource-created string

      The date-time when the resource was created (ISO format relative to UTC)

    • x-cloud-resource-last-modified string

      The date-time when the resource was last modified (ISO format relative to UTC)

    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

POST /platform/configuration/trust-relationships
curl \
 --request POST 'https://{{hostname}}/api/v1/platform/configuration/trust-relationships' \
 --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"}'