Skip to content
Registry StackDocsDevelopment (unreleased)

List the complete Evidence request shapes available to the authenticated caller

GET
/v1/evidence-definitions
curl --request GET \
  --url https://example.com/v1/evidence-definitions \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Requester-scoped Evidence definitions

Media typeapplication/json
Requester-scoped Evidence definitions Version 1
object
assuranceProfile
required
string
Allowed values: local production evidence-grade
definitions
required
Array<object>
<= 16384 items unique items
object
concepts
required
Array<object>
>= 1 items <= 16 items unique items
object
form
required
string
Allowed values: boolean controlled-code controlled-category bounded-integer bounded-decimal date-bucket time-bucket audience-scoped-entity-reference controlled-code-list entity-reference-list reviewed-structured-value
id
required
string format: uri
<= 512 characters
configurationRevision
required
string
/^sha256:[a-f0-9]{64}$/
evidenceType
required
string format: uri
<= 512 characters
kind
required
string
Allowed values: criterion information-requirement constraint
purpose
required
string
/^[a-z][a-z0-9._:-]{0,127}$/
referenceFrameworks
required
Array<string>
>= 1 items <= 16 items unique items
requirement
required
string format: uri
<= 512 characters
subjectBindingMode

What the subject bindings in this requirement’s assertions are derived under. The vocabulary is closed and carries no default: absence means audience-scoped, stated here so a relying party reading a definition without the key knows the requirement issues audience-scoped assertions and is not reading an omission it has to resolve elsewhere. A definition that does carry the key states the mode explicitly.

string
Allowed values: audience-scoped holder-bound
subjects
required
Array<object>
>= 1 items <= 8 items unique items
object
cardinality
required
string
Allowed values: one
role
required
string
/^[a-z][a-z0-9._-]{0,63}$/
selector
required
object
fields
required
Array
>= 1 items <= 16 items unique items
One of:
object
maximumBytes
required
integer
>= 1 <= 8192
minimumBytes
required
integer
>= 1 <= 8192
name
required
string
/^[a-z][a-z0-9._-]{0,63}$/
type
required
string
Allowed values: string
profile
required
string
/^[a-z][a-z0-9._-]{0,127}$/
valueOrigin
required
string
Allowed values: request authenticated-context authenticated-grant
issuedBy
required
string format: uri
<= 512 characters
providedBy
required
string format: uri
<= 512 characters
schema
required
string
Allowed values: registry.evidence-definitions/v1
Example
{
  "assuranceProfile": "local",
  "definitions": [
    {
      "concepts": [
        {
          "form": "boolean"
        }
      ],
      "kind": "criterion",
      "subjectBindingMode": "audience-scoped",
      "subjects": [
        {
          "cardinality": "one",
          "selector": {
            "fields": [
              {
                "type": "string"
              }
            ],
            "valueOrigin": "request"
          }
        }
      ]
    }
  ],
  "schema": "registry.evidence-definitions/v1"
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed values: no-store

Evidence responses are never cacheable.

X-Request-Id
string
/^[0-9A-HJKMNP-TV-Z]{26}$/

Server-minted operation identifier for this request. It is generated by Evidence, never taken from the caller, and is the identifier a caller quotes to an operator. Problem responses repeat it in the operation member.

400

Section titled “400”

Malformed discovery request

Media typeapplication/problem+json
object
One of:
Evidence public problem Version 1
object
code
required
string
Allowed values: malformed_request
operation
required
string
/^[0-9A-HJKMNP-TV-Z]{26}$/
status
required
integer
Allowed values: 400
title
required
string
Allowed values: Request is not valid
type
required
string
Allowed values: https://registrystack.org/problems/evidence/malformed_request
code
required
string
Allowed values: malformed_request
status
required
integer
Allowed values: 400
title
required
string
Allowed values: Request is not valid
type
required
string
Allowed values: https://registrystack.org/problems/evidence/malformed_request
Example
{
  "code": "malformed_request",
  "status": 400,
  "title": "Request is not valid",
  "type": "https://registrystack.org/problems/evidence/malformed_request"
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed values: no-store

Evidence responses are never cacheable.

X-Request-Id
string
/^[0-9A-HJKMNP-TV-Z]{26}$/

Server-minted operation identifier for this request. It is generated by Evidence, never taken from the caller, and is the identifier a caller quotes to an operator. Problem responses repeat it in the operation member.

401

Section titled “401”

Authentication failed

Media typeapplication/problem+json
object
One of:
Evidence public problem Version 1
object
code
required
string
Allowed values: malformed_request
operation
required
string
/^[0-9A-HJKMNP-TV-Z]{26}$/
status
required
integer
Allowed values: 400
title
required
string
Allowed values: Request is not valid
type
required
string
Allowed values: https://registrystack.org/problems/evidence/malformed_request
code
required
string
Allowed values: authentication_failed
status
required
integer
Allowed values: 401
title
required
string
Allowed values: Authentication failed
type
required
string
Allowed values: https://registrystack.org/problems/evidence/authentication_failed
Example
{
  "code": "authentication_failed",
  "status": 401,
  "title": "Authentication failed",
  "type": "https://registrystack.org/problems/evidence/authentication_failed"
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed values: no-store

Evidence responses are never cacheable.

WWW-Authenticate
string
Allowed values: Bearer
X-Request-Id
string
/^[0-9A-HJKMNP-TV-Z]{26}$/

Server-minted operation identifier for this request. It is generated by Evidence, never taken from the caller, and is the identifier a caller quotes to an operator. Problem responses repeat it in the operation member.

429

Section titled “429”

Request rate exceeded

Media typeapplication/problem+json
object
One of:
Evidence public problem Version 1
object
code
required
string
Allowed values: malformed_request
operation
required
string
/^[0-9A-HJKMNP-TV-Z]{26}$/
status
required
integer
Allowed values: 400
title
required
string
Allowed values: Request is not valid
type
required
string
Allowed values: https://registrystack.org/problems/evidence/malformed_request
code
required
string
Allowed values: rate_limited
status
required
integer
Allowed values: 429
title
required
string
Allowed values: Request rate exceeded
type
required
string
Allowed values: https://registrystack.org/problems/evidence/rate_limited
Example
{
  "code": "rate_limited",
  "status": 429,
  "title": "Request rate exceeded",
  "type": "https://registrystack.org/problems/evidence/rate_limited"
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed values: no-store

Evidence responses are never cacheable.

Retry-After
string
Allowed values: 1
X-Request-Id
string
/^[0-9A-HJKMNP-TV-Z]{26}$/

Server-minted operation identifier for this request. It is generated by Evidence, never taken from the caller, and is the identifier a caller quotes to an operator. Problem responses repeat it in the operation member.

503

Section titled “503”

Service temporarily unavailable

Media typeapplication/problem+json
object
One of:
Evidence public problem Version 1
object
code
required
string
Allowed values: malformed_request
operation
required
string
/^[0-9A-HJKMNP-TV-Z]{26}$/
status
required
integer
Allowed values: 400
title
required
string
Allowed values: Request is not valid
type
required
string
Allowed values: https://registrystack.org/problems/evidence/malformed_request
code
required
string
Allowed values: service_unavailable
status
required
integer
Allowed values: 503
title
required
string
Allowed values: Service temporarily unavailable
type
required
string
Allowed values: https://registrystack.org/problems/evidence/service_unavailable
Example
{
  "code": "service_unavailable",
  "status": 503,
  "title": "Service temporarily unavailable",
  "type": "https://registrystack.org/problems/evidence/service_unavailable"
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed values: no-store

Evidence responses are never cacheable.

X-Request-Id
string
/^[0-9A-HJKMNP-TV-Z]{26}$/

Server-minted operation identifier for this request. It is generated by Evidence, never taken from the caller, and is the identifier a caller quotes to an operator. Problem responses repeat it in the operation member.