CCPEDIAby Unity Nodes
Documentation/Canton Network Docs/Wallet GatewayUser APIView on Canton Network Docs ↗

generateApiKey

Wallet Gateway›User API›generateApiKey

User API

​
generateApiKey

JSON-RPCAdded 1.5.0
POSTJSON-RPC generateApiKey

​
Protocol Details

ProtocolJSON-RPC
TransportHTTP POST
MethodgenerateApiKey
Parameters1
Resultobject

​
Inputs

​
params

Shapeobject
Requiredname
namestringrequired

​
Outputs

​
result

Shapeobject
SchemaGeneratedApiKey
RequiredapiKey, id, createdAt
idstringrequired
apiKeystringrequired

params

namestringrequired

GeneratedApiKey

idstringrequired
apiKeystringrequired

​
History

Added1.5.0
cURL
cURL
curl \
  <JSON_RPC_URL> \
  -H 'content-type: application/json' \
  --data @- <<'EOF'
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "generateApiKey",
  "params": {
    "params": {
      "name": "<string>"
    }
  }
}
EOF
Resultapplication/json
Result
{
  "id": "<string>",
  "apiKey": "<string>"
}