openrpc.json

{
  "openrpc": "1.2.4",
  "info": {
    "title": "Authentication with DID",
    "version": "1.0.0"
  },
  "methods": [
    {
      "name": "login",
      "description": "Logs in the user with a DID token",
      "params": [
        {
          "name": "DIDTokenString",
          "schema": {
            "type": "string"
          }
        }
      ],
      "result": {
        "name": "JWTToken",
        "description": "JWT Token for the user to use as a session.",
        "schema": {
          "type": "string",
          "description": "JWT Token"
        }
      }
    },
    {
      "name": "auth_login_with_address",
      "description": "Prompts the user to login by signing a claim with their address",
      "params": [
        {
          "name": "address",
          "description": "address the user claims to own",
          "schema": {
            "pattern": "^0x[a-fA-F\\d]{40}$",
            "title": "address",
            "type": "string"
          }
        }
      ],
      "result": {
        "name": "claim",
        "description": "the claim for the user to sign",
        "schema": {
          "$ref": "#/components/schemas/DIDTokenClaim"
        }
      },
      "examples": [
        {
          "name": "exampleAuthLoginWithAddress",
          "params": [
            {
              "name": "address",
              "value": "0xA4d1e7f6642Df0330890c70372F3516797f11f2C"
            }
          ],
          "result": {
            "name": "result",
            "value": {
              "iat": 1599245366,
              "ext": 1599255366,
              "iss": "did:ethr:0xA4d1e7f6642Df0330890c70372F3516797f11f2C",
              "sub": "did:sig.tools:login",
              "aud": "did:sig.tools:8066696d-7fb1-4a45-91a6-d43890c5c131",
              "nbf": 1599245366,
              "tid": "a1997f88-71ca-4d96-b220-df372b65b07b"
            }
          }
        }
      ]
    },
    {
      "name": "auth_required_method",
      "description": "a route that requires a user to have recieved a JWT token from the login method",
      "params": [
        {
          "name": "JWTToken",
          "schema": {
            "type": "string"
          }
        }
      ],
      "result": {
        "name": "authRequiredMethodResult",
        "description": "Data returned from the authentication required method",
        "schema": {
          "type": "string",
          "description": "random string data returned from auth required method"
        }
      }
    }
  ],
  "components": {
    "schemas": {
      "DIDTokenClaim": {
        "title": "DIDTokenClaim",
        "type": "object",
        "properties": {
          "iat": {
            "title": "IssuedAt",
            "description": "Issued at timestamp",
            "type": "number"
          },
          "ext": {
            "title": "Expiration",
            "description": "Expiration timestamp",
            "type": "number"
          },
          "nbf": {
            "title": "NotValidBefore",
            "description": "Not valid before timestamp",
            "type": "number"
          },
          "iss": {
            "title": "Issuer",
            "description": "Issuer - Decentralized Identifier: https://w3c-ccg.github.io/did-primer/#the-format-of-a-did",
            "type": "string",
            "format": "^did:"
          },
          "sub": {
            "title": "Subject",
            "description": "Subject of the request, could be a nonce or uuid provided by the server.",
            "type": "string",
            "format": "^did:"
          },
          "aud": {
            "title": "Audience",
            "description": "Audience",
            "type": "string",
            "format": "^did:"
          },
          "add": {
            "title": "Additional",
            "description": "Optiona, additional signed data",
            "type": "string"
          },
          "tid": {
            "title": "TokenID",
            "description": "DID TokenID",
            "type": "string"
          }
        }
      }
    }
  }
}