GIP API reference

Reference information for Genero Identity Platform API that manages authorization roles and access scopes.

Table 1. OpenID and OpenIDRegister API scopes
Scope Description Required by
openid Support OpenID-Connect Single sign-on authentication
  • All Genero applications that are run on behalf of a user (called apps in the Genero Console App interface)
  • All users
register Access the Genero Identity Platform registration service to register applications, web service scopes, etc.
  • Administrators
  • service to service apps. Genero applications that do not have to be run on behalf of a user (for example, scripts)
Table 2. Authorization API roles
Authorization role Description Required by
Role.Admin Administrator of Genero Identity Platform Administrators
Role.Supervisor Supervisor of Genero Identity Platform Select users
Role.User Standard user of Genero Identity Platform
  • All apps
  • All users
Table 3. Profile API scopes
Scope Description Required by
profile Provide user profile information of authenticated user at application startup. File sharing users
profile.me Allows a user to modify their own profile. All users
profile.mgr Allows a user to manage all users profiles and user properties. Administrators
profile.query Allows a user to query basic profile information of another user. Basic profile information includes firstname, lastname, and email only. File sharing users
Table 4. Deployment API scopes
Scope Description Required by
deployment Access the Genero Deployment service
  • Service-to-Service apps (for example, scripts deploying apps)
  • Users deploying apps
Table 5. SharedFile API scopes
Scope Description Required by
sharefile Access to file share service File sharing users