Skip to main content
POST
SDK (@phosra/sdk)
A compliance link is a live connection between a family and a platform (the thing enforcement pushes to). Connect a platform, re-verify it, trigger enforcement for just that link, or disconnect.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
family_id
string<uuid>
required
platform_id
string
required
credentials
string
required

Response

Platform connected

id
string<uuid>

Unique identifier for this resource.

family_id
string<uuid>

Identifier of the family this resource belongs to.

platform_id
string

Identifier of the associated platform.

status
enum<string>

Current lifecycle state of the resource.

Available options:
verified,
unverified,
error
external_id
string

Identifier of the associated external.

last_enforcement_at
string<date-time> | null

RFC 3339 timestamp.

last_enforcement_status
string

Outcome of the most recent enforcement run against this link (e.g. success, partial, error).

verified_at
string<date-time>

RFC 3339 timestamp.