Create OAuth clients

Create OAuth clients to allow your integration to act on behalf of an Inxmail user.

You will need to create a separate client ID with a secret for each integration that will act on behalf of an Inxmail user.

Have the following information at hand before you create your OAuth clients:

Name

Description
Name Unique name of the integration
Display name

Meaningful name for the integration.

Your user will see the display name on the consent screen with which he or she allows the integration to act on his or her behalf.
Space Space you want to link with the integration.
Redirect URL(s) of the integration List of valid redirect endpoints of the integration application. Redirect endpoints are called to complete the OAuth authorization code grant. Redirect URIs are required to use the HTTPS protocol.

User logins in Inxmail New Xperience are always valid for one space. This also applies to OAuth clients where your integration acts on behalf of an Inxmail user. In case of a multi-space integration, you will need to create one OAuth client per space.

To ensure that only your integration is able to request tokens on behalf of your Inxmail ID user, your integration application must authenticate itself to Inxmail New Xperience. The client ID and client secret are used at various points in OAuth communication to authenticate the application (see: Requesting a refresh token / Requesting an access token by means of a refresh token).

Step by step

  1. Open the "OAuth-Clients" navigation item.

  2. Click New OAuth client.

  3. Enter a unique name for your OAuth client.

    You cannot change the name later on. Therefore, take extra care when assigning a name. It must be unique in your Inxmail account, and you cannot change it at a future time.

  4. Enter a display name and select the space you wish to link the integration to.

  5. Redirect URL: Enter the redirect URL within your integration that you want to redirect to after the user has successfully logged in and given their consent. If you don’t know it now, you can add it later. Your redirect URL must use the HTTPS protocol.

    The integration only works with a redirect URL: If you do not specify a redirect URL, your integration will not work.

    With third-party integrations: Ask your third-party vendor which redirect URL you need to enter.

    Typically, you will have only one redirect URL. Click the icon to specify more than one redirect URL.

  6. Click Create.

  7. Copy your client ID and secret to the clipboard to ensure they are available to you at a later time.

    Keep your secret safe: This is sensitive information. Do not disclose it or share it with others and save it in a secure location.

    Once you have completed this step, you will no longer have access to your secret: Make sure to store it in a safe location. Neither you nor Inxmail can access your secret once you close this dialog.

  • You have stored an OAuth client with a client ID and secret in Inxmail New Xperience.

Now switch to your integration and complete the OAuth setup there.

This process varies from integration to integration. Consult with your company’s IT department or integration vendor if you are unsure how to proceed.

Also, make sure that the redirect endpoints of your integration application are secured via HTTPS.

For further information, see OAuth clients: Technical information, URLs, and code snippets.