Skip to content
Artbucket

Who can reach it, and why

GET
/api/v1/catalog/{ref}/access
curl --request GET \
  --url http://localhost:3000/api/v1/catalog/example/access \
  --header 'Authorization: Bearer <token>'

Scope: read.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
ref
required
string

An id, or an address

Query Parameters

Section titled “Query Parameters”
who
string

One person, by id or email

Responses

Section titled “Responses”

200

Section titled “200”

Holders

Media typeapplication/json
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
private
required
boolean
holders
required
Array<object>
object
kind
required
string
who
required
string
role
required
string
scope
required
string | null
via
required
string
on
required
Any of:
object
type
required
string
Allowed values: asset brand collection
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
granted
required

The grants made on it, each changed with POST /api/v1/grants or taken back with DELETE /api/v1/grants/{grant}

Array<object>
object
grant
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
kind
required
string
Allowed values: person group
id
required
string
who
required
string
scope
required
string
Example
{
  "on": {
    "type": "asset"
  },
  "granted": [
    {
      "kind": "person"
    }
  ]
}

default

Section titled “default”

An error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
detail
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}