SAML app setup
Single sign-on with Okta supports various configurations. The following is an example of an Okta setup.Create the app integration
- Log in to the Okta dashboard.
- Go to Applications → Applications in the left-hand sidebar.
- Click Create App Integration.
- Select SAML 2.0 and click Next.
- Fill in the General Settings with any values (for example, an app name of
Gr4vy Dashboard).
Sandbox and production are configured separately. Create a separate Okta app
for each environment, each with its own values as shown below.
Configure SAML
On the Configure SAML step, fill in the following for the environment you are setting up. The
Add the following Attribute Statements with an Unspecified name format:
instance_id is the name of your Gr4vy instance.- Sandbox
- Production
- Single sign-on URL:
https://auth.gr4vy.com/login/callback?connection={instance_id}-sandbox-saml&organization={instance_id} - Audience URI (SP Entity ID):
urn:auth0:gr4vy:{instance_id}-sandbox-saml
| Name | Value |
|---|---|
name | user.displayName |
email | user.email |
gr4vy_roles | user.gr4vy_roles |
gr4vy_environments | user.gr4vy_environments |
Finish and retrieve the connection details
- Complete the app setup.
- On the app’s Sign On tab, copy the Identity Provider Single Sign-On URL and download the X.509 Certificate (available via View SAML setup instructions).
- Provide the Sign-On URL and certificate to the support team so they can enable the connection.
Users access
Once an app is set up, make sure the right users have access to it. This can be configured on the user profile, through a group, or through app assignment. Whichever approach you use, apply the profile properties below to the intended users.Roles and environments
By default, users are restricted to theanalyst role in the sandbox environment. To assign
roles and environments, set the gr4vy_roles and gr4vy_environments profile properties on the
relevant users — these are sent in the assertion via the Attribute Statements configured in the preceding step.
Roles
Thegr4vy_roles property controls the roles a user has. This needs to be an array with one or more
of the following values. If not set, it defaults to analyst.
analystadministratorcustomer-supportpii-viewersystem-managersystem-supportuser-managerreport-managerreport-viewer
Environments
Thegr4vy_environments property controls which environments a user can access. This needs to be an
array with one or more of the following values. If not set, it defaults to sandbox.
productionsandbox