Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServerUrlOptions

options selecting Relution server to talk to.

Hierarchy

Hierarchy-Diagram

Index

Properties

Optional application

application: string

name of (backend) application as specified in relution.json.

It is adviced following the convention of using this name prefixed by a slash as the baseAlias. However, in case a different alias is used, set the field to the alias including the slash instead to make the library communicate to the correct endpoint.

Optional serverUrl

serverUrl: string

absolute url path of (default) Relution server.

Notice, the library will work correctly only if the Relution server endpoints are exposed as a (sub-)domain. Operation of Relution at a subpath of URL space is not supported!

Optional tenantOrga

tenantOrga: string

optional tenant Organization unique name.

For fully multi-tenant capable backends this field selects the backend instance the client talks to. The field defaults to using the Organization of the logon User which suffices for most use cases.

When set to the unique name of an Organization, users of of one Organization may log into the (backend) application instance of another Organization serving as the tenant. Notice, in order to use this feature the tenant Organization must have at least execute rights on the (backend) application and the User using it needs to have read permission on the tenant Organization used.

Generated using TypeDoc