Login Endpoint

Added in version 2.3.

Developer Preview The ESS Wallet Service endpoints are available as part of a Developer Preview program to allow early access to these features. Please be aware that these APIs may change.

User Session Properties

The ESS Wallet Service provides the following endpoint for retrieving properties about the user.

https://datawallet.{ESS Domain}/login/userInfo

This endpoint can be used to determine if the user has already completed a signup flow to provision the Pod and establish the containers and access control required by the Wallet.

Note To access the /login/userInfo endpoint, users must be authenticated. The endpoint supports the use of HTTP-only, secure session cookies.

Method	GET
Content-Type	application/json
Endpoint	https://datawallet.{ESS Domain}/login/userInfo
Payload	none

Output

Upon completion of the request user information is returned.

Example response

{
  "webId": "https://id.example/alice",
  "name": "Alice User",
  "logo": "https://images.example/logo.png",
  "signupRequired": true
}

Field	Value
webId	The WebID of the active user session.
name	The preferred name of the user, if available, for display in a user interface.
logo	A URL referencing a logo, if available, for display in a user interface.
signupRequired	Indicates whether the user needs to provision a Pod. true indicates that signup is required before a Pod can be provisioned. false indicates that the user already has a Pod.