Cloud Resource Framework Asset Scope

This document describes the API for reading and creating Framework Asset Scopes.

A Framework Asset Scope defines the scope of an asset (e.g., a Cloud Resource) within a Framework.

Framework Asset Scopes are immutable. Once created, they cannot be modified. To update a scope, create a new resource with the updated information.

List Framework Asset Scopes

Returns a list of Framework Asset Scopes for the Cloud Resource by ID

The absence of a Framework Asset Scope indicates the asset is not in scope for the Framework.

Securityheader_authorization

Request

path Parameters

cloud_resource_id

required

string

Scope response to cloud_resource_id

query Parameters

include	boolean Set to true along with relationships to return the entire relationship data in the `included` key within the response.
relationships	boolean Set to true to return the associated relationships data within the response. (default: false)

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

default

get/cloud_resources/{cloud_resource_id}/framework_asset_scopes

Request samples

Response samples

default

application/json

[{"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string",
"attributes": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"active": true,
"asset_id": "b4695157-0d1d-4da0-8f9e-5c53149389e4",
"asset_type": "string",
"created_at": "2019-08-24T14:15:22Z",
"framework_id": "4c1c36c9-0232-44b3-bdd8-4bdb3daaf53b",
"framework_title": "string",
"manually_scoped": true,
"manually_scoped_reason": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"relationships": { },
"links": { }
},
"includes": { }
}
]

Create Framework Asset Scope

Create a Framework Asset Scope for the Cloud Resource by ID