Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface JetRegistration

JetRegistation is the payload which identifies the registrant (person for whom the key is issued) and the application to which the key can be applied.

Hierarchy

  • JetRegistration

Index

Properties

aud

Audience: The application enabled by the key.

Should be a URN of the form "urn:app:domain/app", or a string of the form "domain/app" or a string of the form "@namespace/app".

Where:

  • 'domain' identifies the publisher by fully qualified domain name.
  • 'namespace' identifies the publisher by npm registry.
  • 'app' is a publisher scoped unique name.

For example, any of these variations:

"aud":"urn:app:neo4j.com/neo4j-desktop"
"aud":"neo4j.com/neo4j-desktop"
"aud":"@neo4j/neo4j-desktop"

See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3

email

email: Email

Email: the registrant's email address.

For example, "email":"bob@build.it"

See https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims

exp

Expiration: Specifies the exact moment when the key will become invalid.

For example, "exp":1574760713

See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.4

iat

Issued At Time: When the key was issued.

For example, "iat":1574760713

See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-2

iss

Issuer: The issuer of the key. Should be a fully qualified domain name.

For example, "iss":"neo4j.com".

See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1

jti

JWT ID: A unique ID for the key.

Should be a string. Base64 is recommended.

For example:

"jti":23TplPdS
"jti":46Juzcyx
"jti":dBvJIh-H
"jti":2WEKaVNO

See https://tools.ietf.org/html/rfc7519#section-4.1.7

name

name: string

Name: the full name of the registrant for whom the key is issued.

For example, "name":"Bob the Builder"

See https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims

nbf

Not Before Time: Specifies the exact moment before the key becomes valid.

For example, "nbf":1574760713

See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.5

Optional org

Organization: the full name of the registrant's organization, or a URI for the organiation.

For example, either of:

"org":"AAA Builders."
"org":"http://built.it"

Note: a custom claim.

Optional pub

Pubisher: the full name of the application publisher, or a URI for the publisher.

For example, either of:

"pub":"Acme, Inc."
"pub":"http://acme.com"

Note: a custom claim.

Optional registry

registry: URI | "github" | "npm" | "maven"

Registry: distribution location of the application.

A custom claim.

Optional scope

Scope: application specific grants given to the registrant.

For example, "scope":"pro experimental sitewide"

See:

Optional sub

Subject: The unique identity of the registrant.

Should be a string containing the unique provider identity plus provider scoped user id of the form "provider|provider-id".

Providers could be:

  • "self" for locally generated identifier (a "self identified" identity)
  • "mkto" for marketo identifier present on neo4j.com
  • common auth0 providers: google-oauth2, github, twitter

Examples:

"sub":"google-oauth2|123456"
"sub":"self|7A8CF3A4-272B-46C9-931D-CBD9BCFA4045"
"sub":"mkto|AZ24L2B"
"sub":"twitter|HoratioDear"

See:

ver

Version: SemVer range of versions enabled by the key.

Examples:

"ver":"1.x"
"ver":">=2.5.0"
"ver":"5.0.0 - 7.2.3"

See SemvVer cheatsheet

See SemVer Calculator

Optional website

website: URI

Website: where to find information about the application.