Skip to content
Registry StackDocsDocumentation preview
Search

List attribute release profiles

GET
/v1/attribute-releases
curl --request GET \
  --url https://data.example.test/v1/attribute-releases \
  --header 'Authorization: Bearer <token>'

Returns all attribute release profiles visible to the calling principal. Authenticated-only: the response includes release_scope strings, which are never exposed anonymously.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Attribute release profile list.

Media typeapplication/json

List of attribute release profiles visible to the calling principal.

object
profiles
required
Array<object>

A governed identity attribute-release profile. Identifies the release scope, accepted subject id types, and the claim names that will be returned on a successful resolve.

object
accepted_subject_id_types
required

Subject identifier types accepted by this profile.

Array<string>
claim_names
required

Names of all claims that may be returned by this profile.

Array<string>
description

Human-readable profile description.

string | null
id
required

Profile identifier, lower-snake or lower-kebab. Globally unique with version.

string
purpose
required

Data-purpose token or IRI this profile is bound to.

string
release_scope
required

Dataset-bound scope a caller must hold to invoke this release. Distinct from the entity read scope.

string
required_claims
required

Names of claims that must be present in any successful response.

Array<string>
response_media_type
required

Media type of the resolve response. Always application/json in v1.

string
title

Human-readable profile title.

string | null
version
required

Profile version. Globally unique with id.

string
Example
{
  "profiles": [
    {
      "response_media_type": "application/json"
    }
  ]
}

401

Section titled “401”

Missing or invalid bearer credential.

Media typeapplication/problem+json

RFC 9457 Problem Details, returned for every non-2xx response.

object
code
required
string
detail
required
string
request_id
required
string
status
required
integer format: int32
title
required
string
type
required
string format: uri
key
additional properties
any
Example
{
  "code": "auth.missing_credential",
  "detail": "no credential provided in Authorization or x-api-key header",
  "request_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "status": 401,
  "title": "Missing credential",
  "type": "https://id.registrystack.org/problems/registry-relay/auth/missing_credential"
}

403

Section titled “403”

Authenticated principal lacks the scope required for this operation.

Media typeapplication/problem+json

RFC 9457 Problem Details, returned for every non-2xx response.

object
code
required
string
detail
required
string
request_id
required
string
status
required
integer format: int32
title
required
string
type
required
string format: uri
key
additional properties
any
Example
{
  "code": "auth.missing_credential",
  "detail": "no credential provided in Authorization or x-api-key header",
  "request_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "status": 401,
  "title": "Missing credential",
  "type": "https://id.registrystack.org/problems/registry-relay/auth/missing_credential"
}

default

Section titled “default”

Problem Details error response.

Media typeapplication/problem+json

RFC 9457 Problem Details, returned for every non-2xx response.

object
code
required
string
detail
required
string
request_id
required
string
status
required
integer format: int32
title
required
string
type
required
string format: uri
key
additional properties
any
Example
{
  "code": "auth.missing_credential",
  "detail": "no credential provided in Authorization or x-api-key header",
  "request_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "status": 401,
  "title": "Missing credential",
  "type": "https://id.registrystack.org/problems/registry-relay/auth/missing_credential"
}