Discovery#

ESS uses /.well-known URIs to provide metadata about its services.

Note

RFC 8615 (Well-Known Uniform Resource Identifiers (URIs) RFC specification) is currently in proposal state.

  • Features based on draft/proposed specifications are subject to change and/or removal.

  • The properties found in ESS services’ metadata may use custom properties (i.e., not defined in the Solid Vocabularies) and are also subject to change and/or removal.

/.well-known URIs#

/.well-known/openid-configuration#

ESS provides OpenID Provider metadata at the following /.well-known/openid-configuration URI:

https://openid.<ESS DOMAIN>/.well-known/openid-configuration

The endpoint returns the current deployment’s OpenID Provider metadata.

/.well-known/solid#

Subject to Change

This endpoint is subject to change and may be replaced in the future.

ESS provides Pod Storage Service (and related) metadata at the following .well-known/solid URI:

https://storage.{ESS Domain}/.well-known/solid

Its Response.body returns Resource Description Framework (RDF) statements. Depending on your configuration, the response can include information about:

@prefix solid: <http://www.w3.org/ns/solid/terms#> .

[ a                          solid:DiscoveryDocument ;
  <http://www.w3.org/ns/auth/acl#trustedApp>
          <https://podbrowser.inrupt.com/api/app> ;
  solid:maxPodsPerOwner      10 ;
  solid:notificationGateway  <https://notification.{ESS DOMAIN}.com/> ;
  solid:provision            <https://provision.{ESS DOMAIN}.com/> ;
  solid:validatesRdfSources  true
] .

/.well-known/uma2-configuration#

ESS provides UMA service metadata resource at the following /.well-known/uma2-configuration URI:

https://uma.<ESS DOMAIN>/.well-known/uma2-configuration

The endpoint returns the current deployment’s UMA service configuration:

{
  "dpop_signing_alg_values_supported": [
    "ES256",
    "RS256"
  ],
  "grant_types_supported": [
    "urn:ietf:params:oauth:grant-type:uma-ticket"
  ],
  "issuer": "https://uma.<ESS DOMAIN>",
  "jwks_uri": "https://uma.<ESS DOMAIN>/jwks",
  "token_endpoint": "https://uma.<ESS DOMAIN>/token",
  "uma_profiles_supported": [
    "https://www.w3.org/TR/vc-data-model/#json-ld",
    "http://openid.net/specs/openid-connect-core-1_0.html#IDToken"
  ],
  "verifiable_credential_issuer": "https://vc.<ESS DOMAIN>"
}

/.well-known/vc-configuration#

Subject to Change

This endpoint is subject to change and may be replaced in the future.

ESS provides a Verifiable Credentials Service metadata resource at the following /.well-known/vc-configuration URI:

https://vc.<ESS Domain>/.well-known/vc-configuration

The endpoint returns a JSON-LD document that includes the locations for the Verifiable Credential-related endpoints:

{
  "@context": [
    "https://www.w3.org/2018/credentials/v1",
    "https://vc.<ESS Domain>/credentials/v1"
  ],
  "derivationService": "https://vc.<ESS Domain>/derive",
  "issuerService": "https://vc.<ESS Domain>/issue",
  "statusService": "https://vc.<ESS Domain>/status",
  "supportedSignatureTypes": [
    "Ed25519Signature2020"
  ],
  "verifierService": "https://vc.<ESS Domain>/verify"
}