DOdod-ccpo
provisioning

Adds a new Environment to an existing Portfolio

Changed on

Adds a new Environment to be provisioned. Once provisioned, Operators can log in to the CSP and begin using provisioned resources and services, funded by the given CLIN.

Note

  • Invitations should be sent to all Operator email addresses included in the request. See #/info/description and #/components/schemas for details of these constructs.

  • If this Portfolio does not contain a CLIN whose classification_level matches that of the given Environment, vendors should return a HTTP 400 response.

post/portfolios/{portfolioId}/environments

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/write-portfolio)

Headers

X-Provision-Deadlinestring date-time

The deadline by which the ATAT client expects the portfolio provisioning process to be complete is dictated by the following values:

Classification LevelDeadline
Unclassified2 Hours
Secret72 Hours
Top Secret72 Hours
Note: this header must NOT be sent if is_migration is true for the given Environment.

Request body

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 request

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

Response

Successful operation

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

  • 22014acb308fRevision changes
    • breaking

      added the new required request property

    • warning

      removed the request property

  • 89a739bd933bRevision changes
    • warning

      removed from the request body allOf list

    • info

      added the new optional request property