diff --git a/ob_v3p0/vocab.html b/ob_v3p0/vocab.html index 225865ab..6f93799f 100644 --- a/ob_v3p0/vocab.html +++ b/ob_v3p0/vocab.html @@ -1,1250 +1,3615 @@ - - - - - - - - - - - -
-

Abstract

-

- This document contains information about the JSON-LD terms used 1EdTech Open Badges versions 1.0+. -

-
- -
-

Terms

-

- This is a complete list of JSON-LD terms used by 1EdTech Open Badges versions 1.0+. -

-
-
Achievement
-
- The achievement being asserted by the issuer. - read more -
-
Alignment
-
- An object describing which objectives or educational standards this badge aligns to, if any. - read more -
-
Allowed Origins
-
- The host registered name subcomponent of an allowed origin. - read more -
-
Audience
-
- A description of the intended audience for a piece of evidence. - read more -
-
Author
-
- The author of the image. - read more -
-
Badge
-
- The achievement being asserted by the issuer. - read more -
-
Caption
-
- The caption for the image. - read more -
-
Claim
-
- An endorser's claim about an entity. - read more -
-
Creator
-
- The key used to sign the assertion. - read more -
-
Criteria
-
- Document describing how to earn the achievement. - read more -
-
Description
-
- A short plaintext description. - read more -
-
Email
-
- Contact email address for the entity. - read more -
-
Endorsement
-
- A claim made about the entity. - read more -
-
Endorsement Comment
-
- A simple claim in writing about the entity. - read more -
-
Evidence
-
- Document describing the work that the recipient did to earn the achievement. - read more -
-
Expires
-
- Timestamp when a badge should no longer be considered valid. - read more -
-
Genre
-
- Describes the type of evidence. - read more -
-
Hashed
-
- Whether or not the recipient identity value is hashed. - read more -
-
Identity
-
- The identity value of the recipient. - read more -
-
Image
-
- Document representing an image. - read more -
-
Issued On
-
- Timestamp of when the assertion was issued. - read more -
-
Issuer
-
- The person or organization that has made an assertion about a person. - read more -
-
Name
-
- The name of the entity. - read more -
-
Narrative
-
- A narrative description, possibly Markdown. - read more -
-
Owner
-
- The owner of the key used to sign the assertion. - read more -
-
Public Key
-
- The key used to sign the assertion. - read more -
-
Public Key PEM
-
- The public key used to verify the signature. - read more -
-
Recipient
-
- An object that describes the recipient's identity. - read more -
- -
- Another entity of the same type. Primarily intended to identify language editions or previous versions of an achievement. - read more -
-
Revocation List
-
- Document that describes assertions that the issuer has revoked. - read more -
-
Revocation Reason
-
- The reason for revocation. - read more -
-
Revoked
-
- Whether or not the assertion is revoked. - read more -
-
Revoked Assertions
-
- Assertions that have been revoked. - read more -
-
Salt
-
- String used to salt hashed identifiers. - read more -
-
Starts With
-
- Set of URI fragments used to determine if an id is valid. - read more -
-
Tags
-
- Tags that describe the type of achievement. - read more -
-
Target Code
-
- Identifies the alignment target. - read more -
-
Target Description
-
- Short description of the alignment target. - read more -
-
Target Framework
-
- Name of the alignment target framework. - read more -
-
Target Name
-
- Name of the alignment target. - read more -
-
Target URL
-
- URL of the alignment target. - read more -
-
Telephone
-
- Phone number for the entity. - read more -
-
UID
-
- Unique identifier for the badge. - read more -
-
URL
-
- The homepage or social media profile of the entity. - read more -
-
Verification
-
- Instructions for how to verify the assertion. - read more -
-
Verification Property
-
- The property to be used for verification. - read more -
-
Verify
-
- Alias for verification. - read more -
-
Version
-
- The version of the achievement. - read more -
-
-
- -
-

Term Details

-

- This section contains information about all the JSON-LD terms used in 1EdTech Open Badges 1.0+. - Each term has a table showing which versions of 1EdTech Open Badges use the term. -

-
-

Achievement

-

The achievement being asserted by the issuer.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Alignment

-

An object describing which objectives or educational standards this badge aligns to, if any.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Allowed Origins

-

The host registered name subcomponent of an allowed origin.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Audience

-

A description of the intended audience for a piece of evidence.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Author

-

The author of the image.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Badge

-

The achievement being asserted by the issuer.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
XX
-
-
-

Caption

-

The caption for the image.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Claim

-

An endorser's claim about an entity.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Creator

-

The key used to sign the assertion.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Criteria

-

Document describing how to earn the achievement.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
XXX
-
-
-

Description

-

A short plaintext description.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
XXX
-
-
-

Email

-

Contact email address for the entity.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
XXX
-
-
-

Endorsement

-

A claim made about the entity.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Endorsement Comment

-

A simple claim in writing about the entity.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Evidence

-

Document describing the work that the recipient did to earn the achievement.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
XXX
-
-
-

Expires

-

Timestamp when a badge should no longer be considered valid.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
XX
-
-
-

Genre

-

Describes the type of evidence.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Hashed

-

Whether or not the recipient identity value is hashed.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
XXX
-
-
-

Identity

-

The identity value of the recipient.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
XXX
-
-
-

Image

-

Document representing an image.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Issued On

-

Timestamp of when the assertion was issued.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
XX
-
-
-

Issuer

-

The person or organization that has made an assertion about a person.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
XXX
-
-
-

Name

-

The name of the entity.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
XXX
-
-
-

Narrative

-

A narrative description, possibly Markdown.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Owner

-

The owner of the key used to sign the assertion.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Public Key

-

The key used to sign the signature.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Public Key PEM

-

The public key used to verify the signature.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Recipient

-

An object that describes the recipient's identity.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
XXX
-
-
-

Related

-

Another entity of the same type. Primarily intended to identify language editions or previous versions of an achievement.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Revocation List

-

Document that describes assertions that the issuer has revoked.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Revocation Reason

-

The reason for revocation.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Revoked

-

Whether or not the assertion is revoked.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Revoked Assertions

-

Assertions that have been revoked.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Salt

-

String used to salt hashed identifiers.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
XXX
-
-
-

Starts With

-

Set of URI fragments used to determine if an id is value.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Tags

-

Tags that describe the type of achievement.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Target Code

-

Identifies the alignment target.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Target Description

-

Short description of the alignment target.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Target Framework

-

Name of the alignement target framework.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Target Name

-

Name of the alignment target.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Target URL

-

URL of the alignment target.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Telephone

-

Phone number for the entity.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

UID

-

Unique identifier for the badge.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

URL

-

The homepage or social media profile of the entity.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
XX
-
-
-

Verification

-

Instructions for how to verify the assertion.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
-
-
-

Verification Property

-

The property to be used for verification.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
+ + + Open Badges + + + + + +
+

Abstract

+

+ This document contains information about the JSON-LD terms used in + 1EdTech Open Badges. +

+

This document is also available in these non-normative formats:

+
-

Verify

-

Alias for Verification

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
+

Class definitions

+

+ This section contains information about all the JSON-LD classes used in + 1EdTech Open Badges +

+
+

Achievement

+

Achievement

+

+ A collection of information about the accomplishment recognized by the + Assertion. Many assertions may be created corresponding to one + Achievement. +

+ +
+

Properties

+ +
+
+
+

AchievementCredential

+

AchievementCredential

+

+ AchievementCredentials are representations of an awarded achievement, + used to share information about a achievement belonging to one earner. + Maps to a Verifiable Credential as defined in the [[VC-DATA-MODEL]]. + As described in + data-integrity, at least one proof mechanism, and the details necessary to evaluate + that proof, MUST be expressed for a credential to be a verifiable + credential. In the case of an embedded proof, the credential MUST + append the proof in the `proof` property. +

+ +
+
Subclass Of:
+
+ VerifiableCredential. +
+
+
+

Properties

+ +
+
+
+

AchievementSubject

+

AchievementSubject

+

+ A collection of information about the recipient of an achievement. + Maps to Credential Subject in [[VC-DATA-MODEL]]. +

+ +
+
Subclass Of:
+
+ CredentialSubject. +
+
+
+

Properties

+ +
+
+
+

Address

+

Address

+

An address for the described entity.

+ +
+

Properties

+ +
+
+
+

Alignment

+

Alignment

+

+ Describes an alignment between an achievement and a node in an + educational framework. +

+ +
+

Properties

+ +
+
+
+

AnyIdentifier

+

AnyIdentifier

+

Can't find any description.

+ +
+

Properties

+ +
+
+
+

Context

+

Context

+

+ JSON-LD Context. Either a URI with the context definition or a Map + with a local context definition MUST be supplied. +

+ +
+
Subclass Of:
+
+ xsd:anyURI, + Map. +
+
+
+
+

Criteria

+

Criteria

+

+ Descriptive metadata about the achievements necessary to be recognized + with an assertion of a particular achievement. This data is added to + the Achievement class so that it may be rendered when the achievement + assertion is displayed, instead of simply a link to human-readable + criteria external to the achievement. Embedding criteria allows either + enhancement of an external criteria page or increased portability and + ease of use by allowing issuers to skip hosting the formerly-required + external criteria page altogether. Criteria is used to allow would-be + recipients to learn what is required of them to be recognized with an + assertion of a particular achievement. It is also used after the + assertion is awarded to a recipient to let those inspecting earned + achievements know the general requirements that the recipients met in + order to earn it. +

+ +
+

Properties

+ +
+
+
+

EndorsementCredential

+

EndorsementCredential

+

+ A verifiable credential that asserts a claim about an entity. As + described in + data-integrity, at least one proof mechanism, and the details necessary to evaluate + that proof, MUST be expressed for a credential to be a verifiable + credential. In the case of an embedded proof, the credential MUST + append the proof in the `proof` property. +

+ +
+
Subclass Of:
+
+ VerifiableCredential. +
+
+
+

Properties

+ +
+
+
+

EndorsementSubject

+

EndorsementSubject

+

+ A collection of information about the subject of the endorsement. +

+ +
+
Subclass Of:
+
+ CredentialSubject. +
+
+
+

Properties

+ +
+
+
+

Evidence

+

Evidence

+

+ Descriptive metadata about evidence related to the achievement + assertion. Each instance of the evidence class present in an assertion + corresponds to one entity, though a single entry can describe a set of + items collectively. There may be multiple evidence entries referenced + from an assertion. The narrative property is also in scope of the + assertion class to provide an overall description of the achievement + related to the assertion in rich text. It is used here to provide a + narrative of achievement of the specific entity described. If both the + description and narrative properties are present, displayers can + assume the narrative value goes into more detail and is not simply a + recapitulation of description. +

+ +
+

Properties

+ +
+
+
+

GeoCoordinates

+

GeoCoordinates

+

The geographic coordinates of a location.

+ +
+

Properties

+ +
+
+
+

GetOpenBadgeCredentialsResponse

+

GetOpenBadgeCredentialsResponse

+

Can't find any description.

+ +
+

Properties

+ +
+
+
+

IdentifierEntry

+

IdentifierEntry

+

Can't find any description.

+ +
+

Properties

+ +
+
+
+

IdentifierType

+

IdentifierType

+

Can't find any description.

+ +
+

Properties

+ +
+
+
+

IdentityObject

+

IdentityObject

+

+ A collection of information about the recipient of an achievement. +

+ +
+

Properties

+ +
+
+
+

Image

+

Image

+

+ Metadata about images that represent assertions, achieve or profiles. + These properties can typically be represented as just the id string of + the image, but using a fleshed-out document allows for including + captions and other applicable metadata. +

+ +
+

Properties

+ +
+
+
+

JWK

+

JWK

+

+ A JSON Web Key (JWK) formatted according to [[RFC7517]]. +

+ +
+

Properties

+ +
+
+
+

JWKS

+

JWKS

+

+ A JWK Set (JWKS) formatted according to [[RFC7517]]. +

+ +
+

Properties

+ +
+
+
+

Map

+

Map

+

+ A map representing an object with unknown, arbitrary properties +

+ +
+
+

Multikey

+

Multikey

+

Can't find any description.

+ +
+

Properties

+ +
+
+
+

Profile

+

Profile

+

+ A Profile is a collection of information that describes the entity or + organization using Open Badges. Issuers must be represented as + Profiles, and endorsers, or other entities may also be represented + using this vocabulary. Each Profile that represents an Issuer may be + referenced in many BadgeClasses that it has defined. Anyone can create + and host an Issuer file to start issuing Open Badges. Issuers may also + serve as recipients of Open Badges, often identified within an + Assertion by specific properties, like their url or contact email + address. +

+ +
+

Properties

+ +
+
+ +
+

Result

+

Result

+

Describes a result that was achieved.

+ +
+

Properties

+ +
+
+
+

ResultDescription

+

ResultDescription

+

Describes a possible achievement result.

+ +
+

Properties

+ +
+
+
+

RubricCriterionLevel

+

RubricCriterionLevel

+

Describes a rubric criterion level.

+ +
+

Properties

+ +
+
-

Version

-

The version of the achievement.

- - - - - - - - - - - - - - - -
1.02.0/2.13.0
X
+

Property definitions

+

+ This section contains information about all the JSON-LD properties used + in 1EdTech Open Badges +

+
+

achievedLevel

+

achievedLevel

+

+ If the result represents an achieved rubric criterion level (e.g. + Mastered), the value is the `id` of the RubricCriterionLevel in linked + ResultDescription. +

+ +
+
Range:
+
+ xsd:anyURI +
+
Domain:
+
+ Result +
+
+
+
+

achievement

+

achievement

+

The achievement being awarded.

+ +
+
Range:
+
+ Achievement +
+
Domain:
+
+ AchievementSubject +
+
+
+
+

achievementType

+

achievementType

+

+ The type of achievement. This is an extensible vocabulary. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ Achievement +
+
+
+
+

activityEndDate

+

activityEndDate

+

The datetime the activity ended.

+ +
+
Range:
+
+ xsd:dateTime +
+
Domain:
+
+ AchievementSubject +
+
+
+
+

activityStartDate

+

activityStartDate

+

The datetime the activity started.

+ +
+
Range:
+
+ xsd:dateTime +
+
Domain:
+
+ AchievementSubject +
+
+
+
+

additionalName

+

additionalName

+

+ Additional name. Includes what is often referred to as 'middle name' + in the western world. +

+ +
+
Range:
+
+ https://schema.org/additionalName +
+
Domain:
+
+ Profile +
+
+
+
+

address

+

address

+

+ An address for the individual or organization. +

+ +
+
Range:
+
+ Address +
+
Domain:
+
+ Profile +
+
+
+
+

addressCountry

+

addressCountry

+

A country.

+ +
+
Range:
+
+ https://schema.org/addressCountry +
+
Domain:
+
+ Address +
+
+
+
+

addressCountryCode

+

addressCountryCode

+

+ A country code. The value must be a ISO 3166-1 alpha-2 country code + [[ISO3166-1]]. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ Address +
+
+
+
+

addressLocality

+

addressLocality

+

A locality within the region.

+ +
+
Range:
+
+ https://schema.org/addressLocality +
+
Domain:
+
+ Address +
+
+
+
+

addressRegion

+

addressRegion

+

A region within the country.

+ +
+
Range:
+
+ https://schema.org/addressRegion +
+
Domain:
+
+ Address +
+
+
+
+

alg

+

alg

+

+ The `alg` (algorithm) parameter identifies the algorithm intended for + use with the key, such as `RS256` or `PS256`. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ JWK +
+
+
+
+

alignment

+

alignment

+

+ In Achievement:An object describing which objectives or educational + standards this achievement aligns to, if any. +

+

+ In Result:The alignments between this result and nodes in external + frameworks. This set of alignments are in addition to the set of + alignments defined in the corresponding ResultDescription object. +

+

+ In ResultDescription:Alignments between this result description and + nodes in external frameworks. +

+

+ In RubricCriterionLevel:Alignments between this rubric criterion level + and a rubric criterion levels defined in external frameworks. +

+ +
+
Range:
+
+ Alignment +
+
Domain:
+
+ Union of:
Achievement
Result
ResultDescription
RubricCriterionLevel +
+
+
+
+

allowedValue

+

allowedValue

+

+ An ordered list of allowed values. The values should be ordered from + low to high as determined by the achievement creator. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ ResultDescription +
+
+
+
+

audience

+

audience

+

+ A description of the intended audience for a piece of evidence. +

+ +
+
Range:
+
+ https://schema.org/audience +
+
Domain:
+
+ Evidence +
+
+
+
+

caption

+

caption

+

The caption for the image.

+ +
+
Range:
+
+ https://schema.org/caption +
+
Domain:
+
+ Image +
+
+
+
+

compactJwsString

+

compactJwsString

+

+ OpenBadgeCredentials that have been signed with the VC-JWT Proof + Format MUST be in the `compactJwsString` array. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ GetOpenBadgeCredentialsResponse +
+
+
+
+

controller

+

controller

+

+ The identify of the entity that controls this public key. +

+ +
+
Range:
+
+ xsd:anyURI +
+
Domain:
+
+ Multikey +
+
+
+
+

creator

+

creator

+

+ The person or organization that created the achievement definition. +

+ +
+
Range:
+
+ Profile +
+
Domain:
+
+ Achievement +
+
+
+
+

credential

+

credential

+

+ OpenBadgeCredentials that have not been signed with the VC-JWT Proof + Format MUST be in the `credential` array. +

+ +
+
Range:
+
+ AchievementCredential +
+
Domain:
+
+ GetOpenBadgeCredentialsResponse +
+
+
+
+

credentialSubject

+

credentialSubject

+

+ In AchievementCredential:The recipient of the achievement. +

+

+ In EndorsementCredential:The individual, entity, organization, + assertion, or achievement that is endorsed and the endorsement + comment. +

+ +
+
Range:
+
+ Union of:
AchievementSubject
EndorsementSubject +
+
Domain:
+
+ Union of:
AchievementCredential
EndorsementCredential +
+
+
+
+

creditsAvailable

+

creditsAvailable

+

+ Credit hours associated with this entity, or credit hours possible. + For example 3.0. +

+ +
+
Range:
+
+ xsd:float +
+
Domain:
+
+ Achievement +
+
+
+
+

creditsEarned

+

creditsEarned

+

+ The number of credits earned, generally in semester or quarter credit + hours. This field correlates with the Achievement `creditsAvailable` + field. +

+ +
+
Range:
+
+ xsd:float +
+
Domain:
+
+ AchievementSubject +
+
+
+
+

criteria

+

criteria

+

+ Criteria describing how to earn the achievement. +

+ +
+
Range:
+
+ Criteria +
+
Domain:
+
+ Achievement +
+
+
+
+

cryptosuite

+

cryptosuite

+

+ The `cryptosuite` of the verification method MUST be the string + `eddsa-rdf-2022`. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ Multikey +
+
+
+
+

dateOfBirth

+

dateOfBirth

+

Birthdate of the person.

+ +
+
Range:
+
+ xsd:date +
+
Domain:
+
+ Profile +
+
+
+
+

description

+

description

+

+ In Achievement:A short description of the achievement. +

+

+ In AchievementCredential:The short description of the credential for + display purposes in wallets. +

+

+ In EndorsementCredential:The short description of the credential for + display purposes in wallets. +

+

+ In Evidence:A longer description of the evidence. +

+

+ In Profile:A short description of the issuer entity or organization. +

+

+ In RubricCriterionLevel:Description of the rubric criterion level. +

+ +
+
Range:
+
+ https://schema.org/description +
+
Domain:
+
+ Union of:
Achievement
AchievementCredential
EndorsementCredential
Evidence
Profile
RubricCriterionLevel +
+
+
+
+

email

+

email

+

An email address.

+ +
+
Range:
+
+ https://schema.org/email +
+
Domain:
+
+ Profile +
+
+
+
+

endorsement

+

endorsement

+

+ In Achievement:Allows endorsers to make specific claims about the + Achievement. These endorsements are signed with a Data Integrity proof + format. +

+

+ In AchievementCredential:Allows endorsers to make specific claims + about the credential, and the achievement and profiles in the + credential. These endorsements are signed with a Data Integrity proof + format. +

+

+ In Profile:Allows endorsers to make specific claims about the + individual or organization represented by this profile. These + endorsements are signed with a Data Integrity proof format. +

+ +
+
Range:
+
+ EndorsementCredential +
+
Domain:
+
+ Union of:
Achievement
AchievementCredential
Profile +
+
+
+
+

endorsementComment

+

endorsementComment

+

+ Allows endorsers to make a simple claim in writing about the entity. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ EndorsementSubject +
+
+
+
+

endorsementJwt

+

endorsementJwt

+

+ In Achievement:Allows endorsers to make specific claims about the + Achievement. These endorsements are signed with the VC-JWT proof + format. +

+

+ In AchievementCredential:Allows endorsers to make specific claims + about the credential, and the achievement and profiles in the + credential. These endorsements are signed with the VC-JWT proof + format. +

+

+ In Profile:Allows endorsers to make specific claims about the + individual or organization represented by this profile. These + endorsements are signed with the VC-JWT proof format. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ Union of:
Achievement
AchievementCredential
Profile +
+
+
+
+

evidence

+

evidence

+

+ A description of the work that the recipient did to earn the + achievement. This can be a page that links out to other pages if + linking directly to the work is infeasible. +

+ +
+
Range:
+
+ Evidence +
+
Domain:
+
+ AchievementCredential +
+
+
+
+

familyName

+

familyName

+

+ Family name. In the western world, often referred to as the 'last + name' of a person. +

+ +
+
Range:
+
+ https://schema.org/familyName +
+
Domain:
+
+ Profile +
+
+
+
+

familyNamePrefix

+

familyNamePrefix

+

+ Family name prefix. As used in some locales, this is the leading part + of a family name (e.g. 'de' in the name 'de Boer'). +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ Profile +
+
+
+
+

fieldOfStudy

+

fieldOfStudy

+

+ Category, subject, area of study, discipline, or general branch of + knowledge. Examples include Business, Education, Psychology, and + Technology. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ Achievement +
+
+
+
+

genre

+

genre

+

+ A string that describes the type of evidence. For example, Poetry, + Prose, Film. +

+ +
+
Range:
+
+ https://schema.org/genre +
+
Domain:
+
+ Evidence +
+
+
+
+

geo

+

geo

+

+ The geographic coordinates of the location. +

+ +
+
Range:
+
+ GeoCoordinates +
+
Domain:
+
+ Address +
+
+
+
+

givenName

+

givenName

+

+ Given name. In the western world, often referred to as the 'first + name' of a person. +

+ +
+
Range:
+
+ https://schema.org/givenName +
+
Domain:
+
+ Profile +
+
+
+
+

hashed

+

hashed

+

+ Whether or not the `identityHash` value is hashed. +

+ +
+
Range:
+
+ xsd:boolean +
+
Domain:
+
+ IdentityObject +
+
+
+
+

honorificPrefix

+

honorificPrefix

+

+ Honorific prefix(es) preceding a person's name (e.g. 'Dr', 'Mrs' or + 'Mr'). +

+ +
+
Range:
+
+ https://schema.org/honorificPrefix +
+
Domain:
+
+ Profile +
+
+
+
+

honorificSuffix

+

honorificSuffix

+

+ Honorific suffix(es) following a person's name (e.g. 'M.D, PhD'). +

+ +
+
Range:
+
+ https://schema.org/honorificSuffix +
+
Domain:
+
+ Profile +
+
+
+
+

humanCode

+

humanCode

+

+ The code, generally human readable, associated with an achievement. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ Achievement +
+
+
+
+

identifier

+

identifier

+

+ In AchievementSubject:Other identifiers for the recipient of the + achievement. Either `id` or at least one `identifier` MUST be + supplied. +

+

In AnyIdentifier:An identifier.

+

In IdentifierEntry:An identifier.

+ +
+
Range:
+
+ Union of:
IdentityObject +
+
Domain:
+
+ Union of:
AchievementSubject
AnyIdentifier
IdentifierEntry +
+
+
+
+

identifierType

+

identifierType

+

In IdentifierEntry:The identifier type.

+

In IdentifierType:The identifier type.

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ Union of:
IdentifierEntry
IdentifierType +
+
+
+
+

identityHash

+

identityHash

+

+ Either the IdentityHash of the identity or the plaintext value. If + it's possible that the plaintext transmission and storage of the + identity value would leak personally identifiable information where + there is an expectation of privacy, it is strongly recommended that an + IdentityHash be used. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ IdentityObject +
+
+
+
+

identityType

+

identityType

+

The identity type.

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ IdentityObject +
+
+
+
+

image

+

image

+

+ In Achievement:An image representing the achievement. +

+

+ In AchievementCredential:The image representing the credential for + display purposes in wallets. +

+

+ In AchievementSubject:An image representing this user's achievement. + If present, this must be a PNG or SVG image, and should be prepared + via the 'baking' instructions. An 'unbaked' image for the achievement + is defined in the Achievement class and should not be duplicated here. +

+

+ In Profile:An image representing the issuer. This must be a PNG or SVG + image. +

+ +
+
Range:
+
+ Image +
+
Domain:
+
+ Union of:
Achievement
AchievementCredential
AchievementSubject
Profile +
+
+
+
+

key_ops

+

key_ops

+

+ The `key_ops` (key operations) parameter identifies the operation(s) + for which the key is intended to be used, such as `sign` (compute + digital signature or MAC) or `verify` (verify digital signature or + MAC). +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ JWK +
+
+
+
+

keys

+

keys

+

+ A JWK Set is a JSON object that represents a set of JWKs. +

+ +
+
Range:
+
+ JWK +
+
Domain:
+
+ JWKS +
+
+
+
+

kid

+

kid

+

+ The `kid` (key ID) parameter is used to match a specific key. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ JWK +
+
+
+
+

kty

+

kty

+

+ The `kty` (key type) parameter identifies the cryptographic algorithm + family used with the key, such as `RSA` or `EC`. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ JWK +
+
+
+
+

latitude

+

latitude

+

The latitude of the location [[WGS84]].

+ +
+
Range:
+
+ https://schema.org/latitude +
+
Domain:
+
+ GeoCoordinates +
+
+
+
+

level

+

level

+

+ The rubric performance level in terms of success. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ RubricCriterionLevel +
+
+
+
+

licenseNumber

+

licenseNumber

+

+ The license number that was issued with this credential. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ AchievementSubject +
+
+
+
+

longitude

+

longitude

+

The longitude of the location [[WGS84]].

+ +
+
Range:
+
+ https://schema.org/longitude +
+
Domain:
+
+ GeoCoordinates +
+
+
+
+

name

+

name

+

+ In Achievement:The name of the achievement. +

+

+ In AchievementCredential:The name of the credential for display + purposes in wallets. For example, in a list of credentials and in + detail views. +

+

+ In EndorsementCredential:The name of the credential for display + purposes in wallets. For example, in a list of credentials and in + detail views. +

+

+ In Evidence:A descriptive title of the evidence. +

+

+ In Profile:The name of the entity or organization. +

+

+ In ResultDescription:The name of the result. +

+

+ In RubricCriterionLevel:The name of the rubric criterion level. +

+ +
+
Range:
+
+ https://schema.org/name +
+
Domain:
+
+ Union of:
Achievement
AchievementCredential
EndorsementCredential
Evidence
Profile
ResultDescription
RubricCriterionLevel +
+
+
+
+

narrative

+

narrative

+

+ In AchievementSubject:A narrative that connects multiple pieces of + evidence. Likely only present at this location if evidence is a + multi-value array. +

+

+ In Criteria:A narrative of what is needed to earn the achievement. + Markdown is allowed. +

+

+ In Evidence:A narrative that describes the evidence and process of + achievement that led to an assertion. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ Union of:
AchievementSubject
Criteria
Evidence +
+
+
+
+

official

+

official

+

+ If the entity is an organization, `official` is the name of an + authorized official of the organization. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ Profile +
+
+
+
+

otherIdentifier

+

otherIdentifier

+

+ In Achievement:A list of identifiers for the described entity. +

+

+ In Profile:A list of identifiers for the described entity. +

+ +
+
Range:
+
+ IdentifierEntry +
+
Domain:
+
+ Union of:
Achievement
Profile +
+
+
+
+

parentOrg

+

parentOrg

+

The parent organization of the entity.

+ +
+
Range:
+
+ Profile +
+
Domain:
+
+ Profile +
+
+
+
+

patronymicName

+

patronymicName

+

Patronymic name.

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ Profile +
+
+
+
+

phone

+

phone

+

A phone number.

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ Profile +
+
+
+
+

points

+

points

+

+ The points associated with this rubric criterion level. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ RubricCriterionLevel +
+
+
+
+

postOfficeBoxNumber

+

postOfficeBoxNumber

+

+ A post office box number for PO box addresses. +

+ +
+
Range:
+
+ https://schema.org/postOfficeBoxNumber +
+
Domain:
+
+ Address +
+
+
+
+

postalCode

+

postalCode

+

A postal code.

+ +
+
Range:
+
+ https://schema.org/postalCode +
+
Domain:
+
+ Address +
+
+
+
+

publicKeyMultibase

+

publicKeyMultibase

+

+ The `publicKeyMultibase` property of the verification method MUST be a + public key encoded according to [[?MULTICODEC]] and formatted + according to [[?MULTIBASE]]. The multicodec encoding of a Ed25519 + public key is the two-byte prefix `0xed01` followed by the 32-byte + public key data. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ Multikey +
+
+
+ +
+

requiredLevel

+

requiredLevel

+

+ The `id` of the rubric criterion level required to pass as determined + by the achievement creator. +

+ +
+
Range:
+
+ xsd:anyURI +
+
Domain:
+
+ ResultDescription +
+
+
+
+

requiredValue

+

requiredValue

+

+ A value from `allowedValue` or within the range of `valueMin` to + `valueMax` required to pass as determined by the achievement creator. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ ResultDescription +
+
+
+
+

result

+

result

+

The set of results being asserted.

+ +
+
Range:
+
+ Result +
+
Domain:
+
+ AchievementSubject +
+
+
+
+

resultDescription

+

resultDescription

+

+ In Achievement:The set of result descriptions that may be asserted as + results with this achievement. +

+

+ In Result:An achievement can have many result descriptions describing + possible results. The value of `resultDescription` is the `id` of the + result description linked to this result. The linked result + description must be in the achievement that is being asserted. +

+ +
+
Range:
+
+ Union of:
ResultDescription +
+
Domain:
+
+ Union of:
Achievement
Result +
+
+
+
+

resultType

+

resultType

+

+ The type of result this description represents. This is an extensible + enumerated vocabulary. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ ResultDescription +
+
+
+
+

role

+

role

+

+ Role, position, or title of the learner when demonstrating or + performing the achievement or evidence of learning being asserted. + Examples include 'Student President', 'Intern', 'Captain', etc. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ AchievementSubject +
+
+
+
+

rubricCriterionLevel

+

rubricCriterionLevel

+

+ An ordered array of rubric criterion levels that may be asserted in + the linked result. The levels should be ordered from low to high as + determined by the achievement creator. +

+ +
+
Range:
+
+ RubricCriterionLevel +
+
Domain:
+
+ ResultDescription +
+
+
+
+

salt

+

salt

+

+ If the `identityHash` is hashed, this should contain the string used + to salt the hash. If this value is not provided, it should be assumed + that the hash was not salted. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ IdentityObject +
+
+
+
+

source

+

source

+

+ The person, organization, or system that assessed the achievement on + behalf of the issuer. For example, a school may assess the + achievement, while the school district issues the credential. +

+ +
+
Range:
+
+ Profile +
+
Domain:
+
+ AchievementSubject +
+
+
+
+

specialization

+

specialization

+

+ Name given to the focus, concentration, or specific area of study + defined in the achievement. Examples include 'Entrepreneurship', + 'Technical Communication', and 'Finance'. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ Achievement +
+
+
+
+

status

+

status

+

+ The status of the achievement. Required if `resultType` of the linked + ResultDescription is Status. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ Result +
+
+
+
+

streetAddress

+

streetAddress

+

A street address within the locality.

+ +
+
Range:
+
+ https://schema.org/streetAddress +
+
Domain:
+
+ Address +
+
+
+
+

tag

+

tag

+

+ One or more short, human-friendly, searchable, keywords that describe + the type of achievement. +

+ +
+
Range:
+
+ https://schema.org/keywords +
+
Domain:
+
+ Achievement +
+
+
+
+

targetCode

+

targetCode

+

+ If applicable, a locally unique string identifier that identifies the + alignment target within its framework and/or targetUrl. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ Alignment +
+
+
+
+

targetDescription

+

targetDescription

+

+ Short description of the alignment target. +

+ +
+
Range:
+
+ https://schema.org/targetDescription +
+
Domain:
+
+ Alignment +
+
+
+
+

targetFramework

+

targetFramework

+

+ Name of the framework the alignment target. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ Alignment +
+
+
+
+

targetName

+

targetName

+

Name of the alignment.

+ +
+
Range:
+
+ https://schema.org/targetName +
+
Domain:
+
+ Alignment +
+
+
+
+

targetType

+

targetType

+

The type of the alignment target node.

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ Alignment +
+
+
+
+

targetUrl

+

targetUrl

+

+ URL linking to the official description of the alignment target, for + example an individual standard within an educational framework. +

+ +
+
Range:
+
+ xsd:anyURI +
+
Domain:
+
+ Alignment +
+
+
+
+

term

+

term

+

+ The academic term in which this assertion was achieved. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ AchievementSubject +
+
+
+
+

url

+

url

+

+ The homepage or social media profile of the entity, whether individual + or institutional. Should be a URL/URI Accessible via HTTP. +

+ +
+
Range:
+
+ xsd:anyURI +
+
Domain:
+
+ Profile +
+
+
+
+

use

+

use

+

+ The `use` (public key use) parameter identifies the intended use of + the public key, such as `sig` (signature) or `end` (encryption). +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ JWK +
+
+
+
+

value

+

value

+

+ A string representing the result of the performance, or demonstration, + of the achievement. For example, 'A' if the recipient received an A + grade in class. +

+ +
+
Range:
+
+ https://schema.org/value +
+
Domain:
+
+ Result +
+
+
+
+

valueMax

+

valueMax

+

+ The maximum possible `value` that may be asserted in a linked result. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ ResultDescription +
+
+
+
+

valueMin

+

valueMin

+

+ The minimum possible `value` that may be asserted in a linked result. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ ResultDescription +
+
+
+
+

version

+

version

+

+ In Achievement:The version property allows issuers to set a version + string for an Achievement. This is particularly useful when replacing + a previous version with an update. +

+

+ In Related:The version of the related achievement. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ Union of:
Achievement
Related +
+
+
+
+

x5c

+

x5c

+

+ The `x5c` (X.509 certificate chain) parameter contains a chain of one + or more PKIX certificates [[RFC5280]]. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ JWK +
+
+
+
+

x5t

+

x5t

+

+ The `x5t` (X.509 certificate SHA-1 thumbprint) parameter is a + base64url-encoded SHA-1 thumbprint (a.k.a. digest) of the DER encoding + of an X.509 certificate [[RFC5280]]. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ JWK +
+
+
+
+

x5t_S256

+

x5t_S256

+

+ The `x5t#S256` (X.509 certificate SHA-256 thumbprint) parameter is a + base64url-encoded SHA-256 thumbprint (a.k.a. digest) of the DER + encoding of an X.509 certificate [[RFC5280]]. +

+ +
+
Range:
+
+ xsd:string +
+
Domain:
+
+ JWK +
+
+
+
+

x5u

+

x5u

+

+ The `x5u` (X.509 URL) parameter is a URI that refers to a resource for + an X.509 public key certificate or certificate chain [[RFC5280]]. +

+ +
+
Range:
+
+ xsd:anyURI +
+
Domain:
+
+ JWK +
+
+
-
- - - \ No newline at end of file + +