Alfresco

SkabelonDesign.Alfresco:Update — Configuration

The SkabelonDesign.Alfresco:Update integration authenticates the user via OAuth 2.0 and fetches metadata from Alfresco’s public REST API to update Document Data in Word.

Example <Cmd> Configuration

<Cmd
  case="SkabelonDesign.Alfresco:Update"
  authUrl="https://<your-auth-domain>/auth/realms/<realm-name>/protocol/openid-connect/auth"
  baseUrl="https://<your-alfresco-domain>/alfresco/api/-default-/public/"
  initialsPropertyName="<alfresco-property-name>"
  tokenUrl="https://<your-auth-domain>/auth/realms/<realm-name>/protocol/openid-connect/token"
  clientId="<client-id>"
  redirectUri="http://127.0.0.1:3000/callback"
/>

Admin reminder: The value of redirectUri must be registered on the OAuth client in the identity server (same place the Postman callback is configured).

Parameters

case

The handler to execute. Must be SkabelonDesign.Alfresco:Update.

authUrl

OAuth 2.0 authorization endpoint for the Alfresco realm. Used to display the login page to the user.
Typical format:
https://<your-auth-domain>/auth/realms/<realm-name>/protocol/openid-connect/auth

tokenUrl

OAuth 2.0 token endpoint where the authorization code is exchanged for an access token (and refresh token).
Typical format:
https://<your-auth-domain>/auth/realms/<realm-name>/protocol/openid-connect/token

baseUrl

The base URL for Alfresco’s public REST API. All requests are made relative to this URL.
Example: https://<your-alfresco-domain>/alfresco/api/-default-/public/

clientId

The OAuth client ID registered for this integration in the identity server (Keycloak / Alfresco SSO).
Example: <client-id>

redirectUri

Local loopback URL where the add-in listens for the OAuth authorization code after login. Must exactly match a redirect URI registered on the OAuth client (including host, port, and path).
Example: http://127.0.0.1:3000/callback

initialsPropertyName

Optional. Name of the Alfresco property used to resolve the document owner’s initials/username during data updates.
Example: Alfresco.dong_documentOwner

How to Obtain Values

• From the client’s Alfresco administrator: authUrl, tokenUrl, baseUrl, clientId, and any required property such as initialsPropertyName.
• Register the local redirectUri on the same OAuth client in the identity server that issues tokens for Alfresco.

Authentication Flow (Summary)

1. User clicks the button that triggers SkabelonDesign.Alfresco:Update.
2. Login opens at authUrl; upon success, the identity server redirects to redirectUri with an authorization code.
3. The add-in exchanges that code at tokenUrl for an access token (and refresh token).
4. The integration calls Alfresco’s public API under baseUrl and updates Document Data in Word.

Quick Template

<Cmd
  case="SkabelonDesign.Alfresco:Update"
  authUrl="https://<your-auth-domain>/auth/realms/<realm-name>/protocol/openid-connect/auth"
  baseUrl="https://<your-alfresco-domain>/alfresco/api/-default-/public/"
  initialsPropertyName="<optional-property-name>"
  tokenUrl="https://<your-auth-domain>/auth/realms/<realm-name>/protocol/openid-connect/token"
  clientId="<client-id>"
  redirectUri="http://127.0.0.1:<port>/callback"
/>

Tip: Keep the redirectUri stable for all environments (e.g., always use the same loopback port/path) and ensure it’s added to the OAuth client’s list of allowed redirects.