{"note":"OpenAPI conversion -- returning structured metadata","name":"6-dot-authentiqio-appspot-com","description":"Authentiq API","version":"6","base_url":"https://6-dot-authentiqio.appspot.com/","endpoints":14,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Authentiq API\n@base https://6-dot-authentiqio.appspot.com/\n@version 6\n@auth ApiKey secret in query\n@endpoints 14\n@toc key(7), login(1), scope(6)\n\n@group key\n@endpoint POST /key\n@desc Register a new ID `JWT(sub, devtoken)`\n@required {body: any # Authentiq ID to register}\n@returns(201) Successfully registered\n@errors {409: Key already registered `duplicate-key`}\n\n@endpoint DELETE /key\n@desc Revoke an Authentiq ID using email & phone.\n@required {email: any # primary email associated to Key (ID), phone: any # primary phone number, international representation}\n@optional {code: any # verification code sent by email}\n@returns(200) Successfully deleted\n@errors {401: Authentication error `auth-error`, 404: Unknown key `unknown-key`, 409: Confirm with code sent `confirm-first`}\n\n@endpoint GET /key/{PK}\n@desc Get public details of an Authentiq ID.\n@required {PK: any # Public Signing Key - Authentiq ID (43 chars)}\n@returns(200) Successfully retrieved\n@errors {404: Unknown key `unknown-key`, 410: Key is revoked (gone). `revoked-key`}\n\n@endpoint POST /key/{PK}\n@desc update properties of an Authentiq ID.\n@required {PK: any # Public Signing Key - Authentiq ID (43 chars), body: any # Authentiq ID to register}\n@returns(200) Successfully updated\n@errors {404: Unknown key `unknown-key`}\n\n@endpoint HEAD /key/{PK}\n@desc HEAD info on Authentiq ID\n@required {PK: any # Public Signing Key - Authentiq ID (43 chars)}\n@returns(200) Key exists\n@errors {404: Unknown key `unknown-key`, 410: Key is revoked `revoked-key`}\n\n@endpoint PUT /key/{PK}\n@desc Update Authentiq ID by replacing the object.\n@required {PK: any # Public Signing Key - Authentiq ID (43 chars), body: any # Authentiq ID to register}\n@returns(200) Successfully updated\n@errors {404: Unknown key `unknown-key`, 409: Already bound to another key `duplicate-hash`}\n\n@endpoint DELETE /key/{PK}\n@desc Revoke an Identity (Key) with a revocation secret\n@required {PK: any # Public Signing Key - Authentiq ID (43 chars), secret: any # revokation secret}\n@returns(200) Successful response\n@errors {401: Key not found / wrong code `auth-error`, 404: Unknown key `unknown-key`}\n\n@endgroup\n\n@group login\n@endpoint POST /login\n@desc push sign-in request\n@required {body: any # Push Token., callback: any # URI App will connect to}\n@returns(200) Successful response\n@errors {401: Unauthorized for this callback audience `aud-error` or JWT should be self-signed `auth-error`}\n\n@endgroup\n\n@group scope\n@endpoint POST /scope\n@desc scope verification request\n@required {body: any # Claims of scope}\n@optional {test: any # test only mode, using test issuer}\n@returns(201) Successful response\n@errors {429: Too Many Requests on same address / number `rate-limit`}\n\n@endpoint POST /scope/{job}\n@desc this is a scope confirmation\n@required {job: any # Job ID (20 chars)}\n@returns(202) Successfully confirmed\n@errors {401: Confirmation error `auth-error`, 404: Job not found `unknown-job`, 405: JWT POSTed to scope `not-supported`}\n\n@endpoint PUT /scope/{job}\n@desc authority updates a JWT with its signature\n@required {job: any # Job ID (20 chars)}\n@returns(200) Successfully updated\n@errors {404: Job not found `unknown-job`, 409: Job not confirmed yet `confirm-first`}\n\n@endpoint GET /scope/{job}\n@desc get the status / current content of a verification job\n@required {job: any # Job ID (20 chars)}\n@returns(200) Successful response (JWT)\n@returns(204) Confirmed, waiting for signing\n@errors {404: Job not found `unknown-job`}\n\n@endpoint HEAD /scope/{job}\n@desc HEAD to get the status of a verification job\n@required {job: any # Job ID (20 chars)}\n@returns(200) Confirmed and signed\n@returns(204) Confirmed, waiting for signing\n@errors {404: Job not found `unknown-job`}\n\n@endpoint DELETE /scope/{job}\n@desc delete a verification job\n@required {job: any # Job ID (20 chars)}\n@returns(200) Successfully deleted\n@errors {404: Job not found `unknown-job`}\n\n@endgroup\n\n@end\n"}