feat: exchange cloud ID by redblom · Pull Request #4417 · nextcloud/contacts

redblom · 2025-04-08T09:08:25Z

~~This is a work in progress~~
This PR implements #4416

About

The goal of this feature is to allow for easy remote contact information exchange (cloud ID, email, name) between 2 users from different instances/organizations based on an invitation request.
The feature is an implementation of the invitation workflow from the OCM specification (https://datatracker.ietf.org/doc/draft-ietf-ocm-open-cloud-mesh/)

A user (sender) creates the invitation. This invitation consists of an invite link and (encoded) invite code. The invitation is sent to another user (receiver) via email or through another channel, eg. chat.
After receiving the invitation, the receiver can accept the invitation by following the invite link or by pasting the (encoded) invite code into a manual accept form.
After accepting, the exchange of user information will take place (OCM /invite-accepted endpoint) resulting in the creation of both users in each other's contacts list.
Following the invite link in the email is the most convenient way to accept. It will redirect the receiver via a WAYF (Where Are You From) page immediately to an accept dialog.
Note: Manual acceptance of the invitation works with both the invite link and (encoded) invite code.

Screenshots

Contacts page with new buttons 'Invite contact', 'Accept invite' and 'All invites'.

Click 'Invite contact' and fill in form fields:

Invite label for reference in the Invites list (optional)
Recipient email (required)
Personal message that will be sent with the email (optional)
Check to send copy of the invite email to yourself (optional)

'All invites' button displays the invites sent.

It's also possible to share the invite by sending the invite link or code through an alternative channel (eg. chat).

This what the email to the receiver of the invite looks like.

This is what the copy of the email to the sender of the invite looks like.

Clicking on the invite link will direct the receiver to a WAYF (Where Are You From) page.
Here you choose your institute. You can also fill in your institute's provider address if you are not on the list. A discovery process will run to check whether your provider supports OCM.

Login after selecting your institute.

You will be redirected to an invite accept dialog.

On acceptance the contact information exchange will take place via the OCM `/invite-accepted` endpoint. This will lead to the creation of a new contact (the sender) on the receiver's end.

And on the sender end the receiver contact info will also be added.

When the config setting `ocm_invites_optional_mail` is set to false, creating an invite will give you by default the option to share the invite through an alternative channel (eg. chat).

Copy the invite link or code and send it via your channel of choice.

You may still decide to send the invite via email by clicking the 'Send via email' button.

The receiver of the invite can click 'Accept invite' and manually paste the invite link, code, or encoded invite code into the accept form.
And this will lead to the exchange of contact information via the OCM /invite-accepted endpoint.

After contact info exchange the sender will be added as a new contact on the receiver's end.

And the receiver will be added as a new contact on the sender's end.

OCM invites admin settings

redblom · 2025-04-08T16:12:23Z

General layout plan:

dedicated button to send an invite to a remote user - below 'New contact' button
dedicated button on cloud ID component for existing remote contacts that have no cloud ID set
new sent invites will be displayed in the left panel - with a revoke option

Status:

invite accept dialog route implemented

github-actions · 2025-04-23T02:47:00Z

Hello there,
Thank you so much for taking the time and effort to create a pull request to our Nextcloud project.

We hope that the review process is going smooth and is helpful for you. We want to ensure your pull request is reviewed to your satisfaction. If you have a moment, our community management team would very much appreciate your feedback on your experience with this PR review process.

Your feedback is valuable to us as we continuously strive to improve our community developer experience. Please take a moment to complete our short survey by clicking on the following link: https://cloud.nextcloud.com/apps/forms/s/i9Ago4EQRZ7TWxjfmeEpPkf6

Thank you for contributing to Nextcloud and we hope to hear from you soon!

(If you believe you should not receive this message, you can add yourself to the blocklist.)

codecov · 2025-04-24T07:46:03Z

Codecov Report

❌ Patch coverage is 6.78670% with 673 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/components/Ocm/OcmInviteDetails.vue	0.00%	145 Missing ⚠️
src/components/Ocm/Wayf.vue	0.00%	97 Missing ⚠️
src/components/Ocm/OcmInviteForm.vue	0.00%	73 Missing ⚠️
src/views/Contacts.vue	4.22%	68 Missing ⚠️
src/components/Ocm/OcmInvitesList.vue	0.00%	54 Missing ⚠️
src/components/AppContent/OcmInvitesContent.vue	0.00%	41 Missing ⚠️
src/components/Ocm/OcmAttachEmailForm.vue	0.00%	39 Missing ⚠️
src/components/AppNavigation/RootNavigation.vue	0.00%	36 Missing ⚠️
src/components/Ocm/OcmInviteShareActions.vue	0.00%	29 Missing ⚠️
src/components/Ocm/OcmAcceptForm.vue	65.71%	24 Missing ⚠️
... and 6 more

📢 Thoughts on this report? Let us know!

ChristophWurst · 2025-04-25T13:28:47Z

Thanks for the contribution, @redblom!

The features relies on an implementation of the Invitation Workflow (see https://github.com/sara-nl/nc-collaboration).

Is there any way this could work without introducing an app dependency?

redblom · 2025-04-29T10:04:32Z

Thanks for the contribution, @redblom!

The features relies on an implementation of the Invitation Workflow (see https://github.com/sara-nl/nc-collaboration).

Is there any way this could work without introducing an app dependency?

Short answer: No, that is to say, the actual cloud ID exchange is not a responsibility of the contacts app but the contacts app (the cloud ID field) is a logical place where to have this option (as per earlier discussion with the Design Team).
The feature actually depends on the implementation of OCM /invite-accepted. This is currently in the process of being implemented for nextcloud server core (nextcloud/server#51113) so cloud ID exchange can become an integral part of nextcloud. Up until then there should be an app present implementing this.
The idea is to make the option not visible to the user when the platform can not do the actual cloud ID exchange (by configuration).
(so the best answer is: yes, when cloud ID exchange has become an integral part of nextcloud :)

ChristophWurst · 2025-04-30T14:55:42Z

Thanks for the clarification

redblom · 2026-04-09T11:18:50Z

@miaulalala - What's wrong with the sign-off, maybe co-author is not allowed ?

No that's not the issue, one setting has Anton P., the other Anton P (no dot) 😅

Pfff 😳

miaulalala · 2026-05-04T11:04:01Z

@redblom - can you check on artonge's review comments please?

redblom · 2026-05-04T11:32:53Z

@redblom - can you check on artonge's review comments please?

👍 working on it.

redblom · 2026-05-12T15:13:24Z

@redblom - can you check on artonge's review comments please?

@miaulalala We've now covered them all we think.

redblom · 2026-05-15T11:32:08Z

Rebased and some cleanup.

miaulalala · 2026-05-18T13:50:37Z

Hi @redblom! CI is currently failing on two fronts:

1. Missing #[Override] attributes (Psalm)
Multiple methods in Cron/UpdateOcmProviders.php, the two new Listener classes, and the Migration files are missing #[Override] attributes. You can fix most of these automatically by running composer psalm:update-baseline and committing the result.

2. NPM lint error in src/wayf.js
Line 13 uses a top-level arrow function — change it to a regular function declaration to satisfy the antfu/top-level-function rule, then run npm run lint:fix.

Sign in to view

+
+class UpdateOcmProviders extends TimedJob {
+	// Run every five minutes
+	private int $expire_time = 5 * 60;


artonge · 2026-05-18T16:03:16Z

@redblom there are still some unresolved conversations from the last time I reviewed, can you address them?

redblom · 2026-05-18T19:21:37Z

@artonge

Is this because the operation is slow?

Yes, it can be slow-ish, so definitely for a responsive wayf page.

You can also manually register a QueuedJob for this kind of use case.

Will have a look at that.

artonge · 2026-05-22T10:16:59Z

+				if (!($code >= 200 && $code < 400)) {
+					continue;
+				}
+				$data = json_decode($res->getBody(), true);


Where is the format of the answer defined?

👍 88ae1b5

artonge · 2026-05-22T10:24:13Z

+	public function inviteAcceptDialog(string $token = '', string $providerDomain = ''): TemplateResponse {
+		$this->initialState->provideInitialState('inviteToken', $token);
+		$this->initialState->provideInitialState('inviteProvider', $providerDomain);
+		$this->initialState->provideInitialState('acceptInviteDialogUrl', FederatedInvitesService::OCM_INVITE_ACCEPT_DIALOG_ROUTE);
+
+		return $this->index();
+	}


Yes, and looking at the variable that you provide:

inviteToken seems to be accessible from the frontend already

same for inviteProvider

So maybe you only need to provide acceptInviteDialogUrl?

nimishavijay · 2026-05-22T10:51:11Z

This seems very comprehensive, nice! :) From what I understand this is a way to exchange contacts with people from other organizations directly from the contacts app. Design wise I have a few questions and some feedback:

Thinking about the design and flow itself, some questions come to mind:

There seem to be a lot of ways of sending invitations: via email, via invite link, via invite code. Is there a necessity to have an invite code? Could we have just one way: invite link and have options like "copy link" and "share via email" for that one link? It would simplify a lot of decision making for the user. They would only have to click on a link to exchange contacts in every case. Does that make sense?
Since the goal is to NOT look at the invites page (there shouldn't be invitations that are sent and pending acceptance, and once you have exchanged contacts there's no reason to look at the invitation again) I am not sure if having an entire view in the main content is the way to go. What do you think about moving it into a modal?
Similar reasoning for the buttons too: the combined visual weight of the invitations is even more than of the CTA of the whole app! So what do you think about collapsing all invites into one item called "External invites" and that opens up a modal with the list of invitations and an option to create?
instead of having an option to send a copy of the invite to the sender's own address, why not have the invite message shown in the UI? It can be collapsed by default to save space of course

Visual design feedback to be more consistent with Nextcloud design:

We want to be accessible, so the headings for the modals/dialogs must be h2. I see that some of them are different like h5. If you want them to look smaller you can override the styles, but it should follow the heading order
The buttons in a dialog a usually positioned as: primary action button on the right end and the cancel button on the left end for left-to-right languages. Your buttons seem to be the other way around, which could lead to accidentally clicking on cancel. The primary action button should also always be the primary variant so that the color stands out in the dialog
Also try to use existing variables or multiples of existing variables for padding, margin and gaps as much as possible. Instead of 4px, use var(--default-grid-baseline)
In the "where are you from" page, consider using the NcFormbox component, it would automatically adjust colours, spacing, etc

But either way this is really cool. Interested to know what you think of the design feedback! :)

redblom · 2026-05-22T11:54:36Z

But either way this is really cool. Interested to know what you think of the design feedback! :)

@nimishavijay - Thank you for this valuable feedback! We're on it.

redblom · 2026-05-27T15:20:57Z

@artonge - addressed all your reviews.
I have two questions left where I would like your input:
#4417 (comment)
#4417 (comment)

redblom · 2026-06-05T11:59:08Z

This seems very comprehensive, nice! :) From what I understand this is a way to exchange contacts with people from other organizations directly from the contacts app. Design wise I have a few questions and some feedback:

...

Re-design of the layout:

3 buttons collapsed into 1 'OCM invitations' and 1 permanent sub item 'All invitations' that shows the nr. of pending invitations

Sub menu displays the options to create and accept invites

main-01-main-create-invitation-show-email-preview-button drawio

A preview of the email can be shown

main-01-main-create-invitation-show-email-preview drawio

The email preview

Options to copy link, (encoded) invite

redblom · 2026-06-21T13:18:46Z

GUI after modifications:

New External invitations header and context menu

Email preview option

Preview email

…ion workflow see https://github.com/cs3org/OCM-API/blob/v1.2.1/IETF-RFC.md Features: - Button to invite remote users to exchange cloudIDs. - Button to manually accept invite to exchange cloudIDs. - WAYF page allowing the receiver of the invite to open and accept the invitation. - Listing of open invitations. - Option to resend, revoke open invitations. - Administer invitation settings Signed-off-by: Antoon P. <antoon.prins@surf.nl> Co-authored-by: Micke Nordin <kano@sunet.se> Co-authored-by: Mahdi Baghbani <mahdi-baghbani@azadehafzar.io>

miaulalala · 2026-06-24T13:08:43Z

jancborchardt · 2026-06-24T13:15:30Z

#4417 (comment)

FYI for reference @nimishavijay this is design feedback I gave in the call. I’ll also take over to do a last review pass over it after the changes are done. :)

[X] Make "All invitations" a list item below the address book list instead of a separate menu section: [X] Make adding a new invitation or accepting an invitation as a separate button next to the "new contact" button - example from Talk: [X] Make "email address" the first input field in the Invitation modal and remove the label [X] Replace "Provider" with "Select your server" as a heading. Remove subtext from heading. [X] Put accept buttons on the rightmost side, and be a primary button (if not fixed yet) [X] Add "create invitation" and "accept invitation" on empty content page when no invitations are open [X] Add title to Invitation and Accept modal [X] Remove icon from cancel button in Invitation and Accept Modal [X] No full stop in headings [X] Give good user feedback for errors - such as an invite not being able to be accepted [X] Also hide the button to accept an invite if the capability is not there (may already be done) **Nice to have** - will not block merge [X] Remove extra container around recipient email and personal message so all form element are on one level Signed-off-by: Antoon P. <antoon.prins@surf.nl>

redblom · 2026-06-26T13:55:57Z

Screenshots belonging to 66bca00

OCM invitations menu moved to top.

New invitation form: label field removed, title fixed, removed extra container

Accept invite form: title fixed

All invitations moved

Options to create/accept invites on empty invitations page

Correct message when trying to accept an invite you've created yourself

WAYF page: new title, removed sub text

Signed-off-by: Antoon P. <info@redblom.com>

jancborchardt

Nice @redblom! Looks very good and basically good to go!

Only have 3 tiny pieces of feedback based on those changes, but they are also not a blocker:

The nav entry should be called "External invitations" instead of "All invitations" as that is clearer, no?
In the modal for "Create invitation", the button says "Send invite", but everywhere else we use the language "invitation". So better to use "Send invitation" here too.
On the emptycontent page "There are no invites", there are 2 primary buttons. There should only ever be 1 primary button, in this case it makes most sense to be "Create invitation". (And they can be next to each other rather than below each other.)

redblom requested review from GVodyanov, SebastianKrupinski and hamza221 as code owners April 8, 2025 09:08

hamza221 assigned redblom Apr 8, 2025

hamza221 added enhancement New feature or request 2. developing Work in progress labels Apr 8, 2025

hamza221 marked this pull request as draft April 8, 2025 09:14

hamza221 added this to the v7.1.0 milestone Apr 10, 2025

redblom force-pushed the invite-for-cloudid-exchange branch from ea81812 to 7c0eaa0 Compare April 10, 2025 20:45

github-actions Bot added the feedback-requested label Apr 23, 2025

hamza221 modified the milestones: v7.1.0, v7.2.0 Apr 28, 2025

redblom force-pushed the invite-for-cloudid-exchange branch 2 times, most recently from 0112a78 to e7c2604 Compare April 30, 2025 14:32

ChristophWurst requested review from ArtificialOwl and removed request for GVodyanov, SebastianKrupinski and hamza221 May 15, 2025 12:09

redblom force-pushed the invite-for-cloudid-exchange branch 5 times, most recently from 76d6df3 to ca42433 Compare June 18, 2025 14:33

redblom force-pushed the invite-for-cloudid-exchange branch from ca42433 to 62ce0c2 Compare June 26, 2025 08:21

redblom force-pushed the invite-for-cloudid-exchange branch from 4e4bdca to e78bd65 Compare April 9, 2026 11:08

MahdiBaghbani mentioned this pull request Apr 10, 2026

feat(invite-email): make OCM invite email optional and improve UI sara-nl/nextcloud-contacts#14

Merged

artonge reviewed Apr 15, 2026

View reviewed changes

redblom force-pushed the invite-for-cloudid-exchange branch 2 times, most recently from 55dafdf to e05f396 Compare May 8, 2026 18:44

artonge reviewed May 18, 2026

View reviewed changes

Comment thread lib/Command/OcmInvitesConfig.php Outdated

Comment thread lib/Cron/UpdateOcmProviders.php Outdated

class UpdateOcmProviders extends TimedJob {

// Run every five minutes

private int $expire_time = 5 * 60;

This comment was marked as duplicate.

Sign in to view

artonge reviewed May 22, 2026

View reviewed changes

redblom mentioned this pull request May 24, 2026

feat: Add OCM discovery and requests events. nextcloud/documentation#14662

Draft

miaulalala requested changes Jun 17, 2026

View reviewed changes

Merge branch 'main' into invite-for-cloudid-exchange

292a84f

Signed-off-by: Antoon P. <info@redblom.com>

jancborchardt reviewed Jun 26, 2026

View reviewed changes

Uh oh!

Conversation

redblom commented Apr 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

About

Screenshots

OCM invites admin settings

Uh oh!

redblom commented Apr 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Apr 23, 2025

Uh oh!

codecov Bot commented Apr 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ChristophWurst commented Apr 25, 2025

Uh oh!

redblom commented Apr 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ChristophWurst commented Apr 30, 2025

Uh oh!

redblom commented Apr 9, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

miaulalala commented May 4, 2026

Uh oh!

redblom commented May 4, 2026

Uh oh!

redblom commented May 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

redblom commented May 15, 2026

Uh oh!

miaulalala commented May 18, 2026

Uh oh!

Uh oh!

This comment was marked as duplicate.

Uh oh!

artonge commented May 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

redblom commented May 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

artonge May 22, 2026

Choose a reason for hiding this comment

Uh oh!

redblom May 26, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

artonge May 22, 2026

Choose a reason for hiding this comment

Uh oh!

nimishavijay commented May 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

redblom commented May 22, 2026

Uh oh!

redblom commented May 27, 2026

Uh oh!

redblom commented Jun 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Re-design of the layout:

Uh oh!

redblom commented Apr 8, 2025 •

edited

Loading

redblom commented Apr 8, 2025 •

edited

Loading

codecov Bot commented Apr 24, 2025 •

edited

Loading

redblom commented Apr 29, 2025 •

edited

Loading

redblom commented May 12, 2026 •

edited

Loading

artonge commented May 18, 2026 •

edited

Loading

redblom commented May 18, 2026 •

edited

Loading

nimishavijay commented May 22, 2026 •

edited

Loading

redblom commented Jun 5, 2026 •

edited

Loading

miaulalala commented Jun 24, 2026 •

edited by jancborchardt

Loading