User-API Settings

  • URL of the User-API - Where user data like Username, ID and Email address can be retrived. Only JSON APIs are supported.
  • Passing of the Access-Tokens - How the access token should be passed. Some applications allow passing as a param, or using the Authorization Header
  • Parametername of the Access-Tokens - Name of the param which should contain the access token
  • Key of the User-ID - Insert which key in the response contains the User-ID. Nested Indices can be used by seperating the keys with colons. E.g. for accessing $userData['firstKey']['secondKey'] insert firstKey:secondKey
  • Key of the Username - Insert which key in the response contains the username. Nested Indices can be used by seperating the keys with colons. E.g. for accessing $userData['firstKey']['secondKey'] insert firstKey:secondKey
  • Key of the Email-Address - Insert which key in the response contains the email address. Nested Indices can be used by seperating the keys with colons. E.g. for accessing $userData['firstKey']['secondKey'] insert firstKey:secondKey
  • Fast Usercreation during the Login - Instead of redirecting the user to the register form, it is tried to create the user during the login process.

Example - Discord

As an example, the plugin will be configured for using Discord. All required information can be found at the Developer Portal.

  • URL of the User-API - https://discordapp.com/api/users/@me
  • Passing of the Access-Tokens - Authorization-Header "Bearer"
  • Parametername of the Access-Tokens - access_token
  • Key of the User-ID - id
  • Key of the Username - username
  • Key of the Email-Address - email

Example - Nextcloud

For Nextcloud, the SEO friendly URLs must be configured.

  • URL of the User-API - https://cloud.somedomain.com/ocs/v2.php/cloud/user?format=json
  • Passing of the Access-Tokens - Authorization-Header "Bearer"
  • Parametername of the Access-Tokens - access_token
  • Key of the User-ID - ocs:data:id
  • Key of the Username - ocs:data:display-name
  • Key of the Email-Address - ocs:data:email