Learner Record
Your Go-to Partner
From foundational initiatives to K-12 and higher education digital transformation to data analytics, 1EdTech standards are designed to accelerate your unique journey to the future of education.
Interconnected Data Powers Better Teaching and Learning.
Explore how 1EdTech standards connect your digital ecosystem.
Achievement
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Achievement Id | id |
Globally unique IRI for the Achievement. If the IRI is a URL it must resolve to an Achievement resource.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Achievement Type | type |
The JSON-LD type of this object. Normally 'Achievement'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Achievement Achievement Type | achievementType |
A CLR Achievement can represent many different types of achievement from an assessment result to membership. Use 'Achievement' to indicate an achievement not in the list of allowed values.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Achievement Alignments | alignments |
Alignment objects describe an alignment between this achievement and a node in an educational framework.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Achievement Associations | associations |
Associations between this achievement and other achievements.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Achievement Available Credits | creditsAvailable |
Credit hours associated with this entity, or credit hours possible. For example '3.0'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Achievement Description | description |
A short description of the achievement. May be the same as name if no description is available.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Achievement Endorsements | endorsements |
Allows endorsers to make specific claims about the Achievement.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Achievement Human Code | humanCode |
The code, generally human readable, associated with an achievement.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Achievement Name | name |
The name of the achievement.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Achievement Fieldofstudy | fieldOfStudy |
Category, subject, area of study, discipline, or general branch of knowledge. Examples include Business, Education, Psychology, and Technology.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Achievement Image | image |
IRI of an image representing the achievement. May be a Data URI or the URL where the image may be found.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Achievement Issuer | issuer |
A profile describing the individual or organization that issues assertions of this achievement.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Achievement Level | level |
Text that describes the level of achievement apart from how the achievement was performed or demonstrated. Examples would include 'Level 1', 'Level 2', 'Level 3', or 'Bachelors', 'Masters', 'Doctoral'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Achievement Requirement | requirement |
Criteria object describing how to earn the achievement.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Achievement Result Descriptions | resultDescriptions |
The set of result descriptions that may be asserted as results with this achievement.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Achievement Signed Endorsements | signedEndorsements |
Signed endorsements in JWS Compact Serialization format.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Achievement Specialization | specialization |
Name given to the focus, concentration, or specific area of study defined in the achievement. Examples include Entrepreneurship, Technical Communication, and Finance.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Achievement Tags | tags |
Tags that describe the type of achievement.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Achievement Extensions | extensions |
The Achievement object can be extended with additional properties.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Achievement Type
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Achievement | Achievement |
Represents a generic achievement.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
AssessmentResult | AssessmentResult |
Represents an assessment result.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Award | Award |
Represents an award.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Badge | Badge |
Represents a generic badge. Set the type to 'BadgeClass' and reference the IMS Open Badges @context file if the achievement is an IMS Open Badges achievement.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Certificate | Certificate |
Represents a credit bearing certificate such as an undergraduate certificate in autism.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Certification | Certification |
Represents a non-credit certification such as a CompTIA certification in IT.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Course | Course |
Represents a course completion.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CommunityService | CommunityService |
Represents community service.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Competency | Competency |
Represents a competency.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Co-Curricular | Co-Curricular |
Represents a co-curricular activity.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Degree | Degree |
Represents a degree.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Diploma | Diploma |
Represents a diploma such as a high school diploma in the United States.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Fieldwork | Fieldwork |
Represents practical activities that are done away school, college, or place of work. Includes internships and practicums.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
License | License |
Represents a license.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Membership | Membership |
Represents membership.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Address
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Address Id | id |
Unique IRI for the Address.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Address Type | type |
The JSON-LD type of this object. Normally 'Address'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Address Country | addressCountry |
The country. For example, USA. You can also provide the two-letter ISO 3166-1 alpha-2 country code.
Found in Comprehensive Learner Record (CLR) 1.0 |
CEDS
Person > Country Code
Similar in intent, with wording differences
|
Address Locality | addressLocality |
The locality. For example, Mountain View.
Found in Comprehensive Learner Record (CLR) 1.0 |
CEDS
Person > Address City
Identical in intent, with wording differences
|
Address Region | addressRegion |
The region. For example, CA.
Found in Comprehensive Learner Record (CLR) 1.0 |
CEDS
Person > State Abbreviation
Identical in intent, with wording differences
|
Postal Code | postalCode |
The postal code. For example, 94043.
Found in Comprehensive Learner Record (CLR) 1.0 |
CEDS
Person > Address Postal Code
Identical in intent, with wording differences
|
P.O. Box Number | postOfficeBoxNumber |
The post office box number for PO box addresses.
Found in Comprehensive Learner Record (CLR) 1.0 |
CEDS
AddresType > postOfficeBox
Identical in intent, with wording differences
|
Street Address | streetAddress |
The street address. For example, 1600 Amphitheatre Pkwy.
Found in Comprehensive Learner Record (CLR) 1.0 |
CEDS
Person > Address Street Number and Name
Identical in intent, with wording differences
|
Alignment
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Alignment ID | id |
Unique IRI for the object.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Alignment Type | type |
The JSON-LD type of this entity. Normally 'Alignment'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Alignment Framework | educationalFramework |
The name of the framework to which the resource being described is aligned.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Alignment Target Code | targetCode |
If applicable, a locally unique string identifier that identifies the alignment target within its framework.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Alignment Target Description | targetDescription |
The description of a node in an established educational framework.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Alignment Target Name | targetName |
The name of a node in an established educational framework.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Alignment Target Type | targetType |
The type of the alignment target node. This is an extensible enumerated vocabulary. Extending the vocabulary makes use of a naming convention.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Alignment Target URL | targetUrl |
The URL of a node in an established educational framework. When the alignment is to a CASE framework and the CASE Service support the CASE JSON-LD binding, the URL should be the 'uri' of the node document, otherwise the URL should be the CASE Service endpoint URL that returns the node JSON.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Alignment Target Type
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
CF Item | CFItem |
An alignment to a CASE Framework Item.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CF Rubric | CFRubric |
An alignment to a CASE Framework Rubric.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CF Rubric Criterion | CFRubricCriterion |
An alignment to a CASE Framework Rubric Criterion.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CF Rubric Criterion Level | CFRubricCriterionLevel |
An alignment to a CASE Framework Rubric Criterion Level.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Credential Engine Item Alignment | CTDL |
An alignment to a Credential Engine Item.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Artifact
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Artifact Type | type |
The JSON-LD type of the object. Normally 'Artifact'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Artifact Description | description |
A description of the artifact.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Artifact Name | name |
The name of the artifact.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Artifact URL | url |
IRI of the artifact. May be a Data URI or the URL where the artifact may be found.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Assertion
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Assertion Id | id |
Globally unique IRI for the Assertion. If the IRI is a URL it must resolve to an Assertion resource. If the Assertion is verified using Hosted verification, the IRI must be a URL.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Assertion Type | type |
The JSON-LD type of this object. Normally 'Assertion'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Assertion Achievement | achievement |
Required unless the assertion is an Open Badge.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Assertion Credits Earned | creditsEarned |
The number of credits earned, generally in semester or quarter credit hours. This field correlates with the Achievement creditsAvailable field.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Assertion End Date | endDate |
If present, the assertion is not valid after this date.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Assertion Endorsements | endorsements |
Allows endorsers to make specific claims about the assertion.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Assertion Evidence | evidence |
Evidence describing the work that the recipient did to earn the achievement. This can be a webpage that links out to other pages if linking directly to the work is infeasible.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Assertion Image | image |
IRI of an image representing the assertion. May be a Data URI or the URL where the image may be found.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Assertion Issuedon | issuedOn |
Timestamp of when the achievement was awarded. Required unless the assertion is revoked.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Assertion License Number | licenseNumber |
The license number that was issued with this assertion.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Assertion Narrative | narrative |
A narrative that describes the connection between multiple pieces of evidence. Likely only present if evidence is a multi-value array. Markdown allowed.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Assertion Recipient | recipient |
The recipient of the achievement. Required unless the assertion is revoked.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Assertion Results | results |
The set of results being asserted.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Assertion Revocation Reason | revocationReason |
Optional published reason for revocation, if revoked.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Assertion Revoked | revoked |
Defaults to false if this assertion is not referenced in a RevocationList. If revoked is true, only revoked and id are required properties, and many issuers strip a hosted assertion down to only those properties when revoked.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Assertion 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.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Assertion Signed Endorsements | signedEndorsements |
Signed endorsements in JWS Compact Serialization format.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Assertion Source | source |
The person, organization, or system that assessed the achievement. The Achievement issuer is responsible for supporting verification.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Assertion Startdate | startDate |
If present, the assertion is not valid before this date.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Assertion Term | term |
The academic term in which this assertion was achieved.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Assertion Verification | verification |
Instructions for third parties to verify this assertion.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Assertion Extensions | extensions |
The assertion object can be extended with additional properties.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Association
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Association Association Type | associationType |
The type of association. This uses an enumerated vocabulary.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Association Target ID | targetId |
The '@id' of another achievement, or target of the association.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Association Title | title |
A human readable title for the associated achievement.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Association Type
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Exact Match Of | exactMatchOf |
The target is derived from the source.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Exemplar | exemplar |
The target is an example of best practice for the definition of the source.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Has Skill Level | hasSkillLevel |
The target is understood to define a given skill level i.e. Reading Lexile 100, Depth Knowledge 2, or Cognitive Level (Blooms Taxonomy) etc.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Is Child Of | isChildOf |
To represent the structural relationship in a taxonomy between parent and child. The source is a child of the target.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Is Parent Of | isParentOf |
To represent the structural relationship in a taxonomy between parent and child. The source is a parent of the target.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Is Part Of | isPartOf |
The source of the association is included either physically or logically in the target. This classifies an Achievement as being logically or semantically contained as a subset of the target.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Is Peer Of | isPeerOf |
The source is a peer of the target. Where IsRelatedTo is intended to show relationships within a topic or domain, isPeerOf shows an approximation of relationships across topics or domains.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Is Related To | isRelatedTo |
The source of the association is related to the target in some way that is not better described by another association type.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Precedes | precedes |
The source of the association comes before the target of the association in time or order.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Replaced By | replacedBy |
The source of the association has been supplanted by, displaced by, or superseded by the target of the association.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Comprehensive Learner Record (CLR)
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
CLR ID | id |
Globally unique IRI for the CLR. If the IRI is a URL is must resolve to a CLR resource and conform to the getClr endpoint format. If the CLR is verified using Hosted verification, the IRI must be a URL.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLR Type | type |
The JSON-LD type of this object. Normally 'CLR'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLR Achievements | achievements |
Array of achievements that are related directly or indirectly through associations with the asserted achievements in the CLR. Primarily used to represent hierarchical pathways. Asserted achievements may appear in both this array and in the achievement assertion. If asserted achievements do appear in both places, they MUST match exactly.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLR Assertions | assertions |
The learner's asserted achievements.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLR Issued On | issuedOn |
Timestamp of when the CLR was published.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLR Learner | learner |
The profile describing the recipient of the achievement assertions.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLR Name | name |
Optional name of the CLR.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLR Partial | partial |
True if CLR does not contain all the assertions known by the publisher for the learner at the time the CLR is issued. Useful if you are sending a small set of achievements in real time when they are achieved. If False or omitted, the CLR SHOULD be interpreted as containing all the assertions for the learner known by the publisher at the time of issue.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLR Publisher | publisher |
A profile describing the publisher of the CLR.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLR Revocation Reason | revocationReason |
If revoked, optional reason for revocation.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLR Revoked | revoked |
If True the CLR is revoked.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLR Signed Assertions | signedAssertions |
Signed assertions in JWS Compact Serialization format.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLR Verification | verification |
Instructions for third parties to verify this CLR.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLR Payload
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
CLR | clr |
The Clr if not signed.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Signed CLR | signedClr |
The signed Clr in JWS Compact Serialization format.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLR Set
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
CLR Set ID | id |
Unique IRI for the ClrSet.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLR Set Type | type |
The JSON-LD type of this object. Normally 'CLRSet'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLRs | clrs |
A set of Clrs
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Signed CLRs | signedClrs |
A set of Clrs in JWS Compact Serialization format.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Compact JWS
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Compact JWS Pattern | pattern |
The regular expression for a Compact JWS. The regular expression for a Compact JWS.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Criteria
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Criteria ID | id |
The URI of a webpage that describes the criteria for the Achievement in a human-readable format.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Criteria Type | type |
The JSON-LD type of this object. Normally 'Criteria'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Criteria | narrative |
A narrative of what is needed to earn the achievement. Markdown allowed.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Criteria Extensions | extensions |
Criteria can be extended with additional properties.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Cryptographic Key
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Cryptographic Key Id | id |
The URI of the CryptographicKey document. Used during signed verification.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Cryptographic Key Type | type |
The JSON-LD type of this object. Normally 'CryptographicKey'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Cryptographic Key Owner | owner |
The identifier for the Profile that owns this PUBLIC KEY and the PRIVATE KEY used to sign the assertion or endorsement.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Cryptographic Key Public Key Pem | publicKeyPem |
The PUBLIC KEY in PEM format corresponding to the PRIVATE KEY used by the owner to sign the assertion or endorsement. The PEM key encoding is a widely-used method to express public keys, compatible with almost every Secure Sockets Layer library implementation.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Discovery Document
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Discovery Document Authorization URL | authorizationUrl |
A fully qualifed URL to the provider's OAuth 2.0 Authorization endpoint.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Discovery Document Image | image |
An image representing the provider. May be a Data URI or the URL where the image may be found.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Discovery Document Name | name |
The user-facing name of the platform providing CLR services.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Discovery Document Privacy Policy URL | privacyPolicyUrl |
A fully qualified URL to the provider's privacy policy.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Discovery Document Registration URL | registrationUrl |
A fully qualified URL to the provider's OAuth 2.0 Registration endpoint.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Discovery Document Scopes | scopesOffered |
An array of OAuth 2.0 Scopes supported by the provider.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Discovery Document Terms of Service URL | termsOfServiceUrl |
A fully qualified URL to the provider's terms of service.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Discovery Document Token URL | tokenUrl |
A fully qualified URL to the provider's OAuth 2.0 Token endpoint.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Endorsement Id | id |
Globally unique IRI for the Endorsement. If this Endorsement will be verified using Hosted verification, the value should be the URL of the hosted version of the Endorsement.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement Type | type |
The JSON-LD type of this entity. Normally 'Endorsement'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement Claim | claim |
An entity, identified by an id and additional properties that the endorser would like to claim about that entity.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement Issued Date | issuedOn |
Timestamp of when the endorsement was published.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement Issuer | issuer |
The issuer's Profile.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement Revocation Reason | revocationReason |
If revoked, optional reason for revocation.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement Revoked | revoked |
If True the endorsement is revoked.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement Verification | verification |
Instructions for third parties to verify this assertion of endorsement.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement Claim
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Endorsement Claim Id | id |
The 'id' of the Profile, Achievement, or Assertion being endorsed.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement Claim Type | type |
The JSON-LD type of this entity. Normally 'EndorsementClaim'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement Claim Endorsement Comment | endorsementComment |
An endorer's comment about the quality or fitness of the endorsed entity. Markdown allowed.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement Claim Extensions | extensions |
The EndorsementClaim object can be extended with additional properties.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement Profile
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Endorsement Profile ID | id |
Globally unique IRI for the Profile.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement Profile Type | type |
The JSON-LD type of this entity. Normally 'EndorsementProfile'. Unlike Profile, EndorsementProfile cannot have endorsements.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement Profile Address | address |
An address for the individual or organization.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement Profile Description | description |
A short description of the individual or organization.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement Profile Email |
A contact email address for the individual or organization.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A | |
Endorsement Profile Image | image |
Image representing the individual or organization.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement Profile Name | name |
The name of the individual or organization.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement Profile Public Key | publicKey |
The CrytographicKey object used to verify signed Assertions, Clrs, and Endorsements.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement Profile Revocation List | revocationList |
The URL of the Revocation List document used for marking revocation of signed Assertions, CLRs, and Endorsements. Required for issuer profiles.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement Profile Interoperability ID | sourcedId |
The individual's unique 'sourcedId' value, which is used for providing interoperability with IMS Learning Information Services (LIS).
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement Profile Student ID | studentId |
An institution's student identifier for the person. This is frequently issued through a Student Information System.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement Profile Telephone | telephone |
Primary phone number for the individual or organization.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement Profile URL | url |
Web resource that uniquely represents or belongs to the individual. This may be a resource about the individual, hosting provided by the instution to the individual, or an web resource independently controlled by the individual.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement Profile Verifcation Instructions | verification |
Instructions for how to verify Assertion issued by this Profile.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Endorsement Profile Extensions | extensions |
Profile can be extended with additional properties.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Vocabulary List Extension Pattern
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Extensible Enumeration Pattern | pattern |
The regular expression to constrain the structure of the string that MUST be used when creating a new, proprietary vocabulary term. The term must start with the substring 'ext:'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Evidence
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Evidence ID | id |
The URI of a webpage presenting evidence of achievement.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Evidence Type | type |
The JSON-LD type of this entity. Normally 'Evidence'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Evidence Artifacts | artifacts |
Artifacts that are part of the evidence.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Evidence Audience | audience |
A description of the intended audience for a piece of evidence.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Evidence Description | description |
A longer description of the evidence.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Evidence Genre | genre |
A string that describes the type of evidence. For example, Poetry, Prose, Film.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Evidence Name | name |
The name of the evidence.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Evidence Narrative | narrative |
A narrative that describes the evidence and process of achievement that led to an assertion. Markdown allowed.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Achievement Type Vocabulary
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Extensible Enumeration Pattern | pattern |
The regular expression to constrain the structure of the string that MUST be used when creating a new, proprietary vocabulary term. The term must start with the substring 'ext:'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Achievement | Achievement |
Represents a generic achievement.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
AssessmentResult | AssessmentResult |
Represents an assessment result.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Award | Award |
Represents an award.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Badge | Badge |
Represents a generic badge. Set the type to 'BadgeClass' and reference the IMS Open Badges @context file if the achievement is an IMS Open Badges achievement.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Certificate | Certificate |
Represents a credit bearing certificate such as an undergraduate certificate in autism.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Certification | Certification |
Represents a non-credit certification such as a CompTIA certification in IT.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Course | Course |
Represents a course completion.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CommunityService | CommunityService |
Represents community service.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Competency | Competency |
Represents a competency.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Co-Curricular | Co-Curricular |
Represents a co-curricular activity.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Degree | Degree |
Represents a degree.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Diploma | Diploma |
Represents a diploma such as a high school diploma in the United States.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Fieldwork | Fieldwork |
Represents practical activities that are done away school, college, or place of work. Includes internships and practicums.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
License | License |
Represents a license.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Membership | Membership |
Represents membership.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Alignment Target Type
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Extensible Enumeration Pattern | pattern |
The regular expression to constrain the structure of the string that MUST be used when creating a new, proprietary vocabulary term. The term must start with the substring 'ext:'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CF Item | CFItem |
An alignment to a CASE Framework Item.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CF Rubric | CFRubric |
An alignment to a CASE Framework Rubric.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CF Rubric Criterion | CFRubricCriterion |
An alignment to a CASE Framework Rubric Criterion.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CF Rubric Criterion Level | CFRubricCriterionLevel |
An alignment to a CASE Framework Rubric Criterion Level.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Credential Engine Item Alignment | CTDL |
An alignment to a Credential Engine Item.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Extensible Result Type
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Extensible Enumeration Pattern | pattern |
The regular expression to constrain the structure of the string that MUST be used when creating a new, proprietary vocabulary term. The term must start with the substring 'ext:'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Type Grade Point Average | GradePointAverage |
The result is a grade point average.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Type Letter Grade | LetterGrade |
The result is a letter grade.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Type Percent | Percent |
The result is a percent score.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Type Performance Level | PerformanceLevel |
The result is a performance level.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Type Predicted Score | PredictedScore |
The result is a predicted score.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Type Result | Result |
Represents a generic result.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Type Raw Score | RawScore |
The result is a raw score.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Type Rubric Criterion | RubricCriterion |
The result is from a rubric criterion.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Type Rubric Criterion Level | RubricCriterionLevel |
The result is a rubric criterion level.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Type Rubric Score | RubricScore |
The result represents a rubric score with both a name and a numeric value.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Type Scaled Score | ScaledScore |
The result is a scaled score.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLR IRI
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|
Identity
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Identity ID | id |
Unique IRI for the Identity.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Identity Type | type |
The type should identify the property by which the recipient of an Assertion is identified. This value should be an IRI mapped in the present context. For example, 'id' indicates that the identity property value is the id of the recipient's profile.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Identity | identity |
Either the hash 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.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Identity Is Hashed | hashed |
Whether or not the identity value is hashed.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Identity Salt | salt |
If the recipient 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.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Markdown
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|
CLR Profile
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
CLR Profile ID | id |
Globally unique IRI for the Learner, Publisher, and Issuer Profile. If the IRI is a URL it must resolve to a Profile resource. The Assertion Recipient is identified by reference to the Learner's Profile via the id, email, url, telephone, sourcedId, or studentId property.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLR Profile Type | type |
The JSON-LD type of this object. Normally 'Profile'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLR User Address | address |
An address for the individual or organization.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLR Profile Description | description |
A short description of the individual or organization.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLR User Email |
A contact email address for the individual or organization.
Found in Comprehensive Learner Record (CLR) 1.0 |
CEDS
Person > Electronic Mail Address
Similar in intent, with wording differences
CEDS
Organization > Electronic Mail Address
Similar in intent, with wording differences
|
|
CLR Profile Endorsements | endorsements |
Allows endorsers to make specific claims about the individual or organization represented by this profile.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLR Profile Image | image |
IRI of an image representing the individual or organization. May be a DATA URI or the URL where the image may be found.
Found in Comprehensive Learner Record (CLR) 1.0 |
CEDS
Organization > Organization Image URL
Identical in intent, with wording differences
|
CLR User Name | name |
The name of the individual or organization.
Found in Comprehensive Learner Record (CLR) 1.0 |
CEDS
Person > Last Name
Superset of
CEDS
Person > First Name
Superset of
CEDS
Person > Middle Name
Superset of
CEDS
Organization > Organization Name
Similar in intent, with wording differences
|
CLR Profile Public Key | publicKey |
The CrytographicKey object used to verify signed Assertions, Clrs, and Endorsements.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLR Profile Revocation List | revocationList |
The URL of the Revocation List document used for marking revocation of signed Assertions, CLRs, and Endorsements. Required for issuer profiles.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLR Profile Signedendorsements | signedEndorsements |
Signed endorsements in JWS Compact Serialization format.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLR Profile Interoperability ID | sourcedId |
The individual's or organization's unique 'sourcedId' value, which is used for providing interoperability with other identity systems.
Found in Comprehensive Learner Record (CLR) 1.0 |
CEDS
Organization > Organization Identifier
Similar in intent, with wording differences
|
CLR Profile Studentid | studentId |
An institution's student identifier for the person. This is frequently issued through a Student Information System.
Found in Comprehensive Learner Record (CLR) 1.0 |
CEDS
Person > Student Identifier
Similar in intent, with wording differences
CEDS
Person > Person Identifier
Similar in intent, with wording differences
|
CLR User Telephone | telephone |
Primary phone number for the individual or organization.
Found in Comprehensive Learner Record (CLR) 1.0 |
CEDS
PhoneType > phoneExtension
Superset of
CEDS
PhoneType > dialNumber
Superset of
CEDS
PhoneType > countryDialingCode
Superset of
CEDS
Organization > Telephone Number
Similar in intent, with wording differences
CEDS
PhoneType > areaDialingCode
Superset of
CEDS
Person > Primary Telephone Number Indicator
Superset of
CEDS
Person > Telephone Number
Superset of
|
CLR Profile Url | url |
Web resource that uniquely represents or belongs to the individual. This may be a resource about the individual, hosting provided by the instution to the individual, or an web resource independently controlled by the individual.
Found in Comprehensive Learner Record (CLR) 1.0 |
CEDS
Organization > Web Site Address
Similar in intent, with wording differences
|
CLR Profile Verification | verification |
Issuer and publisher profiles should have a verification property with a type of 'Verification'. Instructions for how to verify assertions and endorsements issued by the individual or organization represented by this profile.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
CLR Profile Extensions | extensions |
The Profile object can be extended with additional properties.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Result ID | id |
Unique IRI for the object.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Type | type |
The JSON-LD type of this object. Normally 'Result'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Level Achieved | achievedLevel |
The id of the RubricCriterionLevel achieved.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Alignments | alignments |
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.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Description | resultDescription |
The id of the ResultDescription describing this result.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Value | value |
A grade or value representing the result of the performance, or demonstration, of the achievement. For example, 'A' if the recipient received a grade of A in the class.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Description
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Result Description Id | id |
Unique IRI for the ResultDescription.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Description Type | type |
The JSON-LD type of this object. Normally 'ResultDescription'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Description Alignments | alignments |
The alignments between this result description and nodes in external frameworks.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Description Allowed Values | allowedValues |
The ordered from 'low' to 'high' set of allowed values.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Description Name | name |
The name of the result.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Description Required Level | requiredLevel |
The id of the RubricCriterionLevel required to 'pass'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Description Required Value | requiredValue |
The value from allowedValues or within the range of valueMin to valueMax required to 'pass'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Description Resulttype | resultType |
The type of result. This is an extensible enumerated vocabulary.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Description Rubric Criterion Levels | rubricCriterionLevels |
The ordered from 'low' to 'high' set of rubric criterion levels that may be asserted.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Description Valuemax | valueMax |
The maximum possible result that may be asserted.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Description Valuemin | valueMin |
The minimum possible result that may be asserted.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Type
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Result Type Grade Point Average | GradePointAverage |
The result is a grade point average.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Type Letter Grade | LetterGrade |
The result is a letter grade.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Type Percent | Percent |
The result is a percent score.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Type Performance Level | PerformanceLevel |
The result is a performance level.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Type Predicted Score | PredictedScore |
The result is a predicted score.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Type Result | Result |
Represents a generic result.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Type Raw Score | RawScore |
The result is a raw score.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Type Rubric Criterion | RubricCriterion |
The result is from a rubric criterion.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Type Rubric Criterion Level | RubricCriterionLevel |
The result is a rubric criterion level.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Type Rubric Score | RubricScore |
The result represents a rubric score with both a name and a numeric value.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Result Type Scaled Score | ScaledScore |
The result is a scaled score.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Revocation List
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Revocationlist Id | id |
The URI of the RevocationList document. Used during Signed verification.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Revocationlist Type | type |
The JSON-LD type of this entity. Normally 'RevocationList'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Revocationlist Issuer | issuer |
The id of the Issuer.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Revoked Assertions | revokedAssertions |
The ids of revoked Assertions, Clrs, and Endorsements.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Rubric Criterion Level
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Rubric Criterion Level ID | id |
Unique IRI for the ResultCriterionLevel.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Rubric Criterion Level Type | type |
The JSON-LD type of this object. Normally 'RubricCriterionLevel'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Rubric Criterion Level Alignments | alignments |
The alignments between this rubric criterion level and nodes in external frameworks.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Rubric Criterion Level Description | description |
A description of the rubric criterion level.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Rubric Criterion Level Level | level |
The rubric performance level in terms of success.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Rubric Criterion Level Name | name |
The name of the RubricCriterionLevel.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Rubric Criterion Level Points | points |
The number of grade points corresponding to a specific rubric level.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Comprehensive Learner Record (CLR) URL
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|
Universal Unique Identifier
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
UUID Pattern | pattern |
Defines the regular expression that imposes the form of UUID.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Verification
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Verification ID | id |
Unique IRI for the Verification.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Verification Type | type |
The JSON-LD type of this object. The strongly typed value indicates the verification method.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Verification Allowed Origins | allowedOrigins |
The host registered name subcomponent of an allowed origin. Any given id URI will be considered valid.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Verification Creator | creator |
The (HTTP) id of the key used to sign the Assertion, CLR, or Endorsement. If not present, verifiers will check the public key declared in the referenced issuer Profile. If a key is declared here, it must be authorized in the issuer Profile as well. creator is expected to be the dereferencable URI of a document that describes a CryptographicKey.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Verification Address Start | startsWith |
The URI fragment that the verification property must start with. Valid Assertions, Clrs, and Endorsements must have an id within this scope. Multiple values allowed, and Assertions, Clrs, and Endorsements will be considered valid if their id starts with one of these values.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Verification Property | verificationProperty |
The property to be used for verification. Only 'id' is supported. Verifiers will consider 'id' the default value if verificationProperty is omitted or if an issuer Profile has no explicit verification instructions, so it may be safely omitted.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Verification Type
These properties are found in the
Comprehensive Learner Record (CLR)
1.0
Learn more about Comprehensive Learner Record (CLR)
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Hosted | Hosted |
The Assertion or Endorsement should be verified using the object's property identified by the Verification's 'verificationProperty'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Signed | Signed |
The Assertion or Endorsement is cryptographically signed. The signature should be verified using the key identified by the Verification's 'creator' property.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Verification | Verification |
Issuer and publisher profiles should have a verification property with a type of 'Verification'.
Found in Comprehensive Learner Record (CLR) 1.0 |
N/A |
Badge Endorsement
These properties are found in the
Open Badges
2.1
Learn more about Open Badges
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Badge Endorsement Id | id |
Unique IRI for the Endorsement instance. If using hosted verification, this should be the URI where the assertion of endorsement is accessible. For signed Assertions, it is recommended to use a UUID in the urn:uuid namespace.
Found in Open Badges 2.1 |
N/A |
Badge Endorsement Claim | claim |
An entity, identified by an id and additional properties that the endorser would like to claim about that entity.
Found in Open Badges 2.1 |
N/A |
Badge Endorsement Issuer | issuer |
The profile of the Endorsement’s issuer.
Found in Open Badges 2.1 |
N/A |
Badge Endorsement Issued On | issuedOn |
Timestamp of when the endorsement was published.
Found in Open Badges 2.1 |
N/A |
Badge Endorsement Verification | verification |
Instructions for third parties to verify this assertion of endorsement.
Found in Open Badges 2.1 |
N/A |
Badge Endorsement Endorsement Comment | endorsementComment |
Allows endorsers to make a simple claim in writing about the entity.
Found in Open Badges 2.1 |
N/A |
Badge Endorsement Extensions | extensions |
Found in Open Badges 2.1 |
N/A |
Badge Cryptographic Key
These properties are found in the
Open Badges
2.1
Learn more about Open Badges
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Badge Cryptographic Key Owner | owner |
The identifier for the Profile that owns this key. There should be a two-way connection between this Profile and the CryptographicKey through the owner and publicKey properties.
Found in Open Badges 2.1 |
N/A |
Badge Cryptographic Key Public Key Pem Encoding | publicKeyPem |
The PEM key encoding is a widely-used method to express public keys, compatible with almost every Secure Sockets Layer library implementation.
Found in Open Badges 2.1 |
N/A |
Badge Cryptographic Key Extensions | extensions |
Found in Open Badges 2.1 |
N/A |
Badge Verification Object
These properties are found in the
Open Badges
2.1
Learn more about Open Badges
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Badge Verification Object Type | type |
The type of verification method. Supported values for single assertion verification are HostedBadge and SignedBadge (aliases in context are available: hosted and signed). For instances used in Profiles, the type VerificationObject should be used.
Found in Open Badges 2.1 |
N/A |
Badge Verification Object Verification Property | verificationProperty |
The @id of the property to be used for verification that an Assertion is within the allowed scope. Only id is supported. Verifiers will consider id the default value if verificationProperty is omitted or if an issuer Profile has no explicit verification instructions, so it may be safely omitted.
Found in Open Badges 2.1 |
N/A |
Badge Verification Object Starts With | startsWith |
The URI fragment that the verification property must start with. Valid Assertions must have an id within this scope. Multiple values allowed, and Assertions will be considered valid if their id starts with one of these values.
Found in Open Badges 2.1 |
N/A |
Badge Verification Object Allowed Origins | allowedOrigins |
The host registered name subcomponent of an allowed origin. Any given id URI will be considered valid.
Found in Open Badges 2.1 |
N/A |
Badge Verification Object Extensions | extensions |
Found in Open Badges 2.1 |
N/A |
Badge IRI
These properties are found in the
Open Badges
2.1
Learn more about Open Badges
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|
Badge Profile
These properties are found in the
Open Badges
2.1
Learn more about Open Badges
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Badge Profile Type | type |
Valid representation of Profile type. In most cases, this will simply be the string Profile.
Found in Open Badges 2.1 |
N/A |
Badge Profile Name | name |
The name of the entity or organization.
Found in Open Badges 2.1 |
N/A |
Badge Profile Url | url |
The homepage or social media profile of the entity, whether individual or institutional. Should be a URL/URI Accessible via HTTP.
Found in Open Badges 2.1 |
N/A |
Badge Profile Telephone | telephone |
A phone number for the entity. For maximum compatibility, the value should be expressed as a + and country code followed by the number with no spaces or other punctuation, like +16175551212 (E.164 format).
Found in Open Badges 2.1 |
N/A |
Badge Profile Description | description |
A short description of the issuer entity or organization.
Found in Open Badges 2.1 |
N/A |
Badge Profile Image | image |
An image representing the issuer. This must be a PNG or SVG image.
Found in Open Badges 2.1 |
N/A |
Badge Profile Email |
Contact address for the individual or organization.
Found in Open Badges 2.1 |
N/A | |
Badge Profile Public Key | publicKey |
The key(s) an issuer uses to sign Assertions.
Found in Open Badges 2.1 |
N/A |
Badge Profile Verification | verification |
Instructions for how to verify Assertions published by this Profile.
Found in Open Badges 2.1 |
N/A |
Badge Profile Revocation List | revocationList |
HTTP URI of the Badge Revocation List used for marking revocation of signed badges.
Found in Open Badges 2.1 |
N/A |
Badge Profile Extensions | extensions |
Found in Open Badges 2.1 |
N/A |
Badge Alignment Object
These properties are found in the
Open Badges
2.1
Learn more about Open Badges
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Badge Alignment Object Target Name | targetName |
Name of the alignment.
Found in Open Badges 2.1 |
N/A |
Badge Alignment Object Targeturl | targetUrl |
URL linking to the official description of the alignment target, for example an individual standard within an educational framework.
Found in Open Badges 2.1 |
N/A |
Badge Alignment Object Target Description | targetDescription |
Short description of the alignment target.
Found in Open Badges 2.1 |
N/A |
Badge Alignment Object Target Framework | targetFramework |
Name of the framework the alignment target.
Found in Open Badges 2.1 |
N/A |
Badge Alignment Object Targetcode | targetCode |
If applicable, a locally unique string identifier that identifies the alignment target within its framework and/or targetUrl.
Found in Open Badges 2.1 |
N/A |
Badge Alignment Object Extensions | extensions |
Found in Open Badges 2.1 |
N/A |
Badge Assertion
These properties are found in the
Open Badges
2.1
Learn more about Open Badges
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Badge Assertion Type | type |
A valid representation of the Assertion type. In most cases, this will simply be the string Assertion.
Found in Open Badges 2.1 |
N/A |
Badge Assertion Recipient | recipient |
The recipient of the achievement.
Found in Open Badges 2.1 |
N/A |
Badge Assertion Badge | badge |
The type of badge being awarded.
Found in Open Badges 2.1 |
N/A |
Badge Assertion Verification | verification |
Instructions for third parties to verify this assertion.
Found in Open Badges 2.1 |
N/A |
Badge Assertion Issued On | issuedOn |
Timestamp of when the achievement was awarded.
Found in Open Badges 2.1 |
N/A |
Badge Assertion Image | image |
An image representing this user’s achievement. This must be a PNG or SVG image, and should be prepared via the Baking specification. An ‘unbaked’ image for the badge is defined in the BadgeClass and should not be duplicated here.
Found in Open Badges 2.1 |
N/A |
Badge Assertion 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.
Found in Open Badges 2.1 |
N/A |
Badge Assertion Narrative | narrative |
A narrative that connects multiple pieces of evidence. Likely only present at this location if evidence is a multi-value array.
Found in Open Badges 2.1 |
N/A |
Badge Assertion Expires | expires |
If the achievement has some notion of expiry, this indicates a timestamp when a badge should no longer be considered valid. After this time, the badge should be considered expired.
Found in Open Badges 2.1 |
N/A |
Badge Assertion Revoked | revoked |
Defaults to false if Assertion is not referenced from a revokedAssertions list and may be omitted. See RevocationList. If revoked is true, only revoked and id are required properties, and many issuers strip a hosted Assertion down to only those properties when revoked.
Found in Open Badges 2.1 |
N/A |
Badge Assertion Revocation Reason | revocationReason |
Optional published reason for revocation, if revoked.
Found in Open Badges 2.1 |
N/A |
Badge Assertion Extensions | extensions |
Found in Open Badges 2.1 |
N/A |
Badge URI
These properties are found in the
Open Badges
2.1
Learn more about Open Badges
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|
Badge URL
These properties are found in the
Open Badges
2.1
Learn more about Open Badges
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|
Badge Image
These properties are found in the
Open Badges
2.1
Learn more about Open Badges
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Badge Image Id | id |
The URI or Data URI of the image.
Found in Open Badges 2.1 |
N/A |
Badge Image Type | type |
Defaults to schema:ImageObject.
Found in Open Badges 2.1 |
N/A |
Badge Image Caption | caption |
The caption for the image.
Found in Open Badges 2.1 |
N/A |
Badge Image Author | author |
The author of the image, if desired.
Found in Open Badges 2.1 |
N/A |
Badge Image Extensions | extensions |
Found in Open Badges 2.1 |
N/A |
Badge Issuer
These properties are found in the
Open Badges
2.1
Learn more about Open Badges
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Badge Issuer Type | type |
Valid representation of Issuer type. In most cases, this will simply be the string Issuer.
Found in Open Badges 2.1 |
N/A |
Badge Issuer Name | name |
The name of the entity or organization.
Found in Open Badges 2.1 |
N/A |
Badge Issuer Url | url |
The homepage or social media profile of the entity, whether individual or institutional. Should be a URL/URI Accessible via HTTP.
Found in Open Badges 2.1 |
N/A |
Badge Issuer Email |
Contact address for the individual or organization.
Found in Open Badges 2.1 |
N/A | |
Badge Profile Telephone | telephone |
A phone number for the entity. For maximum compatibility, the value should be expressed as a + and country code followed by the number with no spaces or other punctuation, like +16175551212 (E.164 format).
Found in Open Badges 2.1 |
N/A |
Badge Profile Description | description |
A short description of the issuer entity or organization.
Found in Open Badges 2.1 |
N/A |
Badge Profile Image | image |
An image representing the issuer. This must be a PNG or SVG image.
Found in Open Badges 2.1 |
N/A |
Badge Profile Public Key | publicKey |
The key(s) an issuer uses to sign Assertions.
Found in Open Badges 2.1 |
N/A |
Badge Profile Verification | verification |
Instructions for how to verify Assertions published by this Profile.
Found in Open Badges 2.1 |
N/A |
Badge Profile Revocation List | revocationList |
HTTP URI of the Badge Revocation List used for marking revocation of signed badges.
Found in Open Badges 2.1 |
N/A |
Badge Profile Extensions | extensions |
Found in Open Badges 2.1 |
N/A |
Hosted Badge
These properties are found in the
Open Badges
2.1
Learn more about Open Badges
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Hosted Badge Type | type |
Found in Open Badges 2.1 |
N/A |
Badge Verification Object Verification Property | verificationProperty |
The @id of the property to be used for verification that an Assertion is within the allowed scope. Only id is supported. Verifiers will consider id the default value if verificationProperty is omitted or if an issuer Profile has no explicit verification instructions, so it may be safely omitted.
Found in Open Badges 2.1 |
N/A |
Badge Verification Object Starts With | startsWith |
The URI fragment that the verification property must start with. Valid Assertions must have an id within this scope. Multiple values allowed, and Assertions will be considered valid if their id starts with one of these values.
Found in Open Badges 2.1 |
N/A |
Badge Verification Object Allowed Origins | allowedOrigins |
The host registered name subcomponent of an allowed origin. Any given id URI will be considered valid.
Found in Open Badges 2.1 |
N/A |
Badge Verification Object Extensions | extensions |
Found in Open Badges 2.1 |
N/A |
Badge Class
These properties are found in the
Open Badges
2.1
Learn more about Open Badges
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Badge Class Type | type |
Valid representation of the BadgeClass type. In most cases, this will simply be the string BadgeClass.
Found in Open Badges 2.1 |
N/A |
Badge Class Name | name |
The name of the achievement.
Found in Open Badges 2.1 |
N/A |
Badge Class Description | description |
A short description of the achievement.
Found in Open Badges 2.1 |
N/A |
Badge Class Image | image |
An image of the achievement. This must be a PNG or SVG image.
Found in Open Badges 2.1 |
N/A |
Badge Class Criteria | criteria |
Criteria document describing how to earn the achievement.
Found in Open Badges 2.1 |
N/A |
Badge Class Issuer | issuer |
A description of the individual, entity, or organization that issued the badge.
Found in Open Badges 2.1 |
N/A |
Badge Class Alignment | alignment |
An object describing which objectives or educational standards this badge aligns to, if any.
Found in Open Badges 2.1 |
N/A |
Badge Class Tags | tags |
A tag that describes the type of achievement.
Found in Open Badges 2.1 |
N/A |
Badge Class Related | related |
Identifies a related version of the entity.
Found in Open Badges 2.1 |
N/A |
Badge Class Version | version |
The version identifier for the present edition of the entity.
Found in Open Badges 2.1 |
N/A |
Badge Class Endorsement | endorsement |
A claim made about this entity. Note: As endorsements must be published after the publication of the entity they endorse, it will not always be possible to establish a two-way linkage with this property.
Found in Open Badges 2.1 |
N/A |
Badge Class Extensions | extensions |
Found in Open Badges 2.1 |
N/A |
Badge Assertion Payload
These properties are found in the
Open Badges
2.1
Learn more about Open Badges
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Badge Assertion Payload Assertion | assertion |
An unsigned Assertion object.
Found in Open Badges 2.1 |
N/A |
Badge Assertion Payload Signed Assertion | signedAssertion |
A signed Assertion in JWS Compact JWS Serialization format.
Found in Open Badges 2.1 |
N/A |
Badge Evidence
These properties are found in the
Open Badges
2.1
Learn more about Open Badges
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Badge Evidence Type | type |
Defaults to Evidence.
Found in Open Badges 2.1 |
N/A |
Badge Evidence Id | id |
The URI of a webpage presenting evidence of achievement.
Found in Open Badges 2.1 |
N/A |
Badge Evidence Narrative | narrative |
A narrative that describes the evidence and process of achievement that led to an Assertion.
Found in Open Badges 2.1 |
N/A |
Badge Evidence Name | name |
A descriptive title of the evidence.
Found in Open Badges 2.1 |
N/A |
Badge Evidence Description | description |
A longer description of the evidence.
Found in Open Badges 2.1 |
N/A |
Badge Evidence Genre | genre |
A string that describes the type of evidence. For example, Poetry, Prose, Film.
Found in Open Badges 2.1 |
N/A |
Badge Evidence Audience | audience |
A description of the intended audience for a piece of evidence.
Found in Open Badges 2.1 |
N/A |
Badge Evidence Extensions | extensions |
Found in Open Badges 2.1 |
N/A |
Badge Criteria
These properties are found in the
Open Badges
2.1
Learn more about Open Badges
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Badge Criteria Id | id |
The URI of a webpage that describes in a human-readable format the criteria for the BadgeClass.
Found in Open Badges 2.1 |
N/A |
Badge Criteria Type | type |
Defaults to Criteria.
Found in Open Badges 2.1 |
N/A |
Badge Criteria Narrative | narrative |
A narrative of what is needed to earn the badge.
Found in Open Badges 2.1 |
N/A |
Badge Criteria Extensions | extensions |
Found in Open Badges 2.1 |
N/A |
Badge Identity Type
These properties are found in the
Open Badges
2.1
Learn more about Open Badges
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Badge Identity Type Email |
Found in Open Badges 2.1 |
N/A | |
Badge Identity Type Url | url |
Found in Open Badges 2.1 |
N/A |
Badge Identity Type Telephone | telephone |
Found in Open Badges 2.1 |
N/A |
Signed Badge
These properties are found in the
Open Badges
2.1
Learn more about Open Badges
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Signed Badge Type | type |
Found in Open Badges 2.1 |
N/A |
Signed Badge Creator | creator |
The (HTTP) id of the key used to sign the Assertion. If not present, verifiers will check public key(s) declared in the referenced issuer Profile. If a key is declared here, it must be authorized in the issuer Profile as well. creator is expected to be the dereferencable URI of a document that describes a CryptographicKey.
Found in Open Badges 2.1 |
N/A |
Badge Verification Object Verification Property | verificationProperty |
The @id of the property to be used for verification that an Assertion is within the allowed scope. Only id is supported. Verifiers will consider id the default value if verificationProperty is omitted or if an issuer Profile has no explicit verification instructions, so it may be safely omitted.
Found in Open Badges 2.1 |
N/A |
Badge Verification Object Starts With | startsWith |
The URI fragment that the verification property must start with. Valid Assertions must have an id within this scope. Multiple values allowed, and Assertions will be considered valid if their id starts with one of these values.
Found in Open Badges 2.1 |
N/A |
Badge Verification Object Allowed Origins | allowedOrigins |
The host registered name subcomponent of an allowed origin. Any given id URI will be considered valid.
Found in Open Badges 2.1 |
N/A |
Badge Verification Object Extensions | extensions |
Found in Open Badges 2.1 |
N/A |
Badge Identity Object
These properties are found in the
Open Badges
2.1
Learn more about Open Badges
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Badge Identity Object Identity | identity |
Either the hash 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.
Found in Open Badges 2.1 |
N/A |
Badge Identity Object Type | type |
Found in Open Badges 2.1 |
N/A |
Badge Identity Object Hashed | hashed |
Whether or not the identity value is hashed.
Found in Open Badges 2.1 |
N/A |
Badge Identity Object Salt | salt |
If the recipient 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.
Found in Open Badges 2.1 |
N/A |
Badge Identity Object Extensions | extensions |
Found in Open Badges 2.1 |
N/A |
Badge Revocation List
These properties are found in the
Open Badges
2.1
Learn more about Open Badges
Name | Technical Term | Description | Crosswalks (If Currently Available) |
---|---|---|---|
Badge Revocation List Revoked Assertions Issuer Extensions Type | type |
Defaults to RevocationList
Found in Open Badges 2.1 |
N/A |
Badge Revocation List Revoked Assertions Issuer | issuer |
The id of the Issuer.
Found in Open Badges 2.1 |
N/A |
Badge Revocation List Revoked Assertions | revokedAssertions |
A string id or UID-based identification of a badge object that has been revoked.
Found in Open Badges 2.1 |
N/A |
Badge Revocation List Revoked Assertions Issuer Extensions | extensions |
Found in Open Badges 2.1 |
N/A |
Help us improve the SLDM by sending feedback to datamodel@imsglobal.org.