access

Updates an existing Portfolio. Currently limited to the administrators attribute which will add administrators to an existing Portfolio. Note that this is a strictly additive operation; invitations should be sent to all email addresses included in a request. It is expected that removal of access will occur through native CSP mechanisms rather than via ATAT. When an Operator included in this operation does not already have access to the Portfolio in the target Cloud Environment and an invitation should be sent to that Operator's email address. ATAT clients should not specify the needs_reset flag for Operators that do not already have access; however, ATAT implementations must ignore the flag for such Operators who do not already have access. When an Operator included in this operator already has access to the Portfolio in the target Cloud Environment and the needs_reset attribute is set to true, their access should be reset (whether via a token, password, or other vendor-specific means). When an Operator already has access to the Portfolio in the target Cloud Environment and the needs_reset attribute is unspecified or false, ATAT implementations must not make changes to the user's access nor perform any resets.

patch/portfolios/{portfolioId}

Path parameters

portfolioIdstring required

ID of the Portfolio

Headers

X-Target-Impact-Level'IL2' | 'IL4' | 'IL5' | 'IL6' | 'TS'

List of available Impact Levels for target Cloud Environments

Target Impact Level for this request. Optional header which allows an ATAT implementation to route a request to a more specific environment if more than one is available at a given endpoint.

X-Atat-Api-Versionstring

This header may be provided by an ATAT client implementation to provide context for the ATAT API specification that it expects to be compatible with. Implementations may choose to adapt their response to conform to the expected API version. If not provided by the client, the server should assume the client supports the latest version of this specification.

Request body

Example request

{
  "administrators": [
    {
      "email": "portfolio.admin@mail.mil"
    }
  ]
}

Response

Portfolio successfully updated

Example response

{
  "administrators": [
    {
      "email": "portfolio.admin@mail.mil"
    }
  ]
}

Changes