Skip to content

Issue application credentials

Application Credentials are used for background actions without any user interaction required or, when the data displayed in the UI should be independent from the rights of the App User (example, show all assets on the environment independent if the App User has the right to access Asset Management itself).

User Interface

"App Credentials" screen:

app-credentials-ui

Credentials Description
Read and Write In this access, you are allowed to perform all CRUD operations on MindSphere APIs.
Custom In this access, the customizable set of MindSphere core roles can contain any kind of data access level. All MindSphere APIs can be configured as per the user requirement.
Note: In Custom credentials, application scopes are configured only for Developer and Operator environments. These configured application scopes are not applicable for IoT environment tenants.

Note

  • For API application, application credentials are issued with "Read and Write" data access only.
  • If app credentials are created for older version, then it is not possible to changed/remove in new version for API.

Procedure

To issue application credentials, follow these steps:

  1. In “Applications Overview", select your application.
  2. Click button and click “Edit” to issue or revoke the App Credentials.
  3. Select "Application Credentials" to choose the type of app credentials you want to issue.
    • Read & Write: If you choose “Read and Write Credentials”, a dialog box appears with “Client ID” and “Client Secret”.
    • App Credentials: If you choose “Custom Credentials” you can configure custom application credentials and click “Configure”, a dialog box appears with “Client ID” and “Client Secret”. app-credentials-created
  4. Save or download the app credentials.

Note

This app credentials will be displayed only once. Store the credentials to access the application appropriately.

Result

The application credentials is successfully issued for the application.

app-credentials-created-ui

Revoke application credentials

If the user forgets the username and password of the application credentials of the working application, he can re-generate a secret key again by revoking the generated application credential.

Procedure

To revoke the application credentials, follow these steps:

  1. In “Applications Overview", select your application.

  2. Click button and click “Edit” to revoke the app credentials.

    revoke-app-cred

  3. Click “Revoke Credentials” to revoke the application credentials.

Result

The application credentials is successfully revoked for the application. You can re-issue the application credentials again, if required.

Any questions left?

Ask the community

Except where otherwise noted, content on this site is licensed under the MindSphere Development License Agreement.

Last update: November 28, 2022