IMS OBC Context Description Notes
IMS Candidate Final
Version 1.0
This is the set of term definitions for the OBC context.
Open Badges Connect is a secure REST interface for exchanging Open Badges.
List of Properties
Class Definitions
Open Badges 2.0 Assertion object.
The list and definition of the child properties is:-
- id
- Unique IRI for this object.
- type
- The JSON-LD type of this object. Normally 'Assertion'.
- extensions
Configuration information about a single implementation.
The list and definition of the child properties is:-
- id
- Unique IRI for the configuration.
- type
- The JSON-LD type of this object. Normally 'BadgeConnectAPI'.
- apiBase
- Fully qualified URL that will be concatenated with the API endpoints. It SHOULD NOT have a trailing slash '/'. E.g. apiBase + '/assertions'.
- authorizationUrl
- A fully qualified URL to the host's authorization endpoint.
- image
- An image representing the platform. May be a URI to a hosted image or a Data URI.
- name
- The name of the platform supporting the API. This SHOULD reflect the user-facing identity of the platform requesting authorization.
- privacyPolicyUrl
- A fully qualified URL to the platform's privacy policy. Other platforms SHOULD link to this resource as part of their authorization interface.
- registrationUrl
- A fully qualified URL to the host's dynamic client registration endpoint.
- scopesOffered
- Applies to Hosts only. An array of strings listing the scopes supported by the Host in the form of fully qualified URLs to the scope descriptors.
- termsOfServiceUrl
- A fully qualified URL to the platform's terms of service. Other platforms SHOULD link to this resource as part of their authorization interface.
- tokenRevocationUrl
- A fully qualified URL to the host's token revocation endpoint.
- tokenUrl
- A fully qualified URL to the host's token request endpoint for exchanging an authorization code for a bearer token.
- version
- A string representing the implemented version. MUST be in the format of vMAJORpMINOR where MAJOR and MINOR are integers.
A String in JWS Compact Serialization format.
Open Badges 2.0 Profile object.
The list and definition of the child properties is:-
- id
- Unique IRI for this object.
- type
- The JSON-LD type of this object. Normally 'Profile'.
- extensions
Response status.
The list and definition of the child properties is:-
- error
- A nullable string and the human-readable message describing the problem.
- statusCode
- The HTTP status code of the response.
- statusText
- A string matching one of the enumerated and allowed values for the given endpoint.
A status-only response.
The list and definition of the child properties is:-
- status
- The status of the request.
Property Definitions
Fully qualified URL that will be concatenated with the API endpoints. It SHOULD NOT have a trailing slash '/'. E.g. apiBase + '/assertions'.
An unsigned assertion in JSON-LD serialization format.
An array of unsigned assertions in JSON-LD serialization format.
A fully qualified URL to the host's authorization endpoint.
Set of BadgeConnectAPI configurations.
This property is used in the following classes:-
- dtStatus Class
- A nullable string and the human-readable message describing the problem.
This property is used in the following classes:-
- dtAssertion Class
- dtProfile Class
Unique IRI for this object.
This property is used in the following classes:-
- dtBadgeConnectAPI Class
- An image representing the platform. May be a URI to a hosted image or a Data URI.
This property is used in the following classes:-
- dtBadgeConnectAPI Class
- The name of the platform supporting the API. This SHOULD reflect the user-facing identity of the platform requesting authorization.
A fully qualified URL to the platform's privacy policy. Other platforms SHOULD link to this resource as part of their authorization interface.
The profile.
A fully qualified URL to the host's dynamic client registration endpoint.
This property is used in the following classes:-
- dtBadgeConnectAPI Class
- Applies to Hosts only. An array of strings listing the scopes supported by the Host in the form of fully qualified URLs to the scope descriptors.
A signed assertion in JWS Compact Serialization format.
An array of signed assertions in JWS Compact Serialization format.
The response status object.
This property is used in the following classes:-
- dtStatus Class
- The HTTP status code of the response.
A string matching one of the enumerated and allowed values for the given endpoint.
A fully qualified URL to the platform's terms of service. Other platforms SHOULD link to this resource as part of their authorization interface.
A fully qualified URL to the host's token revocation endpoint.
A fully qualified URL to the host's token request endpoint for exchanging an authorization code for a bearer token.
This property is used in the following classes:-
- dtAssertion Class
- The JSON-LD type of this object. Normally 'Assertion'.
- dtBadgeConnectAPI Class
- The JSON-LD type of this object. Normally 'BadgeConnectAPI'.
- dtManifest Class
- The JSON-LD type of this object. Normally 'Manifest'.
- dtProfile Class
- The JSON-LD type of this object. Normally 'Profile'.
This property is used in the following classes:-
- dtBadgeConnectAPI Class
- A string representing the implemented version. MUST be in the format of vMAJORpMINOR where MAJOR and MINOR are integers.