API Reference

Armory Auth API

These endpoints are on the Armory Auth server. See How the Armory Stack works for more context

GEThttp://localhost:3005/ping

Response

200default

Body

application/json

pong*boolean

Request

JavaScriptCurlPythonHTTP

const response = await fetch('http://localhost:3005/ping', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200default

{
  "pong": true
}

Submits a new authorization request for evaluation by the policy engine

POSThttp://localhost:3005/authorization-requests

Authorization

Client-ID

Header parameters

Body

application/json

authentication*string

request*one of

objectobjectobjectobjectobjectobject

metadataobject

approvalsarray of string

Response

201

The authorization request has been successfully submitted for evaluation

Body

application/json

approvalsarray of string

authentication*string

clientId*string

createdAt*any

errorsarray of object

evaluations*array of object

id*string

idempotencyKeynullable string

metadataobject

request*one of

objectobjectobjectobjectobjectobject

status*enum

CREATEDCANCELEDFAILEDPROCESSINGAPPROVINGPERMITTEDFORBIDDEN

updatedAt*any

Request

JavaScriptCurlPythonHTTP

const response = await fetch('http://localhost:3005/authorization-requests', {
    method: 'POST',
    headers: {
      "x-client-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "authentication": "text",
      "request": {
        "action": "signTransaction",
        "nonce": "text",
        "resourceId": "text",
        "transactionRequest": {
          "chainId": 1,
          "from": null,
          "accessList": [
            {
              "address": null,
              "storageKeys": []
            }
          ],
          "type": "2"
        }
      },
      "metadata": {
        "confirmation": {
          "key": {
            "jwk": {
              "kty": "EC",
              "alg": "ES256K",
              "use": "sig",
              "kid": "text",
              "crv": "secp256k1",
              "x": "text",
              "y": "text"
            },
            "proof": "jws"
          }
        }
      },
      "approvals": [
        null
      ]
    }),
});
const data = await response.json();

Response

201

{
  "approvals": [
    "text"
  ],
  "authentication": "text",
  "clientId": "text",
  "createdAt": null,
  "errors": [
    {
      "context": null,
      "id": "text",
      "message": "text",
      "name": "text"
    }
  ],
  "evaluations": [
    {
      "id": "text",
      "decision": "text",
      "signature": "text",
      "transactionRequestIntent": null,
      "approvalRequirements": {
        "required": [
          {
            "approvalCount": 1,
            "approvalEntityType": "Narval::User",
            "entityIds": [
              "text"
            ],
            "countPrincipal": true
          }
        ],
        "missing": [
          {
            "approvalCount": 1,
            "approvalEntityType": "Narval::User",
            "entityIds": [
              "text"
            ],
            "countPrincipal": true
          }
        ],
        "satisfied": [
          {
            "approvalCount": 1,
            "approvalEntityType": "Narval::User",
            "entityIds": [
              "text"
            ],
            "countPrincipal": true
          }
        ]
      },
      "createdAt": null
    }
  ],
  "id": "text",
  "idempotencyKey": "text",
  "metadata": {
    "audience": "text",
    "expiresIn": 1,
    "confirmation": {
      "key": {
        "jwk": {
          "kty": "EC",
          "alg": "ES256K",
          "use": "sig",
          "kid": "text",
          "addr": "text",
          "crv": "secp256k1",
          "x": "text",
          "y": "text"
        },
        "proof": "jws",
        "jws": "text"
      }
    }
  },
  "request": {
    "action": "signTransaction",
    "nonce": "text",
    "resourceId": "text",
    "transactionRequest": {
      "chainId": 1,
      "from": null,
      "nonce": 1,
      "accessList": [
        {
          "address": null,
          "storageKeys": []
        }
      ],
      "data": null,
      "gas": "text",
      "maxFeePerGas": "text",
      "maxPriorityFeePerGas": "text",
      "to": null,
      "type": "2",
      "value": null
    }
  },
  "status": "CREATED",
  "updatedAt": null
}

Gets an authorization request by ID

GEThttp://localhost:3005/authorization-requests/{id}

Authorization

Client-ID

Path parameters

id*string

Header parameters

Response

200404

The authorization request

Body

application/json

approvalsarray of string

authentication*string

clientId*string

createdAt*any

errorsarray of object

evaluations*array of object

id*string

idempotencyKeynullable string

metadataobject

request*one of

objectobjectobjectobjectobjectobject

status*enum

CREATEDCANCELEDFAILEDPROCESSINGAPPROVINGPERMITTEDFORBIDDEN

updatedAt*any

Request

JavaScriptCurlPythonHTTP

const response = await fetch('http://localhost:3005/authorization-requests/{id}', {
    method: 'GET',
    headers: {
      "x-client-id": "text"
    },
});
const data = await response.json();

Response

200404

{
  "approvals": [
    "text"
  ],
  "authentication": "text",
  "clientId": "text",
  "createdAt": null,
  "errors": [
    {
      "context": null,
      "id": "text",
      "message": "text",
      "name": "text"
    }
  ],
  "evaluations": [
    {
      "id": "text",
      "decision": "text",
      "signature": "text",
      "transactionRequestIntent": null,
      "approvalRequirements": {
        "required": [
          {
            "approvalCount": 1,
            "approvalEntityType": "Narval::User",
            "entityIds": [
              "text"
            ],
            "countPrincipal": true
          }
        ],
        "missing": [
          {
            "approvalCount": 1,
            "approvalEntityType": "Narval::User",
            "entityIds": [
              "text"
            ],
            "countPrincipal": true
          }
        ],
        "satisfied": [
          {
            "approvalCount": 1,
            "approvalEntityType": "Narval::User",
            "entityIds": [
              "text"
            ],
            "countPrincipal": true
          }
        ]
      },
      "createdAt": null
    }
  ],
  "id": "text",
  "idempotencyKey": "text",
  "metadata": {
    "audience": "text",
    "expiresIn": 1,
    "confirmation": {
      "key": {
        "jwk": {
          "kty": "EC",
          "alg": "ES256K",
          "use": "sig",
          "kid": "text",
          "addr": "text",
          "crv": "secp256k1",
          "x": "text",
          "y": "text"
        },
        "proof": "jws",
        "jws": "text"
      }
    }
  },
  "request": {
    "action": "signTransaction",
    "nonce": "text",
    "resourceId": "text",
    "transactionRequest": {
      "chainId": 1,
      "from": null,
      "nonce": 1,
      "accessList": [
        {
          "address": null,
          "storageKeys": []
        }
      ],
      "data": null,
      "gas": "text",
      "maxFeePerGas": "text",
      "maxPriorityFeePerGas": "text",
      "to": null,
      "type": "2",
      "value": null
    }
  },
  "status": "CREATED",
  "updatedAt": null
}

Vault API

These endpoints are on the Vault server. See How the Armory Stack works for more context

GEThttps://vault.armory.narval.xyz/ping

Response

default

Body

application/json

pong*boolean

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://vault.armory.narval.xyz/ping', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

default

{
  "pong": true
}

Signs the given request

POSThttps://vault.armory.narval.xyz/v1/sign

Authorization

GNAP

Header parameters

Body

application/json

request*one of

objectobjectobjectobjectobject

Response

201

Body

application/json

signature*any

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://vault.armory.narval.xyz/v1/sign', {
    method: 'POST',
    headers: {
      "Authorization": "GNAP <token>",
      "x-client-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "action": "signTransaction",
        "nonce": "text",
        "resourceId": "text",
        "transactionRequest": {
          "chainId": 1,
          "from": null,
          "accessList": [
            {
              "address": null,
              "storageKeys": []
            }
          ],
          "type": "2"
        }
      }
    }),
});
const data = await response.json();

Response

201

{
  "signature": null
}