{ "openapi": "3.1.1", "info": { "title": "Studmart API Platform", "description": "Standalone partner API. Local Sandbox is simulated. Existing Studmart integrations are blocked; no DEV or production deployment.", "version": "1.0.0" }, "servers": [ { "url": "http://127.0.0.1:5087/" } ], "paths": { "/healthz": { "get": { "tags": [ "Studmart.ApiPlatform" ], "operationId": "get_healthz", "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "status", "mode", "studmartConnected" ], "type": "object", "properties": { "status": { "type": "string" }, "mode": { "type": "string" }, "studmartConnected": { "type": "boolean" } }, "additionalProperties": false } } } } } } }, "/ready": { "get": { "tags": [ "Studmart.ApiPlatform" ], "operationId": "get_ready", "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "status" ], "type": "object", "properties": { "status": { "type": "string" } }, "additionalProperties": false } } } }, "503": { "description": "Own local database unavailable; no response body." } } } }, "/api/admin/v1/platform/capabilities": { "get": { "tags": [ "Studmart.ApiPlatform" ], "operationId": "get_api_admin_v1_platform_capabilities", "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "mode", "studmartConnected", "blockers" ], "type": "object", "properties": { "mode": { "type": "string" }, "studmartConnected": { "type": "boolean" }, "blockers": { "type": "array", "items": { "required": [ "code", "capability", "state", "requiredOwner", "requirement" ], "type": "object", "properties": { "code": { "type": "string" }, "capability": { "type": "string" }, "state": { "type": "string" }, "requiredOwner": { "type": "string" }, "requirement": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "operatorBearer": [] } ] } }, "/api/v1/platform/oauth/token": { "post": { "tags": [ "OAuth" ], "description": "OAuth 2.0 client_credentials. Authenticate using client_id/client_secret form parameters or HTTP Basic (not both). Requested scopes must be a subset of the registered scopes. Access token expires after 600 seconds; rotation/revocation invalidates existing tokens.", "operationId": "post_api_v1_platform_oauth_token", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "grant_type" ], "type": "object", "properties": { "grant_type": { "type": "string", "description": "client_credentials" }, "client_id": { "type": "string" }, "client_secret": { "type": "string", "format": "password" }, "scope": { "type": "string", "description": "Space-delimited permitted scopes" } } } } }, "required": true }, "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "access_token", "token_type", "expires_in", "scope" ], "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "expires_in": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "scope": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "OAuth invalid request/client/scope or bounded platform request failure.", "content": { "application/json": { "schema": { "oneOf": [ { "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "additionalProperties": false }, { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } ] } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "401": { "description": "Invalid HTTP Basic client credentials.", "content": { "application/json": { "schema": { "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "additionalProperties": false } } } }, "429": { "description": "IP or application quota exceeded.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } } } }, "/api/v1/platform/programs/{id}": { "get": { "tags": [ "Programs" ], "operationId": "get_api_v1_platform_programs_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "id", "applicationId", "name", "status", "minimumAssurance", "benefitType", "validFrom", "validUntil", "purposes", "allowedEventTypes", "retentionDays", "maxIssuancesPerSubject", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "applicationId": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "minimumAssurance": { "type": "string" }, "benefitType": { "type": "string" }, "validFrom": { "type": "string", "format": "date-time" }, "validUntil": { "type": "string", "format": "date-time" }, "purposes": { "type": "array", "items": { "type": "string" } }, "allowedEventTypes": { "type": "array", "items": { "type": "string" } }, "retentionDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maxIssuancesPerSubject": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "partnerOAuth": [ "programs:read" ] } ] } }, "/api/v1/platform/benefits": { "post": { "tags": [ "Benefits" ], "operationId": "post_api_v1_platform_benefits", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Application-scoped retry key, 1–128 characters. Reusing a key with a changed payload fails.", "required": true, "schema": { "maxLength": 128, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueBenefitRequest" } } }, "required": true }, "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "id", "subject", "programId", "status", "benefitType", "code", "simulated", "duplicate", "fulfillment" ], "type": "object", "properties": { "id": { "type": "string" }, "subject": { "type": "string" }, "programId": { "type": "string" }, "status": { "type": "string" }, "benefitType": { "type": "string" }, "code": { "type": "string" }, "simulated": { "type": "boolean" }, "duplicate": { "type": "boolean" }, "fulfillment": { "type": "string" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "partnerOAuth": [ "benefits:issue" ] } ] } }, "/api/v1/platform/benefits/{id}": { "get": { "tags": [ "Benefits" ], "operationId": "get_api_v1_platform_benefits_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "id", "programId", "subject", "status", "simulated", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "programId": { "type": "string" }, "subject": { "type": "string" }, "status": { "type": "string" }, "simulated": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "partnerOAuth": [ "benefits:read" ] } ] } }, "/api/admin/v1/platform/benefits": { "get": { "tags": [ "Operator console" ], "operationId": "get_api_admin_v1_platform_benefits", "parameters": [ { "name": "applicationId", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "items", "total" ], "type": "object", "properties": { "items": { "type": "array", "items": { "required": [ "id", "applicationId", "programId", "status", "simulated", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "applicationId": { "type": "string" }, "programId": { "type": "string" }, "status": { "type": "string" }, "simulated": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "operatorBearer": [] } ] } }, "/api/admin/v1/platform/overview": { "get": { "tags": [ "Operator console" ], "operationId": "get_api_admin_v1_platform_overview", "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "partners", "applications", "programs", "clients", "integrationMode", "studmartConnected", "deployment" ], "type": "object", "properties": { "partners": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "applications": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "programs": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "clients": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "integrationMode": { "type": "string" }, "studmartConnected": { "type": "boolean" }, "deployment": { "type": "string" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "operatorBearer": [] } ] } }, "/api/admin/v1/platform/partners": { "get": { "tags": [ "Operator console" ], "operationId": "get_api_admin_v1_platform_partners", "parameters": [ { "name": "page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "items", "total" ], "type": "object", "properties": { "items": { "type": "array", "items": { "required": [ "id", "name", "status", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "operatorBearer": [] } ] }, "post": { "tags": [ "Operator console" ], "operationId": "post_api_admin_v1_platform_partners", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePartner" } } }, "required": true }, "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "required": [ "id", "name", "status", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "operatorBearer": [] } ] } }, "/api/admin/v1/platform/applications": { "get": { "tags": [ "Operator console" ], "operationId": "get_api_admin_v1_platform_applications", "parameters": [ { "name": "page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "items", "total" ], "type": "object", "properties": { "items": { "type": "array", "items": { "required": [ "id", "partnerId", "name", "environment", "status", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "partnerId": { "type": "string" }, "name": { "type": "string" }, "environment": { "type": "string" }, "status": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "operatorBearer": [] } ] }, "post": { "tags": [ "Operator console" ], "operationId": "post_api_admin_v1_platform_applications", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApplication" } } }, "required": true }, "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "required": [ "id", "partnerId", "name", "environment", "status", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "partnerId": { "type": "string" }, "name": { "type": "string" }, "environment": { "type": "string" }, "status": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "operatorBearer": [] } ] } }, "/api/admin/v1/platform/programs": { "get": { "tags": [ "Operator console" ], "operationId": "get_api_admin_v1_platform_programs", "parameters": [ { "name": "applicationId", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "items", "total" ], "type": "object", "properties": { "items": { "type": "array", "items": { "required": [ "id", "applicationId", "name", "status", "minimumAssurance", "benefitType", "validFrom", "validUntil", "purposes", "allowedEventTypes", "retentionDays", "maxIssuancesPerSubject", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "applicationId": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "minimumAssurance": { "type": "string" }, "benefitType": { "type": "string" }, "validFrom": { "type": "string", "format": "date-time" }, "validUntil": { "type": "string", "format": "date-time" }, "purposes": { "type": "array", "items": { "type": "string" } }, "allowedEventTypes": { "type": "array", "items": { "type": "string" } }, "retentionDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maxIssuancesPerSubject": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "operatorBearer": [] } ] }, "post": { "tags": [ "Operator console" ], "operationId": "post_api_admin_v1_platform_programs", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProgram" } } }, "required": true }, "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "required": [ "id", "applicationId", "name", "status", "minimumAssurance", "benefitType", "validFrom", "validUntil", "purposes", "allowedEventTypes", "retentionDays", "maxIssuancesPerSubject", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "applicationId": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "minimumAssurance": { "type": "string" }, "benefitType": { "type": "string" }, "validFrom": { "type": "string", "format": "date-time" }, "validUntil": { "type": "string", "format": "date-time" }, "purposes": { "type": "array", "items": { "type": "string" } }, "allowedEventTypes": { "type": "array", "items": { "type": "string" } }, "retentionDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maxIssuancesPerSubject": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "operatorBearer": [] } ] } }, "/api/admin/v1/platform/{kind}/{id}/status": { "put": { "tags": [ "Operator console" ], "operationId": "put_api_admin_v1_platform_kind_id_status", "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeStatus" } } }, "required": true }, "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "id", "status" ], "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "operatorBearer": [] } ] } }, "/api/admin/v1/platform/clients": { "get": { "tags": [ "Operator console" ], "operationId": "get_api_admin_v1_platform_clients", "parameters": [ { "name": "page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "items", "total" ], "type": "object", "properties": { "items": { "type": "array", "items": { "required": [ "id", "applicationId", "name", "scopes", "revoked", "version", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "applicationId": { "type": "string" }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "revoked": { "type": "boolean" }, "version": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "operatorBearer": [] } ] }, "post": { "tags": [ "Operator console" ], "operationId": "post_api_admin_v1_platform_clients", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateClient" } } }, "required": true }, "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "required": [ "id", "applicationId", "name", "scopes", "clientSecret" ], "type": "object", "properties": { "id": { "type": "string" }, "applicationId": { "type": "string" }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "clientSecret": { "type": "string" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "operatorBearer": [] } ] } }, "/api/admin/v1/platform/clients/{id}/rotate": { "post": { "tags": [ "Operator console" ], "operationId": "post_api_admin_v1_platform_clients_id_rotate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "id", "applicationId", "clientSecret", "version" ], "type": "object", "properties": { "id": { "type": "string" }, "applicationId": { "type": "string" }, "clientSecret": { "type": "string" }, "version": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "operatorBearer": [] } ] } }, "/api/admin/v1/platform/clients/{id}/revoke": { "post": { "tags": [ "Operator console" ], "operationId": "post_api_admin_v1_platform_clients_id_revoke", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "id", "revoked" ], "type": "object", "properties": { "id": { "type": "string" }, "revoked": { "type": "boolean" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "operatorBearer": [] } ] } }, "/api/admin/v1/platform/usage": { "get": { "tags": [ "Operator console" ], "operationId": "get_api_admin_v1_platform_usage", "parameters": [ { "name": "applicationId", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "items", "total" ], "type": "object", "properties": { "items": { "type": "array", "items": { "required": [ "id", "applicationId", "operation", "outcome", "purpose", "resourceId", "correlationId", "occurredAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "applicationId": { "type": [ "null", "string" ] }, "operation": { "type": "string" }, "outcome": { "type": "string" }, "purpose": { "type": [ "null", "string" ] }, "resourceId": { "type": [ "null", "string" ] }, "correlationId": { "type": "string", "format": "uuid" }, "occurredAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "operatorBearer": [] } ] } }, "/api/v1/platform/sandbox/grants": { "post": { "tags": [ "Identity and student assertions" ], "operationId": "post_api_v1_platform_sandbox_grants", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Application-scoped retry key, 1–128 characters. Reusing a key with a changed payload fails.", "required": true, "schema": { "maxLength": 128, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxGrantRequest" } } }, "required": true }, "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "grantCode", "expiresAt", "consentId", "simulated", "scenario" ], "type": "object", "properties": { "grantCode": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" }, "consentId": { "type": "string" }, "simulated": { "type": "boolean" }, "scenario": { "type": "string" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "partnerOAuth": [ "sandbox:simulate" ] } ] } }, "/api/v1/platform/identity/resolve": { "post": { "tags": [ "Identity and student assertions" ], "operationId": "post_api_v1_platform_identity_resolve", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityRequest" } } }, "required": true }, "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "status", "subject", "linkId", "provenance", "simulated", "reasonCodes" ], "type": "object", "properties": { "status": { "type": "string" }, "subject": { "type": [ "null", "string" ] }, "linkId": { "type": [ "null", "string" ] }, "provenance": { "type": [ "null", "string" ] }, "simulated": { "type": "boolean" }, "reasonCodes": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "partnerOAuth": [ "identity:resolve" ] } ] } }, "/api/v1/platform/identity/links": { "post": { "tags": [ "Identity and student assertions" ], "operationId": "post_api_v1_platform_identity_links", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Application-scoped retry key, 1–128 characters. Reusing a key with a changed payload fails.", "required": true, "schema": { "maxLength": 128, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityRequest" } } }, "required": true }, "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "status", "subject", "linkId", "provenance", "simulated", "reasonCodes" ], "type": "object", "properties": { "status": { "type": "string" }, "subject": { "type": [ "null", "string" ] }, "linkId": { "type": [ "null", "string" ] }, "provenance": { "type": [ "null", "string" ] }, "simulated": { "type": "boolean" }, "reasonCodes": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "partnerOAuth": [ "identity:link" ] } ] }, "get": { "tags": [ "Identity and student assertions" ], "operationId": "get_api_v1_platform_identity_links", "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "items", "total" ], "type": "object", "properties": { "items": { "type": "array", "items": { "required": [ "id", "subject", "status", "provenance", "simulated", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "subject": { "type": "string" }, "status": { "type": "string" }, "provenance": { "type": "string" }, "simulated": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "partnerOAuth": [ "identity:resolve" ] } ] } }, "/api/v1/platform/identity/links/{id}": { "get": { "tags": [ "Identity and student assertions" ], "operationId": "get_api_v1_platform_identity_links_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "id", "subject", "status", "provenance", "simulated", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "subject": { "type": "string" }, "status": { "type": "string" }, "provenance": { "type": "string" }, "simulated": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "partnerOAuth": [ "identity:resolve" ] } ] } }, "/api/v1/platform/consents": { "get": { "tags": [ "Identity and student assertions" ], "operationId": "get_api_v1_platform_consents", "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "items", "total" ], "type": "object", "properties": { "items": { "type": "array", "items": { "required": [ "id", "purposes", "grantedAt", "expiresAt", "revokedAt", "simulated" ], "type": "object", "properties": { "id": { "type": "string" }, "purposes": { "type": "array", "items": { "type": "string" } }, "grantedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "revokedAt": { "type": [ "null", "string" ], "format": "date-time" }, "simulated": { "type": "boolean" } }, "additionalProperties": false } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "partnerOAuth": [ "sandbox:simulate" ] } ] } }, "/api/v1/platform/sandbox/consents/{id}/revoke": { "post": { "tags": [ "Identity and student assertions" ], "operationId": "post_api_v1_platform_sandbox_consents_id_revoke", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "description": "Application-scoped retry key, 1–128 characters. Reusing a key with a changed payload fails.", "required": true, "schema": { "maxLength": 128, "minLength": 1, "type": "string" } } ], "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "revoked", "simulated" ], "type": "object", "properties": { "revoked": { "type": "boolean" }, "simulated": { "type": "boolean" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "partnerOAuth": [ "sandbox:simulate" ] } ] } }, "/api/v1/platform/verifications": { "post": { "tags": [ "Identity and student assertions" ], "operationId": "post_api_v1_platform_verifications", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Application-scoped retry key, 1–128 characters. Reusing a key with a changed payload fails.", "required": true, "schema": { "maxLength": 128, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialRequest" } } }, "required": true }, "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "id", "status", "subject", "programId", "credentialId", "student", "assuranceLevel", "validUntil", "simulated", "reasonCodes", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "subject": { "type": "string" }, "programId": { "type": "string" }, "credentialId": { "type": [ "null", "string" ] }, "student": { "type": "boolean" }, "assuranceLevel": { "type": [ "null", "string" ] }, "validUntil": { "type": [ "null", "string" ], "format": "date-time" }, "simulated": { "type": "boolean" }, "reasonCodes": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "partnerOAuth": [ "verification:create" ] } ] }, "get": { "tags": [ "Identity and student assertions" ], "operationId": "get_api_v1_platform_verifications", "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "items", "total" ], "type": "object", "properties": { "items": { "type": "array", "items": { "required": [ "id", "status", "subject", "programId", "credentialId", "student", "assuranceLevel", "validUntil", "simulated", "reasonCodes", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "subject": { "type": "string" }, "programId": { "type": "string" }, "credentialId": { "type": [ "null", "string" ] }, "student": { "type": "boolean" }, "assuranceLevel": { "type": [ "null", "string" ] }, "validUntil": { "type": [ "null", "string" ], "format": "date-time" }, "simulated": { "type": "boolean" }, "reasonCodes": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "partnerOAuth": [ "verification:read" ] } ] } }, "/api/v1/platform/verifications/{id}": { "get": { "tags": [ "Identity and student assertions" ], "operationId": "get_api_v1_platform_verifications_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "id", "status", "subject", "programId", "credentialId", "student", "assuranceLevel", "validUntil", "simulated", "reasonCodes", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "subject": { "type": "string" }, "programId": { "type": "string" }, "credentialId": { "type": [ "null", "string" ] }, "student": { "type": "boolean" }, "assuranceLevel": { "type": [ "null", "string" ] }, "validUntil": { "type": [ "null", "string" ], "format": "date-time" }, "simulated": { "type": "boolean" }, "reasonCodes": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "partnerOAuth": [ "verification:read" ] } ] } }, "/api/v1/platform/credentials/introspect": { "post": { "tags": [ "Identity and student assertions" ], "operationId": "post_api_v1_platform_credentials_introspect", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialRequest" } } }, "required": true }, "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "active", "student", "assuranceLevel", "validUntil", "credentialId", "simulated", "reasonCodes" ], "type": "object", "properties": { "active": { "type": "boolean" }, "student": { "type": "boolean" }, "assuranceLevel": { "type": [ "null", "string" ] }, "validUntil": { "type": [ "null", "string" ], "format": "date-time" }, "credentialId": { "type": [ "null", "string" ] }, "simulated": { "type": "boolean" }, "reasonCodes": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "partnerOAuth": [ "credential:verify" ] } ] } }, "/api/v1/platform/eligibility/check": { "post": { "tags": [ "Identity and student assertions" ], "operationId": "post_api_v1_platform_eligibility_check", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialRequest" } } }, "required": true }, "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "eligible", "decision", "reasonCodes", "simulated" ], "type": "object", "properties": { "eligible": { "type": "boolean" }, "decision": { "type": "string" }, "reasonCodes": { "type": "array", "items": { "type": "string" } }, "simulated": { "type": "boolean" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "partnerOAuth": [ "eligibility:check" ] } ] } }, "/api/v1/platform/events": { "post": { "tags": [ "Studmart.ApiPlatform" ], "operationId": "post_api_v1_platform_events", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityRequest" } } }, "required": true }, "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "id", "status", "simulated" ], "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "simulated": { "type": "boolean" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "partnerOAuth": [ "activity:write" ] } ] }, "get": { "tags": [ "Studmart.ApiPlatform" ], "operationId": "get_api_v1_platform_events", "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "items", "total" ], "type": "object", "properties": { "items": { "type": "array", "items": { "required": [ "id", "programId", "type", "schemaVersion", "purpose", "amount", "currency", "simulated", "occurredAt", "receivedAt", "retainUntil" ], "type": "object", "properties": { "id": { "type": "string" }, "programId": { "type": "string" }, "type": { "type": "string" }, "schemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "purpose": { "type": "string" }, "amount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "currency": { "type": [ "null", "string" ] }, "simulated": { "type": "boolean" }, "occurredAt": { "type": "string", "format": "date-time" }, "receivedAt": { "type": "string", "format": "date-time" }, "retainUntil": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "partnerOAuth": [ "analytics:read" ] } ] } }, "/api/v1/platform/events/batch": { "post": { "tags": [ "Studmart.ApiPlatform" ], "operationId": "post_api_v1_platform_events_batch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityBatchRequest" } } }, "required": true }, "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "results" ], "type": "object", "properties": { "results": { "type": "array", "items": { "required": [ "index", "status" ], "type": "object", "properties": { "index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "status": { "type": "string" }, "id": { "type": [ "null", "string" ] }, "code": { "type": [ "null", "string" ] }, "simulated": { "type": [ "null", "boolean" ] } }, "additionalProperties": false } } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "partnerOAuth": [ "activity:write" ] } ] } }, "/api/v1/platform/analytics": { "get": { "tags": [ "Studmart.ApiPlatform" ], "operationId": "get_api_v1_platform_analytics", "parameters": [ { "name": "programId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "source", "statisticsIntegration", "since", "truncated", "metrics" ], "type": "object", "properties": { "source": { "type": "string" }, "statisticsIntegration": { "type": "string" }, "since": { "type": "string", "format": "date" }, "truncated": { "type": "boolean" }, "metrics": { "type": "array", "items": { "required": [ "date", "programId", "operation", "outcome", "purpose", "activityType", "count", "amount", "currency" ], "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "programId": { "type": "string" }, "operation": { "type": "string" }, "outcome": { "type": "string" }, "purpose": { "type": "string" }, "activityType": { "type": "string" }, "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "amount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "currency": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "partnerOAuth": [ "analytics:read" ] } ] } }, "/api/v1/platform/webhooks": { "post": { "tags": [ "Studmart.ApiPlatform" ], "operationId": "post_api_v1_platform_webhooks", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "id", "url", "eventTypes", "purpose", "status", "signingSecret" ], "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string" } }, "purpose": { "type": "string" }, "status": { "type": "string" }, "signingSecret": { "type": "string" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "partnerOAuth": [ "webhooks:manage" ] } ] }, "get": { "tags": [ "Studmart.ApiPlatform" ], "operationId": "get_api_v1_platform_webhooks", "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "items", "total" ], "type": "object", "properties": { "items": { "type": "array", "items": { "required": [ "id", "url", "eventTypes", "purpose", "status", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string" } }, "purpose": { "type": "string" }, "status": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "partnerOAuth": [ "webhooks:manage" ] } ] } }, "/api/v1/platform/webhooks/{id}": { "delete": { "tags": [ "Studmart.ApiPlatform" ], "operationId": "delete_api_v1_platform_webhooks_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Disabled; no response body." }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "partnerOAuth": [ "webhooks:manage" ] } ] } }, "/api/v1/platform/webhooks/deliveries": { "get": { "tags": [ "Studmart.ApiPlatform" ], "operationId": "get_api_v1_platform_webhooks_deliveries", "responses": { "200": { "description": "Success. Sandbox data is explicitly simulated.", "content": { "application/json": { "schema": { "required": [ "items", "total" ], "type": "object", "properties": { "items": { "type": "array", "items": { "required": [ "id", "subscriptionId", "eventType", "purpose", "status", "attempts", "lastStatusCode", "createdAt", "nextAttemptAt", "completedAt" ], "type": "object", "properties": { "id": { "type": "string" }, "subscriptionId": { "type": "string" }, "eventType": { "type": "string" }, "purpose": { "type": "string" }, "status": { "type": "string" }, "attempts": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "lastStatusCode": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "nextAttemptAt": { "type": "string", "format": "date-time" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time" } }, "additionalProperties": false } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "additionalProperties": false } } } }, "401": { "description": "UNAUTHENTICATED: missing, expired, revoked or invalid credential.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "403": { "description": "SCOPE_DENIED, TENANT_INACTIVE or purpose/consent denied.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "429": { "description": "RATE_LIMITED; Retry-After header indicates wait.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT, LINK_CONFLICT, ineligible or replay invariant violation.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "503": { "description": "Required real Studmart owner capability is unavailable; see /api/admin/v1/platform/capabilities.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "400": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "404": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "413": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "500": { "description": "Safe platform error; inspect code and correlationId.", "content": { "application/json": { "schema": { "required": [ "type", "title", "status", "code", "correlationId" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } } }, "security": [ { "partnerOAuth": [ "webhooks:manage" ] } ] } } }, "components": { "schemas": { "ActivityBatchRequest": { "required": [ "events" ], "type": "object", "properties": { "events": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityRequest" } } }, "additionalProperties": false }, "ActivityRequest": { "required": [ "eventId", "type", "schemaVersion", "occurredAt", "subject", "programId", "purpose", "properties" ], "type": "object", "properties": { "eventId": { "type": "string" }, "type": { "type": "string" }, "schemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "occurredAt": { "type": "string", "format": "date-time" }, "subject": { "$ref": "#/components/schemas/SubjectReference" }, "programId": { "type": "string" }, "purpose": { "type": "string" }, "properties": { "$ref": "#/components/schemas/JsonElement" } }, "additionalProperties": false }, "ChangeStatus": { "required": [ "status" ], "type": "object", "properties": { "status": { "type": "string" } }, "additionalProperties": false }, "CreateApplication": { "required": [ "partnerId", "name", "environment" ], "type": "object", "properties": { "partnerId": { "type": "string" }, "name": { "type": "string" }, "environment": { "type": "string" } }, "additionalProperties": false }, "CreateClient": { "required": [ "applicationId", "name", "scopes" ], "type": "object", "properties": { "applicationId": { "type": "string" }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "CreatePartner": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": false }, "CreateProgram": { "required": [ "applicationId", "name", "minimumAssurance", "validFrom", "validUntil", "purposes", "allowedEventTypes" ], "type": "object", "properties": { "applicationId": { "type": "string" }, "name": { "type": "string" }, "minimumAssurance": { "type": "string" }, "validFrom": { "type": "string", "format": "date-time" }, "validUntil": { "type": "string", "format": "date-time" }, "purposes": { "type": "array", "items": { "type": "string" } }, "allowedEventTypes": { "type": "array", "items": { "type": "string" } }, "benefitOfferReference": { "type": [ "null", "string" ] }, "retentionDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 30 }, "maxIssuancesPerSubject": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, "additionalProperties": false }, "CredentialRequest": { "required": [ "subject", "programId" ], "type": "object", "properties": { "subject": { "type": "string" }, "programId": { "type": "string" } }, "additionalProperties": false }, "IdentityRequest": { "type": "object", "properties": { "grantCode": { "type": [ "null", "string" ] }, "identifierType": { "type": [ "null", "string" ] }, "identifierValue": { "type": [ "null", "string" ] }, "customerId": { "type": [ "null", "string" ] }, "loyaltyMemberId": { "type": [ "null", "string" ] }, "subject": { "type": [ "null", "string" ] }, "purpose": { "type": "string", "default": "LOYALTY_INTEGRATION" } }, "additionalProperties": false }, "IssueBenefitRequest": { "required": [ "subject", "programId" ], "type": "object", "properties": { "subject": { "type": "string" }, "programId": { "type": "string" } }, "additionalProperties": false }, "JsonElement": {}, "SandboxGrantRequest": { "required": [ "scenario", "purposes" ], "type": "object", "properties": { "scenario": { "type": "string" }, "purposes": { "type": "array", "items": { "type": "string" } }, "identityKey": { "type": [ "null", "string" ] }, "identifierType": { "type": [ "null", "string" ] }, "identifierValue": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "SubjectReference": { "type": "object", "properties": { "subject": { "type": [ "null", "string" ] }, "customerId": { "type": [ "null", "string" ] }, "loyaltyMemberId": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "WebhookCreateRequest": { "required": [ "url", "eventTypes", "purpose" ], "type": "object", "properties": { "url": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string" } }, "purpose": { "type": "string" } }, "additionalProperties": false } }, "securitySchemes": { "partnerOAuth": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "/api/v1/platform/oauth/token", "scopes": { "identity:resolve": "identity:resolve", "identity:link": "identity:link", "verification:create": "verification:create", "verification:read": "verification:read", "credential:verify": "credential:verify", "eligibility:check": "eligibility:check", "programs:read": "programs:read", "benefits:read": "benefits:read", "benefits:issue": "benefits:issue", "activity:write": "activity:write", "analytics:read": "analytics:read", "webhooks:manage": "webhooks:manage", "sandbox:simulate": "sandbox:simulate" } } } }, "operatorBearer": { "type": "http", "description": "Separate local operator token; never a partner credential.", "scheme": "bearer" } } }, "tags": [ { "name": "Studmart.ApiPlatform" }, { "name": "OAuth" }, { "name": "Programs" }, { "name": "Benefits" }, { "name": "Operator console" }, { "name": "Identity and student assertions" } ] }