Settings
There are currently two available settings: Single Sign-On (SSO) and Data Retention.
Single Sign-On Configurations
This guide offers a step-by-step walkthrough for setting up SAML Single Sign-On (SSO) into Orby to simplify cross-application authentication. It details the necessary configuration steps, including selecting Okta as the identity provider, providing required information through metadata upload or manual configuration, configuring attributes in the IdP, setting up Default Relay State (if needed), and testing and saving the configuration. The guide also outlines the information needed from both Orby and the identity provider to establish a successful connection.
What you need from Orby to set up SSO
Entity ID - https://grpc.orby.ai
EU Region Entity ID - https://grpc-eu.orby.ai
Callback URL - https://grpc.orby.ai/saml/acs
EU Region Callback URL - https://grpc-eu.orby.ai/saml/acs
Public Certificate for encryption - Certificate
Default Relay State - This can be found on the SAML configuration page
What Orby needs from the identiity provider
Single Sign-On URL Public Certificate Issuer
Logout URL
OR
Idp XML Metadata File/URL
Step by Step Guide
Step 1: Select Provider
Before first setting up SAML SSO, you can contact us with the email account you would like to configure SSO. And we will provide you with a temporary password to login.
Login using the provided temporary username and password. Go to our settings page, and click on the “Configure SSO account” button. Currently, we only support Okta as the identity provider (IdP). Let us know if you need support for other providers.
Step 2: Configure SSO on Orby
You can add multiple domain names for SSO, and have two options for providing the attribute information:
Upload Okta Metadata File: Either upload the metadata file directly or provide the URL for the metadata XML file.
Manual Configuration: enter the information manually
Identiity proviider vallue | Orby fiielld | Requiired | Notes |
|---|---|---|---|
Issuer | Issuer | Yes | This is a distinct name utilized by the IdP for SAML 2.0. Your IdP may refer to this as: Issuer URL Identity Provider Issuer Issuer ID Entity ID |
Single Sign-On URL | Single Sign-On URL | Yes | Upon signing in, Orby will redirect users to this URL for authentication by your IdP. Your IdP may refer to this as: Single Sign-On Service Identity Provider Login URL SAML 2.0 Endpoint (HTTP) Login URL |
x.509 certificate (must be in PEM/CERT/CRT format) | Public Certificate | Yes | This certificate enables Orby to authenticate requests from your IdP. |
Sign Out URL | Sign Out URL | No | The URL where users are redirected after signing out. |
Step 3: Configure Attributes in IdP
Identiity proviider settiing | Vallue | Requiired | Notes |
|---|---|---|---|
Audience | Orby provided Entity ID | Yes | Your identity provider may refer to this as: Entity ID Identifier |
Assertion Consumer Service | Orby provided Callback URI | Yes | Your identity provider may refer to this as: Single Sign-on URL Reply URL Application Callback URL SAML Consumer URL |
Default Relay State | Orby provided Default RelayState | Yes | Default Relay State is necessary only for Identity Provider Initiated Sign-on. If Default Relay State is not configured, users will need to sign in directly through the Idp. |
Name ID Format | EmailAddress | Yes | We use the email address to uniquely identify the user and log into the system. |
Name ID | User’s primary email address | Yes | The unique identifier (email) for the individual. |
Assertion Signature | Signed | Yes | The Assertion must be signed with Orby provided certificate |
Response | Signed | Yes | Response must be signed |
Assertion Encryption | Unencrypted | Yes | This should be Unencrypted |
Signature Certificate | Orby provided Signature Certificate | Yes | Signature certificate will be provided by Orby |
Signed Requests | Signed Requests | Yes | Tick the option to validate SAML requests with signature certificates |
Binding | HTTP-POST | Yes | Ensuring that SAML messages are transmitted securely via HTTP POST between the Identity Provider (IdP) and Orby |
Step 4: Configure Additional SSO Settings
We use just in time provisioning so in your IdP configure these attributes with the names provided below.
NOTE: These attribute names are case sensitive and must match exactly
Name | Requiired | Descriiptiion |
|---|---|---|
firstName | Yes | The user’s given name |
lastName | Yes | The user’s surname |
Step 5: Test and Save Configuration
Click the "Test" button to verify the configuration after saving them.
Ensure that the test is successful and that the SSO connection is functioning correctly.
Data Retention
Organization-level settings can be enabled for data retention. If configured, completed tasks will be automatically deleted permanently N days after task completion. If a completed task is modified, its task completion time is updated to the modification time which will reset the countdown for the auto deletion.
Please note that modifying a completed task results in an update on completion date.
Data retention policy has an impact on existing tasks
Once enabled, the data retention policy will apply on existing tasks as well, which means existing tasks will be auto-deleted after designated days defined.