Skip to main content

xSuite Archive Prism User Guide

OAuth APIs and OAuth clients

In the OAuth APIs and OAuth Clients sections, new OAuth APIs and OAuth Clients can be added or existing OAuth APIs and OAuth Clients removed.

Adding an OAuth API

  1. Open Encore administration.

  2. Click on OAuth APIs.

  3. Click sphere_erstellen_icon.jpg Add.

    ➣ The Add OAuth API dialog will open.

    prism_archive_oauth_api_hinzufugen_dialog.png
  4. Enter the name of the API in the Name field (e.g., cmis).

  5. Enter a scope for each xSuite Archive tenant in the Scope field.

    Notice

    Use the pattern c‍m‍i‍s‍.‍{‍mandant} to specify the scope.

    The scope of the default tenant is cmis._default.

  6. In the Secret field, enter a string of your choice.

    prism_archive_oauth_api_hinzufugen_dialog_ausgefullt.png
  7. Click on Save.

    ➤ The OAuth API has now been added.

Adding an OAuth client

  1. Open Encore administration.

  2. Click on OAuth Clients.

  3. Click sphere_erstellen_icon.jpg Add.

    ➣ The Add OAuth Client dialog will open.

    prism_archive_oauth_client_hinzufugen_dialog.png
  4. Enter the name of the client in the Name field (e.g., cmis).

  5. Enter a scope for each xSuite Archive tenant in the AllowedScopes field.

    Notice

    Use the pattern c‍m‍i‍s‍.‍{‍mandant} to specify the scope.

    The scope of the default tenant is cmis._default.

  6. In the Secret field, enter a string of your choice.

    prism_archive_oauth_client_hinzufugen_dialog_ausgefullt.png
  7. Click on Save.

    ➤ The OAuth client has now been added.

Deleting the OAuth API or the OAuth client

  1. Open Encore administration.

  2. Click on OAuth APIs or on OAuth Clients.

    ➣ The existing APIs or clients are displayed.

  3. Click on an existing API or an existing client.

    ➣ The data of the OAuth APIs or the OAuth client will open in a dialog.

  4. Click Delete.

    ➣ A security prompt will open.

  5. Confirm the security prompt with Yes.

    ➤ The OAuth API or the OAuth client has now been deleted.