Invite device clients

In 10Duke SysAdmin, you create new device clients for an organization by email invitation. You can also use invitations to add existing device clients to organizations.

With the invitation, you add a device client to an organization’s device client group. This grants the device client access to the organization’s licenses that the group is authorized to access.

The invitation can be sent, for example, to the device administrator. The recipient doesn’t need to be a registered user in 10Duke Enterprise, and you can send more than one device client invitation to the same email address.

The invitation recipient must accept the invitation on the physical device (hardware) on which your client application is running. The new device client is created in the system after the invitation has been accepted.

The invitation itself is not targeted at any specific device client: if the recipient accepts it on a device that is already registered as a device client in the system, this existing device client is added to the group specified in the invitation.

Before you start

• The client application running on the device must be connected to 10Duke Enterprise with the OAuth client credentials grant flow, and the client application must support handling the invitation process.

• Make sure that email sending has been configured in 10Duke Enterprise and email templates have been set up. If you need email templates in multiple languages, additional localization configuration is needed. Contact the 10Duke Integration Support team.

• To give the device client access to organization licenses, make sure that the organization has the necessary device client groups defined and that the groups are authorized to access licenses.

Invite a device client to an organization

1. In SysAdmin in the left sidebar, go to IDENTITY > Organizations.

2. In the organization table, select the organization to which to invite the device client, and select Actions > Manage device client groups.

   The organization’s device client group table opens.

3. In the table, select the group to which to invite the device client.

   The device client will get access to the organization licenses that this group has access to.

4. Go to the Device clients tab, and select Actions > Invite device client.

   On the side panel that opens, click Next after completing each step.

5. In step 1 Email, define the email address and language for the invitation:

   • Recipient’s email: Enter the email address where the invitation is sent.

     This can be any email address that the recipient has access to.

   • Choose a language for the email: Select the language for the invitation.

     The languages available depend on the email template setup in your 10Duke Enterprise configuration.

6. In step 2 Details, define the recipient and sender names and a personal message:

   • Recipient’s name: Enter the recipient’s name shown in the invitation.

   • Valid until (optional): Define the date when the invitation validity ends (at the start of the day in UTC time). Use the format YYYY-MM-DD. An expired invitation can no longer be accepted (or declined). The invitation validity starts immediately.

   • Your name: Enter the sender’s name shown in the invitation.

   • Device client name: Define a name for the device client, which is used if accepting the invitation creates a new device client in the system.

     Depending on your client application implementation, the recipient may be able to change the name when accepting the invitation.

   • Personal message (optional): Enter a short personal message.

     This message is added to the default email message. Depending on your client application implementation, it may also be shown in the window where the recipient accepts or declines the invitation.

     The maximum message length is 2048 characters.

     Any line breaks are ignored—the message is shown as one paragraph of text.

7. In step 3 Summary, check that all the information is correct, and click Invite to send the invitation.

Next steps

You can track the status of the device client’s invitation to see when it has been accepted.

Troubleshooting

There may be situations where a recipient is unable to accept an invitation for a device client.

Common issues with email

A common case is that the recipient missed the email because it ended up in their spam folder.

Sometimes an email may also be blocked by a firewall, or the email provider may change the structure of the email’s links and cause them to become invalid.

If you’re using your own email service provider in your 10Duke Enterprise deployment, check if the log data shows any issues for the user. If your deployment uses a 10Duke instance of Amazon Simple Email Service (SES), first check if your SES notifications show any issues, and if needed, contact the 10Duke Integration Support team for further support. See more information on the email setup options.

A recipient is having problems with their invitation

• Check that the email was sent to the correct email address.

• Confirm that the invitation is still valid. Depending on your 10Duke Enterprise configuration, an invitation may only be valid for a certain period of time. See the invitation’s validity on the list of invitations.

• If needed, try resending the email invitation.

• If the device client is using a custom URL scheme to open a welcome window from the invitation email, confirm there are no issues with that implementation.