Pular para o conteúdo principal

Configure Gecert Connect on the server - GeCert

Gecert Connect reads from the GeCert server, without authentication, the address to use and the data for the GrantID login. This data lives in the GecertConnect section of the server configuration.

Gecert Connect application in GrantID​

Gecert Connect signs in through OpenID Connect with the openid, profile and offline_access scopes and the GeCert API scope (the same ApiName as in the OpenID Connect configuration). It needs an application of its own in GrantID, separate from the web interface's application, with:

  • the authorization code flow with PKCE, the one for native applications;
  • offline access allowed, so that the application receives a refresh token and renews the session without asking for the password again;
  • the GeCert API scope among the allowed API scopes;
  • a redirect URI. Gecert Connect intercepts the navigation to that URI inside its own login window, so it does not need to answer: it can be, for example, https://your-gecert-address/gecert-connect/callback.

Create the application in the GrantID console as described in the OpenID Connect configuration, noting its App-id.

GecertConnect section​

  • ServerUrl: the public address of the GeCert instance, which Gecert Connect will use, for example https://gecert.yourcompany.com/
  • GrantIdAuthority: the GrantID OIDC authority (the same value as Oidc:Authority)
  • GrantIdClientAppId: the App-id of the Gecert Connect application in GrantID
  • GrantIdApiName: the name of the GeCert API in GrantID (the same value as Oidc:ApiName)
  • GrantIdRedirectUri: the redirect URI registered in the Gecert Connect application
  • MinSupportedVersion (optional): the lowest Gecert Connect version the server accepts. Older applications show the Update Required screen and stop working until they are updated. The default is 1.1.0.0
  • UnderMaintenance (optional): True to put Gecert Connect in maintenance mode: the application stops calling the server, shows the maintenance screen and resumes by itself when the value goes back to False. The default is False

The first five values are required by Gecert Connect: while any of them is missing, the GET /api/app-configuration/gecert-connect/server route answers with the GecertConnectServerNotConfigured error, and the application shows Error configuring server.

Example (.ini or .conf configuration file):

[GecertConnect]
ServerUrl=https://gecert.yourcompany.com/
GrantIdAuthority=https://login.id.patorum.com
GrantIdClientAppId=gecert-connect
GrantIdApiName=gecert
GrantIdRedirectUri=https://gecert.yourcompany.com/gecert-connect/callback
MinSupportedVersion=1.2.0.0

Example (environment variables):

GecertConnect__ServerUrl=https://gecert.yourcompany.com/
GecertConnect__GrantIdAuthority=https://login.id.patorum.com
GecertConnect__GrantIdClientAppId=gecert-connect
GecertConnect__GrantIdApiName=gecert
GecertConnect__GrantIdRedirectUri=https://gecert.yourcompany.com/gecert-connect/callback
GecertConnect__MinSupportedVersion=1.2.0.0

Handing the configuration to the users​

After configuring the server, send the users the configuration link, which they open with Gecert Connect installed:

gecertconnect://server/gecert.yourcompany.com

The application queries the server, saves the configuration and confirms with the Server configured message. See Server configuration.

See also​

View as Markdown