Sign in
provisioning

Adds a new Portfolio

Adds a new Portfolio to be provisioned, including Task Orders and Operators. Once provisioned, Operators can log in to the CSP and begin using provisioned resources and services, funded by the provided Task Order(s). Note that invitations should be sent to all Operator email addresses included in the request. See #/info/description and #/components/schemas for details of these constructs.

post/portfolios

Request body

idstring required

Represents the unqiue ID of the Portfolio 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

Example request

{
  "id": "csp-portfolio-id-123",
  "name": "Sample Portfolio name",
  "task_orders": [
    {
      "id": "csp-task-order-id-123",
      "task_order_number": "HQ003421F0024",
      "clins": [
        {
          "pop_start_date": "2021-07-22",
          "pop_end_date": "2026-07-21"
        }
      ],
      "pop_start_date": "2021-07-15",
      "pop_end_date": "2026-07-14"
    }
  ]
}

Response

Portfolio response object

idstring required

Represents the unqiue ID of the Portfolio 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

Example response

{
  "id": "csp-portfolio-id-123",
  "name": "Sample Portfolio name",
  "task_orders": [
    {
      "id": "csp-task-order-id-123",
      "task_order_number": "HQ003421F0024",
      "clins": [
        {
          "pop_start_date": "2021-07-22",
          "pop_end_date": "2026-07-21"
        }
      ],
      "pop_start_date": "2021-07-15",
      "pop_end_date": "2026-07-14"
    }
  ]
}

Changes

Changed in 15 of the 50 revisions of this API.221652

  • 682acb0b28b61See the full diff
    • ○

      added the non-success response with the status 405

      response-non-success-status-added

  • 955d3f2e1d842See the full diff
    • ●

      removed the request property migrationOfPortfolioRequired

      request-property-removed

    • ●

      removed the optional property migrationOfPortfolioRequired from the response with the 200 status

      response-optional-property-removed

  • 6c8abf4c408c2See the full diff
    • ○

      added the new optional request property migrationOfPortfolioRequired

      new-optional-request-property

    • ○

      added the optional property migrationOfPortfolioRequired to the response with the 200 status

      response-optional-property-added

  • 0290bea4247c11See the full diff
    • ●

      deleted the header request parameter X-Atat-Api-Version

      request-parameter-removed

    • ○

      added the new optional header request parameter X-Atat-Api-Version to all path's operations

      new-optional-request-default-parameter-to-existing-path

  • 125039a132bc5510See the full diff
    • ▲

      removed the enum value cloud of the request property task_orders/items/allOf[TaskOrder]/clins/items/type

      request-property-enum-value-removed

    • ▲

      removed the enum value non_cloud of the request property task_orders/items/allOf[TaskOrder]/clins/items/type

      request-property-enum-value-removed

    • ▲

      removed the enum value secret of the request property task_orders/items/allOf[TaskOrder]/clins/items/classification_level

      request-property-enum-value-removed

    • ▲

      removed the enum value top_secret of the request property task_orders/items/allOf[TaskOrder]/clins/items/classification_level

      request-property-enum-value-removed

    • ▲

      removed the enum value unclassified of the request property task_orders/items/allOf[TaskOrder]/clins/items/classification_level

      request-property-enum-value-removed

    • ●

      added the new CLOUD enum value to the task_orders/items/allOf[TaskOrder]/clins/items/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new NON_CLOUD enum value to the task_orders/items/allOf[TaskOrder]/clins/items/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new SECRET enum value to the task_orders/items/allOf[TaskOrder]/clins/items/classification_level response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new TOP_SECRET enum value to the task_orders/items/allOf[TaskOrder]/clins/items/classification_level response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new UNCLASSIFIED enum value to the task_orders/items/allOf[TaskOrder]/clins/items/classification_level response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new CLOUD enum value to the request property task_orders/items/allOf[TaskOrder]/clins/items/type

      request-property-enum-value-added

    • ○

      added the new NON_CLOUD enum value to the request property task_orders/items/allOf[TaskOrder]/clins/items/type

      request-property-enum-value-added

    • ○

      added the new SECRET enum value to the request property task_orders/items/allOf[TaskOrder]/clins/items/classification_level

      request-property-enum-value-added

    • ○

      added the new TOP_SECRET enum value to the request property task_orders/items/allOf[TaskOrder]/clins/items/classification_level

      request-property-enum-value-added

    • ○

      added the new UNCLASSIFIED enum value to the request property task_orders/items/allOf[TaskOrder]/clins/items/classification_level

      request-property-enum-value-added

    • ○

      removed the cloud enum value from the task_orders/items/allOf[TaskOrder]/clins/items/type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the non_cloud enum value from the task_orders/items/allOf[TaskOrder]/clins/items/type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the secret enum value from the task_orders/items/allOf[TaskOrder]/clins/items/classification_level response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the top_secret enum value from the task_orders/items/allOf[TaskOrder]/clins/items/classification_level response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the unclassified enum value from the task_orders/items/allOf[TaskOrder]/clins/items/classification_level response property for the response status 200

      response-property-enum-value-removed

  • 9fbf5defc05a334See the full diff
    • ▲

      added the new required request property task_orders/items/allOf[TaskOrder]/clins/items/type

      new-required-request-property

    • ▲

      removed the required property dashboard_link from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the success response with the status 202

      response-success-status-removed

    • ●

      removed PortfolioPatch from the request body allOf list

      request-body-all-of-removed

    • ●

      deleted the header request parameter X-Provision-Deadline

      request-parameter-removed

    • ●

      deleted the header request parameter X-Target-Impact-Level

      request-parameter-removed

    • ○

      added the new optional request property task_orders/items/allOf[TaskOrder]/clins/items/classification_level

      new-optional-request-property

    • ○

      removed PortfolioPatch from the response body allOf list for the response status 200

      response-body-all-of-removed

    • ○

      added the optional property task_orders/items/allOf[TaskOrder]/clins/items/classification_level to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property task_orders/items/allOf[TaskOrder]/clins/items/type to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 70da8a528a1a2See the full diff
    • ○

      the request required property dashboard_link became read-only

      request-required-property-became-read-only

    • ○

      the response required property dashboard_link became read-only for the status 200

      response-required-property-became-read-only

  • 0012adbb99c01See the full diff
    • ▲

      the response property portfolio_id became optional for the status 202

      response-property-became-optional

  • 1574d89ae20e1See the full diff
    • ○

      added the new optional header request parameter X-Atat-Api-Version

      new-optional-request-parameter

  • 9567c20271791See the full diff
    • ●

      deleted the header request parameter X-Atat-Api-Version

      request-parameter-removed