Badgr (Independent Publisher)

Organizations around the world use Badgr to create branded learning ecosystems that support their communities with skills-based digital credentials, stackable learning pathways, and portable learner records.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following:      -   Azure Government regions      -   Azure China regions      -   US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)

Contact
Name	Troy Taylor
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

Connector Metadata
Publisher	Troy Taylor, Hitachi Solutions
Website	https://badgr.com
Privacy policy	https://info.badgr.com/privacy-policy.html
Categories	Human Resources

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Create a BadgeClass	Create a new BadgeClass.
Create a BadgeUser account	Make a BadgeUser account and profile.
Create a Collection	Create a new Collection.
Create a Issuer	Create a new Issuer.
Create an Issuer's BadgeClass	Create a new BadgeClass associated with an Issuer. Authenticated user must have owner, editor, or staff status on the Issuer.
Delete a BadgeClass	Delete a BadgeClass. Restricted to owners or editors (not staff) of the corresponding Issuer.
Delete a collection	Delete a collection from a backpack.
Delete an Issuer	Delete a single Issuer.
Get a BadgeClass	Get a single BadgeClass.
Get a BadgeUser's profile	Get a single BadgeUser profile. Use the entityId 'self' to retrieve the authenticated user's profile.
Get a Collection	Get a single Collection.
Get a single Assertion	Get an Assertion
Get an AccessToken	Get a single AccessToken.
Get an Issuer	Get a single Issuer.
Get Assertions	Get a list of Assertions for a single Issuer.
Get Assertions in a user's backpack	Get a list of Assertions in authenticated user's backpack.
Get Backpack Assertion details	Get details on an Assertion in a user's Backpack.
Get BadgeClass's Assertions	Get a list of Assertions for a single BadgeClass.
Get Collections	Get a list of Collections.
Get Issuer's BadgeClasses	Get a list of BadgeClasses for a single Issuer. Authenticated user must have owner, editor, or staff status on the Issuer.
Get Issuers	Get a list of Issuers for authenticated user.
Get user's access tokens	Get a list of access tokens for authenticated user.
Get user's BadgeClasses	Get a list of BadgeClasses for authenticated user.
Import a Assertion to backpack	Import a new Assertion to a user's backpack.
Issue an Assertion	Issue a new Assertion to a recipient.
Issue an Assertion	Issue an Assertion to a single recipient.
Issue multiple BadgeClass	Issue multiple copies of the same BadgeClass to multiple recipients.
Recover an account	Recover an account and set a new password.
Remove an assertion from backpack	Remove an assertion from a user's backpack.
Request an account recovery email	Request an account recovery email for a user.
Retrieve issuer tokens	Retrieve issuer tokens.
Revoke an AccessToken	Revoke a user's AccessToken.
Revoke an Assertion	Revoke an Assertion.
Revoke multiple Assertions	Revoke multiple Assertions for multiple recipients.
Update a BadgeClass	Update an existing BadgeClass. Previously issued BadgeInstances will not be updated.
Update a BadgeUser	Update a BadgeUser's account. Use the entityId 'self' to update the authenticated user's profile
Update a Collection	Update a Collection in a backpack.
Update an Assertion	Update an Assertion.
Update an Issuer	Update a single Issuer.
Update Assertion acceptance in Backpack	Update acceptance of an Assertion in a user's Backpack.
Upload a Assertion to backpack	Upload a new Assertion to a user's backpack.

Create a BadgeClass

Operation ID:

ClassCreate

Create a new BadgeClass.

Parameters

Name	Key	Required	Type	Description
Number	num		integer	Request pagination of results
Issuer	issuer		string	The person or organization who creates/ offers badges and issues them to earners. .
Issuer Open Badge ID	issuerOpenBadgeId		string	The identifier of the issuer's Open Badge.
Name	name		string	The name.
Image	image		string	The image.
Description	description		string	The description.
Achievement Type	achievementType		string	The type of achievement.
Criteria URL	criteriaUrl		string	The URL of the criteria.
Criteria Narrative	criteriaNarrative		string	The narrative of the criteria.
Target Name	targetName		string	The name of the target.
Target URL	targetUrl		string	The URL of the target.
Target Description	targetDescription		string	The description of the target.
Target Framework	targetFramework		string	The framework of the target.
Target Code	targetCode		string	The code of the target.
Tags	tags		array of string
Amount	amount		string	The amount.
Duration	duration		string	The duration.
Extensions	extensions		string	The extensions.

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
result	result	array of object
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Open Badge ID	result.openBadgeId	string	The identifier of the Open Badge.
Created At	result.createdAt	string	When created at.
Created By	result.createdBy	string	Whom created by.
Issuer	result.issuer	string	The person or organization who creates/ offers badges and issues them to earners.
Issuer Open Badge ID	result.issuerOpenBadgeId	string	The identifier of the issuer's Open Badge.
Name	result.name	string	The name.
Image	result.image	string	The image.
Description	result.description	string	The description.
Achievement Type	result.achievementType	string	The type of achievement.
Criteria URL	result.criteriaUrl	string	The URL address of the criteria.
Criteria Narrative	result.criteriaNarrative	string	The narrative of the criteria.
Alignments	result.alignments	array of object
Target Name	result.alignments.targetName	string	The name of the target.
Target URL	result.alignments.targetUrl	string	The URL address of the target.
Target Description	result.alignments.targetDescription	string	The description of the target.
Target Framework	result.alignments.targetFramework	string	The framework of the target.
Target Code	result.alignments.targetCode	string	The code of the target.
Tags	result.tags	array of string
Amount	result.expires.amount	string	The amount.
Duration	result.expires.duration	string	The duration.
Extensions	result.extensions	string	The extensions.

Create a BadgeUser account

Operation ID:

UserCreate

Make a BadgeUser account and profile.

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity.
Entity Type	entityType		string	The type of entity.
Entity ID	entityId		string	The identifier of the entity.
First Name	firstName		string	The first name.
Last Name	lastName		string	The last name.
Entity Type	entityType		string	The type of entity.
Entity ID	entityId		string	The identifier of the entity.
Email	email		string	The email address.
Verified	verified		boolean	Whether verified.
Primary	primary		boolean	Whether primary.
Case Variants	caseVariants		string	The case variants.
URL	url		string	The URL address.
Telephone	telephone		string	The telephone number.
Agreed Terms Version	agreedTermsVersion		string	The version of the agreed terms.
Has Agreed To Latest Terms Version	hasAgreedToLatestTermsVersion		string	The version of latest terms agreed.
Marketing Opt In	marketingOptIn		string	Has opted in to marketing.
Badgr Domain	badgrDomain		string	The domain of Badgr.
Has Password Set	hasPasswordSet		string	Has password set.
Recipient	recipient		string	The recipient.

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
result	result	array of object
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
First Name	result.firstName	string	The first name.
Last Name	result.lastName	string	The last name.
Emails	result.emails	array of object
Entity Type	result.emails.entityType	string	The type of the entity.
Entity ID	result.emails.entityId	string	The identifier of the entity.
Email	result.emails.email	string	The email address.
Verified	result.emails.verified	boolean	Whether verified.
Primary	result.emails.primary	boolean	Whether primary.
Case Variants	result.emails.caseVariants	string	The case variants.
URL	result.url	string	The URL address.
Telephone	result.telephone	string	The telephone number.
Agreed Terms Version	result.agreedTermsVersion	string	The version of the terms aggreed.
Has Agreed To Latest Terms Version	result.hasAgreedToLatestTermsVersion	string	The version of the laterst terms aggree.
Marketing Opt In	result.marketingOptIn	string	Agreed to marketing opt-in.
Badgr Domain	result.badgrDomain	string	The domain of Badgr.
Has Password Set	result.hasPasswordSet	string	If has password set.
Recipient	result.recipient	string	The recipient.

Create a Collection

Operation ID:

CollectionCreate

Create a new Collection.

Parameters

Name	Key	Required	Type	Description
Entity Type	entityType		string	The type of entity.
Entity ID	entityId		string	The identifier of the entity.
Name	name		string	The name.
Description	description		string	The description.
Owner	owner		string	The owner.
Share URL	share_url		string	The URL address of the share.
Share Hash	shareHash		string	The hash of the share.
Published	published		boolean	Whether published.
BadgeClass	badgeclass		string	The definition of an earnable badge.
BadgeClass Open Badge ID	badgeclassOpenBadgeId		string	The identifier of the BadgeClass's Open Badge.
Issuer	issuer		string	The person or organization who creates/ offers badges and issues them to earners.
Issuer Open Badge ID	issuerOpenBadgeId		string	The identifier of the issuer's Open Badge.
Identity	identity		string	The identity.
Hashed	hashed		boolean	Whether hashed.
Type	type		string	The type.
Plaintext Identity	plaintextIdentity		string	The identity in plaintext.
Salt	salt		string	If hashed, the salt.
Issued On	issuedOn		string	When issued on.
Narrative	narrative		string	The narrative for the badge issued.
URL	url		string	The URL address.
Narrative	narrative		string	The narrative for the badge issued.
Expires	expires		string	When the badge expires.
Extensions	extensions		string	The extensions.
BadgeClass Name	badgeclassName		string	The name of the BadgeClass.
Created At	createdAt		string	Created at.
Created By	createdBy		string	Whom created by.

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
result	result	array of object
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Name	result.name	string	The name.
Description	result.description	string	The description.
Owner	result.owner	string	The owner.
Share URL	result.share_url	string	The URL address of the share.
Share Hash	result.shareHash	string	The hash of the share.
Published	result.published	boolean	Whether published.
Assertions	result.assertions	array of object
Entity Type	result.assertions.entityType	string	The type of the entity.
Entity ID	result.assertions.entityId	string	The identifier of the entity.
Open Badge ID	result.assertions.openBadgeId	string	The identifier of the Open Badge.
Created At	result.assertions.createdAt	string	When created at.
Created By	result.assertions.createdBy	string	Created by.
BadgeClass	result.assertions.badgeclass	string	The BadgeClass.
BadgeClass Open Badge ID	result.assertions.badgeclassOpenBadgeId	string	The identifier of the BadgeClass's Open Badge.
Issuer	result.assertions.issuer	string	The issuer.
Issuer Open Badge ID	result.assertions.issuerOpenBadgeId	string	The identifier of the issuer's Open Badge.
Image	result.assertions.image	string	The image.
Identity	result.assertions.recipient.identity	string	The identity.
Hashed	result.assertions.recipient.hashed	boolean	Whether hashed.
Type	result.assertions.recipient.type	string	The type.
Plaintext Identity	result.assertions.recipient.plaintextIdentity	string	The identity in plaintext.
Salt	result.assertions.recipient.salt	string	If hashed, the salt.
Issued On	result.assertions.issuedOn	string	When issued on.
Narrative	result.assertions.narrative	string	The narrative for the badge issued.
Evidence	result.assertions.evidence	array of object
URL	result.assertions.evidence.url	string	The URL address.
Narrative	result.assertions.evidence.narrative	string	The narrative.
Revoked	result.assertions.revoked	boolean	Whether revoked.
Revocation Reason	result.assertions.revocationReason	string	The reason for revocation.
Acceptance	result.assertions.acceptance	string	The acceptance.
Expires	result.assertions.expires	string	When expires.
Extensions	result.assertions.extensions	string	The extensions.
BadgeClass Name	result.assertions.badgeclassName	string	The name of the BadgeClass.
Created At	result.createdAt	string	When created at.
Created By	result.createdBy	string	Whom created by.

Create a Issuer

Operation ID:

IssuerCreate

Create a new Issuer.

Parameters

Name	Key	Required	Type	Description
Created By	createdBy		string	Whom created by.
Name	name		string	The name.
Image	image		string	The image.
Email	email		string	The email address.
Description	description		string	The description.
URL	url		string	The URL address.
Entity Type	entityType		string	The type of entity.
Entity ID	entityId		string	The identifier of the entity.
User Profile	userProfile		string	The profile of the user.
User	user		string	The user.
Role	role		string	The role.
Extensions	extensions		string	The extensions.
Badgr Domain	badgrDomain		string	The domain of Badgr.

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
result	result	array of object
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Open Badge ID	result.openBadgeId	string	The identifier of the Open Badge.
Created At	result.createdAt	string	When created at.
Created By	result.createdBy	string	Whom created by.
Name	result.name	string	The name.
Image	result.image	string	The image.
Email	result.email	string	The email address.
Description	result.description	string	The description.
URL	result.url	string	The URL address.
Staff	result.staff	array of object
Entity Type	result.staff.entityType	string	The type of the entity.
Entity ID	result.staff.entityId	string	The identifier of the entity.
User Profile	result.staff.userProfile	string	The profile of the user.
User	result.staff.user	string	The user.
Role	result.staff.role	string	The role.
Extensions	result.extensions	string	The extensions.
Badgr Domain	result.badgrDomain	string	The domain of Badgr.

Create an Issuer's BadgeClass

Operation ID:

ClassCreateIssuer

Create a new BadgeClass associated with an Issuer. Authenticated user must have owner, editor, or staff status on the Issuer.

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity.
Issuer	issuer		string	The person or organization who creates/ offers badges and issues them to earners. .
Issuer Open Badge ID	issuerOpenBadgeId		string	The identifier of the issuer's Open Badge.
Name	name		string	The name.
Image	image		string	The image.
Description	description		string	The description.
Achievement Type	achievementType		string	The type of achievement.
Criteria URL	criteriaUrl		string	The URL of the criteria.
Criteria Narrative	criteriaNarrative		string	The narrative of the criteria.
Target Name	targetName		string	The name of the target.
Target URL	targetUrl		string	The URL of the target.
Target Description	targetDescription		string	The description of the target.
Target Framework	targetFramework		string	The framework of the target.
Target Code	targetCode		string	The code of the target.
Tags	tags		array of string
Amount	amount		string	The amount.
Duration	duration		string	The duration.
Extensions	extensions		string	The extensions.

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
result	result	array of object
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Open Badge ID	result.openBadgeId	string	The identifier of the Open Badge.
Created At	result.createdAt	string	When created at.
Created By	result.createdBy	string	Whom created by.
Issuer	result.issuer	string	The person or organization who creates/ offers badges and issues them to earners.
Issuer Open Badge ID	result.issuerOpenBadgeId	string	The identifier of the issuer's Open Badge.
Name	result.name	string	The name.
Image	result.image	string	The image.
Description	result.description	string	The description.
Achievement Type	result.achievementType	string	The type of achievement.
Criteria URL	result.criteriaUrl	string	The URL address of the criteria.
Criteria Narrative	result.criteriaNarrative	string	The narrative of the criteria.
Alignments	result.alignments	array of object
Target Name	result.alignments.targetName	string	The name of the target.
Target URL	result.alignments.targetUrl	string	The URL address of the target.
Target Description	result.alignments.targetDescription	string	The description of the target.
Target Framework	result.alignments.targetFramework	string	The framework of the target.
Target Code	result.alignments.targetCode	string	The code of the target.
Tags	result.tags	array of string
Amount	result.expires.amount	string	The amount.
Duration	result.expires.duration	string	The duration.
Extensions	result.extensions	string	The extensions.

Delete a BadgeClass

Operation ID:

ClassDelete

Delete a BadgeClass. Restricted to owners or editors (not staff) of the corresponding Issuer.

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity

Delete a collection

Operation ID:

CollectionDelete

Delete a collection from a backpack.

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity

Delete an Issuer

Operation ID:

IssuerDelete

Delete a single Issuer.

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity

Get a BadgeClass

Operation ID:

ClassGet

Get a single BadgeClass.

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
Results	result	array of object	The array of results.
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Open Badge ID	result.openBadgeId	string	The identifier of the Open Badge.
Created At	result.createdAt	string	When created at.
Created By	result.createdBy	string	Whom created by.
Issuer	result.issuer	string	The person or organization who creates/ offers badges and issues them to earners.
Issuer Open Badge ID	result.issuerOpenBadgeId	string	The identifier of the issuer's Open Badge.
Name	result.name	string	The name.
Image	result.image	string	The image.
Description	result.description	string	The description.
Achievement Type	result.achievementType	string	The type of achievement.
Criteria URL	result.criteriaUrl	string	The URL address of the criteria.
Criteria Narrative	result.criteriaNarrative	string	The narrative of the criteria.
Alignments	result.alignments	array of object
Target Name	result.alignments.targetName	string	The name of the target.
Target URL	result.alignments.targetUrl	string	The URL address of the target.
Target Description	result.alignments.targetDescription	string	The description of the target.
Target Framework	result.alignments.targetFramework	string	The framework of the target.
Target Code	result.alignments.targetCode	string	The code of the target.
Tags	result.tags	array of string
Amount	result.expires.amount	string	The amount.
Duration	result.expires.duration	string	The duration.
Extensions	result.extensions	string	The extensions.

Get a BadgeUser's profile

Operation ID:

UserGetProfile

Get a single BadgeUser profile. Use the entityId 'self' to retrieve the authenticated user's profile.

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
Results	result	array of object	The array of results.
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
First Name	result.firstName	string	The first name.
Last Name	result.lastName	string	The last name.
Emails	result.emails	array of object
Entity Type	result.emails.entityType	string	The type of the entity.
Entity ID	result.emails.entityId	string	The identifier of the entity.
Email	result.emails.email	string	The email address.
Verified	result.emails.verified	boolean	Whether verified.
Primary	result.emails.primary	boolean	Whether primary.
Case Variants	result.emails.caseVariants	string	The case variants.
URL	result.url	string	The URL address.
Telephone	result.telephone	string	The telephone number.
Agreed Terms Version	result.agreedTermsVersion	string	The version of the terms aggreed.
Has Agreed To Latest Terms Version	result.hasAgreedToLatestTermsVersion	string	The version of the laterst terms aggree.
Marketing Opt In	result.marketingOptIn	string	Agreed to marketing opt-in.
Badgr Domain	result.badgrDomain	string	The domain of Badgr.
Has Password Set	result.hasPasswordSet	string	If has password set.
Recipient	result.recipient	string	The recipient.

Get a Collection

Operation ID:

CollectionGetA

Get a single Collection.

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
Results	result	array of object	The array of results.
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Name	result.name	string	The name.
Description	result.description	string	The description.
Owner	result.owner	string	The owner.
Share URL	result.share_url	string	The URL address of the share.
Share Hash	result.shareHash	string	The hash of the share.
Published	result.published	boolean	Whether published.
Assertions	result.assertions	array of object
Entity Type	result.assertions.entityType	string	The type of the entity.
Entity ID	result.assertions.entityId	string	The identifier of the entity.
Open Badge ID	result.assertions.openBadgeId	string	The identifier of the Open Badge.
Created At	result.assertions.createdAt	string	When created at.
Created By	result.assertions.createdBy	string	Created by.
BadgeClass	result.assertions.badgeclass	string	The BadgeClass.
BadgeClass Open Badge ID	result.assertions.badgeclassOpenBadgeId	string	The identifier of the BadgeClass's Open Badge.
Issuer	result.assertions.issuer	string	The issuer.
Issuer Open Badge ID	result.assertions.issuerOpenBadgeId	string	The identifier of the issuer's Open Badge.
Image	result.assertions.image	string	The image.
Identity	result.assertions.recipient.identity	string	The identity.
Hashed	result.assertions.recipient.hashed	boolean	Whether hashed.
Type	result.assertions.recipient.type	string	The type.
Plaintext Identity	result.assertions.recipient.plaintextIdentity	string	The identity in plaintext.
Salt	result.assertions.recipient.salt	string	If hashed, the salt.
Issued On	result.assertions.issuedOn	string	When issued on.
Narrative	result.assertions.narrative	string	The narrative for the badge issued.
Evidence	result.assertions.evidence	array of object
URL	result.assertions.evidence.url	string	The URL address.
Narrative	result.assertions.evidence.narrative	string	The narrative.
Revoked	result.assertions.revoked	boolean	Whether revoked.
Revocation Reason	result.assertions.revocationReason	string	The reason for revocation.
Acceptance	result.assertions.acceptance	string	The acceptance.
Expires	result.assertions.expires	string	When expires.
Extensions	result.assertions.extensions	string	The extensions.
BadgeClass Name	result.assertions.badgeclassName	string	The name of the BadgeClass.
Created At	result.createdAt	string	When created at.
Created By	result.createdBy	string	Whom created by.

Get a single Assertion

Operation ID:

AssertionGetA

Get an Assertion

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
Results	result	array of object	The array of results.
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Open Badge ID	result.openBadgeId	string	The identifier of the Open Badge.
Created At	result.createdAt	string	When created at.
Created By	result.createdBy	string	Whom created by.
BadgeClass	result.badgeclass	string	The definition of an earnable badge.
BadgeClass Open Badge ID	result.badgeclassOpenBadgeId	string	The identifier of the BadgeClass's Open Badge.
Issuer	result.issuer	string	The person or organization who creates/ offers badges and issues them to earners.
Issuer Open Badge ID	result.issuerOpenBadgeId	string	The identifier of the issuer's Open Badge.
Image	result.image	string	The image.
Identity	result.recipient.identity	string	The identity.
Hashed	result.recipient.hashed	boolean	Whether hashed.
Type	result.recipient.type	string	The type.
Plaintext Identity	result.recipient.plaintextIdentity	string	The identity in plaintext.
Salt	result.recipient.salt	string	If hashed, the salt.
Issued On	result.issuedOn	string	When issued on.
Narrative	result.narrative	string	The narrative for the badge issued.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	The URL address.
Narrative	result.evidence.narrative	string	The narrative for the badge issued.
Revoked	result.revoked	boolean	Whether revoked.
Revocation Reason	result.revocationReason	string	The reason for revocation.
Acceptance	result.acceptance	string	When the badge was accepted.
Expires	result.expires	string	When the badge expires.
Extensions	result.extensions	string	The extensions.
BadgeClass Name	result.badgeclassName	string	The name of the BadgeClass.

Get an AccessToken

Operation ID:

TokenGetA

Get a single AccessToken.

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
result	result	AccessToken

Get an Issuer

Operation ID:

IssuerGetA

Get a single Issuer.

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
Results	result	array of object	The array of results.
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Open Badge ID	result.openBadgeId	string	The identifier of the Open Badge.
Created At	result.createdAt	string	When created at.
Created By	result.createdBy	string	Whom created by.
Name	result.name	string	The name.
Image	result.image	string	The image.
Email	result.email	string	The email address.
Description	result.description	string	The description.
URL	result.url	string	The URL address.
Staff	result.staff	array of object
Entity Type	result.staff.entityType	string	The type of the entity.
Entity ID	result.staff.entityId	string	The identifier of the entity.
User Profile	result.staff.userProfile	string	The profile of the user.
User	result.staff.user	string	The user.
Role	result.staff.role	string	The role.
Extensions	result.extensions	string	The extensions.
Badgr Domain	result.badgrDomain	string	The domain of Badgr.

Get Assertions

Operation ID:

AssertionGet

Get a list of Assertions for a single Issuer.

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity
Recipient	recipient		string	A recipient identifier to filter by
Number	num		string	Request pagination of results
Include Expired	include_expired		boolean	Include expired assertions
Include Revoked	include_revoked		boolean	Include revoked assertions

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
result	result	array of object
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Open Badge ID	result.openBadgeId	string	The identifier of the Open Badge.
Created At	result.createdAt	string	When created at.
Created By	result.createdBy	string	Whom created by.
BadgeClass	result.badgeclass	string	The definition of an earnable badge.
BadgeClass Open Badge ID	result.badgeclassOpenBadgeId	string	The identifier of the BadgeClass's Open Badge.
Issuer	result.issuer	string	The person or organization who creates/ offers badges and issues them to earners.
Issuer Open Badge ID	result.issuerOpenBadgeId	string	The identifier of the issuer's Open Badge.
Image	result.image	string	The image.
Identity	result.recipient.identity	string	The identity.
Hashed	result.recipient.hashed	boolean	Whether hashed.
Type	result.recipient.type	string	The type.
Plaintext Identity	result.recipient.plaintextIdentity	string	The identity in plaintext.
Salt	result.recipient.salt	string	If hashed, the salt.
Issued On	result.issuedOn	string	When issued on.
Narrative	result.narrative	string	The narrative for the badge issued.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	The URL address.
Narrative	result.evidence.narrative	string	The narrative for the badge issued.
Revoked	result.revoked	boolean	Whether revoked.
Revocation Reason	result.revocationReason	string	The reason for revocation.
Acceptance	result.acceptance	string	When the badge was accepted.
Expires	result.expires	string	When the badge expires.
Extensions	result.extensions	string	The extensions.
BadgeClass Name	result.badgeclassName	string	The name of the BadgeClass.

Get Assertions in a user's backpack

Operation ID:

BackpackGetAssertion

Get a list of Assertions in authenticated user's backpack.

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
result	result	array of object
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Open Badge ID	result.openBadgeId	string	The identifier of the Open Badge.
Created At	result.createdAt	string	When created at.
Created By	result.createdBy	string	Whom created by.
BadgeClass	result.badgeclass	string	The definition of an earnable badge.
BadgeClass Open Badge ID	result.badgeclassOpenBadgeId	string	The identifier of the BadgeClass's Open Badge.
Issuer	result.issuer	string	The person or organization who creates/ offers badges and issues them to earners.
Issuer Open Badge ID	result.issuerOpenBadgeId	string	The identifier of the issuer's Open Badge.
Image	result.image	string	The image.
Identity	result.recipient.identity	string	The identity.
Hashed	result.recipient.hashed	boolean	Whether hashed.
Type	result.recipient.type	string	The type.
Plaintext Identity	result.recipient.plaintextIdentity	string	The identity in plaintext.
Salt	result.recipient.salt	string	If hashed, the salt.
Issued On	result.issuedOn	string	When issued on.
Narrative	result.narrative	string	The narrative for the badge issued.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	The URL address.
Narrative	result.evidence.narrative	string	The narrative for the badge issued.
Revoked	result.revoked	boolean	Whether revoked.
Revocation Reason	result.revocationReason	string	The reason for revocation.
Acceptance	result.acceptance	string	When the badge was accepted.
Expires	result.expires	string	When the badge expires.
Extensions	result.extensions	string	The extensions.
BadgeClass Name	result.badgeclassName	string	The name of the BadgeClass.

Get Backpack Assertion details

Operation ID:

BackpackGetAssertionDetails

Get details on an Assertion in a user's Backpack.

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
Results	result	array of object	The array of results.
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Acceptance	result.acceptance	string	When the badge was accepted.
Open Badge ID	result.openBadgeId	string	The identifier of the Open Badge.
BadgeClass	result.badgeclass	string	The definition of an earnable badge.
BadgeClass Open Badge ID	result.badgeclassOpenBadgeId	string	The identifier of the BadgeClass's Open Badge.
Issuer	result.issuer	string	The person or organization who creates/ offers badges and issues them to earners.
Issuer Open Badge ID	result.issuerOpenBadgeId	string	The identifier of the issuer's Open Badge.
Image	result.image	string	The image.
Identity	result.recipient.identity	string	The identity.
Type	result.recipient.type	string	The type.
Hashed	result.recipient.hashed	boolean	Whether hashed.
Plaintext Identity	result.recipient.plaintextIdentity	string	The identity in plaintext.
Issued On	result.issuedOn	string	When issued on.
Narrative	result.narrative	string	The narrative for the badge issued.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	The URL address.
Narrative	result.evidence.narrative	string	The narrative for the badge issued.
Revoked	result.revoked	boolean	Whether revoked.
Revocation Reason	result.revocationReason	string	The reason for revocation.
Expires	result.expires	string	When the badge expires.
Pending	result.pending	string	Pending.

Get BadgeClass's Assertions

Operation ID:

ClassGetAssertion

Get a list of Assertions for a single BadgeClass.

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity
Recipient	recipient		string	A recipient identifier to filter by
Number	num		string	Request pagination of results
Include Expired	include_expired		boolean	Include expired assertions
Include Revoked	include_revoked		boolean	Include revoked assertions

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
result	result	array of object
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Open Badge ID	result.openBadgeId	string	The identifier of the Open Badge.
Created At	result.createdAt	string	When created at.
Created By	result.createdBy	string	Whom created by.
BadgeClass	result.badgeclass	string	The definition of an earnable badge.
BadgeClass Open Badge ID	result.badgeclassOpenBadgeId	string	The identifier of the BadgeClass's Open Badge.
Issuer	result.issuer	string	The person or organization who creates/ offers badges and issues them to earners.
Issuer Open Badge ID	result.issuerOpenBadgeId	string	The identifier of the issuer's Open Badge.
Image	result.image	string	The image.
Identity	result.recipient.identity	string	The identity.
Hashed	result.recipient.hashed	boolean	Whether hashed.
Type	result.recipient.type	string	The type.
Plaintext Identity	result.recipient.plaintextIdentity	string	The identity in plaintext.
Salt	result.recipient.salt	string	If hashed, the salt.
Issued On	result.issuedOn	string	When issued on.
Narrative	result.narrative	string	The narrative for the badge issued.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	The URL address.
Narrative	result.evidence.narrative	string	The narrative for the badge issued.
Revoked	result.revoked	boolean	Whether revoked.
Revocation Reason	result.revocationReason	string	The reason for revocation.
Acceptance	result.acceptance	string	When the badge was accepted.
Expires	result.expires	string	When the badge expires.
Extensions	result.extensions	string	The extensions.
BadgeClass Name	result.badgeclassName	string	The name of the BadgeClass.

Get Collections

Operation ID:

CollectionGet

Get a list of Collections.

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
Results	result	array of object	The array of results.
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Name	result.name	string	The name.
Description	result.description	string	The description.
Owner	result.owner	string	The owner.
Share URL	result.share_url	string	The URL address of the share.
Share Hash	result.shareHash	string	The hash of the share.
Published	result.published	boolean	Whether published.
Assertions	result.assertions	array of object
Entity Type	result.assertions.entityType	string	The type of the entity.
Entity ID	result.assertions.entityId	string	The identifier of the entity.
Open Badge ID	result.assertions.openBadgeId	string	The identifier of the Open Badge.
Created At	result.assertions.createdAt	string	When created at.
Created By	result.assertions.createdBy	string	Created by.
BadgeClass	result.assertions.badgeclass	string	The BadgeClass.
BadgeClass Open Badge ID	result.assertions.badgeclassOpenBadgeId	string	The identifier of the BadgeClass's Open Badge.
Issuer	result.assertions.issuer	string	The issuer.
Issuer Open Badge ID	result.assertions.issuerOpenBadgeId	string	The identifier of the issuer's Open Badge.
Image	result.assertions.image	string	The image.
Identity	result.assertions.recipient.identity	string	The identity.
Hashed	result.assertions.recipient.hashed	boolean	Whether hashed.
Type	result.assertions.recipient.type	string	The type.
Plaintext Identity	result.assertions.recipient.plaintextIdentity	string	The identity in plaintext.
Salt	result.assertions.recipient.salt	string	If hashed, the salt.
Issued On	result.assertions.issuedOn	string	When issued on.
Narrative	result.assertions.narrative	string	The narrative for the badge issued.
Evidence	result.assertions.evidence	array of object
URL	result.assertions.evidence.url	string	The URL address.
Narrative	result.assertions.evidence.narrative	string	The narrative.
Revoked	result.assertions.revoked	boolean	Whether revoked.
Revocation Reason	result.assertions.revocationReason	string	The reason for revocation.
Acceptance	result.assertions.acceptance	string	The acceptance.
Expires	result.assertions.expires	string	When expires.
Extensions	result.assertions.extensions	string	The extensions.
BadgeClass Name	result.assertions.badgeclassName	string	The name of the BadgeClass.
Created At	result.createdAt	string	When created at.
Created By	result.createdBy	string	Whom created by.

Get Issuer's BadgeClasses

Operation ID:

ClassGetIssuer

Get a list of BadgeClasses for a single Issuer. Authenticated user must have owner, editor, or staff status on the Issuer.

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity
Number	num		string	Request pagination of results

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
result	result	array of object
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Open Badge ID	result.openBadgeId	string	The identifier of the Open Badge.
Created At	result.createdAt	string	When created at.
Created By	result.createdBy	string	Whom created by.
Issuer	result.issuer	string	The person or organization who creates/ offers badges and issues them to earners.
Issuer Open Badge ID	result.issuerOpenBadgeId	string	The identifier of the issuer's Open Badge.
Name	result.name	string	The name.
Image	result.image	string	The image.
Description	result.description	string	The description.
Achievement Type	result.achievementType	string	The type of achievement.
Criteria URL	result.criteriaUrl	string	The URL address of the criteria.
Criteria Narrative	result.criteriaNarrative	string	The narrative of the criteria.
Alignments	result.alignments	array of object
Target Name	result.alignments.targetName	string	The name of the target.
Target URL	result.alignments.targetUrl	string	The URL address of the target.
Target Description	result.alignments.targetDescription	string	The description of the target.
Target Framework	result.alignments.targetFramework	string	The framework of the target.
Target Code	result.alignments.targetCode	string	The code of the target.
Tags	result.tags	array of string
Amount	result.expires.amount	string	The amount.
Duration	result.expires.duration	string	The duration.
Extensions	result.extensions	string	The extensions.

Get Issuers

Operation ID:

IssuerGet

Get a list of Issuers for authenticated user.

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
result	result	array of object
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Open Badge ID	result.openBadgeId	string	The identifier of the Open Badge.
Created At	result.createdAt	string	When created at.
Created By	result.createdBy	string	Whom created by.
Name	result.name	string	The name.
Image	result.image	string	The image.
Email	result.email	string	The email address.
Description	result.description	string	The description.
URL	result.url	string	The URL address.
Staff	result.staff	array of object
Entity Type	result.staff.entityType	string	The type of the entity.
Entity ID	result.staff.entityId	string	The identifier of the entity.
Entity Type	result.staff.userProfile.entityType	string	The entity type.
Entity ID	result.staff.userProfile.entityId	string	The entity identifier.
First Name	result.staff.userProfile.firstName	string	The first name.
Last Name	result.staff.userProfile.lastName	string	The last name.
Emails	result.staff.userProfile.emails	array of object
Email	result.staff.userProfile.emails.email	string	The email address.
Verified	result.staff.userProfile.emails.verified	boolean	Whether verified.
Primary	result.staff.userProfile.emails.primary	boolean	Whether primary.
Case Variants	result.staff.userProfile.emails.caseVariants	array of string	The case variants.
URLs	result.staff.userProfile.url	array of string	The URL addresses.
Telephone Numbers	result.staff.userProfile.telephone	array of string	The telephone numbers.
Badgr Domain	result.staff.userProfile.badgrDomain	string	The Badgr domain.
User	result.staff.user	string	The user.
Role	result.staff.role	string	The role.
Extensions	result.extensions	string	The extensions.
Badgr Domain	result.badgrDomain	string	The domain of Badgr.

Get user's access tokens

Operation ID:

TokenGet

Get a list of access tokens for authenticated user.

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
result	result	array of AccessToken

Get user's BadgeClasses

Operation ID:

ClassGetUser

Get a list of BadgeClasses for authenticated user.

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
result	result	array of object
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Open Badge ID	result.openBadgeId	string	The identifier of the Open Badge.
Created At	result.createdAt	string	When created at.
Created By	result.createdBy	string	Whom created by.
Issuer	result.issuer	string	The person or organization who creates/ offers badges and issues them to earners.
Issuer Open Badge ID	result.issuerOpenBadgeId	string	The identifier of the issuer's Open Badge.
Name	result.name	string	The name.
Image	result.image	string	The image.
Description	result.description	string	The description.
Achievement Type	result.achievementType	string	The type of achievement.
Criteria URL	result.criteriaUrl	string	The URL address of the criteria.
Criteria Narrative	result.criteriaNarrative	string	The narrative of the criteria.
Alignments	result.alignments	array of object
Target Name	result.alignments.targetName	string	The name of the target.
Target URL	result.alignments.targetUrl	string	The URL address of the target.
Target Description	result.alignments.targetDescription	string	The description of the target.
Target Framework	result.alignments.targetFramework	string	The framework of the target.
Target Code	result.alignments.targetCode	string	The code of the target.
Tags	result.tags	array of string
Amount	result.expires.amount	string	The amount.
Duration	result.expires.duration	string	The duration.
Extensions	result.extensions	string	The extensions.

Import a Assertion to backpack

Operation ID:

BackpackImportAssertion

Import a new Assertion to a user's backpack.

Parameters

Name	Key	Required	Type	Description
URL	url		string	URL to an OpenBadge compliant badge.
Image	image		string	Base64 encoded Baked OpenBadge image.
Assertion	assertion		object	OpenBadge compliant JSON.

Returns

Issue an Assertion

Operation ID:

AssertionIssue

Issue a new Assertion to a recipient.

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity.
BadgeClass	badgeclass		string	The definition of an earnable badge.
BadgeClass Open Badge ID	badgeclassOpenBadgeId		string	The identifier of the BadgeClass's Open Badge.
Issuer	issuer		string	The person or organization who creates/ offers badges and issues them to earners. .
Issuer Open Badge ID	issuerOpenBadgeId		string	The identifier of the issuer's Open Badge.
Identity	identity		string	The identity.
Hashed	hashed		boolean	Whether hashed.
Type	type		string	The type.
Plaintext Identity	plaintextIdentity		string	The identity in plaintext.
Salt	salt		string	If hashed, the salt.
Issued On	issuedOn		string	When issued on.
Narrative	narrative		string	The narrative for the badge issued.
URL	url		string	The URL address.
Narrative	narrative		string	The narrative for the badge issued.
Expires	expires		string	When expires.
Extensions	extensions		string	The extensions.
BadgeClass Name	badgeclassName		string	The name of the BadgeClass.

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
result	result	array of object
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Open Badge ID	result.openBadgeId	string	The identifier of the Open Badge.
Created At	result.createdAt	string	When created at.
Created By	result.createdBy	string	Whom created by.
BadgeClass	result.badgeclass	string	The definition of an earnable badge.
BadgeClass Open Badge ID	result.badgeclassOpenBadgeId	string	The identifier of the BadgeClass's Open Badge.
Issuer	result.issuer	string	The person or organization who creates/ offers badges and issues them to earners.
Issuer Open Badge ID	result.issuerOpenBadgeId	string	The identifier of the issuer's Open Badge.
Image	result.image	string	The image.
Identity	result.recipient.identity	string	The identity.
Hashed	result.recipient.hashed	boolean	Whether hashed.
Type	result.recipient.type	string	The type.
Plaintext Identity	result.recipient.plaintextIdentity	string	The identity in plaintext.
Salt	result.recipient.salt	string	If hashed, the salt.
Issued On	result.issuedOn	string	When issued on.
Narrative	result.narrative	string	The narrative for the badge issued.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	The URL address.
Narrative	result.evidence.narrative	string	The narrative for the badge issued.
Revoked	result.revoked	boolean	Whether revoked.
Revocation Reason	result.revocationReason	string	The reason for revocation.
Acceptance	result.acceptance	string	When the badge was accepted.
Expires	result.expires	string	When the badge expires.
Extensions	result.extensions	string	The extensions.
BadgeClass Name	result.badgeclassName	string	The name of the BadgeClass.

Issue an Assertion

Operation ID:

ClassIssueAssertion

Issue an Assertion to a single recipient.

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity.
BadgeClass	badgeclass		string	The definition of an earnable badge.
BadgeClass Open Badge ID	badgeclassOpenBadgeId		string	The identifier of the BadgeClass's Open Badge.
Issuer	issuer		string	The person or organization who creates/ offers badges and issues them to earners. .
Issuer Open Badge ID	issuerOpenBadgeId		string	The identifier of the issuer's Open Badge.
Identity	identity		string	The identity.
Hashed	hashed		boolean	Whether hashed.
Type	type		string	The type.
Plaintext Identity	plaintextIdentity		string	The identity in plaintext.
Salt	salt		string	If hashed, the salt.
Issued On	issuedOn		string	When issued on.
Narrative	narrative		string	The narrative for the badge issued.
URL	url		string	The URL address.
Narrative	narrative		string	The narrative for the badge issued.
Expires	expires		string	When expires.
Extensions	extensions		string	The extensions.
BadgeClass Name	badgeclassName		string	The name of the BadgeClass.

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
result	result	array of object
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Open Badge ID	result.openBadgeId	string	The identifier of the Open Badge.
Created At	result.createdAt	string	When created at.
Created By	result.createdBy	string	Whom created by.
BadgeClass	result.badgeclass	string	The definition of an earnable badge.
BadgeClass Open Badge ID	result.badgeclassOpenBadgeId	string	The identifier of the BadgeClass's Open Badge.
Issuer	result.issuer	string	The person or organization who creates/ offers badges and issues them to earners.
Issuer Open Badge ID	result.issuerOpenBadgeId	string	The identifier of the issuer's Open Badge.
Image	result.image	string	The image.
Identity	result.recipient.identity	string	The identity.
Hashed	result.recipient.hashed	boolean	Whether hashed.
Type	result.recipient.type	string	The type.
Plaintext Identity	result.recipient.plaintextIdentity	string	The identity in plaintext.
Salt	result.recipient.salt	string	If hashed, the salt.
Issued On	result.issuedOn	string	When issued on.
Narrative	result.narrative	string	The narrative for the badge issued.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	The URL address.
Narrative	result.evidence.narrative	string	The narrative for the badge issued.
Revoked	result.revoked	boolean	Whether revoked.
Revocation Reason	result.revocationReason	string	The reason for revocation.
Acceptance	result.acceptance	string	When the badge was accepted.
Expires	result.expires	string	When the badge expires.
Extensions	result.extensions	string	The extensions.
BadgeClass Name	result.badgeclassName	string	The name of the BadgeClass.

Issue multiple BadgeClass

Operation ID:

ClassIssueBulk

Issue multiple copies of the same BadgeClass to multiple recipients.

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity.
BadgeClass	badgeclass		string	The definition of an earnable badge.
BadgeClass Open Badge ID	badgeclassOpenBadgeId		string	The identifier of the BadgeClass's Open Badge.
Issuer	issuer		string	The person or organization who creates/ offers badges and issues them to earners. .
Issuer Open Badge ID	issuerOpenBadgeId		string	The identifier of the issuer's Open Badge.
Identity	identity		string	The identity.
Hashed	hashed		boolean	Whether hashed.
Type	type		string	The type.
Plaintext Identity	plaintextIdentity		string	The identity in plaintext.
Salt	salt		string	If hashed, the salt.
Issued On	issuedOn		string	When issued on.
Narrative	narrative		string	The narrative for the badge issued.
URL	url		string	The URL address.
Narrative	narrative		string	The narrative for the badge issued.
Expires	expires		string	When expires.
Extensions	extensions		string	The extensions.
BadgeClass Name	badgeclassName		string	The name of the BadgeClass.

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
result	result	array of object
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Open Badge ID	result.openBadgeId	string	The identifier of the Open Badge.
Created At	result.createdAt	string	When created at.
Created By	result.createdBy	string	Whom created by.
BadgeClass	result.badgeclass	string	The definition of an earnable badge.
BadgeClass Open Badge ID	result.badgeclassOpenBadgeId	string	The identifier of the BadgeClass's Open Badge.
Issuer	result.issuer	string	The person or organization who creates/ offers badges and issues them to earners.
Issuer Open Badge ID	result.issuerOpenBadgeId	string	The identifier of the issuer's Open Badge.
Image	result.image	string	The image.
Identity	result.recipient.identity	string	The identity.
Hashed	result.recipient.hashed	boolean	Whether hashed.
Type	result.recipient.type	string	The type.
Plaintext Identity	result.recipient.plaintextIdentity	string	The identity in plaintext.
Salt	result.recipient.salt	string	If hashed, the salt.
Issued On	result.issuedOn	string	When issued on.
Narrative	result.narrative	string	The narrative for the badge issued.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	The URL address.
Narrative	result.evidence.narrative	string	The narrative for the badge issued.
Revoked	result.revoked	boolean	Whether revoked.
Revocation Reason	result.revocationReason	string	The reason for revocation.
Acceptance	result.acceptance	string	When the badge was accepted.
Expires	result.expires	string	When the badge expires.
Extensions	result.extensions	string	The extensions.
BadgeClass Name	result.badgeclassName	string	The name of the BadgeClass.

Recover an account

Operation ID:

AccountRecover

Recover an account and set a new password.

Parameters

Name	Key	Required	Type	Description
Token	token		string	The token recieved in the recovery email.
Password	password		string	The new password to use.

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
result	result

Remove an assertion from backpack

Operation ID:

BackpackRemoteAssertion

Remove an assertion from a user's backpack.

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity

Request an account recovery email

Operation ID:

AccountRequestRecovery

Request an account recovery email for a user.

Parameters

Name	Key	Required	Type	Description
Email	email		string	The email address on file to send recovery email to.

Returns

Retrieve issuer tokens

Operation ID:

TokenRetrieve

Retrieve issuer tokens.

Parameters

Name	Key	Required	Type	Description
body	body	True

Returns

response

AccessToken

Revoke an AccessToken

Operation ID:

TokenRevoke

Revoke a user's AccessToken.

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity

Revoke an Assertion

Operation ID:

AssertionRevoke

Revoke an Assertion.

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity
Revocation Reason	revocation_reason		string	The reason for revoking this assertion

Revoke multiple Assertions

Operation ID:

AssertionRevokeBulk

Revoke multiple Assertions for multiple recipients.

Parameters

Name	Key	Required	Type	Description
BadgeClass	badgeclass		string	The definition of an earnable badge.
BadgeClass Open Badge ID	badgeclassOpenBadgeId		string	The identifier of the BadgeClass's Open Badge.
Issuer	issuer		string	The person or organization who creates/ offers badges and issues them to earners. .
Issuer Open Badge ID	issuerOpenBadgeId		string	The identifier of the issuer's Open Badge.
Identity	identity		string	The identity.
Hashed	hashed		boolean	Whether hashed.
Type	type		string	The type.
Plaintext Identity	plaintextIdentity		string	The identity in plaintext.
Salt	salt		string	If hashed, the salt.
Issued On	issuedOn		string	When issued on.
Narrative	narrative		string	The narrative for the badge issued.
URL	url		string	The URL address.
Narrative	narrative		string	The narrative for the badge issued.
Expires	expires		string	When expires.
Extensions	extensions		string	The extensions.
BadgeClass Name	badgeclassName		string	The name of the BadgeClass.

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
result	result	array of object
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Open Badge ID	result.openBadgeId	string	The identifier of the Open Badge.
Created At	result.createdAt	string	When created at.
Created By	result.createdBy	string	Whom created by.
BadgeClass	result.badgeclass	string	The definition of an earnable badge.
BadgeClass Open Badge ID	result.badgeclassOpenBadgeId	string	The identifier of the BadgeClass's Open Badge.
Issuer	result.issuer	string	The person or organization who creates/ offers badges and issues them to earners.
Issuer Open Badge ID	result.issuerOpenBadgeId	string	The identifier of the issuer's Open Badge.
Image	result.image	string	The image.
Identity	result.recipient.identity	string	The identity.
Hashed	result.recipient.hashed	boolean	Whether hashed.
Type	result.recipient.type	string	The type.
Plaintext Identity	result.recipient.plaintextIdentity	string	The identity in plaintext.
Salt	result.recipient.salt	string	If hashed, the salt.
Issued On	result.issuedOn	string	When issued on.
Narrative	result.narrative	string	The narrative for the badge issued.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	The URL address.
Narrative	result.evidence.narrative	string	The narrative for the badge issued.
Revoked	result.revoked	boolean	Whether revoked.
Revocation Reason	result.revocationReason	string	The reason for revocation.
Acceptance	result.acceptance	string	When the badge was accepted.
Expires	result.expires	string	When the badge expires.
Extensions	result.extensions	string	The extensions.
BadgeClass Name	result.badgeclassName	string	The name of the BadgeClass.

Update a BadgeClass

Operation ID:

ClassUpdate

Update an existing BadgeClass. Previously issued BadgeInstances will not be updated.

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity.
Issuer	issuer		string	The person or organization who creates/ offers badges and issues them to earners. .
Issuer Open Badge ID	issuerOpenBadgeId		string	The identifier of the issuer's Open Badge.
Name	name		string	The name.
Image	image		string	The image.
Description	description		string	The description.
Achievement Type	achievementType		string	The type of achievement.
Criteria URL	criteriaUrl		string	The URL of the criteria.
Criteria Narrative	criteriaNarrative		string	The narrative of the criteria.
Target Name	targetName		string	The name of the target.
Target URL	targetUrl		string	The URL of the target.
Target Description	targetDescription		string	The description of the target.
Target Framework	targetFramework		string	The framework of the target.
Target Code	targetCode		string	The code of the target.
Tags	tags		array of string
Amount	amount		string	The amount.
Duration	duration		string	The duration.
Extensions	extensions		string	The extensions.

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
Results	result	array of object	The array of results.
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Open Badge ID	result.openBadgeId	string	The identifier of the Open Badge.
Created At	result.createdAt	string	When created at.
Created By	result.createdBy	string	Whom created by.
Issuer	result.issuer	string	The person or organization who creates/ offers badges and issues them to earners.
Issuer Open Badge ID	result.issuerOpenBadgeId	string	The identifier of the issuer's Open Badge.
Name	result.name	string	The name.
Image	result.image	string	The image.
Description	result.description	string	The description.
Achievement Type	result.achievementType	string	The type of achievement.
Criteria URL	result.criteriaUrl	string	The URL address of the criteria.
Criteria Narrative	result.criteriaNarrative	string	The narrative of the criteria.
Alignments	result.alignments	array of object
Target Name	result.alignments.targetName	string	The name of the target.
Target URL	result.alignments.targetUrl	string	The URL address of the target.
Target Description	result.alignments.targetDescription	string	The description of the target.
Target Framework	result.alignments.targetFramework	string	The framework of the target.
Target Code	result.alignments.targetCode	string	The code of the target.
Tags	result.tags	array of string
Amount	result.expires.amount	string	The amount.
Duration	result.expires.duration	string	The duration.
Extensions	result.extensions	string	The extensions.

Update a BadgeUser

Operation ID:

UserUpdate

Update a BadgeUser's account. Use the entityId 'self' to update the authenticated user's profile

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity.
Entity Type	entityType		string	The type of entity.
Entity ID	entityId		string	The identifier of the entity.
First Name	firstName		string	The first name.
Last Name	lastName		string	The last name.
Entity Type	entityType		string	The type of entity.
Entity ID	entityId		string	The identifier of the entity.
Email	email		string	The email address.
Verified	verified		boolean	Whether verified.
Primary	primary		boolean	Whether primary.
Case Variants	caseVariants		string	The case variants.
URL	url		string	The URL address.
Telephone	telephone		string	The telephone number.
Agreed Terms Version	agreedTermsVersion		string	The version of the agreed terms.
Has Agreed To Latest Terms Version	hasAgreedToLatestTermsVersion		string	The version of latest terms agreed.
Marketing Opt In	marketingOptIn		string	Has opted in to marketing.
Badgr Domain	badgrDomain		string	The domain of Badgr.
Has Password Set	hasPasswordSet		string	Has password set.
Recipient	recipient		string	The recipient.

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
Results	result	array of object	The array of results.
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
First Name	result.firstName	string	The first name.
Last Name	result.lastName	string	The last name.
Emails	result.emails	array of object
Entity Type	result.emails.entityType	string	The type of the entity.
Entity ID	result.emails.entityId	string	The identifier of the entity.
Email	result.emails.email	string	The email address.
Verified	result.emails.verified	boolean	Whether verified.
Primary	result.emails.primary	boolean	Whether primary.
Case Variants	result.emails.caseVariants	string	The case variants.
URL	result.url	string	The URL address.
Telephone	result.telephone	string	The telephone number.
Agreed Terms Version	result.agreedTermsVersion	string	The version of the terms aggreed.
Has Agreed To Latest Terms Version	result.hasAgreedToLatestTermsVersion	string	The version of the laterst terms aggree.
Marketing Opt In	result.marketingOptIn	string	Agreed to marketing opt-in.
Badgr Domain	result.badgrDomain	string	The domain of Badgr.
Has Password Set	result.hasPasswordSet	string	If has password set.
Recipient	result.recipient	string	The recipient.

Update a Collection

Operation ID:

CollectionUpdate

Update a Collection in a backpack.

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity.
Entity Type	entityType		string	The type of entity.
Entity ID	entityId		string	The identifier of the entity.
Name	name		string	The name.
Description	description		string	The description.
Owner	owner		string	The owner.
Share URL	share_url		string	The URL address of the share.
Share Hash	shareHash		string	The hash of the share.
Published	published		boolean	Whether published.
BadgeClass	badgeclass		string	The definition of an earnable badge.
BadgeClass Open Badge ID	badgeclassOpenBadgeId		string	The identifier of the BadgeClass's Open Badge.
Issuer	issuer		string	The person or organization who creates/ offers badges and issues them to earners.
Issuer Open Badge ID	issuerOpenBadgeId		string	The identifier of the issuer's Open Badge.
Identity	identity		string	The identity.
Hashed	hashed		boolean	Whether hashed.
Type	type		string	The type.
Plaintext Identity	plaintextIdentity		string	The identity in plaintext.
Salt	salt		string	If hashed, the salt.
Issued On	issuedOn		string	When issued on.
Narrative	narrative		string	The narrative for the badge issued.
URL	url		string	The URL address.
Narrative	narrative		string	The narrative for the badge issued.
Expires	expires		string	When the badge expires.
Extensions	extensions		string	The extensions.
BadgeClass Name	badgeclassName		string	The name of the BadgeClass.
Created At	createdAt		string	Created at.
Created By	createdBy		string	Whom created by.

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
Results	result	array of object	The array of results.
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Name	result.name	string	The name.
Description	result.description	string	The description.
Owner	result.owner	string	The owner.
Share URL	result.share_url	string	The URL address of the share.
Share Hash	result.shareHash	string	The hash of the share.
Published	result.published	boolean	Whether published.
Assertions	result.assertions	array of object
Entity Type	result.assertions.entityType	string	The type of the entity.
Entity ID	result.assertions.entityId	string	The identifier of the entity.
Open Badge ID	result.assertions.openBadgeId	string	The identifier of the Open Badge.
Created At	result.assertions.createdAt	string	When created at.
Created By	result.assertions.createdBy	string	Created by.
BadgeClass	result.assertions.badgeclass	string	The BadgeClass.
BadgeClass Open Badge ID	result.assertions.badgeclassOpenBadgeId	string	The identifier of the BadgeClass's Open Badge.
Issuer	result.assertions.issuer	string	The issuer.
Issuer Open Badge ID	result.assertions.issuerOpenBadgeId	string	The identifier of the issuer's Open Badge.
Image	result.assertions.image	string	The image.
Identity	result.assertions.recipient.identity	string	The identity.
Hashed	result.assertions.recipient.hashed	boolean	Whether hashed.
Type	result.assertions.recipient.type	string	The type.
Plaintext Identity	result.assertions.recipient.plaintextIdentity	string	The identity in plaintext.
Salt	result.assertions.recipient.salt	string	If hashed, the salt.
Issued On	result.assertions.issuedOn	string	When issued on.
Narrative	result.assertions.narrative	string	The narrative for the badge issued.
Evidence	result.assertions.evidence	array of object
URL	result.assertions.evidence.url	string	The URL address.
Narrative	result.assertions.evidence.narrative	string	The narrative.
Revoked	result.assertions.revoked	boolean	Whether revoked.
Revocation Reason	result.assertions.revocationReason	string	The reason for revocation.
Acceptance	result.assertions.acceptance	string	The acceptance.
Expires	result.assertions.expires	string	When expires.
Extensions	result.assertions.extensions	string	The extensions.
BadgeClass Name	result.assertions.badgeclassName	string	The name of the BadgeClass.
Created At	result.createdAt	string	When created at.
Created By	result.createdBy	string	Whom created by.

Update an Assertion

Operation ID:

AssertionUpdate

Update an Assertion.

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity.
BadgeClass	badgeclass		string	The definition of an earnable badge.
BadgeClass Open Badge ID	badgeclassOpenBadgeId		string	The identifier of the BadgeClass's Open Badge.
Issuer	issuer		string	The person or organization who creates/ offers badges and issues them to earners. .
Issuer Open Badge ID	issuerOpenBadgeId		string	The identifier of the issuer's Open Badge.
Identity	identity		string	The identity.
Hashed	hashed		boolean	Whether hashed.
Type	type		string	The type.
Plaintext Identity	plaintextIdentity		string	The identity in plaintext.
Salt	salt		string	If hashed, the salt.
Issued On	issuedOn		string	When issued on.
Narrative	narrative		string	The narrative for the badge issued.
URL	url		string	The URL address.
Narrative	narrative		string	The narrative for the badge issued.
Expires	expires		string	When expires.
Extensions	extensions		string	The extensions.
BadgeClass Name	badgeclassName		string	The name of the BadgeClass.

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
Results	result	array of object	The array of results.
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Open Badge ID	result.openBadgeId	string	The identifier of the Open Badge.
Created At	result.createdAt	string	When created at.
Created By	result.createdBy	string	Whom created by.
BadgeClass	result.badgeclass	string	The definition of an earnable badge.
BadgeClass Open Badge ID	result.badgeclassOpenBadgeId	string	The identifier of the BadgeClass's Open Badge.
Issuer	result.issuer	string	The person or organization who creates/ offers badges and issues them to earners.
Issuer Open Badge ID	result.issuerOpenBadgeId	string	The identifier of the issuer's Open Badge.
Image	result.image	string	The image.
Identity	result.recipient.identity	string	The identity.
Hashed	result.recipient.hashed	boolean	Whether hashed.
Type	result.recipient.type	string	The type.
Plaintext Identity	result.recipient.plaintextIdentity	string	The identity in plaintext.
Salt	result.recipient.salt	string	If hashed, the salt.
Issued On	result.issuedOn	string	When issued on.
Narrative	result.narrative	string	The narrative for the badge issued.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	The URL address.
Narrative	result.evidence.narrative	string	The narrative for the badge issued.
Revoked	result.revoked	boolean	Whether revoked.
Revocation Reason	result.revocationReason	string	The reason for revocation.
Acceptance	result.acceptance	string	When the badge was accepted.
Expires	result.expires	string	When the badge expires.
Extensions	result.extensions	string	The extensions.
BadgeClass Name	result.badgeclassName	string	The name of the BadgeClass.

Update an Issuer

Operation ID:

IssuerUpdate

Update a single Issuer.

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity.
Created By	createdBy		string	Whom created by.
Name	name		string	The name.
Image	image		string	The image.
Email	email		string	The email address.
Description	description		string	The description.
URL	url		string	The URL address.
Entity Type	entityType		string	The type of entity.
Entity ID	entityId		string	The identifier of the entity.
User Profile	userProfile		string	The profile of the user.
User	user		string	The user.
Role	role		string	The role.
Extensions	extensions		string	The extensions.
Badgr Domain	badgrDomain		string	The domain of Badgr.

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
Results	result	array of object	The array of results.
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Open Badge ID	result.openBadgeId	string	The identifier of the Open Badge.
Created At	result.createdAt	string	When created at.
Created By	result.createdBy	string	Whom created by.
Name	result.name	string	The name.
Image	result.image	string	The image.
Email	result.email	string	The email address.
Description	result.description	string	The description.
URL	result.url	string	The URL address.
Staff	result.staff	array of object
Entity Type	result.staff.entityType	string	The type of the entity.
Entity ID	result.staff.entityId	string	The identifier of the entity.
User Profile	result.staff.userProfile	string	The profile of the user.
User	result.staff.user	string	The user.
Role	result.staff.role	string	The role.
Extensions	result.extensions	string	The extensions.
Badgr Domain	result.badgrDomain	string	The domain of Badgr.

Update Assertion acceptance in Backpack

Operation ID:

BackpackUpdateAcceptance

Update acceptance of an Assertion in a user's Backpack.

Parameters

Name	Key	Required	Type	Description
Entity ID	entity_id	True	string	The identifier of the entity.
Acceptance	acceptance		string	The acceptance.
BadgeClass	badgeclass		string	The definition of an earnable badge.
Issuer	issuer		string	The person or organization who creates/ offers badges and issues them to earners. .
Issuer Open Badge ID	issuerOpenBadgeId		string	The identifier of the issuer's Open Badge.
Identity	identity		string	The identity.
Type	type		string	The type.
Hashed	hashed		boolean	Whether hashed.
Plaintext Identity	plaintextIdentity		string	The identity in plaintext.
Issued On	issuedOn		string	When issued on.
Narrative	narrative		string	The narrative for the badge issued.
URL	url		string	The URL address.
Narrative	narrative		string	The narrative for the badge issued.
Expires	expires		string	When expires.
Pending	pending		string	Pending.

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
Results	result	array of object	The array of results.
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Acceptance	result.acceptance	string	When the badge was accepted.
Open Badge ID	result.openBadgeId	string	The identifier of the Open Badge.
BadgeClass	result.badgeclass	string	The definition of an earnable badge.
BadgeClass Open Badge ID	result.badgeclassOpenBadgeId	string	The identifier of the BadgeClass's Open Badge.
Issuer	result.issuer	string	The person or organization who creates/ offers badges and issues them to earners.
Issuer Open Badge ID	result.issuerOpenBadgeId	string	The identifier of the issuer's Open Badge.
Image	result.image	string	The image.
Identity	result.recipient.identity	string	The identity.
Type	result.recipient.type	string	The type.
Hashed	result.recipient.hashed	boolean	Whether hashed.
Plaintext Identity	result.recipient.plaintextIdentity	string	The identity in plaintext.
Issued On	result.issuedOn	string	When issued on.
Narrative	result.narrative	string	The narrative for the badge issued.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	The URL address.
Narrative	result.evidence.narrative	string	The narrative for the badge issued.
Revoked	result.revoked	boolean	Whether revoked.
Revocation Reason	result.revocationReason	string	The reason for revocation.
Expires	result.expires	string	When the badge expires.
Pending	result.pending	string	Pending.

Upload a Assertion to backpack

Operation ID:

BackpackUploadAssertion

Upload a new Assertion to a user's backpack.

Parameters

Name	Key	Required	Type	Description
BadgeClass	badgeclass		string	The definition of an earnable badge.
BadgeClass Open Badge ID	badgeclassOpenBadgeId		string	The identifier of the BadgeClass's Open Badge.
Issuer	issuer		string	The person or organization who creates/ offers badges and issues them to earners. .
Issuer Open Badge ID	issuerOpenBadgeId		string	The identifier of the issuer's Open Badge.
Identity	identity		string	The identity.
Hashed	hashed		boolean	Whether hashed.
Type	type		string	The type.
Plaintext Identity	plaintextIdentity		string	The identity in plaintext.
Salt	salt		string	If hashed, the salt.
Issued On	issuedOn		string	When issued on.
Narrative	narrative		string	The narrative for the badge issued.
URL	url		string	The URL address.
Narrative	narrative		string	The narrative for the badge issued.
Expires	expires		string	When expires.
Extensions	extensions		string	The extensions.
BadgeClass Name	badgeclassName		string	The name of the BadgeClass.

Returns

Name	Path	Type	Description
Description	status.description	string	The description.
Success	status.success	boolean	Whether a success.
result	result	array of object
Entity Type	result.entityType	string	The type of entity.
Entity ID	result.entityId	string	The identifier of the entity.
Open Badge ID	result.openBadgeId	string	The identifier of the Open Badge.
Created At	result.createdAt	string	When created at.
Created By	result.createdBy	string	Whom created by.
BadgeClass	result.badgeclass	string	The definition of an earnable badge.
BadgeClass Open Badge ID	result.badgeclassOpenBadgeId	string	The identifier of the BadgeClass's Open Badge.
Issuer	result.issuer	string	The person or organization who creates/ offers badges and issues them to earners.
Issuer Open Badge ID	result.issuerOpenBadgeId	string	The identifier of the issuer's Open Badge.
Image	result.image	string	The image.
Identity	result.recipient.identity	string	The identity.
Hashed	result.recipient.hashed	boolean	Whether hashed.
Type	result.recipient.type	string	The type.
Plaintext Identity	result.recipient.plaintextIdentity	string	The identity in plaintext.
Salt	result.recipient.salt	string	If hashed, the salt.
Issued On	result.issuedOn	string	When issued on.
Narrative	result.narrative	string	The narrative for the badge issued.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	The URL address.
Narrative	result.evidence.narrative	string	The narrative for the badge issued.
Revoked	result.revoked	boolean	Whether revoked.
Revocation Reason	result.revocationReason	string	The reason for revocation.
Acceptance	result.acceptance	string	When the badge was accepted.
Expires	result.expires	string	When the badge expires.
Extensions	result.extensions	string	The extensions.
BadgeClass Name	result.badgeclassName	string	The name of the BadgeClass.

Definitions

AccessToken