Skip to main content

xSuite Archive Prism Installation Guide

Configuring OAuth APIs and OAuth Clients

Notice

Configuration of Auth APIs and OAuth clients is only available, if the OAuth server is activated.

For information on activation, see Activating an OAuth Server.

  1. Open the file ArchiveEncoreSetup.exe.

    ➣ The configuration dialog will open.

  2. Select the OAuth-Apis tab.

    encore_config_oauth-apis_login.png
  3. Click Login.

    The Tenant Admin Login dialog will open.

    encore_config_oauth-apis_login_dialog.png
  4. Enter your user data and click OK.

    ➤ The fields in the OAuth-Apis and OAuth-Clients tabs can now be edited.

Adding an OAuth API

  1. In the APIs area, click Add.

    beschriftung_encore_config_oauth_api.png
  2. In the Api Name field, enter the name of the API.

    xSuite Group GmbH recommends the API name cmis.

  3. Enter a scope for each xSuite archive tenant in the middle field on the right-hand side (Scopes)

    Notice

    The scope specification must correspond to this pattern: c‍m‍i‍s‍.‍{‍t‍e‍n‍a‍n‍t‍}

    The scope of the default tenant is cmis._default.

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

    beschriftung_encore_config_oauth_api02.png
  5. In the APIs area, click Save.

    ➤ The APIs have now been added.

Adding an OAuth Client

  1. Select the OAuth-Clients tab.

  2. In the Clients area, click Add.

    beschriftung_encore_config_oauth_clients.png
  3. In the ClientId field, enter the name of the OAuth client.

  4. Enter a scope for each xSuite archive tenant in the middle field on the right-hand side (Scopes).

    Notice

    The scope specification must correspond to this pattern: c‍m‍i‍s‍.‍{‍t‍e‍n‍a‍n‍t‍}

    The scope of the default tenant is cmis._default.

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

    encore_config_oauth_clients02.png
  6. In the Clients area, click Save.

    ArchiveEncoreSetup_red_frame_13.png

    ➤ The client has now been added.