1. Partner API v2
  2. Resources
  3. Frameworks

Frameworks

Compliance frameworks assigned to a client and how the client measures against them.
2 endpointsScope readFrameworkFrameworkAssignment
GET/v2/frameworks

List available frameworksLink to this endpoint

RequiresreadscopeCursor-paginatedReturns Page of Framework

The compliance frameworks that can be assigned to a client, with their requirements. Returns every framework in a single page.

No parameters. Send the request with your API key.

curl "https://app.infimasecapis.com/v2/frameworks" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectPage of Framework
dataarray of Framework
Show item properties(6)
idstring
namestring
categorystring
standard_refstringNullable
descriptionstring
requirementsarray of FrameworkRequirement
Show item properties(5)
keystring
typestring

Open enum.

One ofcourse_completiontraining_windowphishing_activephishing_coveragephishing_fail_ratedocument_acknowledgedreporting
namestring
descriptionstring
requiredboolean
pageobject
Show properties(2)
next_cursorstringNullable

Pass as cursor to fetch the next page. Null on the last page.

has_moreboolean
GET/v2/clients/{client_id}/frameworks

List a client's framework assignments with evaluationLink to this endpoint

RequiresreadscopeCursor-paginatedReturns Page of FrameworkAssignment

Each framework assigned to the client, the audience it applies to, and how the client currently measures against each requirement. Returns every assignment in a single page. This is the data behind the Compliance report.

Path parameters

client_idstringRequired

Client id (the client's INFIMA id).

curl "https://app.infimasecapis.com/v2/clients/3f2a9c1e-7b44-5d2e-9a1f-0c6d8e4b2a10/frameworks" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectPage of FrameworkAssignment
dataarray of FrameworkAssignment
Show item properties(6)
idstring
frameworkobject
Show properties(3)
idstring
namestring
categorystring
audienceobject
Show properties(3)
typestring
One ofallgroupcollection
idstringNullable
namestringNullable
modulesobject
Show properties(4)
trainingboolean
phishingboolean
policiesboolean
reportingboolean
evaluationobject
Show properties(5)
metinteger
totalinteger
percentageinteger
requirementsarray of object
Show item properties(6)
keystring
namestring
metboolean
valuenumberNullable

The measured value where the requirement is numeric (for example completion percentage).

targetnumberNullable
detailstring
evaluated_atstring (date-time)
created_atstring (date-time)
pageobject
Show properties(2)
next_cursorstringNullable

Pass as cursor to fetch the next page. Null on the last page.

has_moreboolean
Coming in 2.x2 more Frameworks operations are specified for a later 2.x release.See the roadmap