Connect Widget

Create grant request

post

Creates a new GNAP grant request.

Header parameters

x-client-idstringrequired

detached-jwsstringrequired

Detached JSON Web Signature (JWS) token for request authentication and verification

Body

access_tokenobjectrequired

clientstringrequired

The client ID of the client requesting the access token.

userobjectoptional

interactobjectrequired

providersstring · enum[]optional

The providers enabled for the interaction.

Responses

application/json

post

cURLJavaScriptPythonHTTP

curl -L \
  --request POST \
  --url 'https://auth.armory.narval.xyz/v1/grant' \
  --header 'x-client-id: text' \
  --header 'detached-jws: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "access_token": {
      "label": "text",
      "access": [
        {
          "type": "text",
          "actions": [
            "text"
          ],
          "locations": [
            "text"
          ]
        }
      ]
    },
    "client": "text",
    "user": {
      "id": "text"
    },
    "interact": {
      "start": [
        "text"
      ],
      "finish": {
        "method": "text",
        "uri": "text",
        "nonce": "text"
      }
    },
    "providers": [
      "anchorage"
    ]
  }'

201

400

201

{
  "interact": {
    "redirect": "text",
    "finish": "text",
    "expires_in": 1
  },
  "continue": {
    "access_token": {
      "value": "text"
    },
    "uri": "text"
  }
}

Returns the created grant request details.

Continue grant request

post

Continues an existing GNAP authorization process.

Header parameters

x-client-idstringrequired

authorizationstringrequired

detached-jwsstringrequired

Detached JSON Web Signature (JWS) token for request authentication and verification

Body

interact_refstringrequired

The interact_ref of the grant request

Responses

application/json

post

cURLJavaScriptPythonHTTP

curl -L \
  --request POST \
  --url 'https://auth.armory.narval.xyz/v1/continue' \
  --header 'x-client-id: text' \
  --header 'authorization: text' \
  --header 'detached-jws: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "interact_ref": "text"
  }'

201

400

201

{
  "access_token": {
    "label": "text",
    "value": "text",
    "manage": {
      "uri": "text",
      "access_token": {
        "value": "text"
      }
    },
    "access": [
      {
        "type": "text",
        "actions": [
          "text"
        ],
        "locations": [
          "text"
        ],
        "identifier": "text"
      }
    ],
    "expires_in": 1
  }
}

Returns the continued grant request details.