Added AuthProvider.getDisplayName

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Support to retrieve conformance classes
 - Added `Connection.makeLinksAbsolute`
+- Added `AuthProvider.getDisplayName`
 - Hook to migrate capabilities
 - Support for `usage`, `log_level`, `links` in batch jobs and services
 - Support for `level` parameter for log requests in batch jobs and services

src/authprovider.js

@@ -38,6 +38,15 @@ class AuthProvider {
  return id;
  }
 
+ /**
+ * Returns a display name for the authenticated user.
+ * 
+ * @returns {string?} Name of the user or `null`
+ */
+ getDisplayName() {
+ return null;
+ }
+
  /**
  * Returns the type of the authentication procedure as specified by the API, e.g. `oidc` or `basic`.
  * 

src/basicprovider.js

@@ -20,6 +20,7 @@ class BasicProvider extends AuthProvider {
  title: "HTTP Basic",
  description: "Login with username and password using the method HTTP Basic."
  });
+ this.username = null;
  }
 
  /**
@@ -41,9 +42,29 @@ class BasicProvider extends AuthProvider {
  if (!Utils.isObject(response.data) || typeof response.data.access_token !== 'string') {
  throw new Error("No access_token returned.");
  }
+ this.username = username;
  this.setToken(response.data.access_token);
  }
 
+ /**
+ * Returns a display name for the authenticated user.
+ * 
+ * @returns {string?} Name of the user or `null`
+ */
+ getDisplayName() {
+ return this.username;
+ }
+
+ /**
+ * Logout from the established session.
+ * 
+ * @async
+ */
+ async logout() {
+ this.username = null;
+ await super.logout();
+ }
+
 }
 
 module.exports = BasicProvider;

src/oidcprovider.js

@@ -311,6 +311,18 @@ class OidcProvider extends AuthProvider {
  }
  }
 
+ /**
+ * Returns a display name for the authenticated user.
+ * 
+ * @returns {string?} Name of the user or `null`
+ */
+ getDisplayName() {
+ if (this.user && Utils.isObject(this.user.profile)) {
+ return this.user.profile.name || this.user.profile.preferred_username || this.user.profile.email || null;
+ }
+ return null;
+ }
+
  /**
  * Detects the default OIDC client ID for the given redirect URL.
  *