Skip to content
Kindgi

Read a site

View as Markdown
GET
/v1/projects/{projectId}/sites/{siteId}
curl --request GET \
  --url https://example.com/v1/projects/example/sites/example \
  --header 'Authorization: Bearer <token>'

Its settings and its keys (ids and thumbprints only). Tenant admins only.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string

ProjectId — opaque branded string.

siteId
required
string

The site id (a UUID).

Responses

Section titled “Responses”

200

Section titled “200”

The site.

Media typeapplication/json

A site that signs its own people in to one project: it vouches for whoever is signed in there, so they ask the project’s agents and decide its approvals as themselves. Each person it signs in is a person of the tenant, shown as “, via ”.

object
siteId
required
string format: uuid
projectId
required
string format: uuid
displayName
required

Set by a tenant admin, never by the site: shown after every name the site signs in.

string
origin
required

The site’s origin (https://acme-store.example).

string
approvalsUrl
required

Where an approval opens on the site; {approvalId} is replaced. A site’s people get it in their reviewer email.

string
allowedRoles
required
Array<string>
roleMap
required

Role → grant. A person with several allowed roles gets the most any of them gives.

object
key
additional properties

What a person with one of the site’s roles gets in the site’s project. Reading the project comes with every role; nothing above it ever does.

object
ask
required

Whether they may start turns with the project’s agents.

boolean
reviewer

The reviewer role they decide approvals with, at most the site’s reviewerCeiling; absent: they decide none.

string
Allowed values: standard senior
reviewerCeiling
required
string
Allowed values: standard senior
vouching
required

Whether the site’s statements are accepted.

boolean
peopleCap
required

At most this many live people from the site.

integer
>= 1
newPeoplePerDay
required

At most this many new people from the site per day.

integer
>= 1
keys
required
Array<object>

One of the site’s live public keys. Kindgi never has a private half.

object
kid
required
string
thumbprint
required

The key’s RFC 7638 thumbprint, to compare with the one the site shows.

string
addedAt
required
string format: date-time
audience

What the site’s statements carry as aud: this deployment’s public URL, given at enrollment.

string
createdAt
required
string format: date-time
createdBy
string
pausedAt
string format: date-time
unregisteredAt
string format: date-time
Example
{
  "roleMap": {
    "additionalProperty": {
      "reviewer": "standard"
    }
  },
  "reviewerCeiling": "standard"
}

401

Section titled “401”

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

403

Section titled “403”

Not a tenant admin.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

404

Section titled “404”

No site with that id in this project (site-not-found).

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

See also