API Reference

Armory Auth API

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

GET/ping

Response

200default

Body

application/json

pong*boolean

Request

JavaScriptCurlPython

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

Response

200default

{
  "pong": false
}

Submits a new authorization request for evaluation by the policy engine

POST/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

JavaScriptCurlPython

const response = await fetch('/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": 0
        }
      }
    }),
});
const data = await response.json();

Response

201

{
  "approvals": [
    "text"
  ],
  "authentication": "text",
  "clientId": "text",
  "errors": [
    {
      "id": "text",
      "message": "text",
      "name": "text"
    }
  ],
  "evaluations": [
    {
      "id": "text",
      "decision": "text",
      "signature": "text",
      "approvalRequirements": {
        "required": [
          {
            "approvalCount": 0,
            "approvalEntityType": "Narval::User",
            "entityIds": [
              "text"
            ],
            "countPrincipal": false
          }
        ],
        "missing": [
          {
            "approvalCount": 0,
            "approvalEntityType": "Narval::User",
            "entityIds": [
              "text"
            ],
            "countPrincipal": false
          }
        ],
        "satisfied": [
          {
            "approvalCount": 0,
            "approvalEntityType": "Narval::User",
            "entityIds": [
              "text"
            ],
            "countPrincipal": false
          }
        ]
      }
    }
  ],
  "id": "text",
  "idempotencyKey": "text",
  "metadata": {
    "audience": "text",
    "expiresIn": 0
  },
  "request": {
    "action": "signTransaction",
    "nonce": "text",
    "resourceId": "text",
    "transactionRequest": {
      "chainId": 0,
      "nonce": 0,
      "accessList": [
        {
          "storageKeys": []
        }
      ],
      "gas": "text",
      "maxFeePerGas": "text",
      "maxPriorityFeePerGas": "text",
      "type": "2"
    }
  },
  "status": "CREATED"
}

Gets an authorization request by ID

GET/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

JavaScriptCurlPython

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

Response

200404

{
  "approvals": [
    "text"
  ],
  "authentication": "text",
  "clientId": "text",
  "errors": [
    {
      "id": "text",
      "message": "text",
      "name": "text"
    }
  ],
  "evaluations": [
    {
      "id": "text",
      "decision": "text",
      "signature": "text",
      "approvalRequirements": {
        "required": [
          {
            "approvalCount": 0,
            "approvalEntityType": "Narval::User",
            "entityIds": [
              "text"
            ],
            "countPrincipal": false
          }
        ],
        "missing": [
          {
            "approvalCount": 0,
            "approvalEntityType": "Narval::User",
            "entityIds": [
              "text"
            ],
            "countPrincipal": false
          }
        ],
        "satisfied": [
          {
            "approvalCount": 0,
            "approvalEntityType": "Narval::User",
            "entityIds": [
              "text"
            ],
            "countPrincipal": false
          }
        ]
      }
    }
  ],
  "id": "text",
  "idempotencyKey": "text",
  "metadata": {
    "audience": "text",
    "expiresIn": 0
  },
  "request": {
    "action": "signTransaction",
    "nonce": "text",
    "resourceId": "text",
    "transactionRequest": {
      "chainId": 0,
      "nonce": 0,
      "accessList": [
        {
          "storageKeys": []
        }
      ],
      "gas": "text",
      "maxFeePerGas": "text",
      "maxPriorityFeePerGas": "text",
      "type": "2"
    }
  },
  "status": "CREATED"
}

Vault API

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

GET/ping

Response

default

Body

application/json

pong*boolean

Request

JavaScriptCurlPython

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

Response

default

{
  "pong": false
}

Signs the given request

POST/v1/sign

Authorization

GNAP

Header parameters

Body

application/json

request*one of

objectobjectobjectobjectobject

Response

201

Body

application/json

signature*any

Request

JavaScriptCurlPython

const response = await fetch('/v1/sign', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "x-client-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "action": "signTransaction",
        "nonce": "text",
        "resourceId": "text",
        "transactionRequest": {
          "chainId": 0
        }
      }
    }),
});
const data = await response.json();

Response

201

{}