API Reference

Armory Auth API

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

Vault API

PreviousREST API

Last updated 6 months ago

Signs the given request

post

/v1/sign

Authorizations

Header parameters

x-client-idstringrequired

Authorizationstring

Body

requestone ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://vault.armory.narval.xyz/v1/sign' \
  --header 'Authorization: GNAP YOUR_SECRET_TOKEN' \
  --header 'x-client-id: text' \
  --header 'Content-Type: application/json' \
  --data '{"request":{"nonce":"text","resourceId":"text","action":"signTransaction","transactionRequest":{"from":null,"chainId":1,"type":"2","accessList":[{"address":null,"storageKeys":[]}]}}}'

201

{
  "signature": null
}

Submits a new authorization request for evaluation by the policy engine

post

/authorization-requests

Authorizations

Header parameters

x-client-idstringrequired

Body

authenticationstringrequired

approvalsstring[]

requestone ofrequired

metadataobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:3005/authorization-requests' \
  --header 'x-client-id: text' \
  --header 'Content-Type: application/json' \
  --data '{"authentication":"text","approvals":[null],"request":{"nonce":"text","resourceId":"text","action":"signTransaction","transactionRequest":{"from":null,"chainId":1,"type":"2","accessList":[{"address":null,"storageKeys":[]}]}},"metadata":{"confirmation":{"key":{"proof":"jws","jwk":{"kid":"text","x":"text","y":"text","kty":"EC","alg":"ES256K","use":"sig","crv":"secp256k1"}}}}}'

201

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

The authorization request has been successfully submitted for evaluation

Gets an authorization request by ID

get

/authorization-requests/{id}

Authorizations

Path parameters

idstringrequired

Header parameters

x-client-idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:3005/authorization-requests/{id}' \
  --header 'x-client-id: text'

200

404

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

The authorization request