{"openapi":"3.1.0","info":{"title":"RampGuide trust center API","version":"1","description":"Programmatic access to FedRAMP Certification Data (CDS-TRC-PAC). Sessions are for people (passkey sign-in); party keys are for agency and assessor systems, minted by a party administrator; publish keys are for the provider's build pipeline. Every file download answers 302 with a 60-second URL and a JSON body carrying the file's SHA-256, which you can check against the manifest served by index.json."},"servers":[{"url":"https://trust.rampguide.com"}],"components":{"securitySchemes":{"session":{"type":"apiKey","in":"cookie","name":"__Host-session","description":"Set by passkey sign-in at /sign-in"},"partyKey":{"type":"http","scheme":"bearer","description":"rgt_live_… party API key"},"publishKey":{"type":"http","scheme":"bearer","description":"rgp_live_… publish key"}}},"x-fedramp-rules":{"CDS-CSO-PUB":"public offering information, human-readable and JSON","CDS-CSO-CBF":"human and machine renderings from one source","CDS-CSO-IRP":"the policy and procedure inventory with its seven fields","CDS-CSO-HAD":"snapshots aligned to Ongoing Certification Reports","CDS-TRC-USH":"uninterrupted sharing: standing grants, just-in-time provisioning","CDS-TRC-PAC":"documented programmatic access","CDS-TRC-AAI":"inventory and history of agency users and systems","CDS-TRC-ACL":"access logging with six months of summaries, available to the party","CDS-TRC-HMR":"view and download in both formats","CDS-TRC-SSM":"parties provision and manage their own users and keys","CDS-UTC-AAD":"agency denials reported to FedRAMP within five business days","SCN-CSO-HIS":"twelve months of Significant Change Notifications"},"paths":{"/v1/openapi.json":{"get":{"summary":"this document","x-fedramp-rules":["CDS-TRC-PAC"],"security":[],"parameters":[],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/t/{tenant}/public.json":{"get":{"summary":"public offering information from the published Certification Package Overview","x-fedramp-rules":["CDS-CSO-PUB","CDS-CSO-SVC","CCM-OCR-NRD"],"security":[],"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/t/{tenant}/request-access":{"post":{"summary":"ask for access: sends a six-digit code to the address","x-fedramp-rules":["CDS-UTC-AGA","CDS-TRC-USH"],"security":[],"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/t/{tenant}/request-access/verify":{"post":{"summary":"prove the address; federal domains are provisioned on arrival, others queue","x-fedramp-rules":["CDS-TRC-USH","CDS-TRC-AAI"],"security":[],"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/enroll/code":{"post":{"summary":"redeem an invitation code for an enrollment ticket","security":[],"parameters":[],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/enroll/options":{"post":{"summary":"passkey creation options for a ticket","security":[],"parameters":[],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/enroll/passkey":{"post":{"summary":"register the passkey; returns the recovery code once and starts a session","security":[],"parameters":[],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/auth/options":{"post":{"summary":"passkey sign-in options (discoverable credential)","security":[],"parameters":[],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/auth/verify":{"post":{"summary":"verify the assertion and start a session","security":[],"parameters":[],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/sign-out":{"post":{"summary":"end the session","security":[],"parameters":[],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/recover/start":{"post":{"summary":"send a recovery code to the address","security":[],"parameters":[],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/recover/verify":{"post":{"summary":"emailed code plus saved recovery code → enrollment ticket","security":[],"parameters":[],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/me":{"get":{"summary":"who you are and what you hold","security":[{"session":[]},{"partyKey":[]}],"parameters":[],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/access-log":{"get":{"summary":"your own access events and your party's daily summaries","x-fedramp-rules":["CDS-TRC-ACL"],"security":[{"session":[]},{"partyKey":[]}],"parameters":[],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/t/{tenant}/index.json":{"get":{"summary":"the manifest at your tier, joined with the document inventory","x-fedramp-rules":["CDS-CSO-IRP","CDS-TRC-HMR","CDS-CSO-CBF"],"security":[{"session":[]},{"partyKey":[]}],"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/t/{tenant}/files/{path}":{"get":{"summary":"a file: 302 to a 60-second URL, with its SHA-256; the access is logged","x-fedramp-rules":["CDS-TRC-PAC","CDS-TRC-ACL"],"security":[{"session":[]},{"partyKey":[]}],"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}},{"name":"path","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/t/{tenant}/raw/{path}":{"get":{"summary":"the same file inline (for viewing in the browser); the access is logged","x-fedramp-rules":["CDS-TRC-HMR","CDS-TRC-ACL"],"security":[{"session":[]},{"partyKey":[]}],"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}},{"name":"path","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/t/{tenant}/versions/{path}":{"get":{"summary":"every published version of a path","x-fedramp-rules":["CDS-CSO-HAD"],"security":[{"session":[]},{"partyKey":[]}],"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}},{"name":"path","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/t/{tenant}/snapshots":{"get":{"summary":"snapshots pinned per Ongoing Certification Report","x-fedramp-rules":["CDS-CSO-HAD"],"security":[{"session":[]},{"partyKey":[]}],"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/t/{tenant}/snapshots/{snapshot}/index.json":{"get":{"summary":"a snapshot's index at your tier","x-fedramp-rules":["CDS-CSO-HAD"],"security":[{"session":[]},{"partyKey":[]}],"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}},{"name":"snapshot","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/t/{tenant}/snapshots/{snapshot}/files/{path}":{"get":{"summary":"a file as it was in a snapshot","x-fedramp-rules":["CDS-CSO-HAD"],"security":[{"session":[]},{"partyKey":[]}],"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}},{"name":"snapshot","in":"path","required":true,"schema":{"type":"string"}},{"name":"path","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/t/{tenant}/snapshots/{snapshot}/raw/{path}":{"get":{"summary":"a file as it was in a snapshot, inline","x-fedramp-rules":["CDS-CSO-HAD"],"security":[{"session":[]},{"partyKey":[]}],"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}},{"name":"snapshot","in":"path","required":true,"schema":{"type":"string"}},{"name":"path","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/t/{tenant}/scn":{"get":{"summary":"Significant Change Notifications, twelve months marked","x-fedramp-rules":["SCN-CSO-HIS"],"security":[{"session":[]},{"partyKey":[]}],"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/t/{tenant}/scn/{sha}":{"get":{"summary":"one notification by hash","x-fedramp-rules":["SCN-CSO-HIS"],"security":[{"session":[]},{"partyKey":[]}],"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}},{"name":"sha","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/t/{tenant}/publish":{"post":{"summary":"begin a publish: send the manifest, learn which blobs are needed","security":[{"publishKey":[]}],"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/t/{tenant}/publish/{publishId}/blobs/{sha}":{"put":{"summary":"upload one file; refused unless its bytes hash to the manifest entry","security":[{"publishKey":[]}],"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}},{"name":"publishId","in":"path","required":true,"schema":{"type":"string"}},{"name":"sha","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/t/{tenant}/publish/{publishId}/commit":{"post":{"summary":"make the set current; refused while any file is missing","security":[{"publishKey":[]}],"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}},{"name":"publishId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/t/{tenant}/party":{"get":{"summary":"your party's users and keys","x-fedramp-rules":["CDS-TRC-SSM"],"security":[{"session":[]}],"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/t/{tenant}/party/invite":{"post":{"summary":"invite a colleague at your domain","x-fedramp-rules":["CDS-TRC-SSM"],"security":[{"session":[]}],"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/t/{tenant}/party/keys":{"post":{"summary":"mint an API key for your systems (shown once)","x-fedramp-rules":["CDS-TRC-SSM","CDS-TRC-PAC"],"security":[{"session":[]}],"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}},"/v1/t/{tenant}/party/keys/revoke":{"post":{"summary":"revoke one of your party's keys","x-fedramp-rules":["CDS-TRC-SSM"],"security":[{"session":[]}],"parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"JSON; errors carry {error, message}"}}}}}}