API docs by Redocly

iDroit Dashboard API(DID/VC管理関連) (0.9.2)

Download OpenAPI specification:

これは[株式会社フォアー](https://www.fore-co.ltd/ja/)が開発するを使ったDecentralizd Identifiers / Verifiable Credentials(DID/VC)に関係する機能を簡単に利用するための REST API です。
本ページではiDroit DashboardにおけるDID/VC管理に関連したAPIのみを公開しています。ユーザー・プロジェクト管理を含めたフルバージョンはお問い合わせください。

現在以下のユースケースをサポートしています。これは今後も拡張されていきます。
- DIDの生成: 
- グループ管理機能
  - (企業/プロジェクトのまとまり)ごとにユーザー、クライアント、証明書(VC)スキーマを紐付けて管理する。

詳細は以下を参照してください。
- [idroit dashboard公式ホームページ]()
- [idroit dashboard操作マニュアル]()

以下は関連リンクです。
- [Universal Resolver](https://dev.uniresolver.io/)
- [W3C DID Core 1.0](https://www.w3.org/TR/did-core/)
- [Verifiable Credentials Data Model v2.0](https://www.w3.org/TR/vc-data-model-2.0/)

auth

アカウントログインを実施

アカウントログインを実行し、認証結果に応じてJSON Web Tokenの値を返します。

Authorizations:
bearer
Request Body schema: application/json
required
email
required
string

(必須) アカウントログインに用いるメールアドレス。

password
required
string

(必須) アカウントログインに用いるパスワード

Responses

Request samples

Content type
application/json
{
  • "email": "admin@email.com",
  • "password": "Password1234"
}

Response samples

Content type
application/json
{
  • "access_token": "jwt.token.hoge"
}

ログイン済みのアカウント情報取得

ログイン済みの管理者アカウントの情報を返却します。

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "userId": "70ceb004-0550-460a-ad40-c31614bb0109",
  • "name": "clinet1",
  • "email": "client1@email.com",
  • "role": "client",
  • "iat": 1737255455,
  • "exp": 1737269855
}

did-infos

DID情報一覧取得

アプリケーションが管理するDID情報を一覧として値を返します。

Authorizations:
bearer
query Parameters
page
number
Example: page=1

(必須) ページネーションを表示する際のページ数に当たるクエリパラメーター。全件取得する際は1を指定。(デフォルト: 1)

limit
number
Example: limit=10

(必須) ページネーションを表示する際のページ数あたりに表示する件数を指定するクエリパラメーター。全件取得する際は0を指定。(デフォルト: 10)

did
string

(任意) 例: "did:key:z6MkhGeGj7u5htkCYjE4PaQ8HUqjYyTmxpDb6Q1MqUpUDsN7"

manageUuid
string

(任意) 例: "32bad62a-4186-4d04-a26a-fcee79d5824b"

label
string

(任意) 例: "did-for-project1"

method
string
Enum: "key" "web" "ethr" "ethr:arbitrum:goerli" "ethr:sepolia"

(任意) 例: "did:key

existPrivateKey
boolean

(任意) 例: true

description
string

(任意)

domainName
string

(任意) 例: "did:web:idroit-dashboard.com"

Responses

Response samples

Content type
application/json
{}

新規DID生成

新規DIDを生成します。

Authorizations:
bearer
Request Body schema: application/json
required
didMethod
required
string

(必須) 新規生成するDIDのメソッド。(現在対応するDIDメソッド: "key", "ether", "ethr:sepolia", "ethr:arbitrum:goerli", "web")

label
string

(任意) DIDの識別や整理などの管理するにあったてメタデータとして任意で設定可能な単語のフレーズ。(例: did-for-project1)

domainName
string

(任意) did:webメソッドでDIDを生成する際に必要なドメイン名。DIDによって指定されたドメインがドメインネームシステム(DNS)を通じて解決されるときのホスト名。did:webメソッド以外では必要のないパラメータなため任意の項目である。

description
string

(任意) DIDの生成目的や用途など任意で設定可能な説明文。

Responses

Request samples

Content type
application/json
{
  • "didMethod": "key",
  • "label": "did-for-project1",
  • "domainName": "domain-name.com",
  • "description": "DIDの生成目的や用途など任意で設定可能な説明文。"
}

既存DID登録

外部で生成されたDIDを本アプリケーションに取り込みます。

Authorizations:
bearer
Request Body schema: application/json
required
did
required
string

(必須)

label
string

(任意) DIDの識別や整理などの管理するにあったてメタデータとして任意で設定可能な単語のフレーズ。(例: did-for-project1)

description
string

(任意) DIDの生成目的や用途など任意で設定可能な説明文。

Responses

Request samples

Content type
application/json
{
  • "did": "did:key:z6MkepWVAjYFGvTdffTcJJcE1sJKLHuCefxqw72dPodoxJrP",
  • "label": "did-for-project1",
  • "description": "This is the description of did"
}

DID情報詳細取得

リクエストパラメータのidで指定された単一のDID情報の詳細情報の値を返します。

Authorizations:
bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "didInfo": {
    },
  • "didObject": {
    }
}

DID情報削除

リクエストパラメータのidで指定された単一のDID情報を削除します。

Authorizations:
bearer
path Parameters
id
required
string

Responses

DID情報へのラベル追加

リクエストパラメータのidで指定された単一のDID情報に対して、任意の管理用ラベルを追加します。

Authorizations:
bearer
path Parameters
id
required
string
Request Body schema: application/json
required
label
required
string

(必須) DIDの識別や整理などの管理するにあったてメタデータとして任意で設定可能な単語のフレーズ。(例: did-for-project1)

Responses

Request samples

Content type
application/json
{
  • "label": "did-for-project1"
}

Response samples

Content type
application/json
{
  • "didInfo": {
    },
  • "didObject": {
    }
}

DID解決

DIDを解決した結果であるDID Documentの値を返します。このAPIでは保存などの処理を行いません。生成済みのDIDを保存したい場合、既存DID登録API(/did-infos/register)にリクエストを送信してください。

Authorizations:
bearer
Request Body schema: application/json
required
did
required
string

(必須) 解決を実施するDID文字列。

Responses

Request samples

Content type
application/json
{
  • "did": "did:key:z6MkepWVAjYFGvTdffTcJJcE1sJKLHuCefxqw72dPodoxJrP"
}

Response samples

Content type
application/json
{
  • "context": [],
  • "id": "did:key:z6MkepWVAjYFGvTdffTcJJcE1sJKLHuCefxqw72dPodoxJrP",
  • "verificationMethod": [
    ],
  • "assertionMethod": [
    ],
  • "authentication": [
    ],
  • "capabilityInvocation": [
    ],
  • "capabilityDelegation": [
    ],
  • "keyAgreement": [
    ]
}

vc-infos

VC情報一覧取得

アプリケーションが管理するVC情報を一覧として値を返します。

Authorizations:
bearer
query Parameters
page
number
Example: page=1

(必須) ページネーションを表示する際のページ数に当たるクエリパラメーター。全件取得する際は1を指定。(デフォルト: 1)

limit
number
Example: limit=10

(必須) ページネーションを表示する際のページ数あたりに表示する件数を指定するクエリパラメーター。全件取得する際は0を指定。(デフォルト: 10)

label
string

(任意) 例: "vc-for-project1"

description
string

(任意)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    },
  • "links": {}
}

新規VC発行

新規VCを発行します。

Authorizations:
bearer
Request Body schema: application/json
required
issuer
required
string

(必須) VCの発行者の識別子として用いる文字列の値。現在はDIDのみがサポートされていますが、今後のアップデートでDID以外の文字列をサポートする予定です。

vcSchemaId
required
string

(必須) 新規発行するVCの元となるVCスキーマの識別子

credentialSubject
required
object

(必須) VCの主張内容(クレーム)となる値のオブジェクト型の値

label
string

(任意) VCの識別や整理などの管理するにあったてメタデータとして任意で設定可能な単語のフレーズ。(例: vc-for-project1)

description
string

(任意) VCの発行目的や用途など任意で設定可能な説明文

Responses

Request samples

Content type
application/json
{
  • "issuer": "did:key:z6MkepWVAjYFGvTdffTcJJcE1sJKLHuCefxqw72dPodoxJrP",
  • "vcSchemaId": "3bfc3721-eb7c-4a5b-b5ac-94d1f158911f",
  • "credentialSubject": {
    },
  • "label": "vc-for-project1",
  • "description": "This is the description of VC"
}

Response samples

Content type
application/json
{
  • "vcInfo": {
    },
  • "vcObject": {
    }
}

新規VC発行(スキーマなし)

VCスキーマを指定せず直接新規VCを発行します。

Authorizations:
bearer
Request Body schema: application/json
required
issuer
required
string

(必須) VCの発行者の識別子として用いる文字列の値。現在はDIDのみがサポートされていますが、今後のアップデートでDID以外の文字列をサポートする予定です。

credentialSubject
required
object

(必須) VCの主張内容(クレーム)となる値のオブジェクト型の値

label
string

(任意) VCの識別や整理などの管理するにあったてメタデータとして任意で設定可能な単語のフレーズ。(例: vc-for-project1)

description
string

(任意) VCの発行目的や用途など任意で設定可能な説明文

Responses

Request samples

Content type
application/json
{
  • "issuer": "did:key:z6MkepWVAjYFGvTdffTcJJcE1sJKLHuCefxqw72dPodoxJrP",
  • "credentialSubject": {
    },
  • "label": "vc-for-project1",
  • "description": "This is the description of VC"
}

Response samples

Content type
application/json
{
  • "vcInfo": {
    },
  • "vcObject": {
    }
}

新規VCアップロード

外部で発行された既存VCをアップロードし、本アプリケーションに保存します。。

Authorizations:
bearer
Request Body schema: multipart/form-data
required
credentialObject
object

(任意) JSON形式のVCオブジェクト。ファイルアップロードではなくテキストを用いて作成する場合のみ必須

label
string

(任意) VCの識別や整理などの管理するにあったてメタデータとして任意で設定可能な単語のフレーズ。(例: vc-for-project1)

description
string

(任意) VCの発行目的や用途など任意で設定可能な説明文。

Responses

Response samples

Content type
application/json
{
  • "vcInfo": {
    },
  • "vcObject": {
    }
}

VC情報詳細取得

リクエストパラメータのidで指定された単一のVC情報の詳細情報の値を返します。

Authorizations:
bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "vcInfo": {
    },
  • "vcObject": {
    }
}

VC情報へのクライアントアカウント紐付け

VC情報の所有者、関係者などの管理者としてクライアントアカウントを紐付けます。

Authorizations:
bearer
path Parameters
id
required
string
Request Body schema: application/json
required
userId
required
string

(必須) VC情報を紐づけるアカウントの識別子

Responses

Request samples

Content type
application/json
{
  • "userId": "3bfc3721-eb7c-4a5b-b5ac-94d1f158911f"
}

新規VP情報生成

リクエストパラメータのidで指定されたVC情報から新規VPを発行します。

Authorizations:
bearer
path Parameters
id
required
string
Request Body schema: application/json
required
didInfoId
required
string

(必須) VPを生成する際にVCに対しての署名に用いるDIDの識別子

Responses

Request samples

Content type
application/json
{
  • "didInfoId": "3bfc3721-eb7c-4a5b-b5ac-94d1f158911f"
}

Response samples

Content type
application/json
{
  • "vcInfo": {
    },
  • "vcObject": {
    }
}

VC情報へのラベル追加

リクエストパラメータのidで指定された単一のVC情報に対して、任意の管理用ラベルを追加します。

Authorizations:
bearer
path Parameters
id
required
string
Request Body schema: application/json
required
label
required
string

(必須) VCの識別や整理などの管理するにあったてメタデータとして任意で設定可能な単語のフレーズ。(例: vc-for-project1)

Responses

Request samples

Content type
application/json
{
  • "label": "vc-for-project1"
}

Response samples

Content type
application/json
{
  • "vcInfo": {
    },
  • "vcObject": {
    }
}

vp-infos

VP情報一覧取得

アプリケーションが管理するVP情報を一覧として値を返します。

Authorizations:
bearer
query Parameters
page
number
Example: page=1

(必須) ページネーションを表示する際のページ数に当たるクエリパラメーター。全件取得する際は1を指定。(デフォルト: 1)

limit
number
Example: limit=10

(必須) ページネーションを表示する際のページ数あたりに表示する件数を指定するクエリパラメーター。全件取得する際は0を指定。(デフォルト: 10)

label
string

(任意) 例: "vc-for-project1"

description
string

(任意)

Responses

Response samples

Content type
application/json
{}

新規VP生成

新規VPを生成します。

Authorizations:
bearer
Request Body schema: application/json
required
vcInfoIds
required
Array of strings

(必須) VPを生成する元となるVC情報の識別子の配列

didInfoId
required
string

(必須) VP生成時の署名に用いるDID情報の識別子

label
string

(任意) VPの識別や整理などの管理するにあったてメタデータとして任意で設定可能な単語のフレーズ。(例: vc-for-project1)

description
string

(任意) VPの生成目的や用途などを任意で設定可能な説明文

Responses

Request samples

Content type
application/json
{
  • "vcInfoIds": [
    ],
  • "didInfoId": "3bfc3721-eb7c-4a5b-b5ac-94d1f158911f",
  • "label": "vp-for-project1",
  • "description": "This is the description of did"
}

新規VPアップロード

外部で発行された既存VPをアップロードし、本アプリケーションに保存します。。

Authorizations:
bearer
Request Body schema: multipart/form-data
required
credentialObject
object

(任意) JSON形式のVPオブジェクト。ファイルアップロードではなくテキストを用いて作成する場合のみ必須

label
string

(任意) VPの識別や整理などの管理するにあったてメタデータとして任意で設定可能な単語のフレーズ。(例: vc-for-project1)

description
string

(任意) VPの発行目的や用途など任意で設定可能な説明文。

Responses

Response samples

Content type
application/json
{}

VP情報詳細取得

リクエストパラメータのidで指定された単一のVP情報の詳細情報の値を返します。

Authorizations:
bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "vpInfo": {
    },
  • "vpObject": { }
}

VP情報へのクライアントアカウント紐付け

VP情報の所有者、関係者などの管理者としてクライアントアカウントを紐付けます。

Authorizations:
bearer
path Parameters
id
required
string
Request Body schema: application/json
required
userId
required
string

(必須) VC情報を紐づけるアカウントの識別子

Responses

Request samples

Content type
application/json
{
  • "userId": "3bfc3721-eb7c-4a5b-b5ac-94d1f158911f"
}

VP情報へのラベル追加

リクエストパラメータのidで指定された単一のVP情報に対して、任意の管理用ラベルを追加します。

Authorizations:
bearer
path Parameters
id
required
string
Request Body schema: application/json
required
label
required
string

(必須) VPの識別や整理などの管理するにあったてメタデータとして任意で設定可能な単語のフレーズ。(例: vp-for-project1)

Responses

Request samples

Content type
application/json
{
  • "label": "v p-for-project1"
}

Response samples

Content type
application/json
{}

VP情報のクライアントアカウント紐付け解除

VP情報に紐付いたクライアントアカウントの紐付けを解除します。

Authorizations:
bearer
path Parameters
id
required
string

Responses

verifications

VC/VP検証結果一覧取得

アプリケーションが管理するVC/VP検証結果を一覧として値を返します。

Authorizations:
bearer
query Parameters
page
number
Example: page=1

(必須) ページネーションを表示する際のページ数に当たるクエリパラメーター。全件取得する際は1を指定。(デフォルト: 1)

limit
number
Example: limit=10

(必須) ページネーションを表示する際のページ数あたりに表示する件数を指定するクエリパラメーター。全件取得する際は0を指定。(デフォルト: 10)

label
string

(任意) 例: "verification-for-project1"

result
boolean

(任意) 例: true

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    },
  • "links": {}
}

VC/VP検証

VC/VPの検証を実行します。

Authorizations:
bearer
Request Body schema: application/json
required
label
string

(必須) 検証結果の識別や整理などの管理するにあったてメタデータとして任意で設定可能な単語のフレーズ。(例: verify-for-check)

vcInfoId
string

(任意) 検証を実行するVC情報の識別子。VC情報の識別子を指定して検証を実行する場合は必須。

vpInfoId
string

(任意) 検証を実行するVP情報の識別子。VP情報の識別子を指定して検証を実行する場合は必須。

vcObject
object

(任意) 検証を実行するVCのJSONテキストデータ。VCのJSONテキストデータを入力して検証を実行する場合は必須。

vpObject
object

(任意) 検証を実行するVPのJSONテキストデータ。VPのJSONテキストデータを入力して検証を実行する場合は必須。

Responses

Request samples

Content type
application/json
{
  • "label": "verify-for-check",
  • "vcInfoId": "3bfc3721-eb7c-4a5b-b5ac-94d1f158911f",
  • "vpInfoId": "3bfc3721-eb7c-4a5b-b5ac-94d1f158911f",
  • "vcObject": {
    },
  • "vpObject": {
    }
}

Response samples

Content type
application/json
{
  • "id": "3bfc3721-eb7c-4a5b-b5ac-94d1f158911f",
  • "label": "This is the description of VP",
  • "result": true,
  • "createdBy": {
    },
  • "vcInfo": {
    },
  • "vpInfo": {
    },
  • "createdAt": "2024-05-24T06:39:54.352Z",
  • "updatedAt": "2024-05-24T06:39:54.352Z"
}

VC/VP検証結果詳細取得

リクエストパラメータのidで指定された単一のVC/VP検証結果の詳細情報の値を返します。

Authorizations:
bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "3bfc3721-eb7c-4a5b-b5ac-94d1f158911f",
  • "label": "This is the description of VP",
  • "result": true,
  • "createdBy": {
    },
  • "vcInfo": {
    },
  • "vpInfo": {
    },
  • "createdAt": "2024-05-24T06:39:54.352Z",
  • "updatedAt": "2024-05-24T06:39:54.352Z"
}

vc-schemas

VCスキーマ一覧取得

VCスキーマを一覧として値を返します。

Authorizations:
bearer
query Parameters
page
number
Example: page=1

(必須) ページネーションを表示する際のページ数に当たるクエリパラメーター。全件取得する際は1を指定。(デフォルト: 1)

limit
number
Example: limit=10

(必須) ページネーションを表示する際のページ数あたりに表示する件数を指定するクエリパラメーター。全件取得する際は0を指定。(デフォルト: 10)

title
string

(任意) 例: "Schema Sample"

version
string

(任意) 例: "1.0.0"

description
string

(任意) 例:

isBadgeSchema
boolean

(任意) 例: true

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    },
  • "links": {}
}

新規VCスキーマ作成

新規VCスキーマを作成します。

Authorizations:
bearer
Request Body schema: application/json
required
title
required
string

(必須) 新規生成するVCスキーマのタイトル

version
required
string

(必須) VCスキーマのバージョン(デフォルト: 1.0.0)

contexts
Array of strings

(任意) VCスキーマに設定する@context文字列の配列

description
string

(任意) VCスキーマの説明文

isBadgeSchema
required
boolean

(任意) このスキーマがバッジのスキーマか否か(デフォルト: false)

fileId
required
string

(任意) バッジの画像のファイル識別子。'isBadgeSchemaプロパティがtrueであり、バッジスキーマとして利用する場合は必須のパラメータ。

required
Array of objects (VcSchemaProperty)

(必須) VCのスキーマの各項目における項目名と項目型のオブジェクトの配列

Responses

Request samples

Content type
application/json
{
  • "title": "VC Schema sample",
  • "version": "1.0.0",
  • "contexts": [],
  • "description": "This is the description of did",
  • "isBadgeSchema": false,
  • "fileId": "3bfc3721-eb7c-4a5b-b5ac-94d1f158911f",
  • "propArray": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "3bfc3721-eb7c-4a5b-b5ac-94d1f158911f",
  • "title": "This is VC Schema sample 1",
  • "version": "1.0.0",
  • "description": "This is VC Schema 1.",
  • "isBadgeSchema": false,
  • "vcInfos": [
    ],
  • "vcContexts": [ ],
  • "vcSchemaProperties": [
    ],
  • "badges": [
    ],
  • "file": {
    },
  • "createdBy": {
    },
  • "createdAt": "2024-05-24T06:39:54.352Z",
  • "updatedAt": "2024-05-24T06:39:54.352Z"
}

VCスキーマ情報詳細取得

リクエストパラメータのidで指定された単一のVCスキーマの詳細情報の値を返します。

Authorizations:
bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "3bfc3721-eb7c-4a5b-b5ac-94d1f158911f",
  • "title": "This is VC Schema sample 1",
  • "version": "1.0.0",
  • "description": "This is VC Schema 1.",
  • "isBadgeSchema": false,
  • "vcInfos": [
    ],
  • "vcContexts": [ ],
  • "vcSchemaProperties": [
    ],
  • "badges": [
    ],
  • "file": {
    },
  • "createdBy": {
    },
  • "createdAt": "2024-05-24T06:39:54.352Z",
  • "updatedAt": "2024-05-24T06:39:54.352Z"
}

VCスキーマへのグループ紐付け

VCスキーマに関連するグループを紐付けます。

Authorizations:
bearer
path Parameters
id
required
string
Request Body schema: application/json
required
groupIds
Array of strings

(必須) VCスキーマを紐づけるグループ識別子の配列。

contexts
Array of strings

(必須) VCスキーマを紐づけるcontext項目の配列。

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "3bfc3721-eb7c-4a5b-b5ac-94d1f158911f",
  • "title": "This is VC Schema sample 1",
  • "version": "1.0.0",
  • "description": "This is VC Schema 1.",
  • "isBadgeSchema": false,
  • "vcInfos": [
    ],
  • "vcContexts": [ ],
  • "vcSchemaProperties": [
    ],
  • "badges": [
    ],
  • "file": {
    },
  • "createdBy": {
    },
  • "createdAt": "2024-05-24T06:39:54.352Z",
  • "updatedAt": "2024-05-24T06:39:54.352Z"
}

badges

バッジ一覧取得

アプリケーションが管理するバッジ情報を一覧として値を返します。

Authorizations:
bearer
query Parameters
page
number
Example: page=1

(必須) ページネーションを表示する際のページ数に当たるクエリパラメーター。全件取得する際は1を指定。(デフォルト: 1)

limit
number
Example: limit=10

(必須) ページネーションを表示する際のページ数あたりに表示する件数を指定するクエリパラメーター。全件取得する際は0を指定。(デフォルト: 10)

label
string

(任意) 例: "sample-badge-1"

filename
string

(任意) 例: "badge-12345-12345.png"

description
string

(任意)

status
number

(任意) 例: 1

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    },
  • "links": {}
}

新規バッジ発行

新規バッジを発行します。

Authorizations:
bearer
Request Body schema: application/json
required
label
string

(任意) バッジのタイトル

description
string

(任意) グループの作成目的や用途など任意で設定可能な説明文

issuer
required
string

(必須) VCの発行者の識別子として用いる文字列の値。現在はDIDのみがサポートされていますが、今後のアップデートでDID以外の文字列をサポートする予定です。

credentialSubject
required
object

(必須) VCの主張内容(クレーム)となる値のオブジェクト型の値

vcSchemaId
required
string

(必須) 新規発行するVCの元となるVCスキーマの識別子

Responses

Request samples

Content type
application/json
{
  • "label": "Sample Badge 1",
  • "description": "This is Group A for Project X.",
  • "issuer": "did:key:z6MkepWVAjYFGvTdffTcJJcE1sJKLHuCefxqw72dPodoxJrP",
  • "credentialSubject": {
    },
  • "vcSchemaId": "3bfc3721-eb7c-4a5b-b5ac-94d1f158911f"
}

Response samples

Content type
application/json
{
  • "id": "3bfc3721-eb7c-4a5b-b5ac-94d1f158911f",
  • "label": "sample-badge-1",
  • "filename": "badge-12345-12345.png",
  • "description": "This is Group A for Project X.",
  • "status": 1,
  • "vcSchema": {
    },
  • "vcInfo": {
    },
  • "createdAt": "2024-05-24T06:39:54.352Z",
  • "updatedAt": "2024-05-24T06:39:54.352Z"
}

バッジ詳細取得

リクエストパラメータのidで指定された単一のバッジ情報の詳細情報の値を返します。

Authorizations:
bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "3bfc3721-eb7c-4a5b-b5ac-94d1f158911f",
  • "label": "sample-badge-1",
  • "filename": "badge-12345-12345.png",
  • "description": "This is Group A for Project X.",
  • "status": 1,
  • "vcSchema": {
    },
  • "vcInfo": {
    },
  • "createdAt": "2024-05-24T06:39:54.352Z",
  • "updatedAt": "2024-05-24T06:39:54.352Z"
}

Badgeへのラベル追加

リクエストパラメータのidで指定された単一のBadgeに対して、任意の管理用ラベルを追加します。

Authorizations:
bearer
path Parameters
id
required
string
Request Body schema: application/json
required
label
required
string

(必須) Badgeの識別や整理などの管理するにあったてメタデータとして任意で設定可能な単語のフレーズ。(例: badge-for-project1)

Responses

Request samples

Content type
application/json
{
  • "label": "badge-for-project1"
}

Response samples

Content type
application/json
{
  • "id": "3bfc3721-eb7c-4a5b-b5ac-94d1f158911f",
  • "label": "sample-badge-1",
  • "filename": "badge-12345-12345.png",
  • "description": "This is Group A for Project X.",
  • "status": 1,
  • "vcSchema": {
    },
  • "vcInfo": {
    },
  • "createdAt": "2024-05-24T06:39:54.352Z",
  • "updatedAt": "2024-05-24T06:39:54.352Z"
}

バッジダウンロード

リクエストパラメータのidで指定された単一のバッジ画像のバイナリデータを返します。

Authorizations:
bearer
path Parameters
id
required
string
query Parameters
vpInfoId
required
string

Responses

バッジ検証

バッジのVC/VPの検証を実行します。

Authorizations:
bearer
path Parameters
id
required
string
Request Body schema: application/json
required
veriifyVC
boolean
Default: true

(任意) バッジに紐づいたVC情報を検証するか否か。trueの場合VC情報をfalseの場合vpInfoIdで指定されたVP情報を検証する

vpInfoId
required
string
Default: false

(任意)

Responses

Request samples

Content type
application/json
{
  • "veriifyVC": true,
  • "vpInfoId": "3bfc3721-eb7c-4a5b-b5ac-94d1f158911f"
}

Response samples

Content type
application/json
{
  • "result": "3bfc3721-eb7c-4a5b-b5ac-94d1f158911f"
}

バッジファイル検証

Authorizations:
bearer
Request Body schema: multipart/form-data
required
file
string <binary>

Responses

Response samples

Content type
application/json
{
  • "result": "3bfc3721-eb7c-4a5b-b5ac-94d1f158911f",
  • "filename": "3bfc3721-eb7c-4a5b-b5ac-94d1f158911f"
}

files

ファイル一覧取得

ファイルを一覧として値を返します。

Authorizations:
bearer
query Parameters
page
number
Example: page=1

(必須) ページネーションを表示する際のページ数に当たるクエリパラメーター。全件取得する際は1を指定。(デフォルト: 1)

limit
number
Example: limit=10

(必須) ページネーションを表示する際のページ数あたりに表示する件数を指定するクエリパラメーター。全件取得する際は0を指定。(デフォルト: 10)

filename
string

(任意) 例: "file-1732019975229-394515535.png"

originalname
string

(任意) 例: "english-badge.png"

executed
boolean

(任意) 例: true

type
string

(任意) 例: "image/png"

status
number

(任意) 例: 0

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    },
  • "links": {}
}

ファイルアップロード

新規ファイルアップロードを作成します。

Authorizations:
bearer
Request Body schema: multipart/form-data
required
file
string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": "3bfc3721-eb7c-4a5b-b5ac-94d1f158911f",
  • "filename": "sample_file",
  • "originalname": "sample_file",
  • "fileData": "text/csv:nfhorif2Efr2",
  • "fileType": "text/csv",
  • "type": "image/png",
  • "executed": false,
  • "status": 0,
  • "createdBy": {
    },
  • "createdAt": "2024-05-24T06:39:54.352Z",
  • "updatedAt": "2024-05-24T06:39:54.352Z"
}

ファイル詳細取得

リクエストパラメータのidで指定された単一のファイルの詳細情報の値を返します。

Authorizations:
bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "3bfc3721-eb7c-4a5b-b5ac-94d1f158911f",
  • "filename": "sample_file",
  • "originalname": "sample_file",
  • "fileData": "text/csv:nfhorif2Efr2",
  • "fileType": "text/csv",
  • "type": "image/png",
  • "executed": false,
  • "status": 0,
  • "createdBy": {
    },
  • "createdAt": "2024-05-24T06:39:54.352Z",
  • "updatedAt": "2024-05-24T06:39:54.352Z"
}

CSVファイル実行

(非推奨) ユーザー、クライアント情報を記載したCSVファイルを実行し、新規アカウントを作成します。

Authorizations:
bearer
path Parameters
id
required
string
Request Body schema: application/json
required
didMethod
required
string

(必須) 新規生成するDIDのメソッド。(現在対応するDIDメソッド: "key", "ether", "ethr:sepolia", "ethr:arbitrum:goerli", "web")

label
string

(任意) DIDの識別や整理などの管理するにあったてメタデータとして任意で設定可能な単語のフレーズ。(例: did-for-project1)

domainName
string

(任意) did:webメソッドでDIDを生成する際に必要なドメイン名。DIDによって指定されたドメインがドメインネームシステム(DNS)を通じて解決されるときのホスト名。did:webメソッド以外では必要のないパラメータなため任意の項目である。

description
string

(任意) DIDの生成目的や用途など任意で設定可能な説明文。

Responses

Request samples

Content type
application/json
{
  • "didMethod": "key",
  • "label": "did-for-project1",
  • "domainName": "domain-name.com",
  • "description": "DIDの生成目的や用途など任意で設定可能な説明文。"
}

ファイル削除

リクエストパラメータのidで指定された単一のファイルを削除します。

Authorizations:
bearer
path Parameters
id
required
string

Responses

ファイルダウンロード

リクエストパラメータのidで指定された単一のファイルのバイナリデータを返します。

Authorizations:
bearer
path Parameters
id
required
string

Responses

mails