Skip to content

Commit

Permalink
Merge pull request #71 from ottonomy/IssuerOrg
Browse files Browse the repository at this point in the history
Updates IssuerOrg to Issuer Profile
  • Loading branch information
ottonomy committed Aug 18, 2016
2 parents e40bf89 + 72ddeeb commit 8d0c9d5
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This document represents the current version of the Open Badges Specification.
* [Badge Objects](#BadgeObjects)
- [Assertion](#Assertion)
- [BadgeClass](#BadgeClass)
- [Issuer](#Issuer)
- [Issuer Profile](#Issuer)
- [Extensions](#Extensions)
* [Implementation](#Implementation)
- [Hosted verification](#HostedBadge)
Expand Down Expand Up @@ -117,10 +117,10 @@ Property | Expected Type | Description
**name** | Text | The name of the achievement.
**description** | Text | A short description of the achievement.
**image** | [Data URI](http://en.wikipedia.org/wiki/Data_URI_scheme) or URL | URL of an image representing the achievement.
<a id="Criteria"></a>**criteria** | URL | URL of the criteria for earning the achievement. If the badge represents an educational achievement, consider marking up this up with [LRMI](http://www.lrmi.net/)
**issuer** | URL | URL of the organization that issued the badge. Endpoint should be an [IssuerOrganization](#Issuer)
<a id="criteria"></a>**criteria** | URL | URL of the criteria for earning the achievement. If the badge represents an educational achievement, consider marking up this up with [LRMI](http://www.lrmi.net/)
**issuer** | URL | URL of the organization that issued the badge. Endpoint should be an [Issuer Profile](#Issuer)
alignment | Array of [AlignmentObject](#Alignment)s | List of objects describing which educational standards this badge aligns to, if any.
<a id="Tags"></a>tags | Array of Text | List of tags that describe the type of achievement.
<a id="tags"></a>tags | Array of Text | List of tags that describe the type of achievement.

</div>

Expand All @@ -137,23 +137,23 @@ description | Text | Short description of the standard

</div>

## <a id="Issuer"></a>IssuerOrganization ([example](./examples/#Issuer))
## <a id="Issuer"></a>Issuer Profile ([example](./examples/#Issuer))
A collection of information about the entity or organization issuing the Open Badge. Each issuer may correspond to many BadgeClasses. Anyone can create and host an Issuer file to start issuing Open Badges.

{::options parse_block_html="true" /}
<div class="table-wrapper">

Property | Expected Type | Description
--------|------------|-----------
---------|---------------|------------
**@context** | JSON-LD Context | `https://w3id.org/openbadges/v1` or valid JSON-LD context array or object including the 1.1 Open Badges Context
**id** | URL | Unique IRI for the hosted IssuerOrganization file.
**type** | JSON-LD type | valid JSON-LD representation of the Issuer type. In most cases, this will simply be the string `IssuerOrg`. An array including `IssuerOrg` and other string elements that are either URLs or compact IRIs within the current context are allowed.
<a id="name"></a>**name** | Text | The name of the issuing organization.
**url** | URL | URL of the institution
<a id="description"></a>description | Text | A short description of the institution
<a id="image"></a>image | [Data URI](http://en.wikipedia.org/wiki/Data_URI_scheme) or URL | An image representing the institution
<a id="email"></a>email | Text | Contact address for someone at the organization.
<a id="RevocationList"></a>revocationList | URL | URL of the Badge Revocation List. The endpoint should be a JSON representation of an object where the keys are the `uid` or `id` of a revoked badge assertion, and the values are the reason for revocation. It is only recommended that signed badge issuers use this method when they have revoked at least one badge.
**id** | URL | Unique IRI for the hosted Issuer Profile file.
**type** | JSON-LD type | valid JSON-LD representation of the Issuer type. In most cases, this will simply be the string `Issuer`. An array including `Issuer` and other string elements that are either URLs or compact IRIs within the current context are allowed.
**name** | Text | The name of the issuing entity or organization.
**url** | URL | URL homepage of the issuer, whether individual or institutional.
description | Text | A short description of the issuer entity or organization
image | [Data URI](http://en.wikipedia.org/wiki/Data_URI_scheme) or URL | An image representing the issuer
email | Text | Contact address for the individual or organization.
<a id="revocationList"></a>revocationList | URL | URL of the Badge Revocation List. The endpoint should be a JSON representation of an object where the keys are the `uid` or `id` of a revoked badge assertion, and the values are the reason for revocation. It is only recommended that signed badge issuers use this method when they have revoked at least one badge.

</div>

Expand Down Expand Up @@ -224,7 +224,7 @@ Validators that someday use the proposed FrameValidation method pass JSON-LD obj

## <a id="additional-properties"></a>Additional Properties

Badges consist of sets of claims, properties with values that apply to Issuer Organizations, all earners of a badge, or individual badge recipients. Outside of extensions, additional properties may be added to these claim sets so long as they are mapped to an IRI, as JSON-LD mapped in the context and do not clash with existing properties. For example, if a badge object creatorCreators of Badge Objects may:
Badges consist of sets of claims, properties with values that apply to Issuer Profiles, all earners of a badge, or individual badge recipients. Outside of extensions, additional properties may be added to these claim sets so long as they are mapped to an IRI, as JSON-LD mapped in the context and do not clash with existing properties. For example, if a badge object creatorCreators of Badge Objects may:

1. Add individual mappings to the Badge Object's context: `"@context":["https://w3id.org/openbadges/v1", {"foo": "http://example.org/foo"}]`
2. Link to additional context files in the Badge Object's context: `"@context":["https://w3id.org/openbadges/v1", "http://example.org/context"]`
Expand Down Expand Up @@ -283,7 +283,7 @@ property of the badge assertion.
### Revoking a Signed Badge

To mark a badge as revoked, add an entry to the resource pointed at by
the IssuerOrganization `revocationList` URL with the **uid** of the
the Issuer Profile `revocationList` URL with the **uid** of the
badge and a reason why the badge is being revoked. See an [example](examples/#RevocationList).

## Badge Verification
Expand Down Expand Up @@ -320,7 +320,7 @@ the assertion MUST be treated as invalid.
6. With the public key, perform a JWS verification on the JWS object. If
the verification fails, assertion MUST be treated as invalid.

7. Retrieve the revocation list from the IssuerOrganization object and
7. Retrieve the revocation list from the Issuer Profile object and
ensure the `uid` of the badge does not appear in the list.

8. If the above steps pass, assertion MAY BE treated as valid.
Expand Down

0 comments on commit 8d0c9d5

Please sign in to comment.