OpenID API GetStarted - kmd-identity/documentation GitHub Wiki

Information needed to register your API with KMD Identity using OpenID

  • Specify a name for the API. The recommended standard is: [ORGANIZATION] [PRODUCT] - [ENVIRONMENT]
    • Examples:
      • KMD Identity Test Applications Web API - local
      • KMD Identity Test Applications Web API - dev
      • KMD Identity Test Applications Web API - prod
  • Specify a unique audience (identifier of your API). The recommended standard is: urn:[ORGANIZATION]-[PRODUCT]-api.[ENVIRONMENT]
    • Examples:
      • urn:kmd-identity-test-application-api.local
      • urn:kmd-identity-test-application-api.dev
      • urn:kmd-identity-test-application-api.prod
  • The API will by default have a scope called user_impersonation. The user_impersonation scope will be used by applications to request an access_token to the API. Read more about scopes at auth0. Contact KMD Identity if you are interested in custom scopes for the API.
  • If a front-end application that has already been registered with KMD Identity should be allowed to request a scope on this API, specify the ClientId of that front-end application and the API scope(s) it should be permitted to request.
  • If a front-end application that has not yet been registered with KMD Identity should be allowed to request a scope on this API (eg. one that is being requested in the same issue as this API), you can refer to it by name instead.