Variable: ROUTES

const ROUTES: object

Defined in: packages/contracts/src/routes.ts:72

Every authenticated gateway route, keyed <METHOD> <path>. verifyEstate checks each names a registered request, that a GET is not a mutation, and that no admin route accepts the holder population.

Slice 1's routes are staff and public (D1.4). Slice 2's are the trust tree's, and every one is admin (D2.9): admitting an entity is the capability 28 section 1 says must be absent from the public surface, not guarded on it. The public deployment registers none of them and answers their paths as unknown.

Slice 3's are the identifier's, and they are public again (D3.7): an entity administering its own identifier is Studio's audience, which 17 puts on the public gateway behind authentication. Admitting the entity was the admin act; holding its own keys is not.

Type Declaration

GET /api/v1/accreditations

readonly GET /api/v1/accreditations: object

GET /api/v1/accreditations.contract

readonly contract: "request.*.governance.accreditation.list.v1" = 'request.*.governance.accreditation.list.v1'

GET /api/v1/accreditations.method

readonly method: "GET" = 'GET'

GET /api/v1/accreditations.path

readonly path: "/api/v1/accreditations" = '/api/v1/accreditations'

GET /api/v1/accreditations.permission

readonly permission: "accreditation.read" = 'accreditation.read'

GET /api/v1/accreditations.population

readonly population: "staff" = 'staff'

GET /api/v1/accreditations.surface

readonly surface: "admin" = 'admin'

GET /api/v1/accreditations/:id

readonly GET /api/v1/accreditations/:id: object

GET /api/v1/accreditations/:id.contract

readonly contract: "request.*.governance.accreditation.get.v1" = 'request.*.governance.accreditation.get.v1'

GET /api/v1/accreditations/:id.method

readonly method: "GET" = 'GET'

GET /api/v1/accreditations/:id.path

readonly path: "/api/v1/accreditations/:id" = '/api/v1/accreditations/:id'

GET /api/v1/accreditations/:id.permission

readonly permission: "accreditation.read" = 'accreditation.read'

GET /api/v1/accreditations/:id.population

readonly population: "staff" = 'staff'

GET /api/v1/accreditations/:id.surface

readonly surface: "admin" = 'admin'

GET /api/v1/entity-statements

readonly GET /api/v1/entity-statements: object

GET /api/v1/entity-statements.contract

readonly contract: "request.*.trust.entity-statement.list.v1" = 'request.*.trust.entity-statement.list.v1'

GET /api/v1/entity-statements.method

readonly method: "GET" = 'GET'

GET /api/v1/entity-statements.path

readonly path: "/api/v1/entity-statements" = '/api/v1/entity-statements'

GET /api/v1/entity-statements.permission

readonly permission: "entity-statement.read" = 'entity-statement.read'

GET /api/v1/entity-statements.population

readonly population: "staff" = 'staff'

GET /api/v1/entity-statements.surface

readonly surface: "admin" = 'admin'

GET /api/v1/entity-statements/:id/preview

readonly GET /api/v1/entity-statements/:id/preview: object

GET /api/v1/entity-statements/:id/preview.contract

readonly contract: "request.*.trust.entity-statement.preview.v1" = 'request.*.trust.entity-statement.preview.v1'

GET /api/v1/entity-statements/:id/preview.method

readonly method: "GET" = 'GET'

GET /api/v1/entity-statements/:id/preview.path

readonly path: "/api/v1/entity-statements/:id/preview" = '/api/v1/entity-statements/:id/preview'

GET /api/v1/entity-statements/:id/preview.permission

readonly permission: "entity-statement.read" = 'entity-statement.read'

GET /api/v1/entity-statements/:id/preview.population

readonly population: "staff" = 'staff'

GET /api/v1/entity-statements/:id/preview.surface

readonly surface: "admin" = 'admin'

GET /api/v1/grants

readonly GET /api/v1/grants: object

GET /api/v1/grants.contract

readonly contract: "request.*.identity.grant.list.v1" = 'request.*.identity.grant.list.v1'

GET /api/v1/grants.method

readonly method: "GET" = 'GET'

GET /api/v1/grants.path

readonly path: "/api/v1/grants" = '/api/v1/grants'

GET /api/v1/grants.permission

readonly permission: "grant.read" = 'grant.read'

GET /api/v1/grants.population

readonly population: "staff" = 'staff'

GET /api/v1/grants.surface

readonly surface: "public" = 'public'

GET /api/v1/identifiers

readonly GET /api/v1/identifiers: object

GET /api/v1/identifiers.contract

readonly contract: "request.*.issuance.identifier.list.v1" = 'request.*.issuance.identifier.list.v1'

GET /api/v1/identifiers.method

readonly method: "GET" = 'GET'

GET /api/v1/identifiers.path

readonly path: "/api/v1/identifiers" = '/api/v1/identifiers'

GET /api/v1/identifiers.permission

readonly permission: "identifier.read" = 'identifier.read'

GET /api/v1/identifiers.population

readonly population: "staff" = 'staff'

GET /api/v1/identifiers.surface

readonly surface: "public" = 'public'

GET /api/v1/identifiers/:id

readonly GET /api/v1/identifiers/:id: object

GET /api/v1/identifiers/:id.contract

readonly contract: "request.*.issuance.identifier.get.v1" = 'request.*.issuance.identifier.get.v1'

GET /api/v1/identifiers/:id.method

readonly method: "GET" = 'GET'

GET /api/v1/identifiers/:id.path

readonly path: "/api/v1/identifiers/:id" = '/api/v1/identifiers/:id'

GET /api/v1/identifiers/:id.permission

readonly permission: "identifier.read" = 'identifier.read'

GET /api/v1/identifiers/:id.population

readonly population: "staff" = 'staff'

GET /api/v1/identifiers/:id.surface

readonly surface: "public" = 'public'

GET /api/v1/identifiers/:id/preview

readonly GET /api/v1/identifiers/:id/preview: object

GET /api/v1/identifiers/:id/preview.contract

readonly contract: "request.*.issuance.identifier.preview.v1" = 'request.*.issuance.identifier.preview.v1'

GET /api/v1/identifiers/:id/preview.method

readonly method: "GET" = 'GET'

GET /api/v1/identifiers/:id/preview.path

readonly path: "/api/v1/identifiers/:id/preview" = '/api/v1/identifiers/:id/preview'

GET /api/v1/identifiers/:id/preview.permission

readonly permission: "identifier.read" = 'identifier.read'

GET /api/v1/identifiers/:id/preview.population

readonly population: "staff" = 'staff'

GET /api/v1/identifiers/:id/preview.surface

readonly surface: "public" = 'public'

GET /api/v1/me

readonly GET /api/v1/me: object

GET /api/v1/me.contract

readonly contract: "request.platform.identity.me.get.v1" = 'request.platform.identity.me.get.v1'

GET /api/v1/me.method

readonly method: "GET" = 'GET'

GET /api/v1/me.path

readonly path: "/api/v1/me" = '/api/v1/me'

GET /api/v1/me.permission

readonly permission: "none" = 'none'

GET /api/v1/me.population

readonly population: "staff" = 'staff'

GET /api/v1/me.surface

readonly surface: "public" = 'public'

GET /api/v1/persons/:id

readonly GET /api/v1/persons/:id: object

GET /api/v1/persons/:id.contract

readonly contract: "request.*.identity.person.get.v1" = 'request.*.identity.person.get.v1'

GET /api/v1/persons/:id.method

readonly method: "GET" = 'GET'

GET /api/v1/persons/:id.path

readonly path: "/api/v1/persons/:id" = '/api/v1/persons/:id'

GET /api/v1/persons/:id.permission

readonly permission: "person.read" = 'person.read'

GET /api/v1/persons/:id.population

readonly population: "staff" = 'staff'

GET /api/v1/persons/:id.surface

readonly surface: "public" = 'public'

GET /api/v1/subjects/:id

readonly GET /api/v1/subjects/:id: object

GET /api/v1/subjects/:id.contract

readonly contract: "request.*.identity.subject.get.v1" = 'request.*.identity.subject.get.v1'

GET /api/v1/subjects/:id.method

readonly method: "GET" = 'GET'

GET /api/v1/subjects/:id.path

readonly path: "/api/v1/subjects/:id" = '/api/v1/subjects/:id'

GET /api/v1/subjects/:id.permission

readonly permission: "subject.read" = 'subject.read'

GET /api/v1/subjects/:id.population

readonly population: "staff" = 'staff'

GET /api/v1/subjects/:id.surface

readonly surface: "public" = 'public'

POST /api/v1/accreditations

readonly POST /api/v1/accreditations: object

POST /api/v1/accreditations.contract

readonly contract: "request.*.governance.accreditation.apply.v1" = 'request.*.governance.accreditation.apply.v1'

POST /api/v1/accreditations.method

readonly method: "POST" = 'POST'

POST /api/v1/accreditations.path

readonly path: "/api/v1/accreditations" = '/api/v1/accreditations'

POST /api/v1/accreditations.permission

readonly permission: "accreditation.apply" = 'accreditation.apply'

POST /api/v1/accreditations.population

readonly population: "staff" = 'staff'

POST /api/v1/accreditations.surface

readonly surface: "admin" = 'admin'

POST /api/v1/accreditations/:id/admit

readonly POST /api/v1/accreditations/:id/admit: object

POST /api/v1/accreditations/:id/admit.contract

readonly contract: "request.*.governance.accreditation.admit.v1" = 'request.*.governance.accreditation.admit.v1'

POST /api/v1/accreditations/:id/admit.method

readonly method: "POST" = 'POST'

POST /api/v1/accreditations/:id/admit.path

readonly path: "/api/v1/accreditations/:id/admit" = '/api/v1/accreditations/:id/admit'

POST /api/v1/accreditations/:id/admit.permission

readonly permission: "accreditation.admit" = 'accreditation.admit'

POST /api/v1/accreditations/:id/admit.population

readonly population: "staff" = 'staff'

POST /api/v1/accreditations/:id/admit.surface

readonly surface: "admin" = 'admin'

POST /api/v1/accreditations/:id/publish

readonly POST /api/v1/accreditations/:id/publish: object

POST /api/v1/accreditations/:id/publish.contract

readonly contract: "request.*.governance.accreditation.publish.v1" = 'request.*.governance.accreditation.publish.v1'

POST /api/v1/accreditations/:id/publish.method

readonly method: "POST" = 'POST'

POST /api/v1/accreditations/:id/publish.path

readonly path: "/api/v1/accreditations/:id/publish" = '/api/v1/accreditations/:id/publish'

POST /api/v1/accreditations/:id/publish.permission

readonly permission: "accreditation.publish" = 'accreditation.publish'

POST /api/v1/accreditations/:id/publish.population

readonly population: "staff" = 'staff'

POST /api/v1/accreditations/:id/publish.surface

readonly surface: "admin" = 'admin'

POST /api/v1/grants

readonly POST /api/v1/grants: object

POST /api/v1/grants.contract

readonly contract: "request.*.identity.grant.create.v1" = 'request.*.identity.grant.create.v1'

POST /api/v1/grants.method

readonly method: "POST" = 'POST'

POST /api/v1/grants.path

readonly path: "/api/v1/grants" = '/api/v1/grants'

POST /api/v1/grants.permission

readonly permission: "grant.create" = 'grant.create'

POST /api/v1/grants.population

readonly population: "staff" = 'staff'

POST /api/v1/grants.surface

readonly surface: "public" = 'public'

POST /api/v1/grants/:id/revoke

readonly POST /api/v1/grants/:id/revoke: object

POST /api/v1/grants/:id/revoke.contract

readonly contract: "request.*.identity.grant.revoke.v1" = 'request.*.identity.grant.revoke.v1'

POST /api/v1/grants/:id/revoke.method

readonly method: "POST" = 'POST'

POST /api/v1/grants/:id/revoke.path

readonly path: "/api/v1/grants/:id/revoke" = '/api/v1/grants/:id/revoke'

POST /api/v1/grants/:id/revoke.permission

readonly permission: "grant.revoke" = 'grant.revoke'

POST /api/v1/grants/:id/revoke.population

readonly population: "staff" = 'staff'

POST /api/v1/grants/:id/revoke.surface

readonly surface: "public" = 'public'

POST /api/v1/identifiers

readonly POST /api/v1/identifiers: object

POST /api/v1/identifiers.contract

readonly contract: "request.*.issuance.identifier.create.v1" = 'request.*.issuance.identifier.create.v1'

POST /api/v1/identifiers.method

readonly method: "POST" = 'POST'

POST /api/v1/identifiers.path

readonly path: "/api/v1/identifiers" = '/api/v1/identifiers'

POST /api/v1/identifiers.permission

readonly permission: "identifier.create" = 'identifier.create'

POST /api/v1/identifiers.population

readonly population: "staff" = 'staff'

POST /api/v1/identifiers.surface

readonly surface: "public" = 'public'

POST /api/v1/identifiers/:id/publish

readonly POST /api/v1/identifiers/:id/publish: object

POST /api/v1/identifiers/:id/publish.contract

readonly contract: "request.*.issuance.identifier.publish.v1" = 'request.*.issuance.identifier.publish.v1'

POST /api/v1/identifiers/:id/publish.method

readonly method: "POST" = 'POST'

POST /api/v1/identifiers/:id/publish.path

readonly path: "/api/v1/identifiers/:id/publish" = '/api/v1/identifiers/:id/publish'

POST /api/v1/identifiers/:id/publish.permission

readonly permission: "identifier.publish" = 'identifier.publish'

POST /api/v1/identifiers/:id/publish.population

readonly population: "staff" = 'staff'

POST /api/v1/identifiers/:id/publish.surface

readonly surface: "public" = 'public'

POST /api/v1/identifiers/:id/update

readonly POST /api/v1/identifiers/:id/update: object

POST /api/v1/identifiers/:id/update.contract

readonly contract: "request.*.issuance.identifier.update.v1" = 'request.*.issuance.identifier.update.v1'

POST /api/v1/identifiers/:id/update.method

readonly method: "POST" = 'POST'

POST /api/v1/identifiers/:id/update.path

readonly path: "/api/v1/identifiers/:id/update" = '/api/v1/identifiers/:id/update'

POST /api/v1/identifiers/:id/update.permission

readonly permission: "identifier.update" = 'identifier.update'

POST /api/v1/identifiers/:id/update.population

readonly population: "staff" = 'staff'

POST /api/v1/identifiers/:id/update.surface

readonly surface: "public" = 'public'

POST /api/v1/persons

readonly POST /api/v1/persons: object

POST /api/v1/persons.contract

readonly contract: "request.*.identity.person.create.v1" = 'request.*.identity.person.create.v1'

POST /api/v1/persons.method

readonly method: "POST" = 'POST'

POST /api/v1/persons.path

readonly path: "/api/v1/persons" = '/api/v1/persons'

POST /api/v1/persons.permission

readonly permission: "person.create" = 'person.create'

POST /api/v1/persons.population

readonly population: "staff" = 'staff'

POST /api/v1/persons.surface

readonly surface: "public" = 'public'

POST /api/v1/persons/:id/invitation

readonly POST /api/v1/persons/:id/invitation: object

POST /api/v1/persons/:id/invitation.contract

readonly contract: "request.*.identity.person.invite.v1" = 'request.*.identity.person.invite.v1'

POST /api/v1/persons/:id/invitation.method

readonly method: "POST" = 'POST'

POST /api/v1/persons/:id/invitation.path

readonly path: "/api/v1/persons/:id/invitation" = '/api/v1/persons/:id/invitation'

POST /api/v1/persons/:id/invitation.permission

readonly permission: "person.create" = 'person.create'

POST /api/v1/persons/:id/invitation.population

readonly population: "staff" = 'staff'

POST /api/v1/persons/:id/invitation.surface

readonly surface: "public" = 'public'

POST /api/v1/subjects

readonly POST /api/v1/subjects: object

POST /api/v1/subjects.contract

readonly contract: "request.*.identity.subject.create.v1" = 'request.*.identity.subject.create.v1'

POST /api/v1/subjects.method

readonly method: "POST" = 'POST'

POST /api/v1/subjects.path

readonly path: "/api/v1/subjects" = '/api/v1/subjects'

POST /api/v1/subjects.permission

readonly permission: "subject.create" = 'subject.create'

POST /api/v1/subjects.population

readonly population: "staff" = 'staff'

POST /api/v1/subjects.surface

readonly surface: "public" = 'public'