Background
When you view an Agent device or a specific software product object in Analytics Web UI, it is not generally possible to use the URL in the browser address bar - such as https://app.applixure.com/Reports/Devices/Detail/02c2cbe4-501c-524d-966e-5646f47ef08c - to later on to refer or link to that particular object.
The reason for this is that the address shown is specific to a currently selected Applixure Environment active in the Analytics Web UI and does not include the Environment's ID, and trying to open that page directly may require you to choose an environment first in multi-environment scenarios where your Applixure user account has access to a more than one environment.
Furthermore, users may need to explicitly enter their Applixure user account name for seamless single sign-on to work for users configured to use SSO.
Using a specially constructed URL, it is, however, possible to link to a detail view of an individual device or software in a specific Applixure Environment. If you utilize data from our public API, you could use this link for example in your external system(s) to allow users to follow the link directly to the intended object to view it in context of Applixure.
Linking to an Agent device
To create a direct link to an Agent device in an Applixure Environment, you will need to have the following identifiers available for link construction:
- An Applixure Environment's unique ID (EnvironmentId -property in the API data for an Agent)
- An Agent device's unique ID (AgentId -property in the API data for an Agent)
By placing these values in the following form of URL, you can create a direct link to the Agent that will open in Analytics Web UI directly to that device's detail view after the user has been authenticated (explicitly or implicitly using an already existing session):
https://app.applixure.com/Go/Device/<EnvironmentId>/<AgentId>
This URL is valid for as long as the Agent device exists in that Environment's data.
Linking to software product
To create a direct link to software product in an Applixure Environment, you will need to have the following identifiers available for link construction:
- An Applixure Environment's unique ID (EnvironmentId -property in the API data for software)
- A software product's unique ID (ProductGroupId -property in the API data for software)
By placing these values in the following form of URL, you can create a direct link to the Agent that will open in Analytics Web UI directly to that device's detail view after the user has been authenticated (explicitly or implicitly using an already existing session):
https://app.applixure.com/Go/Software/<EnvironmentId>/<ProductGroupId>
This URL is valid for as long as the software product group exists in that Environment's data.
Including username and/or user organization in the link
For scenarios involving external single sign-on users, you can optionally include information about the Applixure user account or the owning Applixure Account or Environment in the link. This allows for a seamless login procedure without the user possibly having to enter their user name into the Applixure login screen to be redirected to a configured SSO identity provider.
Using login name for intended user
Normally, the Applixure authentication and authorization flow requires the login username of the user intending to log in to the system to determine whether or not to redirect the user to authenticate using the configured SSO provider. Providing the user login name as a parameter to the link can already make this determination without the user having to enter it themselves.
Using Account or Environment ID/name for all users with SSO
If the Account or Environment where your users are owned has mandatory SSO for all users, providing the Account or Environment ID allows the authentication procedure to redirect to SSO based on that information.
Please note that the Account or Environment ID might not be the same ID that is used for EnvironmentId in the link, as that EnvironmentId is one hosting the intended linked object, whereas Environment ID or Account ID provided as an optional parameter is the one hosting the user account intending to log in!
For organisational parameter, we recommend using Account or Environment ID directly as that is guaranteed to be unambiguous for the system. It is also possible to use the name of the Account or Environment for this purpose as an alternative form. Account names across all customers of Applixure are guaranteed to be distinct, but several customers can have identically named Environments, in which case passing it as a parameter does not disambiguate the intended Environment for which the SSO should be used.
Parameters to add
User login name or organization's Applixure Account or Environment name for the user account must be appended to the link URL as URI parameters user or org, respectively, with encoding for characters not allowed in the URI parameters, such as spaces:
https://app.applixure.com/Go/Device/<EnvironmentId>/<AgentId>?user=user@organization.com
https://app.applixure.com/Go/Device/<EnvironmentId>/<AgentId>?org=f6062b1a55d64943ba6e48671dc6e03d
https://app.applixure.com/Go/Device/<EnvironmentId>/<AgentId>?org=Applixure%20Oy
0 Comments