add key to Digital Twin

PATCH 
/api/gemini/v1/digital-twin/key/add/:did

add key to the DID Document, supports only single key manipulation, so multiple updates increase the time

Request

Path Parameters

did stringrequired

the digital identifier

application/json

Body

required

keys

object[]

required

Array [

kid stringrequired

identifier of the Key, acts like an alias for the key

kms stringrequired

the key management system of the key

type string

Key algorithm

publicKeyHex stringrequired

public part of the key as a string in hex format

privateKeyHex stringdeprecated

the private part of the key, based on the security reasons will not be returned

meta

object

algorithms string[]

a lis tof supported key algorithm

]

Responses

200

application/json

Schema

Schema

@context

object

required

anyOf

MOD1

string

MOD2

Array [

string

]

id stringrequired
alsoKnownAs string[]

controller

object

anyOf

MOD1

string

MOD2

Array [

string

]

verificationMethod

object[]

Array [

id stringrequired

type stringrequired

controller stringrequired

publicKeyBase58 string

publicKeyBase64 string

publicKeyJwk

object

alg string

crv string

e string

ext boolean

key_ops string[]

kid string

kty stringrequired

n string

use string

x string

y string

publicKeyHex string

publicKeyMultibase string

blockchainAccountId string

ethereumAddress string

]

service

object[]

Array [

id stringrequired

the identifier of the service. Required for deletion operation

type stringrequired

Default value: LinkedDomain

categorization of the provided service url, if not maintained, LinkedDomain will be used.
Only chars a-z or A-Z are allowed

serviceEndpoint stringrequired

the endpoint url providing additional services / information for the digital twin

description string

Endpoint is providing additional material information like Certificates and hazardous information

]

publicKey

object[]

Array [

id stringrequired

type stringrequired

controller stringrequired

publicKeyBase58 string

publicKeyBase64 string

publicKeyJwk

object

alg string

crv string

e string

ext boolean

key_ops string[]

kid string

kty stringrequired

n string

use string

x string

y string

publicKeyHex string

publicKeyMultibase string

blockchainAccountId string

ethereumAddress string

]

authentication

object[]

Array [

anyOf

MOD1

Array [

id stringrequired

type stringrequired

controller stringrequired

publicKeyBase58 string

publicKeyBase64 string

publicKeyJwk

object

alg string

crv string

e string

ext boolean

key_ops string[]

kid string

kty stringrequired

n string

use string

x string

y string

publicKeyHex string

publicKeyMultibase string

blockchainAccountId string

ethereumAddress string

]

MOD2

Array [

string

]

]

assertionMethod

object[]

Array [

anyOf

MOD1

Array [

id stringrequired

type stringrequired

controller stringrequired

publicKeyBase58 string

publicKeyBase64 string

publicKeyJwk

object

alg string

crv string

e string

ext boolean

key_ops string[]

kid string

kty stringrequired

n string

use string

x string

y string

publicKeyHex string

publicKeyMultibase string

blockchainAccountId string

ethereumAddress string

]

MOD2

Array [

string

]

]

keyAgreement

object[]

Array [

anyOf

MOD1

Array [

id stringrequired

type stringrequired

controller stringrequired

publicKeyBase58 string

publicKeyBase64 string

publicKeyJwk

object

alg string

crv string

e string

ext boolean

key_ops string[]

kid string

kty stringrequired

n string

use string

x string

y string

publicKeyHex string

publicKeyMultibase string

blockchainAccountId string

ethereumAddress string

]

MOD2

Array [

string

]

]

capabilityInvocation

object[]

Array [

anyOf

MOD1

Array [

id stringrequired

type stringrequired

controller stringrequired

publicKeyBase58 string

publicKeyBase64 string

publicKeyJwk

object

alg string

crv string

e string

ext boolean

key_ops string[]

kid string

kty stringrequired

n string

use string

x string

y string

publicKeyHex string

publicKeyMultibase string

blockchainAccountId string

ethereumAddress string

]

MOD2

Array [

string

]

]

capabilityDelegation

object[]

Array [

anyOf

MOD1

Array [

id stringrequired

type stringrequired

controller stringrequired

publicKeyBase58 string

publicKeyBase64 string

publicKeyJwk

object

alg string

crv string

e string

ext boolean

key_ops string[]

kid string

kty stringrequired

n string

use string

x string

y string

publicKeyHex string

publicKeyMultibase string

blockchainAccountId string

ethereumAddress string

]

MOD2

Array [

string

]

]

Example (from schema)

{
  "@context": "string",
  "id": "string",
  "alsoKnownAs": [
    "string"
  ],
  "controller": "string",
  "verificationMethod": [
    {
      "id": "string",
      "type": "string",
      "controller": "string",
      "publicKeyBase58": "string",
      "publicKeyBase64": "string",
      "publicKeyJwk": {
        "alg": "string",
        "crv": "string",
        "e": "string",
        "ext": true,
        "key_ops": [
          "string"
        ],
        "kid": "string",
        "kty": "string",
        "n": "string",
        "use": "string",
        "x": "string",
        "y": "string"
      },
      "publicKeyHex": "string",
      "publicKeyMultibase": "string",
      "blockchainAccountId": "string",
      "ethereumAddress": "string"
    }
  ],
  "service": [
    {
      "id": "did:example:123456789#service-1",
      "type": "LinkedDomain",
      "serviceEndpoint": "https://foo.bar",
      "description": "The purpose and/or additional information to the service endpoint"
    }
  ],
  "publicKey": [
    {
      "id": "string",
      "type": "string",
      "controller": "string",
      "publicKeyBase58": "string",
      "publicKeyBase64": "string",
      "publicKeyJwk": {
        "alg": "string",
        "crv": "string",
        "e": "string",
        "ext": true,
        "key_ops": [
          "string"
        ],
        "kid": "string",
        "kty": "string",
        "n": "string",
        "use": "string",
        "x": "string",
        "y": "string"
      },
      "publicKeyHex": "string",
      "publicKeyMultibase": "string",
      "blockchainAccountId": "string",
      "ethereumAddress": "string"
    }
  ],
  "authentication": [
    [
      null
    ],
    [
      null
    ]
  ],
  "assertionMethod": [
    [
      null
    ],
    [
      null
    ]
  ],
  "keyAgreement": [
    [
      null
    ],
    [
      null
    ]
  ],
  "capabilityInvocation": [
    [
      null
    ],
    [
      null
    ]
  ],
  "capabilityDelegation": [
    [
      null
    ],
    [
      null
    ]
  ]
}

Loading...