(EU) Client application setup in Entra ID for calling PALMA Composer APIs

Modified on Tue, 5 Nov, 2024 at 5:27 PM

Application administration privileges in Entra ID are required to perform this setup.

If your application is already set up in Entra ID, you may skip to the section "Grant permission to call PALMA Composer APIs". If not, then proceed with the next section.

The following sections assume that you have access to the Entra ID App registrations page for your tenant.

Create the application

Add a New registration. In the initial setup give it an appropriate name, for example "PALMA PLM Integration", and accept the default settings.
Go to Certificates & secrets to set up credentials for the application.

Grant permission to call PALMA Composer APIs

Note that permissions set up for the application as described here does not allow the application to act on behalf of an interactive user. It means that even if an interactive user may be able to obtain a personal access token for this application, such tokens cannot be used to make calls to PALMA Composer APIs.

Open the settings for your existing or newly created application.
Open the application Manifest.

In the array "requiredResourceAccess": [ ... ], add an entry to allow access to PALMA Composer APIs for PALMA Composer hosted at eu.palmacloud.com (EU):

{
    "resourceAppId": "f558e12b-e93f-46ad-ac01-10a717495cec",
    "resourceAccess": [
        {
            "id": "42855924-eba1-4eda-b0fd-f07d9ed73234",
            "type": "Role"
        }
    ]
}

Be sure to save the manifest before proceeding to the next step.

Go to API permissions.
The entry added in the manifest will be shown here as application permissions for PALMA @ eu.palmacloud.com / API.
Click the button to Grant admin consent for [YOUR ORGANIZATION] to complete the grant.

Submit your request

Go to the Overview page for your application.
Copy the Application (client) ID and submit it to PALMA Support with your request to set up a machine-to-machine (M2M) integration client.