Badgr (独立発行者)
世界中の多くの組織は、スキル ベースのデジタル資格情報、スタック可能な学習経路、移植可能な学習者レコードを備えたコミュニティをサポートするブランド学習エコシステムを作成するため、Badgr を使用しています。
このコネクタは、次の製品および地域で利用可能です:
Service | クラス | 地域 |
---|---|---|
Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
お問い合わせ先 | |
---|---|
件名 | Troy Taylor |
[URL] | https://www.hitachisolutions.com |
メール | ttaylor@hitachisolutions.com |
Connector Metadata | |
---|---|
発行者 | Troy Taylor、Hitachi Solutions |
Web サイト | https://badgr.com |
プライバシー ポリシー | https://info.badgr.com/privacy-policy.html |
カテゴリ | 人事 |
調整制限
名前 | 呼び出し | 更新期間 |
---|---|---|
接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
Access |
ユーザーの AccessToken を取り消します。 |
Access |
AccessToken を取得します。 |
Badge |
単一の BadgeClass のアサーションの一覧を取得します。 |
Badge |
新しい BadgeClass を作成します。 |
Badge |
BadgeClass を削除します。 対応する発行者の所有者またはエディター (スタッフでない) に制限されています。 |
Badge |
単一の BadgeClass を取得します。 |
Badge |
既存の BadgeClass を更新する。 以前に発行された BadgeInstance は更新されません。 |
Badge |
BadgeUser アカウントを更新します。 認証されたユーザーのプロファイルを更新するには、entityId 'セルフ' を使用してください |
Badge |
BadgeUser アカウントとプロファイルを作成します。 |
Badge |
単一の BadgeUser プロファイルを取得します。 認証されたユーザーのプロファイルを取得するには、entityId 'セルフ' を使用してください。 |
アカウントを復元する |
新しいパスワードを設定してアカウントを復元します。 |
アカウント復元電子メールを要求する |
ユーザーのアカウント復元電子メールを要求します。 |
アサーションをバックパックにアップロードする |
ユーザーのバックパックに新しいアサーションをアップロードします。 |
アサーションを取り消す |
アサーションを取り消します。 |
アサーションを取得する |
単一の発行者のためのアサーションの一覧を取得します。 |
アサーションを更新する |
アサーションを更新します。 |
アサーションを発行する |
受信者に新しいアサーションを発行します。 |
アサーションを発行する |
単一の受信者にアサーションを発行します。 |
コレクションの作成 |
コレクションを作成する。 |
コレクションを削除する |
バックパックからコレクションを削除します。 |
コレクションを取得する |
単一のコレクションを取得します。 |
コレクションを取得する |
コレクションの一覧を取得します。 |
コレクションを更新する |
バックパックのコレクションを更新します。 |
バックパック アサーションの詳細を取得する |
ユーザーのバックパックからアサーションの詳細を取得します。 |
バックパックからアサーションを削除する |
ユーザーのバックパックからアサーションを削除します。 |
バックパックでアサーション承認を更新する |
ユーザーのバックパックでアサーションの承認を更新します。 |
バックパックにアサーションをインポートする |
ユーザーのバックパックに新しいアサーションをインポートします。 |
ユーザーの Badge |
認証済みユーザーの BadgeClass の一覧を取得します。 |
ユーザーのアクセス トークンを取得する |
認証済みユーザーのアクセス トークンの一覧を取得します。 |
ユーザーのバックパックからアサーションを取得する |
認証済みユーザーのバックパックからアサーションの一覧を取得します。 |
単一のアサーションを取得する |
アサーションを取得します |
発行者 Badge |
発行者 BadgeClass を作成します。 認証されたユーザーは、発行者の所有者、エディター、またはスタッフのステータスを持っている必要があります。 |
発行者の Badge |
単一の発行者の BadgeClass の一覧を取得します。 認証されたユーザーは、発行者の所有者、エディター、またはスタッフのステータスを持っている必要があります。 |
発行者を作成する |
新しい発行者を作成します。 |
発行者を削除する |
単一の発行者を削除します。 |
発行者を取得する |
単一の発行者を取得します。 |
発行者を取得する |
認証済みユーザーの発行者の一覧を取得します。 |
発行者を更新する |
単一の発行者を更新します。 |
発行者トークンを取得する |
発行者トークンを取得します。 |
複数の Badge |
複数の受信者に同じ BadgeClass のコピーを複数発行します。 |
複数のアサーションを取り消す |
複数の受信者の複数のアサーションを取り消します。 |
AccessToken を取り消す
ユーザーの AccessToken を取り消します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの識別子 |
AccessToken を取得する
AccessToken を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの識別子 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | AccessToken |
BadgeClass のアサーションを取得する
単一の BadgeClass のアサーションの一覧を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの識別子 |
受信者
|
recipient | string |
フィルター処理する受信者の識別子 |
|
数
|
num | string |
結果のページ割りを要求します |
|
期限切れを含める
|
include_expired | boolean |
期限切れのアサーションを含めます |
|
失効を含める
|
include_revoked | boolean |
失効したアサーションを含めます |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object | |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
オープン バッジ ID
|
result.openBadgeId | string |
オープン バッジの識別子。 |
作成日
|
result.createdAt | string |
作成された日時。 |
作成者
|
result.createdBy | string |
だれが作成したか。 |
BadgeClass
|
result.badgeclass | string |
獲得できるバッジの定義。 |
BadgeClass オープン バッジ ID
|
result.badgeclassOpenBadgeId | string |
BadgeClass のオープンバッジの識別子。 |
発行者
|
result.issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 |
発行者オープン バッジ ID
|
result.issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
画像
|
result.image | string |
画像。 |
ID
|
result.recipient.identity | string |
ID。 |
ハッシュ済み
|
result.recipient.hashed | boolean |
ハッシュ済みかどうか。 |
種類
|
result.recipient.type | string |
種類。 |
プレーンテキスト ID
|
result.recipient.plaintextIdentity | string |
プレーンテキストの ID。 |
ソルト
|
result.recipient.salt | string |
ハッシュ化されているなら、そのソルト。 |
発行日
|
result.issuedOn | string |
発行された日付。 |
物語
|
result.narrative | string |
発行されたバッジの物語。 |
エビデンス
|
result.evidence | array of object | |
URL
|
result.evidence.url | string |
URL アドレス。 |
物語
|
result.evidence.narrative | string |
発行されたバッジの物語。 |
失効
|
result.revoked | boolean |
失効しているかどうか。 |
失効理由
|
result.revocationReason | string |
失効した理由。 |
承認
|
result.acceptance | string |
バッジが承認されたかどうか。 |
有効期限
|
result.expires | string |
バッジの有効期限。 |
拡張
|
result.extensions | string |
拡張機能。 |
BadgeClass 名
|
result.badgeclassName | string |
BadgeClass の名前。 |
BadgeClass を作成する
新しい BadgeClass を作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
数
|
num | integer |
結果のページ割りを要求します |
|
発行者
|
issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 。 |
|
発行者オープン バッジ ID
|
issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
|
名前
|
name | string |
名前。 |
|
画像
|
image | string |
画像。 |
|
説明
|
description | string |
説明。 |
|
実績の種類
|
achievementType | string |
実績の種類。 |
|
基準 URL
|
criteriaUrl | string |
基準の URL。 |
|
基準説明
|
criteriaNarrative | string |
基準の説明。 |
|
ターゲット名
|
targetName | string |
ターゲットの名前。 |
|
ターゲット URL
|
targetUrl | string |
ターゲットのURL。 |
|
ターゲット説明
|
targetDescription | string |
ターゲットの説明。 |
|
ターゲット フレームワーク
|
targetFramework | string |
ターゲットのフレームワーク。 |
|
ターゲット コード
|
targetCode | string |
ターゲットのコード。 |
|
タグ
|
tags | array of string | ||
量
|
amount | string |
量。 |
|
期間
|
duration | string |
期間。 |
|
拡張
|
extensions | string |
拡張機能。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object | |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
オープン バッジ ID
|
result.openBadgeId | string |
オープン バッジの識別子。 |
作成日
|
result.createdAt | string |
作成された日時。 |
作成者
|
result.createdBy | string |
だれが作成したか。 |
発行者
|
result.issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 |
発行者オープン バッジ ID
|
result.issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
名前
|
result.name | string |
名前。 |
画像
|
result.image | string |
画像。 |
説明
|
result.description | string |
説明。 |
実績の種類
|
result.achievementType | string |
実績の種類。 |
基準 URL
|
result.criteriaUrl | string |
基準の URL アドレス。 |
基準説明
|
result.criteriaNarrative | string |
基準の説明。 |
配列
|
result.alignments | array of object | |
ターゲット名
|
result.alignments.targetName | string |
ターゲットの名前。 |
ターゲット URL
|
result.alignments.targetUrl | string |
ターゲットの URL アドレス。 |
ターゲット説明
|
result.alignments.targetDescription | string |
ターゲットの説明。 |
ターゲット フレームワーク
|
result.alignments.targetFramework | string |
ターゲットのフレームワーク。 |
ターゲット コード
|
result.alignments.targetCode | string |
ターゲットのコード。 |
タグ
|
result.tags | array of string | |
量
|
result.expires.amount | string |
量。 |
期間
|
result.expires.duration | string |
期間。 |
拡張
|
result.extensions | string |
拡張機能。 |
BadgeClass を削除する
BadgeClass を削除します。 対応する発行者の所有者またはエディター (スタッフでない) に制限されています。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの識別子 |
BadgeClass を取得する
単一の BadgeClass を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの識別子 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object |
結果の配列。 |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
オープン バッジ ID
|
result.openBadgeId | string |
オープン バッジの識別子。 |
作成日
|
result.createdAt | string |
作成された日時。 |
作成者
|
result.createdBy | string |
だれが作成したか。 |
発行者
|
result.issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 |
発行者オープン バッジ ID
|
result.issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
名前
|
result.name | string |
名前。 |
画像
|
result.image | string |
画像。 |
説明
|
result.description | string |
説明。 |
実績の種類
|
result.achievementType | string |
実績の種類。 |
基準 URL
|
result.criteriaUrl | string |
基準の URL アドレス。 |
基準説明
|
result.criteriaNarrative | string |
基準の説明。 |
配列
|
result.alignments | array of object | |
ターゲット名
|
result.alignments.targetName | string |
ターゲットの名前。 |
ターゲット URL
|
result.alignments.targetUrl | string |
ターゲットの URL アドレス。 |
ターゲット説明
|
result.alignments.targetDescription | string |
ターゲットの説明。 |
ターゲット フレームワーク
|
result.alignments.targetFramework | string |
ターゲットのフレームワーク。 |
ターゲット コード
|
result.alignments.targetCode | string |
ターゲットのコード。 |
タグ
|
result.tags | array of string | |
量
|
result.expires.amount | string |
量。 |
期間
|
result.expires.duration | string |
期間。 |
拡張
|
result.extensions | string |
拡張機能。 |
BadgeClass を更新する
既存の BadgeClass を更新する。 以前に発行された BadgeInstance は更新されません。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの ID。 |
発行者
|
issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 。 |
|
発行者オープン バッジ ID
|
issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
|
名前
|
name | string |
名前。 |
|
画像
|
image | string |
画像。 |
|
説明
|
description | string |
説明。 |
|
実績の種類
|
achievementType | string |
実績の種類。 |
|
基準 URL
|
criteriaUrl | string |
基準の URL。 |
|
基準説明
|
criteriaNarrative | string |
基準の説明。 |
|
ターゲット名
|
targetName | string |
ターゲットの名前。 |
|
ターゲット URL
|
targetUrl | string |
ターゲットのURL。 |
|
ターゲット説明
|
targetDescription | string |
ターゲットの説明。 |
|
ターゲット フレームワーク
|
targetFramework | string |
ターゲットのフレームワーク。 |
|
ターゲット コード
|
targetCode | string |
ターゲットのコード。 |
|
タグ
|
tags | array of string | ||
量
|
amount | string |
量。 |
|
期間
|
duration | string |
期間。 |
|
拡張
|
extensions | string |
拡張機能。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object |
結果の配列。 |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
オープン バッジ ID
|
result.openBadgeId | string |
オープン バッジの識別子。 |
作成日
|
result.createdAt | string |
作成された日時。 |
作成者
|
result.createdBy | string |
だれが作成したか。 |
発行者
|
result.issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 |
発行者オープン バッジ ID
|
result.issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
名前
|
result.name | string |
名前。 |
画像
|
result.image | string |
画像。 |
説明
|
result.description | string |
説明。 |
実績の種類
|
result.achievementType | string |
実績の種類。 |
基準 URL
|
result.criteriaUrl | string |
基準の URL アドレス。 |
基準説明
|
result.criteriaNarrative | string |
基準の説明。 |
配列
|
result.alignments | array of object | |
ターゲット名
|
result.alignments.targetName | string |
ターゲットの名前。 |
ターゲット URL
|
result.alignments.targetUrl | string |
ターゲットの URL アドレス。 |
ターゲット説明
|
result.alignments.targetDescription | string |
ターゲットの説明。 |
ターゲット フレームワーク
|
result.alignments.targetFramework | string |
ターゲットのフレームワーク。 |
ターゲット コード
|
result.alignments.targetCode | string |
ターゲットのコード。 |
タグ
|
result.tags | array of string | |
量
|
result.expires.amount | string |
量。 |
期間
|
result.expires.duration | string |
期間。 |
拡張
|
result.extensions | string |
拡張機能。 |
BadgeUser を更新する
BadgeUser アカウントを更新します。 認証されたユーザーのプロファイルを更新するには、entityId 'セルフ' を使用してください
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの ID。 |
エンティティの種類
|
entityType | string |
エンティティの種類。 |
|
エンティティ ID
|
entityId | string |
エンティティの ID。 |
|
名
|
firstName | string |
名。 |
|
姓
|
lastName | string |
姓。 |
|
エンティティの種類
|
entityType | string |
エンティティの種類。 |
|
エンティティ ID
|
entityId | string |
エンティティの ID。 |
|
電子メール
|
string |
電子メール アドレス。 |
||
検証済み
|
verified | boolean |
検証済みかどうか。 |
|
主要
|
primary | boolean |
主要かどうか。 |
|
ケース バリアント
|
caseVariants | string |
ケース バリアント。 |
|
URL
|
url | string |
URL アドレス。 |
|
電話
|
telephone | string |
電話番号。 |
|
同意条件バージョン
|
agreedTermsVersion | string |
同意した条件のバージョン。 |
|
最新の条件バージョンに同意
|
hasAgreedToLatestTermsVersion | string |
条件の最新バージョンに同意済み。 |
|
マーケティング オプトイン
|
marketingOptIn | string |
マーケティングにオプトイン済み。 |
|
Badgr ドメイン
|
badgrDomain | string |
Badgr のドメイン。 |
|
パスワード設定済み
|
hasPasswordSet | string |
パスワード設定済み。 |
|
受信者
|
recipient | string |
受信者。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object |
結果の配列。 |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
名
|
result.firstName | string |
名。 |
姓
|
result.lastName | string |
姓。 |
電子メール
|
result.emails | array of object | |
エンティティの種類
|
result.emails.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.emails.entityId | string |
エンティティの ID。 |
電子メール
|
result.emails.email | string |
電子メール アドレス。 |
検証済み
|
result.emails.verified | boolean |
検証済みかどうか。 |
主要
|
result.emails.primary | boolean |
主要かどうか。 |
ケース バリアント
|
result.emails.caseVariants | string |
ケース バリアント。 |
URL
|
result.url | string |
URL アドレス。 |
電話
|
result.telephone | string |
電話番号。 |
同意条件バージョン
|
result.agreedTermsVersion | string |
同意した条件のバージョン。 |
最新の条件バージョンに同意
|
result.hasAgreedToLatestTermsVersion | string |
条件の最新バージョンに同意済み。 |
マーケティング オプトイン
|
result.marketingOptIn | string |
マーケティング オプトインに同意済み。 |
Badgr ドメイン
|
result.badgrDomain | string |
Badgr のドメイン。 |
パスワード設定済み
|
result.hasPasswordSet | string |
パスワードが設定済みかどうか。 |
受信者
|
result.recipient | string |
受信者。 |
BadgeUser アカウントを作成する
BadgeUser アカウントとプロファイルを作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの ID。 |
エンティティの種類
|
entityType | string |
エンティティの種類。 |
|
エンティティ ID
|
entityId | string |
エンティティの ID。 |
|
名
|
firstName | string |
名。 |
|
姓
|
lastName | string |
姓。 |
|
エンティティの種類
|
entityType | string |
エンティティの種類。 |
|
エンティティ ID
|
entityId | string |
エンティティの ID。 |
|
電子メール
|
string |
電子メール アドレス。 |
||
検証済み
|
verified | boolean |
検証済みかどうか。 |
|
主要
|
primary | boolean |
主要かどうか。 |
|
ケース バリアント
|
caseVariants | string |
ケース バリアント。 |
|
URL
|
url | string |
URL アドレス。 |
|
電話
|
telephone | string |
電話番号。 |
|
同意条件バージョン
|
agreedTermsVersion | string |
同意した条件のバージョン。 |
|
最新の条件バージョンに同意
|
hasAgreedToLatestTermsVersion | string |
条件の最新バージョンに同意済み。 |
|
マーケティング オプトイン
|
marketingOptIn | string |
マーケティングにオプトイン済み。 |
|
Badgr ドメイン
|
badgrDomain | string |
Badgr のドメイン。 |
|
パスワード設定済み
|
hasPasswordSet | string |
パスワード設定済み。 |
|
受信者
|
recipient | string |
受信者。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object | |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
名
|
result.firstName | string |
名。 |
姓
|
result.lastName | string |
姓。 |
電子メール
|
result.emails | array of object | |
エンティティの種類
|
result.emails.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.emails.entityId | string |
エンティティの ID。 |
電子メール
|
result.emails.email | string |
電子メール アドレス。 |
検証済み
|
result.emails.verified | boolean |
検証済みかどうか。 |
主要
|
result.emails.primary | boolean |
主要かどうか。 |
ケース バリアント
|
result.emails.caseVariants | string |
ケース バリアント。 |
URL
|
result.url | string |
URL アドレス。 |
電話
|
result.telephone | string |
電話番号。 |
同意条件バージョン
|
result.agreedTermsVersion | string |
同意した条件のバージョン。 |
最新の条件バージョンに同意
|
result.hasAgreedToLatestTermsVersion | string |
条件の最新バージョンに同意済み。 |
マーケティング オプトイン
|
result.marketingOptIn | string |
マーケティング オプトインに同意済み。 |
Badgr ドメイン
|
result.badgrDomain | string |
Badgr のドメイン。 |
パスワード設定済み
|
result.hasPasswordSet | string |
パスワードが設定済みかどうか。 |
受信者
|
result.recipient | string |
受信者。 |
BadgeUser プロファイルを取得する
単一の BadgeUser プロファイルを取得します。 認証されたユーザーのプロファイルを取得するには、entityId 'セルフ' を使用してください。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの識別子 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object |
結果の配列。 |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
名
|
result.firstName | string |
名。 |
姓
|
result.lastName | string |
姓。 |
電子メール
|
result.emails | array of object | |
エンティティの種類
|
result.emails.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.emails.entityId | string |
エンティティの ID。 |
電子メール
|
result.emails.email | string |
電子メール アドレス。 |
検証済み
|
result.emails.verified | boolean |
検証済みかどうか。 |
主要
|
result.emails.primary | boolean |
主要かどうか。 |
ケース バリアント
|
result.emails.caseVariants | string |
ケース バリアント。 |
URL
|
result.url | string |
URL アドレス。 |
電話
|
result.telephone | string |
電話番号。 |
同意条件バージョン
|
result.agreedTermsVersion | string |
同意した条件のバージョン。 |
最新の条件バージョンに同意
|
result.hasAgreedToLatestTermsVersion | string |
条件の最新バージョンに同意済み。 |
マーケティング オプトイン
|
result.marketingOptIn | string |
マーケティング オプトインに同意済み。 |
Badgr ドメイン
|
result.badgrDomain | string |
Badgr のドメイン。 |
パスワード設定済み
|
result.hasPasswordSet | string |
パスワードが設定済みかどうか。 |
受信者
|
result.recipient | string |
受信者。 |
アカウントを復元する
新しいパスワードを設定してアカウントを復元します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
トークン
|
token | string |
復元メールで受け取るトークン。 |
|
パスワード
|
password | string |
使用する新しいパスワード。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result |
アカウント復元電子メールを要求する
ユーザーのアカウント復元電子メールを要求します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
電子メール
|
string |
復元電子メールを送信する、ファイルの電子メール アドレス。 |
戻り値
アサーションをバックパックにアップロードする
ユーザーのバックパックに新しいアサーションをアップロードします。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
BadgeClass
|
badgeclass | string |
獲得できるバッジの定義。 |
|
BadgeClass オープン バッジ ID
|
badgeclassOpenBadgeId | string |
BadgeClass のオープンバッジの識別子。 |
|
発行者
|
issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 。 |
|
発行者オープン バッジ ID
|
issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
|
ID
|
identity | string |
ID。 |
|
ハッシュ済み
|
hashed | boolean |
ハッシュ済みかどうか。 |
|
種類
|
type | string |
種類。 |
|
プレーンテキスト ID
|
plaintextIdentity | string |
プレーンテキストの ID。 |
|
ソルト
|
salt | string |
ハッシュ化されているなら、そのソルト。 |
|
発行日
|
issuedOn | string |
発行された日付。 |
|
物語
|
narrative | string |
発行されたバッジの物語。 |
|
URL
|
url | string |
URL アドレス。 |
|
物語
|
narrative | string |
発行されたバッジの物語。 |
|
有効期限
|
expires | string |
有効期限。 |
|
拡張
|
extensions | string |
拡張機能。 |
|
BadgeClass 名
|
badgeclassName | string |
BadgeClass の名前。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object | |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
オープン バッジ ID
|
result.openBadgeId | string |
オープン バッジの識別子。 |
作成日
|
result.createdAt | string |
作成された日時。 |
作成者
|
result.createdBy | string |
だれが作成したか。 |
BadgeClass
|
result.badgeclass | string |
獲得できるバッジの定義。 |
BadgeClass オープン バッジ ID
|
result.badgeclassOpenBadgeId | string |
BadgeClass のオープンバッジの識別子。 |
発行者
|
result.issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 |
発行者オープン バッジ ID
|
result.issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
画像
|
result.image | string |
画像。 |
ID
|
result.recipient.identity | string |
ID。 |
ハッシュ済み
|
result.recipient.hashed | boolean |
ハッシュ済みかどうか。 |
種類
|
result.recipient.type | string |
種類。 |
プレーンテキスト ID
|
result.recipient.plaintextIdentity | string |
プレーンテキストの ID。 |
ソルト
|
result.recipient.salt | string |
ハッシュ化されているなら、そのソルト。 |
発行日
|
result.issuedOn | string |
発行された日付。 |
物語
|
result.narrative | string |
発行されたバッジの物語。 |
エビデンス
|
result.evidence | array of object | |
URL
|
result.evidence.url | string |
URL アドレス。 |
物語
|
result.evidence.narrative | string |
発行されたバッジの物語。 |
失効
|
result.revoked | boolean |
失効しているかどうか。 |
失効理由
|
result.revocationReason | string |
失効した理由。 |
承認
|
result.acceptance | string |
バッジが承認されたかどうか。 |
有効期限
|
result.expires | string |
バッジの有効期限。 |
拡張
|
result.extensions | string |
拡張機能。 |
BadgeClass 名
|
result.badgeclassName | string |
BadgeClass の名前。 |
アサーションを取り消す
アサーションを取り消します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの識別子 |
取り消し理由
|
revocation_reason | string |
アサーションを取り消した理由 |
アサーションを取得する
単一の発行者のためのアサーションの一覧を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの識別子 |
受信者
|
recipient | string |
フィルター処理する受信者の識別子 |
|
数
|
num | string |
結果のページ割りを要求します |
|
期限切れを含める
|
include_expired | boolean |
期限切れのアサーションを含めます |
|
失効を含める
|
include_revoked | boolean |
失効したアサーションを含めます |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object | |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
オープン バッジ ID
|
result.openBadgeId | string |
オープン バッジの識別子。 |
作成日
|
result.createdAt | string |
作成された日時。 |
作成者
|
result.createdBy | string |
だれが作成したか。 |
BadgeClass
|
result.badgeclass | string |
獲得できるバッジの定義。 |
BadgeClass オープン バッジ ID
|
result.badgeclassOpenBadgeId | string |
BadgeClass のオープンバッジの識別子。 |
発行者
|
result.issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 |
発行者オープン バッジ ID
|
result.issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
画像
|
result.image | string |
画像。 |
ID
|
result.recipient.identity | string |
ID。 |
ハッシュ済み
|
result.recipient.hashed | boolean |
ハッシュ済みかどうか。 |
種類
|
result.recipient.type | string |
種類。 |
プレーンテキスト ID
|
result.recipient.plaintextIdentity | string |
プレーンテキストの ID。 |
ソルト
|
result.recipient.salt | string |
ハッシュ化されているなら、そのソルト。 |
発行日
|
result.issuedOn | string |
発行された日付。 |
物語
|
result.narrative | string |
発行されたバッジの物語。 |
エビデンス
|
result.evidence | array of object | |
URL
|
result.evidence.url | string |
URL アドレス。 |
物語
|
result.evidence.narrative | string |
発行されたバッジの物語。 |
失効
|
result.revoked | boolean |
失効しているかどうか。 |
失効理由
|
result.revocationReason | string |
失効した理由。 |
承認
|
result.acceptance | string |
バッジが承認されたかどうか。 |
有効期限
|
result.expires | string |
バッジの有効期限。 |
拡張
|
result.extensions | string |
拡張機能。 |
BadgeClass 名
|
result.badgeclassName | string |
BadgeClass の名前。 |
アサーションを更新する
アサーションを更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの ID。 |
BadgeClass
|
badgeclass | string |
獲得できるバッジの定義。 |
|
BadgeClass オープン バッジ ID
|
badgeclassOpenBadgeId | string |
BadgeClass のオープンバッジの識別子。 |
|
発行者
|
issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 。 |
|
発行者オープン バッジ ID
|
issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
|
ID
|
identity | string |
ID。 |
|
ハッシュ済み
|
hashed | boolean |
ハッシュ済みかどうか。 |
|
種類
|
type | string |
種類。 |
|
プレーンテキスト ID
|
plaintextIdentity | string |
プレーンテキストの ID。 |
|
ソルト
|
salt | string |
ハッシュ化されているなら、そのソルト。 |
|
発行日
|
issuedOn | string |
発行された日付。 |
|
物語
|
narrative | string |
発行されたバッジの物語。 |
|
URL
|
url | string |
URL アドレス。 |
|
物語
|
narrative | string |
発行されたバッジの物語。 |
|
有効期限
|
expires | string |
有効期限。 |
|
拡張
|
extensions | string |
拡張機能。 |
|
BadgeClass 名
|
badgeclassName | string |
BadgeClass の名前。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object |
結果の配列。 |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
オープン バッジ ID
|
result.openBadgeId | string |
オープン バッジの識別子。 |
作成日
|
result.createdAt | string |
作成された日時。 |
作成者
|
result.createdBy | string |
だれが作成したか。 |
BadgeClass
|
result.badgeclass | string |
獲得できるバッジの定義。 |
BadgeClass オープン バッジ ID
|
result.badgeclassOpenBadgeId | string |
BadgeClass のオープンバッジの識別子。 |
発行者
|
result.issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 |
発行者オープン バッジ ID
|
result.issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
画像
|
result.image | string |
画像。 |
ID
|
result.recipient.identity | string |
ID。 |
ハッシュ済み
|
result.recipient.hashed | boolean |
ハッシュ済みかどうか。 |
種類
|
result.recipient.type | string |
種類。 |
プレーンテキスト ID
|
result.recipient.plaintextIdentity | string |
プレーンテキストの ID。 |
ソルト
|
result.recipient.salt | string |
ハッシュ化されているなら、そのソルト。 |
発行日
|
result.issuedOn | string |
発行された日付。 |
物語
|
result.narrative | string |
発行されたバッジの物語。 |
エビデンス
|
result.evidence | array of object | |
URL
|
result.evidence.url | string |
URL アドレス。 |
物語
|
result.evidence.narrative | string |
発行されたバッジの物語。 |
失効
|
result.revoked | boolean |
失効しているかどうか。 |
失効理由
|
result.revocationReason | string |
失効した理由。 |
承認
|
result.acceptance | string |
バッジが承認されたかどうか。 |
有効期限
|
result.expires | string |
バッジの有効期限。 |
拡張
|
result.extensions | string |
拡張機能。 |
BadgeClass 名
|
result.badgeclassName | string |
BadgeClass の名前。 |
アサーションを発行する
受信者に新しいアサーションを発行します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの ID。 |
BadgeClass
|
badgeclass | string |
獲得できるバッジの定義。 |
|
BadgeClass オープン バッジ ID
|
badgeclassOpenBadgeId | string |
BadgeClass のオープンバッジの識別子。 |
|
発行者
|
issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 。 |
|
発行者オープン バッジ ID
|
issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
|
ID
|
identity | string |
ID。 |
|
ハッシュ済み
|
hashed | boolean |
ハッシュ済みかどうか。 |
|
種類
|
type | string |
種類。 |
|
プレーンテキスト ID
|
plaintextIdentity | string |
プレーンテキストの ID。 |
|
ソルト
|
salt | string |
ハッシュ化されているなら、そのソルト。 |
|
発行日
|
issuedOn | string |
発行された日付。 |
|
物語
|
narrative | string |
発行されたバッジの物語。 |
|
URL
|
url | string |
URL アドレス。 |
|
物語
|
narrative | string |
発行されたバッジの物語。 |
|
有効期限
|
expires | string |
有効期限。 |
|
拡張
|
extensions | string |
拡張機能。 |
|
BadgeClass 名
|
badgeclassName | string |
BadgeClass の名前。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object | |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
オープン バッジ ID
|
result.openBadgeId | string |
オープン バッジの識別子。 |
作成日
|
result.createdAt | string |
作成された日時。 |
作成者
|
result.createdBy | string |
だれが作成したか。 |
BadgeClass
|
result.badgeclass | string |
獲得できるバッジの定義。 |
BadgeClass オープン バッジ ID
|
result.badgeclassOpenBadgeId | string |
BadgeClass のオープンバッジの識別子。 |
発行者
|
result.issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 |
発行者オープン バッジ ID
|
result.issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
画像
|
result.image | string |
画像。 |
ID
|
result.recipient.identity | string |
ID。 |
ハッシュ済み
|
result.recipient.hashed | boolean |
ハッシュ済みかどうか。 |
種類
|
result.recipient.type | string |
種類。 |
プレーンテキスト ID
|
result.recipient.plaintextIdentity | string |
プレーンテキストの ID。 |
ソルト
|
result.recipient.salt | string |
ハッシュ化されているなら、そのソルト。 |
発行日
|
result.issuedOn | string |
発行された日付。 |
物語
|
result.narrative | string |
発行されたバッジの物語。 |
エビデンス
|
result.evidence | array of object | |
URL
|
result.evidence.url | string |
URL アドレス。 |
物語
|
result.evidence.narrative | string |
発行されたバッジの物語。 |
失効
|
result.revoked | boolean |
失効しているかどうか。 |
失効理由
|
result.revocationReason | string |
失効した理由。 |
承認
|
result.acceptance | string |
バッジが承認されたかどうか。 |
有効期限
|
result.expires | string |
バッジの有効期限。 |
拡張
|
result.extensions | string |
拡張機能。 |
BadgeClass 名
|
result.badgeclassName | string |
BadgeClass の名前。 |
アサーションを発行する
単一の受信者にアサーションを発行します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの ID。 |
BadgeClass
|
badgeclass | string |
獲得できるバッジの定義。 |
|
BadgeClass オープン バッジ ID
|
badgeclassOpenBadgeId | string |
BadgeClass のオープンバッジの識別子。 |
|
発行者
|
issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 。 |
|
発行者オープン バッジ ID
|
issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
|
ID
|
identity | string |
ID。 |
|
ハッシュ済み
|
hashed | boolean |
ハッシュ済みかどうか。 |
|
種類
|
type | string |
種類。 |
|
プレーンテキスト ID
|
plaintextIdentity | string |
プレーンテキストの ID。 |
|
ソルト
|
salt | string |
ハッシュ化されているなら、そのソルト。 |
|
発行日
|
issuedOn | string |
発行された日付。 |
|
物語
|
narrative | string |
発行されたバッジの物語。 |
|
URL
|
url | string |
URL アドレス。 |
|
物語
|
narrative | string |
発行されたバッジの物語。 |
|
有効期限
|
expires | string |
有効期限。 |
|
拡張
|
extensions | string |
拡張機能。 |
|
BadgeClass 名
|
badgeclassName | string |
BadgeClass の名前。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object | |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
オープン バッジ ID
|
result.openBadgeId | string |
オープン バッジの識別子。 |
作成日
|
result.createdAt | string |
作成された日時。 |
作成者
|
result.createdBy | string |
だれが作成したか。 |
BadgeClass
|
result.badgeclass | string |
獲得できるバッジの定義。 |
BadgeClass オープン バッジ ID
|
result.badgeclassOpenBadgeId | string |
BadgeClass のオープンバッジの識別子。 |
発行者
|
result.issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 |
発行者オープン バッジ ID
|
result.issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
画像
|
result.image | string |
画像。 |
ID
|
result.recipient.identity | string |
ID。 |
ハッシュ済み
|
result.recipient.hashed | boolean |
ハッシュ済みかどうか。 |
種類
|
result.recipient.type | string |
種類。 |
プレーンテキスト ID
|
result.recipient.plaintextIdentity | string |
プレーンテキストの ID。 |
ソルト
|
result.recipient.salt | string |
ハッシュ化されているなら、そのソルト。 |
発行日
|
result.issuedOn | string |
発行された日付。 |
物語
|
result.narrative | string |
発行されたバッジの物語。 |
エビデンス
|
result.evidence | array of object | |
URL
|
result.evidence.url | string |
URL アドレス。 |
物語
|
result.evidence.narrative | string |
発行されたバッジの物語。 |
失効
|
result.revoked | boolean |
失効しているかどうか。 |
失効理由
|
result.revocationReason | string |
失効した理由。 |
承認
|
result.acceptance | string |
バッジが承認されたかどうか。 |
有効期限
|
result.expires | string |
バッジの有効期限。 |
拡張
|
result.extensions | string |
拡張機能。 |
BadgeClass 名
|
result.badgeclassName | string |
BadgeClass の名前。 |
コレクションの作成
コレクションを作成する。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティの種類
|
entityType | string |
エンティティの種類。 |
|
エンティティ ID
|
entityId | string |
エンティティの ID。 |
|
名前
|
name | string |
名前。 |
|
説明
|
description | string |
説明。 |
|
所有者
|
owner | string |
所有者。 |
|
共有 URL
|
share_url | string |
共有の URL アドレス。 |
|
共有ハッシュ
|
shareHash | string |
共有のハッシュ。 |
|
公開済み
|
published | boolean |
公開済みかどうか。 |
|
BadgeClass
|
badgeclass | string |
獲得できるバッジの定義。 |
|
BadgeClass オープン バッジ ID
|
badgeclassOpenBadgeId | string |
BadgeClass のオープンバッジの識別子。 |
|
発行者
|
issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 |
|
発行者オープン バッジ ID
|
issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
|
ID
|
identity | string |
ID。 |
|
ハッシュ済み
|
hashed | boolean |
ハッシュ済みかどうか。 |
|
種類
|
type | string |
種類。 |
|
プレーンテキスト ID
|
plaintextIdentity | string |
プレーンテキストの ID。 |
|
ソルト
|
salt | string |
ハッシュ化されているなら、そのソルト。 |
|
発行日
|
issuedOn | string |
発行された日付。 |
|
物語
|
narrative | string |
発行されたバッジの物語。 |
|
URL
|
url | string |
URL アドレス。 |
|
物語
|
narrative | string |
発行されたバッジの物語。 |
|
有効期限
|
expires | string |
バッジの有効期限。 |
|
拡張
|
extensions | string |
拡張機能。 |
|
BadgeClass 名
|
badgeclassName | string |
BadgeClass の名前。 |
|
作成日
|
createdAt | string |
作成日。 |
|
作成者
|
createdBy | string |
だれが作成したか。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object | |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
名前
|
result.name | string |
名前。 |
説明
|
result.description | string |
説明。 |
所有者
|
result.owner | string |
所有者。 |
共有 URL
|
result.share_url | string |
共有の URL アドレス。 |
共有ハッシュ
|
result.shareHash | string |
共有のハッシュ。 |
公開済み
|
result.published | boolean |
公開済みかどうか。 |
アサーション
|
result.assertions | array of object | |
エンティティの種類
|
result.assertions.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.assertions.entityId | string |
エンティティの ID。 |
オープン バッジ ID
|
result.assertions.openBadgeId | string |
オープン バッジの識別子。 |
作成日
|
result.assertions.createdAt | string |
作成された日時。 |
作成者
|
result.assertions.createdBy | string |
作成者。 |
BadgeClass
|
result.assertions.badgeclass | string |
BadgeClass。 |
BadgeClass オープン バッジ ID
|
result.assertions.badgeclassOpenBadgeId | string |
BadgeClass のオープンバッジの識別子。 |
発行者
|
result.assertions.issuer | string |
発行者。 |
発行者オープン バッジ ID
|
result.assertions.issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
画像
|
result.assertions.image | string |
画像。 |
ID
|
result.assertions.recipient.identity | string |
ID。 |
ハッシュ済み
|
result.assertions.recipient.hashed | boolean |
ハッシュ済みかどうか。 |
種類
|
result.assertions.recipient.type | string |
種類。 |
プレーンテキスト ID
|
result.assertions.recipient.plaintextIdentity | string |
プレーンテキストの ID。 |
ソルト
|
result.assertions.recipient.salt | string |
ハッシュ化されているなら、そのソルト。 |
発行日
|
result.assertions.issuedOn | string |
発行された日付。 |
物語
|
result.assertions.narrative | string |
発行されたバッジの物語。 |
エビデンス
|
result.assertions.evidence | array of object | |
URL
|
result.assertions.evidence.url | string |
URL アドレス。 |
物語
|
result.assertions.evidence.narrative | string |
物語。 |
失効
|
result.assertions.revoked | boolean |
失効しているかどうか。 |
失効理由
|
result.assertions.revocationReason | string |
失効した理由。 |
承認
|
result.assertions.acceptance | string |
承認。 |
有効期限
|
result.assertions.expires | string |
有効期限。 |
拡張
|
result.assertions.extensions | string |
拡張機能。 |
BadgeClass 名
|
result.assertions.badgeclassName | string |
BadgeClass の名前。 |
作成日
|
result.createdAt | string |
作成された日時。 |
作成者
|
result.createdBy | string |
だれが作成したか。 |
コレクションを削除する
バックパックからコレクションを削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの識別子 |
コレクションを取得する
単一のコレクションを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの識別子 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object |
結果の配列。 |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
名前
|
result.name | string |
名前。 |
説明
|
result.description | string |
説明。 |
所有者
|
result.owner | string |
所有者。 |
共有 URL
|
result.share_url | string |
共有の URL アドレス。 |
共有ハッシュ
|
result.shareHash | string |
共有のハッシュ。 |
公開済み
|
result.published | boolean |
公開済みかどうか。 |
アサーション
|
result.assertions | array of object | |
エンティティの種類
|
result.assertions.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.assertions.entityId | string |
エンティティの ID。 |
オープン バッジ ID
|
result.assertions.openBadgeId | string |
オープン バッジの識別子。 |
作成日
|
result.assertions.createdAt | string |
作成された日時。 |
作成者
|
result.assertions.createdBy | string |
作成者。 |
BadgeClass
|
result.assertions.badgeclass | string |
BadgeClass。 |
BadgeClass オープン バッジ ID
|
result.assertions.badgeclassOpenBadgeId | string |
BadgeClass のオープンバッジの識別子。 |
発行者
|
result.assertions.issuer | string |
発行者。 |
発行者オープン バッジ ID
|
result.assertions.issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
画像
|
result.assertions.image | string |
画像。 |
ID
|
result.assertions.recipient.identity | string |
ID。 |
ハッシュ済み
|
result.assertions.recipient.hashed | boolean |
ハッシュ済みかどうか。 |
種類
|
result.assertions.recipient.type | string |
種類。 |
プレーンテキスト ID
|
result.assertions.recipient.plaintextIdentity | string |
プレーンテキストの ID。 |
ソルト
|
result.assertions.recipient.salt | string |
ハッシュ化されているなら、そのソルト。 |
発行日
|
result.assertions.issuedOn | string |
発行された日付。 |
物語
|
result.assertions.narrative | string |
発行されたバッジの物語。 |
エビデンス
|
result.assertions.evidence | array of object | |
URL
|
result.assertions.evidence.url | string |
URL アドレス。 |
物語
|
result.assertions.evidence.narrative | string |
物語。 |
失効
|
result.assertions.revoked | boolean |
失効しているかどうか。 |
失効理由
|
result.assertions.revocationReason | string |
失効した理由。 |
承認
|
result.assertions.acceptance | string |
承認。 |
有効期限
|
result.assertions.expires | string |
有効期限。 |
拡張
|
result.assertions.extensions | string |
拡張機能。 |
BadgeClass 名
|
result.assertions.badgeclassName | string |
BadgeClass の名前。 |
作成日
|
result.createdAt | string |
作成された日時。 |
作成者
|
result.createdBy | string |
だれが作成したか。 |
コレクションを取得する
コレクションの一覧を取得します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object |
結果の配列。 |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
名前
|
result.name | string |
名前。 |
説明
|
result.description | string |
説明。 |
所有者
|
result.owner | string |
所有者。 |
共有 URL
|
result.share_url | string |
共有の URL アドレス。 |
共有ハッシュ
|
result.shareHash | string |
共有のハッシュ。 |
公開済み
|
result.published | boolean |
公開済みかどうか。 |
アサーション
|
result.assertions | array of object | |
エンティティの種類
|
result.assertions.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.assertions.entityId | string |
エンティティの ID。 |
オープン バッジ ID
|
result.assertions.openBadgeId | string |
オープン バッジの識別子。 |
作成日
|
result.assertions.createdAt | string |
作成された日時。 |
作成者
|
result.assertions.createdBy | string |
作成者。 |
BadgeClass
|
result.assertions.badgeclass | string |
BadgeClass。 |
BadgeClass オープン バッジ ID
|
result.assertions.badgeclassOpenBadgeId | string |
BadgeClass のオープンバッジの識別子。 |
発行者
|
result.assertions.issuer | string |
発行者。 |
発行者オープン バッジ ID
|
result.assertions.issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
画像
|
result.assertions.image | string |
画像。 |
ID
|
result.assertions.recipient.identity | string |
ID。 |
ハッシュ済み
|
result.assertions.recipient.hashed | boolean |
ハッシュ済みかどうか。 |
種類
|
result.assertions.recipient.type | string |
種類。 |
プレーンテキスト ID
|
result.assertions.recipient.plaintextIdentity | string |
プレーンテキストの ID。 |
ソルト
|
result.assertions.recipient.salt | string |
ハッシュ化されているなら、そのソルト。 |
発行日
|
result.assertions.issuedOn | string |
発行された日付。 |
物語
|
result.assertions.narrative | string |
発行されたバッジの物語。 |
エビデンス
|
result.assertions.evidence | array of object | |
URL
|
result.assertions.evidence.url | string |
URL アドレス。 |
物語
|
result.assertions.evidence.narrative | string |
物語。 |
失効
|
result.assertions.revoked | boolean |
失効しているかどうか。 |
失効理由
|
result.assertions.revocationReason | string |
失効した理由。 |
承認
|
result.assertions.acceptance | string |
承認。 |
有効期限
|
result.assertions.expires | string |
有効期限。 |
拡張
|
result.assertions.extensions | string |
拡張機能。 |
BadgeClass 名
|
result.assertions.badgeclassName | string |
BadgeClass の名前。 |
作成日
|
result.createdAt | string |
作成された日時。 |
作成者
|
result.createdBy | string |
だれが作成したか。 |
コレクションを更新する
バックパックのコレクションを更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの ID。 |
エンティティの種類
|
entityType | string |
エンティティの種類。 |
|
エンティティ ID
|
entityId | string |
エンティティの ID。 |
|
名前
|
name | string |
名前。 |
|
説明
|
description | string |
説明。 |
|
所有者
|
owner | string |
所有者。 |
|
共有 URL
|
share_url | string |
共有の URL アドレス。 |
|
共有ハッシュ
|
shareHash | string |
共有のハッシュ。 |
|
公開済み
|
published | boolean |
公開済みかどうか。 |
|
BadgeClass
|
badgeclass | string |
獲得できるバッジの定義。 |
|
BadgeClass オープン バッジ ID
|
badgeclassOpenBadgeId | string |
BadgeClass のオープンバッジの識別子。 |
|
発行者
|
issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 |
|
発行者オープン バッジ ID
|
issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
|
ID
|
identity | string |
ID。 |
|
ハッシュ済み
|
hashed | boolean |
ハッシュ済みかどうか。 |
|
種類
|
type | string |
種類。 |
|
プレーンテキスト ID
|
plaintextIdentity | string |
プレーンテキストの ID。 |
|
ソルト
|
salt | string |
ハッシュ化されているなら、そのソルト。 |
|
発行日
|
issuedOn | string |
発行された日付。 |
|
物語
|
narrative | string |
発行されたバッジの物語。 |
|
URL
|
url | string |
URL アドレス。 |
|
物語
|
narrative | string |
発行されたバッジの物語。 |
|
有効期限
|
expires | string |
バッジの有効期限。 |
|
拡張
|
extensions | string |
拡張機能。 |
|
BadgeClass 名
|
badgeclassName | string |
BadgeClass の名前。 |
|
作成日
|
createdAt | string |
作成日。 |
|
作成者
|
createdBy | string |
だれが作成したか。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明設定。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object |
結果の配列。 |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
名前
|
result.name | string |
名前。 |
説明
|
result.description | string |
説明。 |
所有者
|
result.owner | string |
所有者。 |
共有 URL
|
result.share_url | string |
共有の URL アドレス。 |
共有ハッシュ
|
result.shareHash | string |
共有のハッシュ。 |
公開済み
|
result.published | boolean |
公開済みかどうか。 |
アサーション
|
result.assertions | array of object | |
エンティティの種類
|
result.assertions.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.assertions.entityId | string |
エンティティの ID。 |
オープン バッジ ID
|
result.assertions.openBadgeId | string |
オープン バッジの識別子。 |
作成日
|
result.assertions.createdAt | string |
作成された日時。 |
作成者
|
result.assertions.createdBy | string |
作成者。 |
BadgeClass
|
result.assertions.badgeclass | string |
BadgeClass。 |
BadgeClass オープン バッジ ID
|
result.assertions.badgeclassOpenBadgeId | string |
BadgeClass のオープンバッジの識別子。 |
発行者
|
result.assertions.issuer | string |
発行者。 |
発行者オープン バッジ ID
|
result.assertions.issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
画像
|
result.assertions.image | string |
画像。 |
ID
|
result.assertions.recipient.identity | string |
ID。 |
ハッシュ済み
|
result.assertions.recipient.hashed | boolean |
ハッシュ済みかどうか。 |
種類
|
result.assertions.recipient.type | string |
種類。 |
プレーンテキスト ID
|
result.assertions.recipient.plaintextIdentity | string |
プレーンテキストの ID。 |
ソルト
|
result.assertions.recipient.salt | string |
ハッシュ化されているなら、そのソルト。 |
発行日
|
result.assertions.issuedOn | string |
発行された日付。 |
物語
|
result.assertions.narrative | string |
発行されたバッジの物語。 |
エビデンス
|
result.assertions.evidence | array of object | |
URL
|
result.assertions.evidence.url | string |
URL アドレス。 |
物語
|
result.assertions.evidence.narrative | string |
物語。 |
失効
|
result.assertions.revoked | boolean |
失効しているかどうか。 |
失効理由
|
result.assertions.revocationReason | string |
失効した理由。 |
承認
|
result.assertions.acceptance | string |
承認。 |
有効期限
|
result.assertions.expires | string |
有効期限。 |
拡張
|
result.assertions.extensions | string |
拡張機能。 |
BadgeClass 名
|
result.assertions.badgeclassName | string |
BadgeClass の名前。 |
作成日
|
result.createdAt | string |
作成された日時。 |
作成者
|
result.createdBy | string |
だれが作成したか。 |
バックパック アサーションの詳細を取得する
ユーザーのバックパックからアサーションの詳細を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの識別子 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object |
結果の配列。 |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
承認
|
result.acceptance | string |
バッジが承認されたかどうか。 |
オープン バッジ ID
|
result.openBadgeId | string |
オープン バッジの識別子。 |
BadgeClass
|
result.badgeclass | string |
獲得できるバッジの定義。 |
BadgeClass オープン バッジ ID
|
result.badgeclassOpenBadgeId | string |
BadgeClass のオープンバッジの識別子。 |
発行者
|
result.issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 |
発行者オープン バッジ ID
|
result.issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
画像
|
result.image | string |
画像。 |
ID
|
result.recipient.identity | string |
ID。 |
種類
|
result.recipient.type | string |
種類。 |
ハッシュ済み
|
result.recipient.hashed | boolean |
ハッシュ済みかどうか。 |
プレーンテキスト ID
|
result.recipient.plaintextIdentity | string |
プレーンテキストの ID。 |
発行日
|
result.issuedOn | string |
発行された日付。 |
物語
|
result.narrative | string |
発行されたバッジの物語。 |
エビデンス
|
result.evidence | array of object | |
URL
|
result.evidence.url | string |
URL アドレス。 |
物語
|
result.evidence.narrative | string |
発行されたバッジの物語。 |
失効
|
result.revoked | boolean |
失効しているかどうか。 |
失効理由
|
result.revocationReason | string |
失効した理由。 |
有効期限
|
result.expires | string |
バッジの有効期限。 |
保留
|
result.pending | string |
保留中。 |
バックパックからアサーションを削除する
ユーザーのバックパックからアサーションを削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの識別子 |
バックパックでアサーション承認を更新する
ユーザーのバックパックでアサーションの承認を更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの ID。 |
承認
|
acceptance | string |
承認。 |
|
BadgeClass
|
badgeclass | string |
獲得できるバッジの定義。 |
|
発行者
|
issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 。 |
|
発行者オープン バッジ ID
|
issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
|
ID
|
identity | string |
ID。 |
|
種類
|
type | string |
種類。 |
|
ハッシュ済み
|
hashed | boolean |
ハッシュ済みかどうか。 |
|
プレーンテキスト ID
|
plaintextIdentity | string |
プレーンテキストの ID。 |
|
発行日
|
issuedOn | string |
発行された日付。 |
|
物語
|
narrative | string |
発行されたバッジの物語。 |
|
URL
|
url | string |
URL アドレス。 |
|
物語
|
narrative | string |
発行されたバッジの物語。 |
|
有効期限
|
expires | string |
有効期限。 |
|
保留
|
pending | string |
保留中。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object |
結果の配列。 |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
承認
|
result.acceptance | string |
バッジが承認されたかどうか。 |
オープン バッジ ID
|
result.openBadgeId | string |
オープン バッジの識別子。 |
BadgeClass
|
result.badgeclass | string |
獲得できるバッジの定義。 |
BadgeClass オープン バッジ ID
|
result.badgeclassOpenBadgeId | string |
BadgeClass のオープンバッジの識別子。 |
発行者
|
result.issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 |
発行者オープン バッジ ID
|
result.issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
画像
|
result.image | string |
画像。 |
ID
|
result.recipient.identity | string |
ID。 |
種類
|
result.recipient.type | string |
種類。 |
ハッシュ済み
|
result.recipient.hashed | boolean |
ハッシュ済みかどうか。 |
プレーンテキスト ID
|
result.recipient.plaintextIdentity | string |
プレーンテキストの ID。 |
発行日
|
result.issuedOn | string |
発行された日付。 |
物語
|
result.narrative | string |
発行されたバッジの物語。 |
エビデンス
|
result.evidence | array of object | |
URL
|
result.evidence.url | string |
URL アドレス。 |
物語
|
result.evidence.narrative | string |
発行されたバッジの物語。 |
失効
|
result.revoked | boolean |
失効しているかどうか。 |
失効理由
|
result.revocationReason | string |
失効した理由。 |
有効期限
|
result.expires | string |
バッジの有効期限。 |
保留
|
result.pending | string |
保留中。 |
バックパックにアサーションをインポートする
ユーザーのバックパックに新しいアサーションをインポートします。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
URL
|
url | string |
OpenBadge に準拠したバッジの URL。 |
|
Image
|
image | string |
Base64 エンコードが組み込まれた OpenBadge 画像。 |
|
アサーション
|
assertion | object |
OpenBadge 準拠の JSON。 |
戻り値
ユーザーの BadgeClass を取得する
認証済みユーザーの BadgeClass の一覧を取得します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object | |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
オープン バッジ ID
|
result.openBadgeId | string |
オープン バッジの識別子。 |
作成日
|
result.createdAt | string |
作成された日時。 |
作成者
|
result.createdBy | string |
だれが作成したか。 |
発行者
|
result.issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 |
発行者オープン バッジ ID
|
result.issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
名前
|
result.name | string |
名前。 |
画像
|
result.image | string |
画像。 |
説明
|
result.description | string |
説明。 |
実績の種類
|
result.achievementType | string |
実績の種類。 |
基準 URL
|
result.criteriaUrl | string |
基準の URL アドレス。 |
基準説明
|
result.criteriaNarrative | string |
基準の説明。 |
配列
|
result.alignments | array of object | |
ターゲット名
|
result.alignments.targetName | string |
ターゲットの名前。 |
ターゲット URL
|
result.alignments.targetUrl | string |
ターゲットの URL アドレス。 |
ターゲット説明
|
result.alignments.targetDescription | string |
ターゲットの説明。 |
ターゲット フレームワーク
|
result.alignments.targetFramework | string |
ターゲットのフレームワーク。 |
ターゲット コード
|
result.alignments.targetCode | string |
ターゲットのコード。 |
タグ
|
result.tags | array of string | |
量
|
result.expires.amount | string |
量。 |
期間
|
result.expires.duration | string |
期間。 |
拡張
|
result.extensions | string |
拡張機能。 |
ユーザーのアクセス トークンを取得する
認証済みユーザーのアクセス トークンの一覧を取得します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of AccessToken |
ユーザーのバックパックからアサーションを取得する
認証済みユーザーのバックパックからアサーションの一覧を取得します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object | |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
オープン バッジ ID
|
result.openBadgeId | string |
オープン バッジの識別子。 |
作成日
|
result.createdAt | string |
作成された日時。 |
作成者
|
result.createdBy | string |
だれが作成したか。 |
BadgeClass
|
result.badgeclass | string |
獲得できるバッジの定義。 |
BadgeClass オープン バッジ ID
|
result.badgeclassOpenBadgeId | string |
BadgeClass のオープンバッジの識別子。 |
発行者
|
result.issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 |
発行者オープン バッジ ID
|
result.issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
画像
|
result.image | string |
画像。 |
ID
|
result.recipient.identity | string |
ID。 |
ハッシュ済み
|
result.recipient.hashed | boolean |
ハッシュ済みかどうか。 |
種類
|
result.recipient.type | string |
種類。 |
プレーンテキスト ID
|
result.recipient.plaintextIdentity | string |
プレーンテキストの ID。 |
ソルト
|
result.recipient.salt | string |
ハッシュ化されているなら、そのソルト。 |
発行日
|
result.issuedOn | string |
発行された日付。 |
物語
|
result.narrative | string |
発行されたバッジの物語。 |
エビデンス
|
result.evidence | array of object | |
URL
|
result.evidence.url | string |
URL アドレス。 |
物語
|
result.evidence.narrative | string |
発行されたバッジの物語。 |
失効
|
result.revoked | boolean |
失効しているかどうか。 |
失効理由
|
result.revocationReason | string |
失効した理由。 |
承認
|
result.acceptance | string |
バッジが承認されたかどうか。 |
有効期限
|
result.expires | string |
バッジの有効期限。 |
拡張
|
result.extensions | string |
拡張機能。 |
BadgeClass 名
|
result.badgeclassName | string |
BadgeClass の名前。 |
単一のアサーションを取得する
アサーションを取得します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの識別子 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object |
結果の配列。 |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
オープン バッジ ID
|
result.openBadgeId | string |
オープン バッジの識別子。 |
作成日
|
result.createdAt | string |
作成された日時。 |
作成者
|
result.createdBy | string |
だれが作成したか。 |
BadgeClass
|
result.badgeclass | string |
獲得できるバッジの定義。 |
BadgeClass オープン バッジ ID
|
result.badgeclassOpenBadgeId | string |
BadgeClass のオープンバッジの識別子。 |
発行者
|
result.issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 |
発行者オープン バッジ ID
|
result.issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
画像
|
result.image | string |
画像。 |
ID
|
result.recipient.identity | string |
ID。 |
ハッシュ済み
|
result.recipient.hashed | boolean |
ハッシュ済みかどうか。 |
種類
|
result.recipient.type | string |
種類。 |
プレーンテキスト ID
|
result.recipient.plaintextIdentity | string |
プレーンテキストの ID。 |
ソルト
|
result.recipient.salt | string |
ハッシュ化されているなら、そのソルト。 |
発行日
|
result.issuedOn | string |
発行された日付。 |
物語
|
result.narrative | string |
発行されたバッジの物語。 |
エビデンス
|
result.evidence | array of object | |
URL
|
result.evidence.url | string |
URL アドレス。 |
物語
|
result.evidence.narrative | string |
発行されたバッジの物語。 |
失効
|
result.revoked | boolean |
失効しているかどうか。 |
失効理由
|
result.revocationReason | string |
失効した理由。 |
承認
|
result.acceptance | string |
バッジが承認されたかどうか。 |
有効期限
|
result.expires | string |
バッジの有効期限。 |
拡張
|
result.extensions | string |
拡張機能。 |
BadgeClass 名
|
result.badgeclassName | string |
BadgeClass の名前。 |
発行者 BadgeClass を作成する
発行者 BadgeClass を作成します。 認証されたユーザーは、発行者の所有者、エディター、またはスタッフのステータスを持っている必要があります。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの ID。 |
発行者
|
issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 。 |
|
発行者オープン バッジ ID
|
issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
|
名前
|
name | string |
名前。 |
|
画像
|
image | string |
画像。 |
|
説明
|
description | string |
説明。 |
|
実績の種類
|
achievementType | string |
実績の種類。 |
|
基準 URL
|
criteriaUrl | string |
基準の URL。 |
|
基準説明
|
criteriaNarrative | string |
基準の説明。 |
|
ターゲット名
|
targetName | string |
ターゲットの名前。 |
|
ターゲット URL
|
targetUrl | string |
ターゲットのURL。 |
|
ターゲット説明
|
targetDescription | string |
ターゲットの説明。 |
|
ターゲット フレームワーク
|
targetFramework | string |
ターゲットのフレームワーク。 |
|
ターゲット コード
|
targetCode | string |
ターゲットのコード。 |
|
タグ
|
tags | array of string | ||
量
|
amount | string |
量。 |
|
期間
|
duration | string |
期間。 |
|
拡張
|
extensions | string |
拡張機能。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object | |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
オープン バッジ ID
|
result.openBadgeId | string |
オープン バッジの識別子。 |
作成日
|
result.createdAt | string |
作成された日時。 |
作成者
|
result.createdBy | string |
だれが作成したか。 |
発行者
|
result.issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 |
発行者オープン バッジ ID
|
result.issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
名前
|
result.name | string |
名前。 |
画像
|
result.image | string |
画像。 |
説明
|
result.description | string |
説明。 |
実績の種類
|
result.achievementType | string |
実績の種類。 |
基準 URL
|
result.criteriaUrl | string |
基準の URL アドレス。 |
基準説明
|
result.criteriaNarrative | string |
基準の説明。 |
配列
|
result.alignments | array of object | |
ターゲット名
|
result.alignments.targetName | string |
ターゲットの名前。 |
ターゲット URL
|
result.alignments.targetUrl | string |
ターゲットの URL アドレス。 |
ターゲット説明
|
result.alignments.targetDescription | string |
ターゲットの説明。 |
ターゲット フレームワーク
|
result.alignments.targetFramework | string |
ターゲットのフレームワーク。 |
ターゲット コード
|
result.alignments.targetCode | string |
ターゲットのコード。 |
タグ
|
result.tags | array of string | |
量
|
result.expires.amount | string |
量。 |
期間
|
result.expires.duration | string |
期間。 |
拡張
|
result.extensions | string |
拡張機能。 |
発行者の BadgeClass を取得する
単一の発行者の BadgeClass の一覧を取得します。 認証されたユーザーは、発行者の所有者、エディター、またはスタッフのステータスを持っている必要があります。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの識別子 |
数
|
num | string |
結果のページ割りを要求します |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object | |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
オープン バッジ ID
|
result.openBadgeId | string |
オープン バッジの識別子。 |
作成日
|
result.createdAt | string |
作成された日時。 |
作成者
|
result.createdBy | string |
だれが作成したか。 |
発行者
|
result.issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 |
発行者オープン バッジ ID
|
result.issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
名前
|
result.name | string |
名前。 |
画像
|
result.image | string |
画像。 |
説明
|
result.description | string |
説明。 |
実績の種類
|
result.achievementType | string |
実績の種類。 |
基準 URL
|
result.criteriaUrl | string |
基準の URL アドレス。 |
基準説明
|
result.criteriaNarrative | string |
基準の説明。 |
配列
|
result.alignments | array of object | |
ターゲット名
|
result.alignments.targetName | string |
ターゲットの名前。 |
ターゲット URL
|
result.alignments.targetUrl | string |
ターゲットの URL アドレス。 |
ターゲット説明
|
result.alignments.targetDescription | string |
ターゲットの説明。 |
ターゲット フレームワーク
|
result.alignments.targetFramework | string |
ターゲットのフレームワーク。 |
ターゲット コード
|
result.alignments.targetCode | string |
ターゲットのコード。 |
タグ
|
result.tags | array of string | |
量
|
result.expires.amount | string |
量。 |
期間
|
result.expires.duration | string |
期間。 |
拡張
|
result.extensions | string |
拡張機能。 |
発行者を作成する
新しい発行者を作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
作成者
|
createdBy | string |
だれが作成したか。 |
|
名前
|
name | string |
名前。 |
|
画像
|
image | string |
画像。 |
|
電子メール
|
string |
電子メール アドレス。 |
||
説明
|
description | string |
説明。 |
|
URL
|
url | string |
URL アドレス。 |
|
エンティティの種類
|
entityType | string |
エンティティの種類。 |
|
エンティティ ID
|
entityId | string |
エンティティの ID。 |
|
ユーザー プロファイル
|
userProfile | string |
ユーザーのプロファイル。 |
|
ユーザー
|
user | string |
ユーザー。 |
|
ロール
|
role | string |
ロール。 |
|
拡張
|
extensions | string |
拡張機能。 |
|
Badgr ドメイン
|
badgrDomain | string |
Badgr のドメイン。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object | |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
オープン バッジ ID
|
result.openBadgeId | string |
オープン バッジの識別子。 |
作成日
|
result.createdAt | string |
作成された日時。 |
作成者
|
result.createdBy | string |
だれが作成したか。 |
名前
|
result.name | string |
名前。 |
画像
|
result.image | string |
画像。 |
電子メール
|
result.email | string |
電子メール アドレス。 |
説明
|
result.description | string |
説明。 |
URL
|
result.url | string |
URL アドレス。 |
スタッフ
|
result.staff | array of object | |
エンティティの種類
|
result.staff.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.staff.entityId | string |
エンティティの ID。 |
ユーザー プロファイル
|
result.staff.userProfile | string |
ユーザーのプロファイル。 |
ユーザー
|
result.staff.user | string |
ユーザー。 |
ロール
|
result.staff.role | string |
ロール。 |
拡張
|
result.extensions | string |
拡張機能。 |
Badgr ドメイン
|
result.badgrDomain | string |
Badgr のドメイン。 |
発行者を削除する
単一の発行者を削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの識別子 |
発行者を取得する
単一の発行者を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの識別子 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object |
結果の配列。 |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
オープン バッジ ID
|
result.openBadgeId | string |
オープン バッジの識別子。 |
作成日
|
result.createdAt | string |
作成された日時。 |
作成者
|
result.createdBy | string |
だれが作成したか。 |
名前
|
result.name | string |
名前。 |
画像
|
result.image | string |
画像。 |
電子メール
|
result.email | string |
電子メール アドレス。 |
説明
|
result.description | string |
説明。 |
URL
|
result.url | string |
URL アドレス。 |
スタッフ
|
result.staff | array of object | |
エンティティの種類
|
result.staff.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.staff.entityId | string |
エンティティの ID。 |
ユーザー プロファイル
|
result.staff.userProfile | string |
ユーザーのプロファイル。 |
ユーザー
|
result.staff.user | string |
ユーザー。 |
ロール
|
result.staff.role | string |
ロール。 |
拡張
|
result.extensions | string |
拡張機能。 |
Badgr ドメイン
|
result.badgrDomain | string |
Badgr のドメイン。 |
発行者を取得する
認証済みユーザーの発行者の一覧を取得します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object | |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
オープン バッジ ID
|
result.openBadgeId | string |
オープン バッジの識別子。 |
作成日
|
result.createdAt | string |
作成された日時。 |
作成者
|
result.createdBy | string |
だれが作成したか。 |
名前
|
result.name | string |
名前。 |
画像
|
result.image | string |
画像。 |
電子メール
|
result.email | string |
電子メール アドレス。 |
説明
|
result.description | string |
説明。 |
URL
|
result.url | string |
URL アドレス。 |
スタッフ
|
result.staff | array of object | |
エンティティの種類
|
result.staff.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.staff.entityId | string |
エンティティの ID。 |
エンティティの種類
|
result.staff.userProfile.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.staff.userProfile.entityId | string |
エンティティの識別子。 |
First Name
|
result.staff.userProfile.firstName | string |
名。 |
Last Name
|
result.staff.userProfile.lastName | string |
姓。 |
メール
|
result.staff.userProfile.emails | array of object | |
メール
|
result.staff.userProfile.emails.email | string |
メール アドレス。 |
認証済
|
result.staff.userProfile.emails.verified | boolean |
検証済みかどうか。 |
主要
|
result.staff.userProfile.emails.primary | boolean |
主要かどうか。 |
ケース バリアント
|
result.staff.userProfile.emails.caseVariants | array of string |
ケース バリアント。 |
URL
|
result.staff.userProfile.url | array of string |
URL アドレス。 |
電話番号
|
result.staff.userProfile.telephone | array of string |
電話番号。 |
Badgr ドメイン
|
result.staff.userProfile.badgrDomain | string |
Badgr ドメイン。 |
User
|
result.staff.user | string |
ユーザー。 |
役割
|
result.staff.role | string |
ロール。 |
拡張
|
result.extensions | string |
拡張機能。 |
Badgr ドメイン
|
result.badgrDomain | string |
Badgr のドメイン。 |
発行者を更新する
単一の発行者を更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの ID。 |
作成者
|
createdBy | string |
だれが作成したか。 |
|
名前
|
name | string |
名前。 |
|
画像
|
image | string |
画像。 |
|
電子メール
|
string |
電子メール アドレス。 |
||
説明
|
description | string |
説明。 |
|
URL
|
url | string |
URL アドレス。 |
|
エンティティの種類
|
entityType | string |
エンティティの種類。 |
|
エンティティ ID
|
entityId | string |
エンティティの ID。 |
|
ユーザー プロファイル
|
userProfile | string |
ユーザーのプロファイル。 |
|
ユーザー
|
user | string |
ユーザー。 |
|
ロール
|
role | string |
ロール。 |
|
拡張
|
extensions | string |
拡張機能。 |
|
Badgr ドメイン
|
badgrDomain | string |
Badgr のドメイン。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object |
結果の配列。 |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
オープン バッジ ID
|
result.openBadgeId | string |
オープン バッジの識別子。 |
作成日
|
result.createdAt | string |
作成された日時。 |
作成者
|
result.createdBy | string |
だれが作成したか。 |
名前
|
result.name | string |
名前。 |
画像
|
result.image | string |
画像。 |
電子メール
|
result.email | string |
電子メール アドレス。 |
説明
|
result.description | string |
説明。 |
URL
|
result.url | string |
URL アドレス。 |
スタッフ
|
result.staff | array of object | |
エンティティの種類
|
result.staff.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.staff.entityId | string |
エンティティの ID。 |
ユーザー プロファイル
|
result.staff.userProfile | string |
ユーザーのプロファイル。 |
ユーザー
|
result.staff.user | string |
ユーザー。 |
ロール
|
result.staff.role | string |
ロール。 |
拡張
|
result.extensions | string |
拡張機能。 |
Badgr ドメイン
|
result.badgrDomain | string |
Badgr のドメイン。 |
発行者トークンを取得する
複数の BadgeClass を発行する
複数の受信者に同じ BadgeClass のコピーを複数発行します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
エンティティ ID
|
entity_id | True | string |
エンティティの ID。 |
BadgeClass
|
badgeclass | string |
獲得できるバッジの定義。 |
|
BadgeClass オープン バッジ ID
|
badgeclassOpenBadgeId | string |
BadgeClass のオープンバッジの識別子。 |
|
発行者
|
issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 。 |
|
発行者オープン バッジ ID
|
issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
|
ID
|
identity | string |
ID。 |
|
ハッシュ済み
|
hashed | boolean |
ハッシュ済みかどうか。 |
|
種類
|
type | string |
種類。 |
|
プレーンテキスト ID
|
plaintextIdentity | string |
プレーンテキストの ID。 |
|
ソルト
|
salt | string |
ハッシュ化されているなら、そのソルト。 |
|
発行日
|
issuedOn | string |
発行された日付。 |
|
物語
|
narrative | string |
発行されたバッジの物語。 |
|
URL
|
url | string |
URL アドレス。 |
|
物語
|
narrative | string |
発行されたバッジの物語。 |
|
有効期限
|
expires | string |
有効期限。 |
|
拡張
|
extensions | string |
拡張機能。 |
|
BadgeClass 名
|
badgeclassName | string |
BadgeClass の名前。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object | |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
オープン バッジ ID
|
result.openBadgeId | string |
オープン バッジの識別子。 |
作成日
|
result.createdAt | string |
作成された日時。 |
作成者
|
result.createdBy | string |
だれが作成したか。 |
BadgeClass
|
result.badgeclass | string |
獲得できるバッジの定義。 |
BadgeClass オープン バッジ ID
|
result.badgeclassOpenBadgeId | string |
BadgeClass のオープンバッジの識別子。 |
発行者
|
result.issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 |
発行者オープン バッジ ID
|
result.issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
画像
|
result.image | string |
画像。 |
ID
|
result.recipient.identity | string |
ID。 |
ハッシュ済み
|
result.recipient.hashed | boolean |
ハッシュ済みかどうか。 |
種類
|
result.recipient.type | string |
種類。 |
プレーンテキスト ID
|
result.recipient.plaintextIdentity | string |
プレーンテキストの ID。 |
ソルト
|
result.recipient.salt | string |
ハッシュ化されているなら、そのソルト。 |
発行日
|
result.issuedOn | string |
発行された日付。 |
物語
|
result.narrative | string |
発行されたバッジの物語。 |
エビデンス
|
result.evidence | array of object | |
URL
|
result.evidence.url | string |
URL アドレス。 |
物語
|
result.evidence.narrative | string |
発行されたバッジの物語。 |
失効
|
result.revoked | boolean |
失効しているかどうか。 |
失効理由
|
result.revocationReason | string |
失効した理由。 |
承認
|
result.acceptance | string |
バッジが承認されたかどうか。 |
有効期限
|
result.expires | string |
バッジの有効期限。 |
拡張
|
result.extensions | string |
拡張機能。 |
BadgeClass 名
|
result.badgeclassName | string |
BadgeClass の名前。 |
複数のアサーションを取り消す
複数の受信者の複数のアサーションを取り消します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
BadgeClass
|
badgeclass | string |
獲得できるバッジの定義。 |
|
BadgeClass オープン バッジ ID
|
badgeclassOpenBadgeId | string |
BadgeClass のオープンバッジの識別子。 |
|
発行者
|
issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 。 |
|
発行者オープン バッジ ID
|
issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
|
ID
|
identity | string |
ID。 |
|
ハッシュ済み
|
hashed | boolean |
ハッシュ済みかどうか。 |
|
種類
|
type | string |
種類。 |
|
プレーンテキスト ID
|
plaintextIdentity | string |
プレーンテキストの ID。 |
|
ソルト
|
salt | string |
ハッシュ化されているなら、そのソルト。 |
|
発行日
|
issuedOn | string |
発行された日付。 |
|
物語
|
narrative | string |
発行されたバッジの物語。 |
|
URL
|
url | string |
URL アドレス。 |
|
物語
|
narrative | string |
発行されたバッジの物語。 |
|
有効期限
|
expires | string |
有効期限。 |
|
拡張
|
extensions | string |
拡張機能。 |
|
BadgeClass 名
|
badgeclassName | string |
BadgeClass の名前。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
説明
|
status.description | string |
説明。 |
成功
|
status.success | boolean |
成功したかどうか。 |
結果
|
result | array of object | |
エンティティの種類
|
result.entityType | string |
エンティティの種類。 |
エンティティ ID
|
result.entityId | string |
エンティティの ID。 |
オープン バッジ ID
|
result.openBadgeId | string |
オープン バッジの識別子。 |
作成日
|
result.createdAt | string |
作成された日時。 |
作成者
|
result.createdBy | string |
だれが作成したか。 |
BadgeClass
|
result.badgeclass | string |
獲得できるバッジの定義。 |
BadgeClass オープン バッジ ID
|
result.badgeclassOpenBadgeId | string |
BadgeClass のオープンバッジの識別子。 |
発行者
|
result.issuer | string |
獲得者にバッジを作成 / 提供して発行する個人または組織。 |
発行者オープン バッジ ID
|
result.issuerOpenBadgeId | string |
発行者のオープン バッジの識別子。 |
画像
|
result.image | string |
画像。 |
ID
|
result.recipient.identity | string |
ID。 |
ハッシュ済み
|
result.recipient.hashed | boolean |
ハッシュ済みかどうか。 |
種類
|
result.recipient.type | string |
種類。 |
プレーンテキスト ID
|
result.recipient.plaintextIdentity | string |
プレーンテキストの ID。 |
ソルト
|
result.recipient.salt | string |
ハッシュ化されているなら、そのソルト。 |
発行日
|
result.issuedOn | string |
発行された日付。 |
物語
|
result.narrative | string |
発行されたバッジの物語。 |
エビデンス
|
result.evidence | array of object | |
URL
|
result.evidence.url | string |
URL アドレス。 |
物語
|
result.evidence.narrative | string |
発行されたバッジの物語。 |
失効
|
result.revoked | boolean |
失効しているかどうか。 |
失効理由
|
result.revocationReason | string |
失効した理由。 |
承認
|
result.acceptance | string |
バッジが承認されたかどうか。 |
有効期限
|
result.expires | string |
バッジの有効期限。 |
拡張
|
result.extensions | string |
拡張機能。 |
BadgeClass 名
|
result.badgeclassName | string |
BadgeClass の名前。 |