API reference · Enrolment
Read an invitation
GET
/v1/enrollments/{invitationId}The invitation’s state and when it expires. Authorised with the enrolment token, not a signature.
PermissionNone
AuthenticationEnrolment token
Staff-set limits it counts towardNone
.NET SDK
enrollment.GetAsync()Parameters
| Name | In | Type | Notes |
|---|---|---|---|
invitationIdrequired | path | UUID | A UUID, lower-case with hyphens. |
Request
Authorised with Authorization: Enrollment <token>; not signed.
Headers: Accept-Language (optional). The SDKs set all of them for you.
Body: none.
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | Success. | EnrollmentState |
| 401 | Refused: not authenticated. | Problem |
| 404 | Refused: not found, or not yours. | Problem |
| 429 | Refused: a limit was reached. | Problem |
| 503 | No decision: a dependency was unavailable. | Problem |
Every answer is signed by Anis; the SDKs check it before you see it.
Refusals
Every refusal is a signed problem. Branch on its code; each links to what it means and what to do.
| Error | Code | Status |
|---|---|---|
| Invitation invalid | invitation_invalid | 401 |
| Not found | resource_not_found | 404 |
| Rate limited | rate_limited | 429 |
| Service unavailable | dependency_unavailable | 503 |
| Request timeout | request_timeout | 504 |
| Internal error | internal_error | 500 |
Types
EnrollmentState
| Field | Type | Notes |
|---|---|---|
invitationId | UUID | The invitation. |
applicationId | UUID | The application being enrolled. |
state | string | pendingInvitation, pendingPublicKey, pendingProof, pendingApproval, active or unavailable. |
expiresAt | string (date-time) | When the invitation expires — about a day after it is issued, by default. |