All authenticated endpoints require a valid session to access. Information on how to obtain and use a session can be found here.
Note: Sessions last 12 hours until they are considered expired and have to be renewed.
To enable SSO authentication, enter the domain which users must have an email address associated with.
Users can enable a multi factor authentication for password based logins in Gremlin Company Settings under the Security tab. Currently, Time-based Token (Time-based One Time Passwords, TOTP) MFA is supported. An example of a compatible authenticator is the Google Authenticator, available on the Apple App Store and Google Play.
MFA can be forced for users across the entire company. When
Enforce MFA is enabled all users who authenticate without MFA will be provided with a secret key and QR barcode to setup their authenticator. Certain user roles also have the ability to disable MFA for individual users within their company, useful in cases where a user loses their authenticator.
Companies who host their own SAML compatible Identity Provider (IDP) can utilize SAML sign-on for their users to authenticate with Gremlin. SAML provides your organization complete control over the users authentication process and experience. When using SAML, authentication requests are forwarded to your IDP, which performs authentication as your company specifies. Once a user has authenticated, their details such as their email address, are securely delivered to Gremlin and the user is granted access.
In order to configure your IDP for SAML please use our Service Provider (SP) metadata, available with the following command:
- Assertion Consumer Service URL -
https://api.gremlin.com/v1/users/auth/saml/acs: Represents the location your IDP will send the SAML assertion to be validated by our SP.
- Entity ID -
http://api.gremlin.com/saml: Unique identifier for the Gremlin SP.
- RelayState -
<Company Name>|||https://app.gremlin.com/users/sso/saml/acs|||/|||getCompanySession: Four parameters seperated by
|||. The first being your company name. The second parameter is the app address, where our ACS sends the user once it is done validating. The third is where we send the user once the login is fully complete, the default destination is the home page. The last parameter is for backwards compatability purposes to ensure you get the correct session.
- NameID Format -
urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress: Specifies the format of the NameID within the SAML assertion. We require a valid email be used.
- Signature Method -
http://www.w3.org/2001/04/xmldsig-more#rsa-sha256: What we use for signing our SAML metadata and requests.
- AuthnRequest -
urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect: Used by our SP to send users to their IDP during SP initiated logins.
- AuthnResponse -
urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST: Used by your IDP when returning the response to our ACS.
- AuthnRequest -