DOdod-ccpo
access

Get the Environment object by the EnvironmentId.

Changed on

Returns a single existing Environment

get/portfolios/{portfolioId}/environments/{environmentId}

Request

  • The document declares no server URL.
  • Auth
    OpenID Connect (https://cognito-idp-fips.us-gov-west-1.amazonaws.com/us-gov-west-1_2e6R3aYgi/.well-known/openid-configuration, scopes: atat/read-portfolio)

Response

Environment successfully retrieved

idstring required

Represents the unique ID of the Environment created by the vendor. In order to enable the ATAT UI to construct links back to the provisioned environment, this should be the same ID generated internally for the vendor's Portfolio-equivalent construct.

namestring required
account_namestring

Text which is meant to represent a name that uniquely identifies this Environment in the vendor cloud which can be used in part of a host name or URL.

email_distribution_liststring email

Represents an email meant to be used as a distribution list for communication from the vendor to the owners of this Environment. Should not be an individual's email address.

dashboard_linkstring uri required

Represents a deep link to the Environment as represented in the vendor's dashboard. Allows ATAT to provide direct links to a Mission Owner's Environment within the vendor's target cloud. Will NOT be supplied by the ATAT Client on initial call to create the Environment, but is expected to be provided upon successful Environment creation.

classification_level'UNCLASSIFIED' | 'SECRET' | 'TOP_SECRET' required

Represents the classification level for this environment. Attempts to change this field via PUT or PATCH should result in a HTTP 400.

is_migrationboolean

A boolean value representing whether or not the Environment being created requires the migration of existing cloud resources.

Example response

{
  "id": "csp-environment-id-123",
  "name": "Sample Environment name",
  "account_name": "sampleenvironment-a_1",
  "email_distribution_list": "my-agency-mbx-program-abc-il2@agency.mil",
  "dashboard_link": "https://vendor.com/account/csp-portfolio-id-123/environment/csp-environment-id-123",
  "cloud_distinguisher": {
    "name": "il4_dod",
    "display_name": "Department of Defense - IL4",
    "description": "Cloud System meant for use by DoD organizations with IL4 workloads"
  }
}

Changes

  • a61a8cf84512Revision changes
    • info

      the response's property pattern was changed from ^[A-Za-z0-9](?:[A-Za-z0-9\-_]{0,61}[A-Za-z0-9])$ to ^[a-zA-Z][a-zA-Z0-9]{5,25}$ for the status

  • 0fe40bce74d0Revision changes
    • info

      the response's property pattern was changed from ^[A-Za-z0-9](?:[A-Za-z0-9\-_]{0,61}[A-Za-z0-9])?$ to ^[A-Za-z0-9](?:[A-Za-z0-9\-_]{0,61}[A-Za-z0-9])$ for the status