Deeplink API Guide Reference
Deeplink API Guide
Deeplink is another way to integrate with Usher. For example, you can pass QR code to let Usher app authenticate. Usher SDK supports the following Deeplinks. When you use deeplinks for your app, make sure use your own URL scheme.
Server Configuration
Use this to configure Usher with the server. The surl value can be found in your Usher Server’s configuration page.
Example:
uniusher://cs?surl=myXyXdVO0stBHUPYUM66dQFFgd5IOtX1d4Vapx0BfqhnGXc%2FwAurirlBzrd6Sf2CrVAG3Eb4jEBnJTOo7MatiQXlBC7MvCkmh%2BlUi6Caapk%3D
URL Action: cs
Parameters:
| Parameter | Value |
|---|---|
| surl | Server configuration URL. |
Badge Recovery
Once you have the badge recovery code, you can use this URL to recovery badges.
Example:
uniusher://rb?code=2HzpAE_izDioQNksq3rRlb5xRrIWC7&badge_count=4&surl=myXyXdVO0stBHUPYUM66dQFFgd5IOtX1d4Vapx0BfqhnGXc%2FwAurirlBzrd6Sf2CrVAG3Eb4jEBnJTOo7MatiQXlBC7MvCkmh%2BlUi6Caapk%3D
URL Action: rb
Parameters:
| Parameter | Value |
|---|---|
| code | The badge recovery code generated by the server. It expires if a new code is generated |
| badge_count | The badge count, not used by client |
| surl | Server configuration URL. If it is provided, client will switch to this server. |
Badge Invitation
Badge invitation code is sent by Network Administrator.
Example:
uniusher://ab?code=M7pbDSzk2aQ5ajf8JciOY0695wottw&surl=myXyXdVO0stBHUPYUM66dQFFgd5IOtX1d4Vapx0BfqhnGXc%2FwAurirlBzrd6Sf2CrVAG3Eb4jEBnJTOo7MatiQXlBC7MvCkmh%2BlUi6Caapk%3D
URL Action: ab
| Parameter | Value |
|---|---|
| code | The badge recovery code generated by the server. It expires if a new code is generated |
| surl | Server configuration URL. If it is provided, the client will switch to this server. |
Add Organization Badge
If your network is AD-enabled, this is the static URL that can be used to add user’s badge. Login and password will be required to install the badge.
Example:
uniusher://ao?org_id=15064&org_name=MicroStrategy
URL Action: ao
| Parameter | Value |
|---|---|
| org_id | The organization id. |
| org_name | The organization name. It is only used for displaying purposes. |
Mobile App SSO & Mobile Web SSO
This link is used for login into the Usherized website or application on the mobile device.
Example:
uniusher://authorize?qr=TAAahbXJVO94IaQE97hKQTyGWBc52Ew.eyJzIjogImM0MTUtdXNoZXIuY3VzdG9tZXIuY2xvdWQubWljcm9zdHJhdGVneS5jb20iLCAicCI6IDI0NDN9:15064:_17&client_id=17&redirect=true&redirect_uri=googedrive%3A%2F%2F%3F
URL Action: authorize
| Parameter | Value |
|---|---|
| qr | The QR Code. |
| client_id | The client id. |
| redirect | Whether to redirect. |
| redirect_uri | The uri to redirect. |