{ "openapi": "3.1.0", "info": { "title": "Taifa Identity management", "version": "0.2.0" }, "paths": { "/v1/me": { "get": { "tags": [ "Personal account" ], "summary": "Me", "operationId": "me_v1_me_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnAccount" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/me/freshness": { "get": { "tags": [ "Personal account" ], "summary": "Freshness", "operationId": "freshness_v1_me_freshness_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Freshness" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/me/sessions": { "get": { "tags": [ "Personal account" ], "summary": "Sessions", "operationId": "sessions_v1_me_sessions_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/me/authenticators": { "get": { "tags": [ "Personal account" ], "summary": "Authenticators", "operationId": "authenticators_v1_me_authenticators_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/me/credential-actions": { "get": { "tags": [ "Credential actions" ], "summary": "Capabilities", "operationId": "capabilities_v1_me_credential_actions_get", "security": [ { "HTTPBearer": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } }, "post": { "tags": [ "Credential actions" ], "summary": "Start", "operationId": "start_v1_me_credential_actions_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "idempotency-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "x-portal-binding", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Portal-Binding" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartAction" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/me/credential-actions/{intent_id}/complete": { "post": { "tags": [ "Credential actions" ], "summary": "Complete", "operationId": "complete_v1_me_credential_actions__intent_id__complete_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "intent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Intent Id" } }, { "name": "idempotency-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "x-portal-binding", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Portal-Binding" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinishAction" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/access-grant-reviews": { "get": { "tags": [ "Reviewed Access grants" ], "summary": "List exact Access grant reviews and candidates", "description": "Requires a current actual Institution Sponsor or effective administrator with active membership. Current validity and product acknowledgement are read-time facts, not assignment authority.", "operationId": "list_scoped_v1_institutions__institution_id__access_grant_reviews_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantReviewList" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Reviewed Access grants" ], "summary": "Propose independent review of one Access version", "description": "A current actual Sponsor proposes the exact active Access version. The accepted receipt records no issuer assignment. Exact idempotency replay returns the original receipt.", "operationId": "propose_v1_institutions__institution_id__access_grant_reviews_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantProposal" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantReceipt" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/access-grant-reviews/{review_id}/approve": { "post": { "tags": [ "Reviewed Access grants" ], "summary": "Independently approve an exact Access review", "description": "A distinct current effective administrator approves the locked Sponsor decision and exact grant Event. Dynamic validity is available from the scoped list.", "operationId": "approve_v1_institutions__institution_id__access_grant_reviews__review_id__approve_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "review_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Review Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity__access_grant_review_router__Reason" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantReceipt" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/access-grant-reviews/{review_id}/revoke": { "post": { "tags": [ "Reviewed Access grants" ], "summary": "Revoke a reviewed Access decision", "description": "Retains the immutable decision evidence while ending its review authority. It does not change the underlying Access grant.", "operationId": "revoke_v1_institutions__institution_id__access_grant_reviews__review_id__revoke_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "review_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Review Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity__access_grant_review_router__Reason" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantReceipt" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/projects/{project_id}/lifecycle-service-grants": { "post": { "tags": [ "Lifecycle service authority" ], "summary": "Propose", "operationId": "propose_v1_projects__project_id__lifecycle_service_grants_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LifecycleServiceProposal" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Lifecycle service authority" ], "summary": "Listing", "operationId": "listing_v1_projects__project_id__lifecycle_service_grants_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(?:[1-9]|[1-9][0-9]|100)$", "default": "50", "title": "Limit" } }, { "name": "after_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "After Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GrantRead" }, "title": "Response Listing V1 Projects Project Id Lifecycle Service Grants Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/projects/{project_id}/lifecycle-service-grants/{grant_id}/approve": { "post": { "tags": [ "Lifecycle service authority" ], "summary": "Approve", "operationId": "approve_v1_projects__project_id__lifecycle_service_grants__grant_id__approve_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "grant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Grant Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LifecycleServiceApproval" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/projects/{project_id}/lifecycle-service-grants/{grant_id}/revoke": { "post": { "tags": [ "Lifecycle service authority" ], "summary": "Revoke", "operationId": "revoke_v1_projects__project_id__lifecycle_service_grants__grant_id__revoke_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "grant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Grant Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LifecycleServiceRevocation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/projects/{project_id}/lifecycle-service-grants/{grant_id}": { "get": { "tags": [ "Lifecycle service authority" ], "summary": "Detail", "operationId": "detail_v1_projects__project_id__lifecycle_service_grants__grant_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "grant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Grant Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/federation/deployments": { "get": { "tags": [ "Institution federation" ], "summary": "Inventory", "operationId": "inventory_v1_institutions__institution_id__federation_deployments_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Institution federation" ], "summary": "Propose", "operationId": "propose_v1_institutions__institution_id__federation_deployments_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FederationProposal" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/federation/deployments/{identifier}/approve": { "post": { "tags": [ "Institution federation" ], "summary": "Approve", "operationId": "approve_v1_institutions__institution_id__federation_deployments__identifier__approve_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Identifier" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity__federation_router__Reason" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions": { "get": { "summary": "Institutions", "operationId": "institutions_v1_institutions_get", "security": [ { "HTTPBearer": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/InstitutionForOperator" }, { "$ref": "#/components/schemas/InstitutionForAdministrator" } ] }, "title": "Response Institutions V1 Institutions Get" } } } } } }, "post": { "summary": "Create Institution", "operationId": "create_institution_v1_institutions_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstitutionCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/approve": { "post": { "summary": "Approve Institution", "operationId": "approve_institution_v1_institutions__institution_id__approve_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mutation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/people": { "get": { "summary": "People", "operationId": "people_v1_people_get", "security": [ { "HTTPBearer": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PersonRead" }, "title": "Response People V1 People Get" } } } } } }, "post": { "summary": "Create Person", "operationId": "create_person_v1_people_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/projects": { "get": { "summary": "Projects", "operationId": "projects_v1_projects_get", "security": [ { "HTTPBearer": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectRead" }, "title": "Response Projects V1 Projects Get" } } } } } }, "post": { "summary": "Create Project", "operationId": "create_project_v1_projects_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/access": { "post": { "summary": "Access", "operationId": "access_v1_access_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessChange" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "summary": "Access List", "operationId": "access_list_v1_access_get", "security": [ { "HTTPBearer": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccessRead" }, "title": "Response Access List V1 Access Get" } } } } } } }, "/v1/audit": { "get": { "summary": "Audit", "operationId": "audit_v1_audit_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AuditRead" }, "type": "array", "title": "Response Audit V1 Audit Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/audit/search": { "get": { "tags": [ "Audit investigation" ], "summary": "Search", "operationId": "search_v1_audit_search_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Institution Id" } }, { "name": "actor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Actor" } }, { "name": "operation", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Operation" } }, { "name": "outcome", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ], "title": "Outcome" } }, { "name": "target", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Target" } }, { "name": "since", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ], "title": "Since" } }, { "name": "until", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ], "title": "Until" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 1500 }, { "type": "null" } ], "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditSearch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/audit/export": { "get": { "tags": [ "Audit investigation" ], "summary": "Export", "operationId": "export_v1_audit_export_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Institution Id" } }, { "name": "actor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Actor" } }, { "name": "operation", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Operation" } }, { "name": "outcome", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ], "title": "Outcome" } }, { "name": "target", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Target" } }, { "name": "since", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ], "title": "Since" } }, { "name": "until", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ], "title": "Until" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 1500 }, { "type": "null" } ], "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/operations": { "get": { "summary": "Operations", "operationId": "operations_v1_operations_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationsSummary" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/lifecycle/{project_id}": { "get": { "summary": "Feed", "operationId": "feed_v1_lifecycle__project_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "integer", "default": 0, "title": "After" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LifecycleFeed" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/lifecycle/{project_id}/ack": { "post": { "summary": "Acknowledge", "operationId": "acknowledge_v1_lifecycle__project_id__ack_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Acknowledgement" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LifecycleAcknowledgement" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/projects/{project_id}/approve": { "post": { "summary": "Approve Project", "operationId": "approve_project_v1_projects__project_id__approve_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mutation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/memberships": { "post": { "summary": "Membership", "operationId": "membership_v1_memberships_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipChange" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/lifecycle/{project_id}/snapshot": { "get": { "summary": "Snapshot", "operationId": "snapshot_v1_lifecycle__project_id__snapshot_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LifecycleSnapshot" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/registration-context": { "get": { "tags": [ "workflows" ], "summary": "Deployment Context", "operationId": "deployment_context_v1_registration_context_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/institutions/{institution_id}/administrators": { "post": { "tags": [ "workflows" ], "summary": "Propose Admin", "operationId": "propose_admin_v1_institutions__institution_id__administrators_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministratorCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/administrators/{proposal_id}/approve": { "post": { "tags": [ "workflows" ], "summary": "Approve Admin", "operationId": "approve_admin_v1_institutions__institution_id__administrators__proposal_id__approve_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "proposal_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Proposal Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mutation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/domains": { "post": { "tags": [ "workflows" ], "summary": "Propose Domain", "operationId": "propose_domain_v1_institutions__institution_id__domains_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/domains/{domain_id}/verify": { "post": { "tags": [ "workflows" ], "summary": "Verify Domain", "operationId": "verify_domain_v1_institutions__institution_id__domains__domain_id__verify_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Evidence" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/sponsors": { "post": { "tags": [ "workflows" ], "summary": "Sponsor Change", "operationId": "sponsor_change_v1_institutions__institution_id__sponsors_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SponsorChange" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/invitations": { "post": { "tags": [ "workflows" ], "summary": "Invite", "operationId": "invite_v1_institutions__institution_id__invitations_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvitationCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/invitations/{invitation_id}/redeem": { "post": { "tags": [ "workflows" ], "summary": "Redeem", "operationId": "redeem_v1_invitations__invitation_id__redeem_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "invitation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Invitation Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvitationRedeem" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/account-proofs": { "post": { "tags": [ "workflows" ], "summary": "Proof", "operationId": "proof_v1_institutions__institution_id__account_proofs_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProofCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/link-requests": { "post": { "tags": [ "workflows" ], "summary": "Request Link", "operationId": "request_link_v1_link_requests_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/link-requests/{request_id}/approve": { "post": { "tags": [ "workflows" ], "summary": "Approve Link", "operationId": "approve_link_v1_link_requests__request_id__approve_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Request Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mutation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/recovery-requests": { "post": { "tags": [ "workflows" ], "summary": "Recovery", "operationId": "recovery_v1_institutions__institution_id__recovery_requests_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecoveryCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/recovery-requests/{request_id}/approve": { "post": { "tags": [ "workflows" ], "summary": "Approve Recovery", "operationId": "approve_recovery_v1_recovery_requests__request_id__approve_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Request Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mutation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/projects/{project_id}/owners": { "post": { "tags": [ "workflows" ], "summary": "Owner", "operationId": "owner_v1_projects__project_id__owners_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnerChange" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/projects/{project_id}/environments": { "post": { "tags": [ "workflows" ], "summary": "Environment", "operationId": "environment_v1_projects__project_id__environments_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "workflows" ], "summary": "Environments", "operationId": "environments_v1_projects__project_id__environments_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/projects/{project_id}/environments/{environment_id}/review-existing": { "post": { "tags": [ "workflows" ], "summary": "Review Existing Environment", "operationId": "review_existing_environment_v1_projects__project_id__environments__environment_id__review_existing_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mutation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/projects/{project_id}/environments/{environment_id}/approve": { "post": { "tags": [ "workflows" ], "summary": "Approve Environment", "operationId": "approve_environment_v1_projects__project_id__environments__environment_id__approve_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mutation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/projects/{project_id}/environments/{environment_id}/credential/reveal": { "post": { "tags": [ "workflows" ], "summary": "Reveal Credential", "operationId": "reveal_credential_v1_projects__project_id__environments__environment_id__credential_reveal_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mutation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/projects/{project_id}/environments/{environment_id}/credential": { "get": { "tags": [ "workflows" ], "summary": "Credential Status", "operationId": "credential_status_v1_projects__project_id__environments__environment_id__credential_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/projects/{project_id}/environments/{environment_id}/credential/rotate": { "post": { "tags": [ "workflows" ], "summary": "Rotate Credential", "operationId": "rotate_credential_v1_projects__project_id__environments__environment_id__credential_rotate_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mutation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/invitations/{invitation_id}/cancel": { "post": { "tags": [ "workflows" ], "summary": "Cancel Invitation", "operationId": "cancel_invitation_v1_institutions__institution_id__invitations__invitation_id__cancel_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "invitation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Invitation Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mutation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/workflow-decisions/{kind}/{record_id}/reject": { "post": { "tags": [ "workflows" ], "summary": "Reject", "operationId": "reject_v1_institutions__institution_id__workflow_decisions__kind___record_id__reject_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "kind", "in": "path", "required": true, "schema": { "enum": [ "administrator", "domain", "link", "recovery", "federation" ], "type": "string", "title": "Kind" } }, { "name": "record_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Record Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mutation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/workflows": { "get": { "tags": [ "workflows" ], "summary": "Institution Workflows", "operationId": "institution_workflows_v1_institutions__institution_id__workflows_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/workflow-evidence/{kind}/{record_id}": { "get": { "tags": [ "workflows" ], "summary": "Workflow Evidence", "operationId": "workflow_evidence_v1_institutions__institution_id__workflow_evidence__kind___record_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "kind", "in": "path", "required": true, "schema": { "enum": [ "administrator", "domain", "federation", "recovery" ], "type": "string", "title": "Kind" } }, { "name": "record_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Record Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/projects/{project_id}/registration-context": { "get": { "tags": [ "workflows" ], "summary": "Registration Context", "operationId": "registration_context_v1_projects__project_id__registration_context_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/projects/{project_id}/native-profiles": { "get": { "tags": [ "workflows" ], "summary": "Native Profiles", "operationId": "native_profiles_v1_projects__project_id__native_profiles_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/me/workflows": { "get": { "tags": [ "workflows" ], "summary": "Personal Workflows", "operationId": "personal_workflows_v1_me_workflows_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/institutions/{institution_id}/enrollments": { "get": { "tags": [ "staff enrollment" ], "summary": "Inventory", "operationId": "inventory_v1_institutions__institution_id__enrollments_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "staff enrollment" ], "summary": "Propose", "operationId": "propose_v1_institutions__institution_id__enrollments_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrollmentCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/enrollments/{identifier}/review": { "get": { "tags": [ "staff enrollment" ], "summary": "Review Details", "operationId": "review_details_v1_institutions__institution_id__enrollments__identifier__review_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Identifier" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/enrollments/{identifier}/refresh-review": { "post": { "tags": [ "staff enrollment" ], "summary": "Refresh", "operationId": "refresh_v1_institutions__institution_id__enrollments__identifier__refresh_review_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Identifier" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity__enrollment_router__Reason" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/enrollments/{identifier}/approve": { "post": { "tags": [ "staff enrollment" ], "summary": "Approve", "operationId": "approve_v1_institutions__institution_id__enrollments__identifier__approve_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Identifier" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity__enrollment_router__Reason" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/enrollments/{identifier}/cancel": { "post": { "tags": [ "staff enrollment" ], "summary": "Cancel", "operationId": "cancel_v1_institutions__institution_id__enrollments__identifier__cancel_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Identifier" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity__enrollment_router__Reason" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/auth-engine-enrollments": { "get": { "tags": [ "standalone workforce admission" ], "summary": "Inventory", "operationId": "inventory_v1_institutions__institution_id__auth_engine_enrollments_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "standalone workforce admission" ], "summary": "Propose", "operationId": "propose_v1_institutions__institution_id__auth_engine_enrollments_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FreshEnrollmentCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/auth-engine-enrollments/{identifier}/review": { "get": { "tags": [ "standalone workforce admission" ], "summary": "Review Details", "operationId": "review_details_v1_institutions__institution_id__auth_engine_enrollments__identifier__review_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Identifier" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/auth-engine-enrollments/{identifier}/approve": { "post": { "tags": [ "standalone workforce admission" ], "summary": "Approve", "operationId": "approve_v1_institutions__institution_id__auth_engine_enrollments__identifier__approve_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Identifier" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity__auth_engine_enrollment_router__Reason" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/auth-engine-enrollments/{identifier}/cancel": { "post": { "tags": [ "standalone workforce admission" ], "summary": "Cancel", "operationId": "cancel_v1_institutions__institution_id__auth_engine_enrollments__identifier__cancel_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Identifier" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity__auth_engine_enrollment_router__Reason" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/members": { "get": { "summary": "Members", "operationId": "members_v1_institutions__institution_id__members_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MembershipRead" }, "title": "Response Members V1 Institutions Institution Id Members Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/people/{person_id}/suspend": { "post": { "summary": "Suspend", "operationId": "suspend_v1_people__person_id__suspend_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "person_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Person Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mutation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/jobs": { "get": { "summary": "Jobs", "operationId": "jobs_v1_jobs_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/me/sessions/revoke-all": { "post": { "tags": [ "Personal sessions" ], "summary": "Revoke All", "operationId": "revoke_all_v1_me_sessions_revoke_all_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mutation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/me/sessions/{session_id}/revoke": { "post": { "tags": [ "Personal sessions" ], "summary": "Revoke Session", "operationId": "revoke_session_v1_me_sessions__session_id__revoke_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mutation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/link-challenges": { "post": { "tags": [ "account linking" ], "summary": "Create Challenge", "operationId": "create_challenge_v1_link_challenges_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChallengeCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/link-challenges/{challenge_id}": { "get": { "tags": [ "account linking" ], "summary": "Read Challenge", "operationId": "read_challenge_v1_link_challenges__challenge_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "challenge_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Challenge Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/link-challenges/{challenge_id}/attest": { "post": { "tags": [ "account linking" ], "summary": "Attest", "operationId": "attest_v1_link_challenges__challenge_id__attest_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "challenge_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Challenge Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attestation" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/link-requests/{link_id}": { "get": { "tags": [ "account linking" ], "summary": "Read Link", "operationId": "read_link_v1_link_requests__link_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "link_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Link Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/link-requests/{link_id}/ack": { "post": { "tags": [ "account linking" ], "summary": "Acknowledge", "operationId": "acknowledge_v1_link_requests__link_id__ack_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "link_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Link Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BindingAcknowledgement" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/projects/{project_id}/service-identities": { "get": { "tags": [ "account linking" ], "summary": "Read Services", "operationId": "read_services_v1_projects__project_id__service_identities_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "account linking" ], "summary": "Propose Service", "operationId": "propose_service_v1_projects__project_id__service_identities_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceProposal" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/projects/{project_id}/service-identities/{grant_id}/approve": { "post": { "tags": [ "account linking" ], "summary": "Approve Service", "operationId": "approve_service_v1_projects__project_id__service_identities__grant_id__approve_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "grant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Grant Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mutation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/projects/{project_id}/service-identities/{grant_id}/revoke": { "post": { "tags": [ "account linking" ], "summary": "Revoke Service", "operationId": "revoke_service_v1_projects__project_id__service_identities__grant_id__revoke_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "grant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Grant Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mutation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/security/people": { "get": { "tags": [ "Security incident sessions" ], "summary": "Identities", "operationId": "identities_v1_security_people_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "subject", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200, "default": "", "title": "Subject" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/people/{person_id}/sessions": { "get": { "tags": [ "Security incident sessions" ], "summary": "Sessions", "operationId": "sessions_v1_people__person_id__sessions_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "person_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Person Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/people/{person_id}/sessions/{session_id}/revoke": { "post": { "tags": [ "Security incident sessions" ], "summary": "Revoke", "operationId": "revoke_v1_people__person_id__sessions__session_id__revoke_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "person_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Person Id" } }, { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mutation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/policies": { "get": { "tags": [ "Reviewed authentication policy" ], "summary": "Policies", "operationId": "policies_v1_policies_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/policies/reviews": { "post": { "tags": [ "Reviewed authentication policy" ], "summary": "Propose", "operationId": "propose_v1_policies_reviews_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Proposal" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/policies/reviews/{review_id}/approve": { "post": { "tags": [ "Reviewed authentication policy" ], "summary": "Approve", "operationId": "approve_v1_policies_reviews__review_id__approve_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "review_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Review Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Approval" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/policies/reviews/{review_id}/reconcile": { "post": { "tags": [ "Reviewed authentication policy" ], "summary": "Reconcile", "operationId": "reconcile_v1_policies_reviews__review_id__reconcile_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "review_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Review Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mutation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/operations/diagnostics": { "get": { "tags": [ "Operations" ], "summary": "Diagnostics", "operationId": "diagnostics_v1_operations_diagnostics_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/projects/{project_id}/diagnostics": { "get": { "tags": [ "Operations" ], "summary": "Project Diagnostics", "operationId": "project_diagnostics_v1_projects__project_id__diagnostics_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/projects/{project_id}/diagnostics/clients/{environment_id}": { "post": { "tags": [ "Operations" ], "summary": "Check Client", "operationId": "check_client_v1_projects__project_id__diagnostics_clients__environment_id__post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientCheck" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/jobs/{job_id}/review": { "post": { "tags": [ "Operations" ], "summary": "Review Job", "operationId": "review_job_v1_jobs__job_id__review_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobReview" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/projects/{project_id}/launch-proposals": { "post": { "tags": [ "Personal capabilities" ], "summary": "Launch", "operationId": "launch_v1_projects__project_id__launch_proposals_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LaunchCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Personal capabilities" ], "summary": "Launch Proposals", "operationId": "launch_proposals_v1_projects__project_id__launch_proposals_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/projects/{project_id}/launch-proposals/{proposal_id}/approve": { "post": { "tags": [ "Personal capabilities" ], "summary": "Approve Launch", "operationId": "approve_launch_v1_projects__project_id__launch_proposals__proposal_id__approve_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "proposal_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Proposal Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity__personal_capabilities__Reason" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/me/apps": { "get": { "tags": [ "Personal capabilities" ], "summary": "Apps", "operationId": "apps_v1_me_apps_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/me/access-requests": { "get": { "tags": [ "Personal capabilities" ], "summary": "Requests", "operationId": "requests_v1_me_access_requests_get", "security": [ { "HTTPBearer": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } }, "post": { "tags": [ "Personal capabilities" ], "summary": "Request", "operationId": "request_v1_me_access_requests_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/access-requests": { "get": { "tags": [ "Personal capabilities" ], "summary": "Queue", "operationId": "queue_v1_institutions__institution_id__access_requests_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/access-requests/{request_id}/endorse": { "post": { "tags": [ "Personal capabilities" ], "summary": "Endorse", "operationId": "endorse_v1_institutions__institution_id__access_requests__request_id__endorse_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Request Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity__personal_capabilities__Reason" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/institutions/{institution_id}/access-requests/{request_id}/approve": { "post": { "tags": [ "Personal capabilities" ], "summary": "Approve Request", "operationId": "approve_request_v1_institutions__institution_id__access_requests__request_id__approve_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "institution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Institution Id" } }, { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Request Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity__personal_capabilities__Reason" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/me/provider-account": { "get": { "tags": [ "Personal capabilities" ], "summary": "Provider Account", "operationId": "provider_account_v1_me_provider_account_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/me/authentication-activity": { "get": { "tags": [ "Personal capabilities" ], "summary": "Authentication Activity", "operationId": "authentication_activity_v1_me_authentication_activity_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/me/security-activity": { "get": { "tags": [ "Personal capabilities" ], "summary": "Activity", "operationId": "activity_v1_me_security_activity_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/me/consents": { "get": { "tags": [ "Personal capabilities" ], "summary": "Consents", "operationId": "consents_v1_me_consents_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/me/consents/{client_id}/revoke": { "post": { "tags": [ "Personal capabilities" ], "summary": "Revoke Consent", "operationId": "revoke_consent_v1_me_consents__client_id__revoke_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "client_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Client Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity__personal_capabilities__Reason" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/projects/{project_id}/permission-catalogs": { "get": { "tags": [ "Reviewed project clients" ], "summary": "List reviewed permission catalogs", "operationId": "catalogs_v1_projects__project_id__permission_catalogs_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogList" } } } }, "403": { "description": "Current project authority or independent review required" }, "409": { "description": "Current exact proposal, catalog, version or idempotency conflict" }, "413": { "description": "Exact JSON request exceeds 64 KiB" }, "422": { "description": "Invalid exact reviewed policy or registration" }, "503": { "description": "Configured owned issuer authority unavailable" } } }, "post": { "tags": [ "Reviewed project clients" ], "summary": "Propose an immutable permission catalog", "description": "Current project owner proposes a versioned catalog. A separate current platform project approver must approve it. Idempotency-Key replays the exact actor and body.", "operationId": "catalog_propose_v1_projects__project_id__permission_catalogs_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogProposal" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogRead" } } } }, "403": { "description": "Current project authority or independent review required" }, "409": { "description": "Current exact proposal, catalog, version or idempotency conflict" }, "413": { "description": "Exact JSON request exceeds 64 KiB" }, "422": { "description": "Invalid exact reviewed policy or registration" }, "503": { "description": "Configured owned issuer authority unavailable" } } } }, "/v1/projects/{project_id}/permission-catalogs/{catalog_id}/approve": { "post": { "tags": [ "Reviewed project clients" ], "summary": "Independently approve a catalog", "operationId": "catalog_approve_v1_projects__project_id__permission_catalogs__catalog_id__approve_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "catalog_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Catalog Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity__owned_client_router__Reason" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogRead" } } } }, "403": { "description": "Current project authority or independent review required" }, "409": { "description": "Current exact proposal, catalog, version or idempotency conflict" }, "413": { "description": "Exact JSON request exceeds 64 KiB" }, "422": { "description": "Invalid exact reviewed policy or registration" }, "503": { "description": "Configured owned issuer authority unavailable" } } } }, "/v1/projects/{project_id}/permission-catalogs/{catalog_id}/revoke": { "post": { "tags": [ "Reviewed project clients" ], "summary": "Revoke an approved catalog", "operationId": "catalog_revoke_v1_projects__project_id__permission_catalogs__catalog_id__revoke_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "catalog_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Catalog Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity__owned_client_router__Reason" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogRead" } } } }, "403": { "description": "Current project authority or independent review required" }, "409": { "description": "Current exact proposal, catalog, version or idempotency conflict" }, "413": { "description": "Exact JSON request exceeds 64 KiB" }, "422": { "description": "Invalid exact reviewed policy or registration" }, "503": { "description": "Configured owned issuer authority unavailable" } } } }, "/v1/projects/{project_id}/owned-clients": { "get": { "tags": [ "Reviewed project clients" ], "summary": "List reviewed owned-client proposals", "operationId": "clients_v1_projects__project_id__owned_clients_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientList" } } } }, "403": { "description": "Current project authority or independent review required" }, "409": { "description": "Current exact proposal, catalog, version or idempotency conflict" }, "413": { "description": "Exact JSON request exceeds 64 KiB" }, "422": { "description": "Invalid exact reviewed policy or registration" }, "503": { "description": "Configured owned issuer authority unavailable" } } }, "post": { "tags": [ "Reviewed project clients" ], "summary": "Propose an exact owned-client registration policy", "description": "Requires a controlled credential preparation and fresh private issuer custody readback. Stores the full immutable registration and versioned digest with exact accepted owner and catalog evidence for independent review. Approval does not install a client or authorize an assignment. Idempotency-Key replays the exact actor and body after current authority and fresh custody checks.", "operationId": "client_propose_v1_projects__project_id__owned_clients_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientProposal" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientRead" } } } }, "403": { "description": "Current project authority or independent review required" }, "409": { "description": "Current exact proposal, catalog, version or idempotency conflict" }, "413": { "description": "Exact JSON request exceeds 64 KiB" }, "422": { "description": "Invalid exact reviewed policy or registration" }, "503": { "description": "Configured owned issuer authority unavailable" } } } }, "/v1/projects/{project_id}/owned-clients/{policy_id}/approve": { "post": { "tags": [ "Reviewed project clients" ], "summary": "Independently approve an owned-client proposal", "description": "Obtains fresh private custody readback before source locks and records an independent current approver with the exact proposal and approved catalog evidence. The approved_pending_readback state still requires separate reviewed installation and product acknowledgement.", "operationId": "client_approve_v1_projects__project_id__owned_clients__policy_id__approve_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "policy_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Policy Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity__owned_client_router__Reason" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientRead" } } } }, "403": { "description": "Current project authority or independent review required" }, "409": { "description": "Current exact proposal, catalog, version or idempotency conflict" }, "413": { "description": "Exact JSON request exceeds 64 KiB" }, "422": { "description": "Invalid exact reviewed policy or registration" }, "503": { "description": "Configured owned issuer authority unavailable" } } } }, "/v1/projects/{project_id}/owned-clients/{policy_id}/revoke": { "post": { "tags": [ "Reviewed project clients" ], "summary": "Revoke an owned-client proposal", "operationId": "client_revoke_v1_projects__project_id__owned_clients__policy_id__revoke_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "policy_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Policy Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity__owned_client_router__Reason" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientRead" } } } }, "403": { "description": "Current project authority or independent review required" }, "409": { "description": "Current exact proposal, catalog, version or idempotency conflict" }, "413": { "description": "Exact JSON request exceeds 64 KiB" }, "422": { "description": "Invalid exact reviewed policy or registration" }, "503": { "description": "Configured owned issuer authority unavailable" } } } }, "/v1/projects/{project_id}/owned-clients/credential-intents": { "post": { "tags": [ "Owned client custody" ], "summary": "Request controlled custody for a proposed owned-client credential", "description": "A current approved project owner with exact active sponsorship and recent strong authentication records an audited, short-lived intent for the configured runtime. Idempotency-Key scopes retries to the exact actor and body. This response contains only the intent ID and pending custody status. Controlled private delivery and independent registration review remain required.", "operationId": "intent_v1_projects__project_id__owned_clients_credential_intents_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntentRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntentResponse" } } } }, "400": { "description": "Empty or oversized idempotency key" }, "401": { "description": "Workforce authentication required" }, "403": { "description": "Current owner, sponsorship or recent strong authentication required" }, "409": { "description": "Ambiguous sponsorship, client/version binding or concurrent authority conflict" }, "410": { "description": "Original replayed intent expired, cancelled or authority revoked" }, "422": { "description": "Missing required fields or header, invalid exact payload or audit reason" }, "503": { "description": "Disabled custody source or current local key profile unavailable" } } } }, "/v1/projects/{project_id}/authority-status": { "get": { "tags": [ "Project authority status" ], "summary": "Read scoped project authority status", "description": "Read current source review and signed activation observations for an approved project as its current owner or a current project approver. A fresh positive Go readback is an observation, not a lasting sign-in guarantee.", "operationId": "project_authority_status", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128, "title": "Project Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 50, "minimum": 1, "default": 25, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectAuthorityStatus" } } } }, "403": { "description": "Current project owner or approver authority required." }, "404": { "description": "Approved project not found." }, "409": { "description": "More rows exist beyond the bounded pagination ceiling." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/projects/{project_id}/lifecycle": { "get": { "tags": [ "Project lifecycle" ], "summary": "Read project lifecycle and issuer removal state", "description": "Scoped to a current owner or project approver. Revocation state is Management ledger state plus authenticated Go receipts. local_sessions is always unobserved.", "operationId": "read_v1_projects__project_id__lifecycle_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LifecycleRead" } } } }, "403": { "description": "Current scoped authority, independent review or recent strong authentication required" }, "409": { "description": "Current project state, target set or idempotency conflict" }, "422": { "description": "Invalid exact request" } } } }, "/v1/projects/{project_id}/lifecycle/suspend": { "post": { "tags": [ "Project lifecycle" ], "summary": "Suspend a project", "description": "Reversible. Blocks new authority, revokes workforce access through the ordered lifecycle feed and leaves issuer clients installed. Resume does not restore access.", "operationId": "suspend_route_v1_projects__project_id__lifecycle_suspend_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity__owned_client_router__Reason" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionResult" } } } }, "403": { "description": "Current scoped authority, independent review or recent strong authentication required" }, "409": { "description": "Current project state, target set or idempotency conflict" }, "422": { "description": "Invalid exact request" } } } }, "/v1/projects/{project_id}/lifecycle/resume": { "post": { "tags": [ "Project lifecycle" ], "summary": "Resume a suspended project", "description": "Requires a current project approver other than the suspender. Workforce access must be granted again through the normal reviewed workflow.", "operationId": "resume_route_v1_projects__project_id__lifecycle_resume_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity__owned_client_router__Reason" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionResult" } } } }, "403": { "description": "Current scoped authority, independent review or recent strong authentication required" }, "409": { "description": "Current project state, target set or idempotency conflict" }, "422": { "description": "Invalid exact request" } } } }, "/v1/projects/{project_id}/lifecycle/decommission": { "post": { "tags": [ "Project lifecycle" ], "summary": "Request irreversible decommission", "description": "Records a request that expires after 72 hours. It changes no project authority until an independent approver approves it.", "operationId": "decommission_request_v1_projects__project_id__lifecycle_decommission_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity__owned_client_router__Reason" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionResult" } } } }, "403": { "description": "Current scoped authority, independent review or recent strong authentication required" }, "409": { "description": "Current project state, target set or idempotency conflict" }, "422": { "description": "Invalid exact request" } } } }, "/v1/projects/{project_id}/lifecycle/decommission/{action_id}/approve": { "post": { "tags": [ "Project lifecycle" ], "summary": "Approve irreversible decommission", "description": "Requires an independent current project approver. Queues exact issuer revoke commands. The project becomes decommissioned only after every removal is acknowledged or was never installed.", "operationId": "decommission_approve_v1_projects__project_id__lifecycle_decommission__action_id__approve_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "action_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Action Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity__owned_client_router__Reason" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionResult" } } } }, "403": { "description": "Current scoped authority, independent review or recent strong authentication required" }, "409": { "description": "Current project state, target set or idempotency conflict" }, "422": { "description": "Invalid exact request" } } } }, "/v1/projects/{project_id}/lifecycle/decommission/{action_id}/cancel": { "post": { "tags": [ "Project lifecycle" ], "summary": "Cancel a pending decommission request", "operationId": "decommission_cancel_v1_projects__project_id__lifecycle_decommission__action_id__cancel_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "action_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Action Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity__owned_client_router__Reason" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionResult" } } } }, "403": { "description": "Current scoped authority, independent review or recent strong authentication required" }, "409": { "description": "Current project state, target set or idempotency conflict" }, "422": { "description": "Invalid exact request" } } } } }, "components": { "securitySchemes": { "HTTPBearer": { "type": "http", "scheme": "bearer" } }, "schemas": { "AccessChange": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "person_id": { "type": "string", "title": "Person Id" }, "institution_id": { "type": "string", "title": "Institution Id" }, "project_id": { "type": "string", "title": "Project Id" }, "active": { "type": "boolean", "title": "Active" } }, "type": "object", "required": [ "reason", "person_id", "institution_id", "project_id", "active" ], "title": "AccessChange" }, "AccessRead": { "properties": { "id": { "type": "string", "title": "Id" }, "person_id": { "type": "string", "title": "Person Id" }, "institution_id": { "type": "string", "title": "Institution Id" }, "project_id": { "type": "string", "title": "Project Id" }, "active": { "type": "boolean", "title": "Active" }, "version": { "type": "integer", "title": "Version" }, "approved_link": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Approved Link" } }, "additionalProperties": false, "type": "object", "required": [ "id", "person_id", "institution_id", "project_id", "active", "version", "approved_link" ], "title": "AccessRead" }, "Acknowledgement": { "properties": { "sequence": { "type": "integer", "maximum": 2147483647, "minimum": 0, "title": "Sequence" } }, "type": "object", "required": [ "sequence" ], "title": "Acknowledgement" }, "ActionRead": { "properties": { "id": { "type": "string", "title": "Id" }, "project_id": { "type": "string", "title": "Project Id" }, "kind": { "type": "string", "enum": [ "suspend", "resume", "decommission" ], "title": "Kind" }, "status": { "type": "string", "enum": [ "requested", "effective", "cancelled" ], "title": "Status" }, "requested_by": { "type": "string", "title": "Requested By" }, "decided_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Decided By" }, "reason": { "type": "string", "title": "Reason" }, "created_at": { "type": "string", "title": "Created At" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "effective_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Effective At" }, "completed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completed At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "project_id", "kind", "status", "requested_by", "decided_by", "reason", "created_at", "expires_at", "effective_at", "completed_at" ], "title": "ActionRead" }, "ActionResult": { "properties": { "id": { "type": "string", "title": "Id" }, "project_id": { "type": "string", "title": "Project Id" }, "kind": { "type": "string", "enum": [ "suspend", "resume", "decommission" ], "title": "Kind" }, "status": { "type": "string", "enum": [ "requested", "effective", "cancelled" ], "title": "Status" }, "requested_by": { "type": "string", "title": "Requested By" }, "decided_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Decided By" }, "reason": { "type": "string", "title": "Reason" }, "created_at": { "type": "string", "title": "Created At" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "effective_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Effective At" }, "completed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "project_status": { "type": "string", "title": "Project Status" }, "access_revoked": { "type": "integer", "title": "Access Revoked" }, "lifecycle_head": { "type": "integer", "title": "Lifecycle Head" }, "revocations": { "items": { "$ref": "#/components/schemas/RevocationRead" }, "type": "array", "title": "Revocations" } }, "additionalProperties": false, "type": "object", "required": [ "id", "project_id", "kind", "status", "requested_by", "decided_by", "reason", "created_at", "expires_at", "effective_at", "completed_at", "project_status", "access_revoked", "lifecycle_head", "revocations" ], "title": "ActionResult" }, "ActivationIntentStatus": { "properties": { "id": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Id" }, "state": { "type": "string", "enum": [ "not_requested", "not_in_current_chain", "binding_mismatch", "pending_outcome", "intent_expired", "not_yet_current" ], "title": "State" }, "expires_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expires At", "description": "Activation request intent expiry, Unix seconds; exclusive." }, "effectiveness": { "type": "string", "enum": [ "unknown", "observed_active" ], "title": "Effectiveness", "description": "A fresh signed Go positive readback can confirm an observed active row; unknown is not absence." }, "observed_active_until": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Observed Active Until", "description": "Exclusive evidence deadline for observed_active, not the original activation intent expiry." } }, "additionalProperties": false, "type": "object", "required": [ "id", "state", "expires_at", "effectiveness", "observed_active_until" ], "title": "ActivationIntentStatus" }, "AdministratorCreate": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "evidence_reference": { "type": "string", "maxLength": 500, "minLength": 5, "title": "Evidence Reference" }, "person_id": { "type": "string", "title": "Person Id" } }, "type": "object", "required": [ "reason", "evidence_reference", "person_id" ], "title": "AdministratorCreate" }, "Approval": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "role": { "type": "string", "title": "Role" } }, "type": "object", "required": [ "reason", "role" ], "title": "Approval" }, "Attestation": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "local_account_id": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Local Account Id" }, "local_auth_time": { "type": "integer", "title": "Local Auth Time" }, "local_auth_method": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Local Auth Method" }, "local_session_digest": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Local Session Digest" }, "central_issuer": { "type": "string", "title": "Central Issuer" }, "central_subject": { "type": "string", "title": "Central Subject" }, "central_auth_time": { "type": "integer", "title": "Central Auth Time" }, "central_acr": { "type": "string", "enum": [ "taifa-mfa", "taifa-phishing-resistant" ], "title": "Central Acr" }, "central_sid_digest": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Central Sid Digest" } }, "type": "object", "required": [ "reason", "local_account_id", "local_auth_time", "local_auth_method", "local_session_digest", "central_issuer", "central_subject", "central_auth_time", "central_acr", "central_sid_digest" ], "title": "Attestation" }, "AuditRead": { "properties": { "id": { "type": "string", "title": "Id" }, "actor": { "type": "string", "title": "Actor" }, "operation": { "type": "string", "title": "Operation" }, "target": { "type": "string", "title": "Target" }, "institution_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Institution Id" }, "request_id": { "type": "string", "title": "Request Id" }, "reason": { "type": "string", "title": "Reason" }, "outcome": { "type": "string", "title": "Outcome" }, "changes": { "additionalProperties": true, "type": "object", "title": "Changes" }, "created_at": { "type": "string", "title": "Created At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "actor", "operation", "target", "institution_id", "request_id", "reason", "outcome", "changes", "created_at" ], "title": "AuditRead" }, "AuditSearch": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AuditRead" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "limit": { "type": "integer", "title": "Limit" } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor", "limit" ], "title": "AuditSearch" }, "BindingAcknowledgement": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "entity_id": { "type": "string", "title": "Entity Id" }, "entity_version": { "type": "integer", "minimum": 1, "title": "Entity Version" }, "local_account_id": { "type": "string", "title": "Local Account Id" }, "proof_id": { "type": "string", "title": "Proof Id" }, "approval_id": { "type": "string", "title": "Approval Id" } }, "type": "object", "required": [ "reason", "entity_id", "entity_version", "local_account_id", "proof_id", "approval_id" ], "title": "BindingAcknowledgement" }, "CatalogList": { "properties": { "catalogs": { "items": { "$ref": "#/components/schemas/CatalogRead" }, "type": "array", "title": "Catalogs" }, "_actions": { "items": { "type": "string", "const": "catalog-propose" }, "type": "array", "title": "Actions" } }, "additionalProperties": false, "type": "object", "required": [ "catalogs", "_actions" ], "title": "CatalogList" }, "CatalogProposal": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "permissions": { "items": { "$ref": "#/components/schemas/Permission" }, "type": "array", "maxItems": 32, "minItems": 1, "title": "Permissions" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "permissions" ], "title": "CatalogProposal", "examples": [ { "permissions": [ { "description": "Read assigned case records", "id": "case.read" } ], "reason": "Define reviewed case access permissions" } ] }, "CatalogRead": { "properties": { "id": { "type": "string", "title": "Id" }, "project_id": { "type": "string", "title": "Project Id" }, "revision": { "type": "integer", "title": "Revision" }, "permissions": { "items": { "$ref": "#/components/schemas/Permission" }, "type": "array", "title": "Permissions" }, "digest": { "type": "string", "title": "Digest" }, "status": { "type": "string", "enum": [ "pending_review", "approved", "superseded", "revoked" ], "title": "Status" }, "proposer": { "type": "string", "title": "Proposer" }, "approver": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Approver" }, "created_at": { "type": "string", "title": "Created At" }, "expires_at": { "type": "string", "title": "Expires At" }, "actions": { "items": { "type": "string", "enum": [ "approve", "revoke" ] }, "type": "array", "title": "Actions" }, "revocations": { "items": { "$ref": "#/components/schemas/RevocationRead" }, "type": "array", "title": "Revocations", "default": [] } }, "additionalProperties": false, "type": "object", "required": [ "id", "project_id", "revision", "permissions", "digest", "status", "proposer", "approver", "created_at", "expires_at", "actions" ], "title": "CatalogRead" }, "ChallengeCreate": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "project_id": { "type": "string", "title": "Project Id" }, "institution_id": { "type": "string", "title": "Institution Id" } }, "type": "object", "required": [ "reason", "project_id", "institution_id" ], "title": "ChallengeCreate" }, "ClientAuthorityStatus": { "properties": { "target_issuer": { "type": "string", "maxLength": 2048, "minLength": 1, "title": "Target Issuer" }, "client_id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Client Id" }, "stream": { "$ref": "#/components/schemas/StreamStatus" }, "policy": { "$ref": "#/components/schemas/PolicyStatus" }, "source_ack": { "$ref": "#/components/schemas/SourceAckStatus" }, "grant": { "$ref": "#/components/schemas/SourceGrantStatus" }, "activation": { "$ref": "#/components/schemas/ActivationIntentStatus" } }, "additionalProperties": false, "type": "object", "required": [ "target_issuer", "client_id", "stream", "policy", "source_ack", "grant", "activation" ], "title": "ClientAuthorityStatus" }, "ClientCheck": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" } }, "type": "object", "required": [ "reason" ], "title": "ClientCheck" }, "ClientList": { "properties": { "clients": { "items": { "$ref": "#/components/schemas/ClientRead" }, "type": "array", "title": "Clients" }, "_actions": { "items": { "type": "string", "const": "client-propose" }, "type": "array", "title": "Actions" } }, "additionalProperties": false, "type": "object", "required": [ "clients", "_actions" ], "title": "ClientList" }, "ClientProposal": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "target_issuer": { "type": "string", "maxLength": 2048, "minLength": 1, "title": "Target Issuer" }, "client_id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Client Id" }, "client_version": { "type": "integer", "maximum": 9223372036854775807, "minimum": 1, "title": "Client Version", "x-taifa-integer-bounds": { "maximum": "9223372036854775807" } }, "display_name": { "type": "string", "maxLength": 120, "minLength": 3, "title": "Display Name" }, "catalog_id": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Catalog Id" }, "credential_preparation_id": { "type": "string", "maxLength": 36, "minLength": 36, "title": "Credential Preparation Id", "description": "Canonical preparation UUID from controlled credential delivery. Management verifies fresh private issuer readback; browser proof is reference metadata only." }, "permission_ids": { "items": { "type": "string" }, "type": "array", "maxItems": 32, "minItems": 1, "title": "Permission Ids" }, "registration": { "$ref": "#/components/schemas/RegistrationProposal" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "target_issuer", "client_id", "client_version", "display_name", "catalog_id", "credential_preparation_id", "permission_ids", "registration" ], "title": "ClientProposal", "examples": [ { "catalog_id": "00000000-0000-4000-8000-000000000001", "client_id": "case-app-test", "client_version": 1, "credential_preparation_id": "00000000-0000-4000-8000-000000000002", "display_name": "Case application test", "permission_ids": [ "case.read" ], "reason": "Review an owned case application registration", "registration": { "enabled": true, "management_access": false, "post_logout_redirect_uris": [ "https://case.example.test/signed-out" ], "redirect_uris": [ "https://case.example.test/callback" ], "refresh_allowed": false, "resource_audiences": [ "case-api-test" ], "secret_hash_fingerprint": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "target_issuer": "https://owned-issuer.example.test" } ] }, "ClientRead": { "properties": { "id": { "type": "string", "title": "Id" }, "project_id": { "type": "string", "title": "Project Id" }, "target_issuer": { "type": "string", "title": "Target Issuer" }, "client_id": { "type": "string", "title": "Client Id" }, "client_version": { "type": "integer", "title": "Client Version" }, "generation": { "type": "integer", "title": "Generation" }, "display_name": { "type": "string", "title": "Display Name" }, "catalog_id": { "type": "string", "title": "Catalog Id" }, "catalog_digest": { "type": "string", "title": "Catalog Digest" }, "permission_ids": { "items": { "type": "string" }, "type": "array", "title": "Permission Ids" }, "registration": { "$ref": "#/components/schemas/RegistrationRead" }, "registration_digest": { "type": "string", "title": "Registration Digest" }, "policy_digest": { "type": "string", "title": "Policy Digest" }, "credential_preparation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Credential Preparation Id" }, "custody_binding_digest": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custody Binding Digest" }, "status": { "type": "string", "enum": [ "pending_review", "approved_pending_readback", "superseded", "revoked" ], "title": "Status" }, "proposer": { "type": "string", "title": "Proposer" }, "approver": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Approver" }, "created_at": { "type": "string", "title": "Created At" }, "expires_at": { "type": "string", "title": "Expires At" }, "actions": { "items": { "type": "string", "enum": [ "approve", "revoke" ] }, "type": "array", "title": "Actions" }, "revocation": { "anyOf": [ { "$ref": "#/components/schemas/RevocationRead" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "id", "project_id", "target_issuer", "client_id", "client_version", "generation", "display_name", "catalog_id", "catalog_digest", "permission_ids", "registration", "registration_digest", "policy_digest", "status", "proposer", "approver", "created_at", "expires_at", "actions" ], "title": "ClientRead" }, "DomainCreate": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "evidence_reference": { "type": "string", "maxLength": 500, "minLength": 5, "title": "Evidence Reference" }, "domain": { "type": "string", "maxLength": 253, "minLength": 3, "title": "Domain" } }, "type": "object", "required": [ "reason", "evidence_reference", "domain" ], "title": "DomainCreate" }, "DownstreamRead": { "properties": { "head": { "type": "integer", "title": "Head" }, "acknowledged": { "type": "integer", "title": "Acknowledged" }, "state": { "type": "string", "enum": [ "acknowledged", "pending" ], "title": "State" }, "local_sessions": { "type": "string", "const": "unobserved", "title": "Local Sessions", "description": "Management cannot observe application local sessions." } }, "additionalProperties": false, "type": "object", "required": [ "head", "acknowledged", "state", "local_sessions" ], "title": "DownstreamRead" }, "EnrollmentCreate": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "recipient": { "type": "string", "maxLength": 254, "minLength": 3, "title": "Recipient" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "recipient" ], "title": "EnrollmentCreate" }, "EnvironmentCreate": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "name": { "type": "string", "pattern": "^(development|staging|production)$", "title": "Name" }, "client_type": { "type": "string", "enum": [ "public", "confidential-web", "native-mail-ios", "native-mail-android", "native-mail-desktop" ], "title": "Client Type", "default": "public" }, "redirect_uris": { "items": { "type": "string" }, "type": "array", "maxItems": 20, "minItems": 1, "title": "Redirect Uris" }, "scopes": { "items": { "type": "string" }, "type": "array", "maxItems": 10, "minItems": 1, "title": "Scopes" } }, "type": "object", "required": [ "reason", "name", "redirect_uris" ], "title": "EnvironmentCreate" }, "Evidence": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "evidence_reference": { "type": "string", "maxLength": 500, "minLength": 5, "title": "Evidence Reference" } }, "type": "object", "required": [ "reason", "evidence_reference" ], "title": "Evidence" }, "FederationProposal": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "protocol": { "type": "string", "enum": [ "oidc", "saml" ], "title": "Protocol" }, "issuer": { "type": "string", "maxLength": 512, "minLength": 1, "title": "Issuer" }, "metadata_url": { "type": "string", "maxLength": 2000, "minLength": 1, "title": "Metadata Url" }, "alias": { "type": "string", "pattern": "^[a-z][a-z0-9-]{2,56}$", "title": "Alias" }, "assurance_evidence_reference": { "type": "string", "maxLength": 500, "minLength": 5, "title": "Assurance Evidence Reference" }, "upstream_client_id": { "anyOf": [ { "type": "string", "maxLength": 200, "minLength": 1 }, { "type": "null" } ], "title": "Upstream Client Id" }, "secret_reference": { "anyOf": [ { "type": "string", "pattern": "^[a-zA-Z0-9_-]{3,100}$" }, { "type": "null" } ], "title": "Secret Reference" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "protocol", "issuer", "metadata_url", "alias", "assurance_evidence_reference" ], "title": "FederationProposal" }, "FinishAction": { "properties": { "callback_status": { "type": "string", "pattern": "^(success|canceled|error)$", "title": "Callback Status" } }, "type": "object", "required": [ "callback_status" ], "title": "FinishAction" }, "FreshEnrollmentCreate": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "recipient": { "type": "string", "maxLength": 254, "minLength": 3, "title": "Recipient" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "recipient" ], "title": "FreshEnrollmentCreate" }, "Freshness": { "properties": { "snapshot": { "type": "string", "title": "Snapshot", "description": "Opaque signed snapshot JWT" }, "receipt": { "type": "string", "title": "Receipt", "description": "Opaque signed receipt JWT" } }, "additionalProperties": false, "type": "object", "required": [ "snapshot", "receipt" ], "title": "Freshness" }, "GoReceiptRead": { "properties": { "digest": { "type": "string", "title": "Digest" }, "revoked_at": { "type": "string", "title": "Revoked At" }, "registry_present": { "type": "boolean", "title": "Registry Present" } }, "additionalProperties": false, "type": "object", "required": [ "digest", "revoked_at", "registry_present" ], "title": "GoReceiptRead" }, "GrantCandidate": { "properties": { "access_id": { "type": "string", "title": "Access Id" }, "access_version": { "type": "integer", "title": "Access Version" }, "project_id": { "type": "string", "title": "Project Id" }, "beneficiary_person_id": { "type": "string", "title": "Beneficiary Person Id" }, "beneficiary_issuer": { "type": "string", "title": "Beneficiary Issuer" }, "beneficiary_subject": { "type": "string", "title": "Beneficiary Subject" }, "event_id": { "type": "string", "title": "Event Id" }, "event_sequence": { "type": "integer", "title": "Event Sequence" }, "delivery_acknowledged": { "type": "boolean", "title": "Delivery Acknowledged" } }, "additionalProperties": false, "type": "object", "required": [ "access_id", "access_version", "project_id", "beneficiary_person_id", "beneficiary_issuer", "beneficiary_subject", "event_id", "event_sequence", "delivery_acknowledged" ], "title": "GrantCandidate" }, "GrantProposal": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "access_id": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Access Id" }, "access_version": { "type": "integer", "maximum": 9223372036854775807, "minimum": 1, "title": "Access Version", "x-taifa-integer-bounds": { "maximum": "9223372036854775807" } } }, "additionalProperties": false, "type": "object", "required": [ "reason", "access_id", "access_version" ], "title": "GrantProposal", "examples": [ { "access_id": "00000000-0000-4000-8000-000000000001", "access_version": 1, "reason": "Request independent review of current case access" } ] }, "GrantRead": { "properties": { "id": { "type": "string", "title": "Id" }, "project_id": { "type": "string", "title": "Project Id" }, "issuer": { "type": "string", "title": "Issuer" }, "subject": { "type": "string", "title": "Subject" }, "capability": { "type": "string", "const": "lifecycle-consumer", "title": "Capability" }, "status": { "type": "string", "enum": [ "pending_review", "effective", "revoked" ], "title": "Status" }, "active": { "type": "boolean", "title": "Active" }, "version": { "type": "integer", "maximum": 3, "minimum": 1, "title": "Version" }, "proposal_digest": { "type": "string", "pattern": "^[a-f0-9]{64}$", "title": "Proposal Digest" }, "proposer": { "type": "string", "title": "Proposer" }, "approver": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Approver" }, "proposal_audit_id": { "type": "string", "title": "Proposal Audit Id" }, "approval_audit_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Approval Audit Id" }, "revocation_audit_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Revocation Audit Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "approved_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "format": "date-time", "title": "Approved At" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "format": "date-time", "title": "Revoked At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "project_id", "issuer", "subject", "capability", "status", "active", "version", "proposal_digest", "proposer", "approver", "proposal_audit_id", "approval_audit_id", "revocation_audit_id", "created_at", "approved_at", "revoked_at" ], "title": "GrantRead" }, "GrantReceipt": { "properties": { "id": { "type": "string", "title": "Id" }, "status": { "type": "string", "enum": [ "pending_review", "approved", "revoked", "superseded" ], "title": "Status" }, "access_id": { "type": "string", "title": "Access Id" }, "access_version": { "type": "integer", "title": "Access Version" }, "project_id": { "type": "string", "title": "Project Id" }, "beneficiary_person_id": { "type": "string", "title": "Beneficiary Person Id" }, "beneficiary_issuer": { "type": "string", "title": "Beneficiary Issuer" }, "beneficiary_subject": { "type": "string", "title": "Beneficiary Subject" }, "beneficiary_person_version": { "type": "integer", "title": "Beneficiary Person Version" }, "beneficiary_membership_id": { "type": "string", "title": "Beneficiary Membership Id" }, "beneficiary_membership_version": { "type": "integer", "title": "Beneficiary Membership Version" }, "event_id": { "type": "string", "title": "Event Id" }, "event_sequence": { "type": "integer", "title": "Event Sequence" }, "event_digest": { "type": "string", "title": "Event Digest" }, "source_request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Request Id" }, "sponsor_id": { "type": "string", "title": "Sponsor Id" }, "sponsor_generation": { "type": "integer", "title": "Sponsor Generation" }, "sponsor_actor": { "type": "string", "title": "Sponsor Actor" }, "sponsor_person_id": { "type": "string", "title": "Sponsor Person Id" }, "sponsor_person_version": { "type": "integer", "title": "Sponsor Person Version" }, "sponsor_membership_id": { "type": "string", "title": "Sponsor Membership Id" }, "sponsor_membership_version": { "type": "integer", "title": "Sponsor Membership Version" }, "sponsor_fingerprint": { "type": "string", "title": "Sponsor Fingerprint" }, "sponsor_audit_id": { "type": "string", "title": "Sponsor Audit Id" }, "sponsor_operation": { "type": "string", "title": "Sponsor Operation" }, "sponsor_target": { "type": "string", "title": "Sponsor Target" }, "administrator_proposal_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Administrator Proposal Id" }, "administrator_generation": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Administrator Generation" }, "administrator_actor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Administrator Actor" }, "administrator_person_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Administrator Person Id" }, "administrator_person_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Administrator Person Version" }, "administrator_membership_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Administrator Membership Id" }, "administrator_membership_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Administrator Membership Version" }, "approved_fingerprint": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Approved Fingerprint" }, "administrator_audit_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Administrator Audit Id" }, "administrator_operation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Administrator Operation" }, "administrator_target": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Administrator Target" }, "created_at": { "type": "string", "title": "Created At" }, "expires_at": { "type": "string", "title": "Expires At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "status", "access_id", "access_version", "project_id", "beneficiary_person_id", "beneficiary_issuer", "beneficiary_subject", "beneficiary_person_version", "beneficiary_membership_id", "beneficiary_membership_version", "event_id", "event_sequence", "event_digest", "source_request_id", "sponsor_id", "sponsor_generation", "sponsor_actor", "sponsor_person_id", "sponsor_person_version", "sponsor_membership_id", "sponsor_membership_version", "sponsor_fingerprint", "sponsor_audit_id", "sponsor_operation", "sponsor_target", "administrator_proposal_id", "administrator_generation", "administrator_actor", "administrator_person_id", "administrator_person_version", "administrator_membership_id", "administrator_membership_version", "approved_fingerprint", "administrator_audit_id", "administrator_operation", "administrator_target", "created_at", "expires_at" ], "title": "GrantReceipt", "examples": [ { "access_id": "00000000-0000-4000-8000-000000000011", "access_version": 2, "administrator_actor": "https://people.example.test|synthetic-administrator", "administrator_audit_id": "00000000-0000-4000-8000-000000000023", "administrator_generation": 2, "administrator_membership_id": "00000000-0000-4000-8000-000000000022", "administrator_membership_version": 1, "administrator_operation": "access-grant-review.approve:institution:review", "administrator_person_id": "00000000-0000-4000-8000-000000000021", "administrator_person_version": 2, "administrator_proposal_id": "00000000-0000-4000-8000-000000000020", "administrator_target": "00000000-0000-4000-8000-000000000010", "approved_fingerprint": "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc", "beneficiary_issuer": "https://people.example.test", "beneficiary_membership_id": "00000000-0000-4000-8000-000000000014", "beneficiary_membership_version": 1, "beneficiary_person_id": "00000000-0000-4000-8000-000000000013", "beneficiary_person_version": 1, "beneficiary_subject": "synthetic-holder", "created_at": "2026-10-04T10:00:00+00:00", "event_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "event_id": "00000000-0000-4000-8000-000000000015", "event_sequence": 7, "expires_at": "2027-01-02T10:00:00+00:00", "id": "00000000-0000-4000-8000-000000000010", "project_id": "00000000-0000-4000-8000-000000000012", "sponsor_actor": "https://people.example.test|synthetic-sponsor", "sponsor_audit_id": "00000000-0000-4000-8000-000000000019", "sponsor_fingerprint": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", "sponsor_generation": 3, "sponsor_id": "00000000-0000-4000-8000-000000000016", "sponsor_membership_id": "00000000-0000-4000-8000-000000000018", "sponsor_membership_version": 2, "sponsor_operation": "access-grant-review.propose:institution:access", "sponsor_person_id": "00000000-0000-4000-8000-000000000017", "sponsor_person_version": 2, "sponsor_target": "00000000-0000-4000-8000-000000000010", "status": "approved" } ] }, "GrantReviewList": { "properties": { "institution": { "$ref": "#/components/schemas/InstitutionDisplay" }, "reviews": { "items": { "$ref": "#/components/schemas/GrantReviewRead" }, "type": "array", "title": "Reviews" }, "candidates": { "items": { "$ref": "#/components/schemas/GrantCandidate" }, "type": "array", "title": "Candidates" }, "_actions": { "items": { "type": "string", "const": "propose" }, "type": "array", "title": "Actions" } }, "additionalProperties": false, "type": "object", "required": [ "institution", "reviews", "candidates", "_actions" ], "title": "GrantReviewList", "examples": [ { "_actions": [ "propose" ], "candidates": [], "institution": { "id": "00000000-0000-4000-8000-000000000030", "name": "Synthetic institution" }, "reviews": [] } ] }, "GrantReviewRead": { "properties": { "id": { "type": "string", "title": "Id" }, "status": { "type": "string", "enum": [ "pending_review", "approved", "revoked", "superseded" ], "title": "Status" }, "access_id": { "type": "string", "title": "Access Id" }, "access_version": { "type": "integer", "title": "Access Version" }, "project_id": { "type": "string", "title": "Project Id" }, "beneficiary_person_id": { "type": "string", "title": "Beneficiary Person Id" }, "beneficiary_issuer": { "type": "string", "title": "Beneficiary Issuer" }, "beneficiary_subject": { "type": "string", "title": "Beneficiary Subject" }, "beneficiary_person_version": { "type": "integer", "title": "Beneficiary Person Version" }, "beneficiary_membership_id": { "type": "string", "title": "Beneficiary Membership Id" }, "beneficiary_membership_version": { "type": "integer", "title": "Beneficiary Membership Version" }, "event_id": { "type": "string", "title": "Event Id" }, "event_sequence": { "type": "integer", "title": "Event Sequence" }, "event_digest": { "type": "string", "title": "Event Digest" }, "source_request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Request Id" }, "sponsor_id": { "type": "string", "title": "Sponsor Id" }, "sponsor_generation": { "type": "integer", "title": "Sponsor Generation" }, "sponsor_actor": { "type": "string", "title": "Sponsor Actor" }, "sponsor_person_id": { "type": "string", "title": "Sponsor Person Id" }, "sponsor_person_version": { "type": "integer", "title": "Sponsor Person Version" }, "sponsor_membership_id": { "type": "string", "title": "Sponsor Membership Id" }, "sponsor_membership_version": { "type": "integer", "title": "Sponsor Membership Version" }, "sponsor_fingerprint": { "type": "string", "title": "Sponsor Fingerprint" }, "sponsor_audit_id": { "type": "string", "title": "Sponsor Audit Id" }, "sponsor_operation": { "type": "string", "title": "Sponsor Operation" }, "sponsor_target": { "type": "string", "title": "Sponsor Target" }, "administrator_proposal_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Administrator Proposal Id" }, "administrator_generation": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Administrator Generation" }, "administrator_actor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Administrator Actor" }, "administrator_person_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Administrator Person Id" }, "administrator_person_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Administrator Person Version" }, "administrator_membership_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Administrator Membership Id" }, "administrator_membership_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Administrator Membership Version" }, "approved_fingerprint": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Approved Fingerprint" }, "administrator_audit_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Administrator Audit Id" }, "administrator_operation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Administrator Operation" }, "administrator_target": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Administrator Target" }, "created_at": { "type": "string", "title": "Created At" }, "expires_at": { "type": "string", "title": "Expires At" }, "current": { "type": "boolean", "title": "Current" }, "delivery_acknowledged": { "type": "boolean", "title": "Delivery Acknowledged" }, "actions": { "items": { "type": "string", "enum": [ "approve", "revoke" ] }, "type": "array", "title": "Actions" } }, "additionalProperties": false, "type": "object", "required": [ "id", "status", "access_id", "access_version", "project_id", "beneficiary_person_id", "beneficiary_issuer", "beneficiary_subject", "beneficiary_person_version", "beneficiary_membership_id", "beneficiary_membership_version", "event_id", "event_sequence", "event_digest", "source_request_id", "sponsor_id", "sponsor_generation", "sponsor_actor", "sponsor_person_id", "sponsor_person_version", "sponsor_membership_id", "sponsor_membership_version", "sponsor_fingerprint", "sponsor_audit_id", "sponsor_operation", "sponsor_target", "administrator_proposal_id", "administrator_generation", "administrator_actor", "administrator_person_id", "administrator_person_version", "administrator_membership_id", "administrator_membership_version", "approved_fingerprint", "administrator_audit_id", "administrator_operation", "administrator_target", "created_at", "expires_at", "current", "delivery_acknowledged", "actions" ], "title": "GrantReviewRead", "examples": [ { "access_id": "00000000-0000-4000-8000-000000000011", "access_version": 2, "administrator_actor": "https://people.example.test|synthetic-administrator", "administrator_audit_id": "00000000-0000-4000-8000-000000000023", "administrator_generation": 2, "administrator_membership_id": "00000000-0000-4000-8000-000000000022", "administrator_membership_version": 1, "administrator_operation": "access-grant-review.approve:institution:review", "administrator_person_id": "00000000-0000-4000-8000-000000000021", "administrator_person_version": 2, "administrator_proposal_id": "00000000-0000-4000-8000-000000000020", "administrator_target": "00000000-0000-4000-8000-000000000010", "approved_fingerprint": "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc", "beneficiary_issuer": "https://people.example.test", "beneficiary_membership_id": "00000000-0000-4000-8000-000000000014", "beneficiary_membership_version": 1, "beneficiary_person_id": "00000000-0000-4000-8000-000000000013", "beneficiary_person_version": 1, "beneficiary_subject": "synthetic-holder", "created_at": "2026-10-04T10:00:00+00:00", "event_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "event_id": "00000000-0000-4000-8000-000000000015", "event_sequence": 7, "expires_at": "2027-01-02T10:00:00+00:00", "id": "00000000-0000-4000-8000-000000000010", "project_id": "00000000-0000-4000-8000-000000000012", "sponsor_actor": "https://people.example.test|synthetic-sponsor", "sponsor_audit_id": "00000000-0000-4000-8000-000000000019", "sponsor_fingerprint": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", "sponsor_generation": 3, "sponsor_id": "00000000-0000-4000-8000-000000000016", "sponsor_membership_id": "00000000-0000-4000-8000-000000000018", "sponsor_membership_version": 2, "sponsor_operation": "access-grant-review.propose:institution:access", "sponsor_person_id": "00000000-0000-4000-8000-000000000017", "sponsor_person_version": 2, "sponsor_target": "00000000-0000-4000-8000-000000000010", "status": "approved" } ] }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "identity__access_grant_review_router__Reason": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" } }, "additionalProperties": false, "type": "object", "required": [ "reason" ], "title": "Reason", "examples": [ { "reason": "Approve independently reviewed current access" } ] }, "identity__auth_engine_enrollment_router__Reason": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" } }, "additionalProperties": false, "type": "object", "required": [ "reason" ], "title": "Reason" }, "identity__enrollment_router__Reason": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" } }, "additionalProperties": false, "type": "object", "required": [ "reason" ], "title": "Reason" }, "identity__federation_router__Reason": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" } }, "additionalProperties": false, "type": "object", "required": [ "reason" ], "title": "Reason" }, "identity__owned_client_router__Reason": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" } }, "additionalProperties": false, "type": "object", "required": [ "reason" ], "title": "Reason" }, "identity__personal_capabilities__Reason": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" } }, "type": "object", "required": [ "reason" ], "title": "Reason" }, "InstitutionCreate": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "name": { "type": "string", "maxLength": 200, "minLength": 2, "title": "Name" }, "evidence_reference": { "type": "string", "maxLength": 500, "minLength": 5, "title": "Evidence Reference" } }, "type": "object", "required": [ "reason", "name", "evidence_reference" ], "title": "InstitutionCreate" }, "InstitutionDisplay": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" } }, "additionalProperties": false, "type": "object", "required": [ "id", "name" ], "title": "InstitutionDisplay" }, "InstitutionForAdministrator": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "status": { "type": "string", "title": "Status" }, "proposer": { "type": "string", "title": "Proposer" }, "approver": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Approver" }, "can_review_evidence": { "type": "boolean", "const": false, "title": "Can Review Evidence" } }, "additionalProperties": false, "type": "object", "required": [ "id", "name", "status", "proposer", "approver", "can_review_evidence" ], "title": "InstitutionForAdministrator" }, "InstitutionForOperator": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "status": { "type": "string", "title": "Status" }, "proposer": { "type": "string", "title": "Proposer" }, "approver": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Approver" }, "evidence_reference": { "type": "string", "title": "Evidence Reference" }, "can_review_evidence": { "type": "boolean", "const": true, "title": "Can Review Evidence" } }, "additionalProperties": false, "type": "object", "required": [ "id", "name", "status", "proposer", "approver", "evidence_reference", "can_review_evidence" ], "title": "InstitutionForOperator" }, "IntentRequest": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason", "description": "Trimmed printable reason recorded in the accepted Audit", "examples": [ "Provision a controlled project credential" ] }, "client_id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Client Id", "description": "Exact client ID for the proposed registration", "examples": [ "project-app" ] }, "client_version": { "type": "integer", "maximum": 9223372036854775807, "minimum": 1, "title": "Client Version", "description": "Proposed registration version, greater than approved history", "examples": [ 1 ], "x-taifa-integer-bounds": { "maximum": "9223372036854775807" } }, "destination_runtime": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Destination Runtime", "description": "Exact locally configured custody runtime", "examples": [ "owner-runtime" ] } }, "additionalProperties": false, "type": "object", "required": [ "reason", "client_id", "client_version", "destination_runtime" ], "title": "IntentRequest" }, "IntentResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Server-generated canonical intent UUID" }, "custody_status": { "type": "string", "const": "pending", "title": "Custody Status", "description": "Awaiting controlled private custody delivery" } }, "additionalProperties": false, "type": "object", "required": [ "id", "custody_status" ], "title": "IntentResponse" }, "InvitationCreate": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "recipient": { "type": "string", "maxLength": 254, "minLength": 3, "title": "Recipient" }, "expires_in_hours": { "type": "integer", "maximum": 168, "minimum": 1, "title": "Expires In Hours", "default": 48 } }, "type": "object", "required": [ "reason", "recipient" ], "title": "InvitationCreate" }, "InvitationRedeem": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "secret": { "type": "string", "maxLength": 256, "minLength": 32, "title": "Secret" } }, "type": "object", "required": [ "reason", "secret" ], "title": "InvitationRedeem" }, "JobReview": { "properties": { "expected_status": { "type": "string", "enum": [ "failed", "ambiguous" ], "title": "Expected Status" }, "action": { "type": "string", "enum": [ "retry", "reconcile" ], "title": "Action" }, "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" } }, "type": "object", "required": [ "expected_status", "action", "reason" ], "title": "JobReview" }, "LaunchCreate": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "launch_url": { "type": "string", "maxLength": 2048, "title": "Launch Url" } }, "type": "object", "required": [ "reason", "launch_url" ], "title": "LaunchCreate" }, "LifecycleAcknowledgement": { "properties": { "head": { "type": "integer", "title": "Head" }, "acknowledged": { "type": "integer", "title": "Acknowledged" }, "status": { "type": "string", "enum": [ "pending", "effective" ], "title": "Status" } }, "additionalProperties": false, "type": "object", "required": [ "head", "acknowledged", "status" ], "title": "LifecycleAcknowledgement" }, "LifecycleFeed": { "properties": { "events": { "items": { "type": "string" }, "type": "array", "title": "Events", "description": "Opaque signed event JWTs" }, "receipt": { "type": "string", "title": "Receipt", "description": "Opaque signed receipt JWT" }, "next_cursor": { "type": "integer", "title": "Next Cursor" }, "has_more": { "type": "boolean", "title": "Has More" } }, "additionalProperties": false, "type": "object", "required": [ "events", "receipt", "next_cursor", "has_more" ], "title": "LifecycleFeed" }, "LifecycleRead": { "properties": { "project_id": { "type": "string", "title": "Project Id" }, "name": { "type": "string", "title": "Name" }, "status": { "type": "string", "title": "Status" }, "downstream": { "$ref": "#/components/schemas/DownstreamRead" }, "actions": { "items": { "$ref": "#/components/schemas/ActionRead" }, "type": "array", "title": "Actions" }, "revocations": { "items": { "$ref": "#/components/schemas/RevocationDetail" }, "type": "array", "title": "Revocations" }, "allowed": { "items": { "type": "string", "enum": [ "suspend", "resume", "decommission-request", "decommission-approve", "decommission-cancel" ] }, "type": "array", "title": "Allowed" } }, "additionalProperties": false, "type": "object", "required": [ "project_id", "name", "status", "downstream", "actions", "revocations", "allowed" ], "title": "LifecycleRead" }, "LifecycleServiceApproval": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "expected_version": { "type": "integer", "minimum": 1, "title": "Expected Version" }, "proposal_digest": { "type": "string", "pattern": "^[a-f0-9]{64}$", "title": "Proposal Digest" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "expected_version", "proposal_digest" ], "title": "LifecycleServiceApproval" }, "LifecycleServiceProposal": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "issuer": { "type": "string", "maxLength": 2048, "minLength": 1, "title": "Issuer" }, "subject": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Subject" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "issuer", "subject" ], "title": "LifecycleServiceProposal" }, "LifecycleServiceRevocation": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "expected_version": { "type": "integer", "minimum": 1, "title": "Expected Version" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "expected_version" ], "title": "LifecycleServiceRevocation" }, "LifecycleSnapshot": { "properties": { "snapshot": { "type": "string", "title": "Snapshot", "description": "Opaque signed snapshot JWT" } }, "additionalProperties": false, "type": "object", "required": [ "snapshot" ], "title": "LifecycleSnapshot" }, "LifecycleStatus": { "properties": { "head": { "type": "string", "pattern": "^(0|[1-9][0-9]{0,18})$", "title": "Head", "description": "Decimal source lifecycle head sequence." }, "acknowledged": { "type": "string", "pattern": "^(0|[1-9][0-9]{0,18})$", "title": "Acknowledged", "description": "Decimal consumer acknowledged sequence." }, "acknowledged_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Acknowledged At", "description": "Last acknowledged observation, Unix seconds." }, "state": { "type": "string", "enum": [ "unobserved", "lagging", "stale", "current" ], "title": "State" } }, "additionalProperties": false, "type": "object", "required": [ "head", "acknowledged", "acknowledged_at", "state" ], "title": "LifecycleStatus" }, "LinkCreate": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "proof_id": { "type": "string", "title": "Proof Id" } }, "type": "object", "required": [ "reason", "proof_id" ], "title": "LinkCreate" }, "MembershipChange": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "person_id": { "type": "string", "title": "Person Id" }, "institution_id": { "type": "string", "title": "Institution Id" }, "active": { "type": "boolean", "title": "Active" } }, "type": "object", "required": [ "reason", "person_id", "institution_id", "active" ], "title": "MembershipChange" }, "MembershipRead": { "properties": { "id": { "type": "string", "title": "Id" }, "person_id": { "type": "string", "title": "Person Id" }, "institution_id": { "type": "string", "title": "Institution Id" }, "active": { "type": "boolean", "title": "Active" }, "sponsor": { "type": "string", "title": "Sponsor" }, "version": { "type": "integer", "title": "Version" } }, "additionalProperties": false, "type": "object", "required": [ "id", "person_id", "institution_id", "active", "sponsor", "version" ], "title": "MembershipRead" }, "Mutation": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" } }, "type": "object", "required": [ "reason" ], "title": "Mutation" }, "OperationsSummary": { "properties": { "pending": { "type": "integer", "title": "Pending" }, "failed": { "type": "integer", "title": "Failed" }, "failure_diagnostics_available": { "type": "boolean", "title": "Failure Diagnostics Available" }, "status": { "type": "string", "enum": [ "failed", "pending", "effective" ], "title": "Status" } }, "additionalProperties": false, "type": "object", "required": [ "pending", "failed", "failure_diagnostics_available", "status" ], "title": "OperationsSummary" }, "OwnAccess": { "properties": { "id": { "type": "string", "title": "Id" }, "institution_id": { "type": "string", "title": "Institution Id" }, "project_id": { "type": "string", "title": "Project Id" }, "active": { "type": "boolean", "title": "Active" }, "version": { "type": "integer", "title": "Version" } }, "additionalProperties": false, "type": "object", "required": [ "id", "institution_id", "project_id", "active", "version" ], "title": "OwnAccess" }, "OwnAccount": { "properties": { "id": { "type": "string", "title": "Id" }, "issuer": { "type": "string", "title": "Issuer" }, "subject": { "type": "string", "title": "Subject" }, "status": { "type": "string", "const": "active", "title": "Status" }, "version": { "type": "integer", "title": "Version" }, "roles": { "items": { "type": "string" }, "type": "array", "title": "Roles" }, "memberships": { "items": { "$ref": "#/components/schemas/OwnMembership" }, "type": "array", "title": "Memberships" }, "access": { "items": { "$ref": "#/components/schemas/OwnAccess" }, "type": "array", "title": "Access" } }, "additionalProperties": false, "type": "object", "required": [ "id", "issuer", "subject", "status", "version", "roles", "memberships", "access" ], "title": "OwnAccount" }, "OwnerChange": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "person_id": { "type": "string", "title": "Person Id" }, "active": { "type": "boolean", "title": "Active", "default": true } }, "type": "object", "required": [ "reason", "person_id" ], "title": "OwnerChange" }, "OwnMembership": { "properties": { "id": { "type": "string", "title": "Id" }, "institution_id": { "type": "string", "title": "Institution Id" }, "active": { "type": "boolean", "title": "Active" }, "version": { "type": "integer", "title": "Version" } }, "additionalProperties": false, "type": "object", "required": [ "id", "institution_id", "active", "version" ], "title": "OwnMembership" }, "Permission": { "properties": { "id": { "type": "string", "maxLength": 64, "minLength": 1, "title": "Id" }, "description": { "type": "string", "maxLength": 200, "minLength": 8, "title": "Description" } }, "additionalProperties": false, "type": "object", "required": [ "id", "description" ], "title": "Permission" }, "PersonCreate": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "issuer": { "type": "string", "title": "Issuer" }, "subject": { "type": "string", "minLength": 1, "title": "Subject" } }, "type": "object", "required": [ "reason", "issuer", "subject" ], "title": "PersonCreate" }, "PersonRead": { "properties": { "id": { "type": "string", "title": "Id" }, "issuer": { "type": "string", "title": "Issuer" }, "subject": { "type": "string", "title": "Subject" }, "enabled": { "type": "boolean", "title": "Enabled" }, "version": { "type": "integer", "title": "Version" } }, "additionalProperties": false, "type": "object", "required": [ "id", "issuer", "subject", "enabled", "version" ], "title": "PersonRead" }, "PolicyStatus": { "properties": { "id": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Id" }, "client_version": { "anyOf": [ { "type": "string", "pattern": "^(0|[1-9][0-9]{0,18})$" }, { "type": "null" } ], "title": "Client Version", "description": "Decimal reviewed client version." }, "generation": { "anyOf": [ { "type": "string", "pattern": "^(0|[1-9][0-9]{0,18})$" }, { "type": "null" } ], "title": "Generation", "description": "Decimal reviewed generation." }, "expires_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expires At", "description": "Policy expiry, Unix seconds; exclusive." }, "state": { "type": "string", "enum": [ "not_recorded", "pending_review", "approved_pending_readback", "not_current", "superseded", "revoked", "ambiguous" ], "title": "State" } }, "additionalProperties": false, "type": "object", "required": [ "id", "client_version", "generation", "expires_at", "state" ], "title": "PolicyStatus" }, "ProjectAuthorityStatus": { "properties": { "project_id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Project Id" }, "observed_at": { "type": "integer", "title": "Observed At", "description": "Read time, Unix seconds." }, "lifecycle": { "$ref": "#/components/schemas/LifecycleStatus" }, "activation_effectiveness": { "type": "string", "const": "unknown", "title": "Activation Effectiveness", "description": "Project-wide effectiveness remains unknown; inspect each current signed client observation." }, "clients": { "items": { "$ref": "#/components/schemas/ClientAuthorityStatus" }, "type": "array", "maxItems": 50, "title": "Clients" }, "next_offset": { "anyOf": [ { "type": "integer", "maximum": 10000, "minimum": 0 }, { "type": "null" } ], "title": "Next Offset", "description": "Offset for the next page, or null at the end." } }, "additionalProperties": false, "type": "object", "required": [ "project_id", "observed_at", "lifecycle", "activation_effectiveness", "clients", "next_offset" ], "title": "ProjectAuthorityStatus" }, "ProjectCreate": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "name": { "type": "string", "minLength": 2, "title": "Name" } }, "type": "object", "required": [ "reason", "name" ], "title": "ProjectCreate" }, "ProjectRead": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "owner": { "type": "string", "title": "Owner" }, "status": { "type": "string", "title": "Status" }, "head": { "type": "integer", "title": "Head" }, "acknowledged": { "type": "integer", "title": "Acknowledged" } }, "additionalProperties": false, "type": "object", "required": [ "id", "name", "owner", "status", "head", "acknowledged" ], "title": "ProjectRead" }, "ProofCreate": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "evidence_reference": { "type": "string", "maxLength": 500, "minLength": 5, "title": "Evidence Reference" }, "project_id": { "type": "string", "title": "Project Id" }, "person_id": { "type": "string", "title": "Person Id" }, "local_account_id": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Local Account Id" }, "expires_in_minutes": { "type": "integer", "maximum": 60, "minimum": 1, "title": "Expires In Minutes", "default": 30 } }, "type": "object", "required": [ "reason", "evidence_reference", "project_id", "person_id", "local_account_id" ], "title": "ProofCreate" }, "Proposal": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "accessTokenLifespan": { "type": "integer", "maximum": 3600, "minimum": 60, "title": "Accesstokenlifespan" }, "ssoSessionIdleTimeout": { "type": "integer", "maximum": 28800, "minimum": 60, "title": "Ssosessionidletimeout" }, "ssoSessionMaxLifespan": { "type": "integer", "maximum": 86400, "minimum": 300, "title": "Ssosessionmaxlifespan" } }, "type": "object", "required": [ "reason", "accessTokenLifespan", "ssoSessionIdleTimeout", "ssoSessionMaxLifespan" ], "title": "Proposal" }, "RecoveryCreate": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "evidence_reference": { "type": "string", "maxLength": 500, "minLength": 5, "title": "Evidence Reference" }, "person_id": { "type": "string", "title": "Person Id" } }, "type": "object", "required": [ "reason", "evidence_reference", "person_id" ], "title": "RecoveryCreate" }, "RegistrationProposal": { "properties": { "secret_hash_fingerprint": { "type": "string", "maxLength": 64, "minLength": 64, "title": "Secret Hash Fingerprint", "description": "Lowercase SHA-256 fingerprint of the controlled 32-byte issuer secret_hash. This fingerprint is not a credential." }, "redirect_uris": { "items": { "type": "string", "maxLength": 1024 }, "type": "array", "maxItems": 16, "minItems": 1, "title": "Redirect Uris", "description": "Exact HTTPS authorization callbacks, at most 1024 ASCII bytes each as required by the owned issuer." }, "post_logout_redirect_uris": { "items": { "type": "string" }, "type": "array", "maxItems": 16, "title": "Post Logout Redirect Uris" }, "resource_audiences": { "items": { "type": "string" }, "type": "array", "maxItems": 16, "title": "Resource Audiences" }, "refresh_allowed": { "type": "boolean", "title": "Refresh Allowed" }, "management_access": { "type": "boolean", "title": "Management Access" }, "backchannel_logout_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Backchannel Logout Uri" }, "enabled": { "type": "boolean", "title": "Enabled" } }, "additionalProperties": false, "type": "object", "required": [ "secret_hash_fingerprint", "redirect_uris", "post_logout_redirect_uris", "resource_audiences", "refresh_allowed", "management_access", "backchannel_logout_uri", "enabled" ], "title": "RegistrationProposal" }, "RegistrationRead": { "properties": { "secret_hash_fingerprint": { "type": "string", "maxLength": 64, "minLength": 64, "title": "Secret Hash Fingerprint", "description": "Lowercase SHA-256 fingerprint of the controlled 32-byte issuer secret_hash. This fingerprint is not a credential." }, "redirect_uris": { "items": { "type": "string", "maxLength": 1024 }, "type": "array", "maxItems": 16, "minItems": 1, "title": "Redirect Uris", "description": "Exact HTTPS authorization callbacks, at most 1024 ASCII bytes each as required by the owned issuer." }, "post_logout_redirect_uris": { "items": { "type": "string" }, "type": "array", "maxItems": 16, "title": "Post Logout Redirect Uris" }, "resource_audiences": { "items": { "type": "string" }, "type": "array", "maxItems": 16, "title": "Resource Audiences" }, "refresh_allowed": { "type": "boolean", "title": "Refresh Allowed" }, "management_access": { "type": "boolean", "title": "Management Access" }, "backchannel_logout_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Backchannel Logout Uri" }, "enabled": { "type": "boolean", "title": "Enabled" }, "review_id": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Review Id" } }, "additionalProperties": false, "type": "object", "required": [ "secret_hash_fingerprint", "redirect_uris", "post_logout_redirect_uris", "resource_audiences", "refresh_allowed", "management_access", "backchannel_logout_uri", "enabled", "review_id" ], "title": "RegistrationRead" }, "RequestCreate": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "institution_id": { "type": "string", "title": "Institution Id" }, "project_id": { "type": "string", "title": "Project Id" } }, "type": "object", "required": [ "reason", "institution_id", "project_id" ], "title": "RequestCreate" }, "RevocationDetail": { "properties": { "id": { "type": "string", "title": "Id" }, "target_issuer": { "type": "string", "title": "Target Issuer" }, "client_id": { "type": "string", "title": "Client Id" }, "scope": { "type": "string", "title": "Scope" }, "reason_code": { "type": "string", "title": "Reason Code" }, "state": { "type": "string", "enum": [ "queued", "staged", "acknowledged", "not_installed", "already_revoked" ], "title": "State" }, "delivery": { "type": "string", "enum": [ "none", "signed_not_sent", "sent_unconfirmed", "receipt_accepted", "not_applicable" ], "title": "Delivery" }, "authority_sequence": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Authority Sequence" }, "command_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Command Id" }, "attempts": { "type": "integer", "title": "Attempts" }, "last_attempt_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Attempt At" }, "last_outcome": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Outcome" }, "needs_attention": { "type": "boolean", "title": "Needs Attention" }, "receipt": { "anyOf": [ { "$ref": "#/components/schemas/GoReceiptRead" }, { "type": "null" } ] }, "created_at": { "type": "string", "title": "Created At" }, "completed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completed At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "target_issuer", "client_id", "scope", "reason_code", "state", "delivery", "authority_sequence", "command_id", "attempts", "last_attempt_at", "last_outcome", "needs_attention", "receipt", "created_at", "completed_at" ], "title": "RevocationDetail" }, "RevocationRead": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "state": { "type": "string", "enum": [ "queued", "staged", "acknowledged", "not_installed", "already_revoked" ], "title": "State" }, "scope": { "type": "string", "enum": [ "client_policy", "catalog", "project_decommission" ], "title": "Scope" }, "reason_code": { "type": "string", "title": "Reason Code" }, "target_issuer": { "type": "string", "title": "Target Issuer" }, "client_id": { "type": "string", "title": "Client Id" } }, "additionalProperties": false, "type": "object", "required": [ "id", "state", "scope", "reason_code", "target_issuer", "client_id" ], "title": "RevocationRead" }, "ServiceProposal": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "issuer": { "type": "string", "title": "Issuer" }, "subject": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Subject" }, "capability": { "type": "string", "const": "account-link-attestor", "title": "Capability" } }, "type": "object", "required": [ "reason", "issuer", "subject", "capability" ], "title": "ServiceProposal" }, "SourceAckStatus": { "properties": { "id": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Id" }, "state": { "type": "string", "enum": [ "not_recorded", "recorded_historical", "not_in_current_chain" ], "title": "State" }, "expires_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expires At", "description": "Original ACK expiry, Unix seconds; historical ACK may support renewal." } }, "additionalProperties": false, "type": "object", "required": [ "id", "state", "expires_at" ], "title": "SourceAckStatus" }, "SourceGrantStatus": { "properties": { "id": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Id" }, "state": { "type": "string", "enum": [ "not_recorded", "not_in_current_chain", "multiple_recorded", "unexpired_source_record", "expired_source_record", "not_yet_current" ], "title": "State", "description": "Source ledger observation only, never Go activation or sign-in effectiveness." }, "expires_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expires At", "description": "Grant expiry, Unix seconds; exclusive." } }, "additionalProperties": false, "type": "object", "required": [ "id", "state", "expires_at" ], "title": "SourceGrantStatus" }, "SponsorChange": { "properties": { "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" }, "evidence_reference": { "type": "string", "maxLength": 500, "minLength": 5, "title": "Evidence Reference" }, "person_id": { "type": "string", "title": "Person Id" }, "active": { "type": "boolean", "title": "Active", "default": true } }, "type": "object", "required": [ "reason", "evidence_reference", "person_id" ], "title": "SponsorChange" }, "StartAction": { "properties": { "action": { "type": "string", "maxLength": 64, "minLength": 1, "title": "Action" }, "reason": { "type": "string", "maxLength": 500, "minLength": 8, "title": "Reason" } }, "type": "object", "required": [ "action", "reason" ], "title": "StartAction" }, "StreamStatus": { "properties": { "id": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Id" }, "authority_sequence": { "anyOf": [ { "type": "string", "pattern": "^(0|[1-9][0-9]{0,18})$" }, { "type": "null" } ], "title": "Authority Sequence", "description": "Decimal current source sequence." }, "state": { "type": "string", "enum": [ "not_recorded", "tombstoned", "pointer_mismatch", "recorded" ], "title": "State" } }, "additionalProperties": false, "type": "object", "required": [ "id", "authority_sequence", "state" ], "title": "StreamStatus" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" } } } }