Uploaded image for project: 'Apache NiFi'
  1. Apache NiFi
  2. NIFI-9322

OIDC and SAML Access Resources Produce Invalid Documentation

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Resolved
    • Minor
    • Resolution: Fixed
    • 1.14.0
    • 1.15.0
    • Core Framework
    • None

    Description

      Nifi API guide at https://nifi.apache.org/docs/nifi-docs/rest-api/index.html has an API 

      /access/oidc/token

      However this API is missing from the actual code at  

      OIDCAccessResource.java

      Exposed API's are defined as constants in 

      OIDCEndpoints.java

       And the constants are

      package org.apache.nifi.web.security.oidc;
      
      public interface OIDCEndpoints {
          String OIDC_ACCESS_ROOT = "/access/oidc";
          String LOGIN_REQUEST_RELATIVE = "/request";
          String LOGIN_REQUEST = OIDC_ACCESS_ROOT + LOGIN_REQUEST_RELATIVE;
          String LOGIN_CALLBACK_RELATIVE = "/callback";
          String LOGIN_CALLBACK = OIDC_ACCESS_ROOT + LOGIN_CALLBACK_RELATIVE;
          String TOKEN_EXCHANGE_RELATIVE = "/exchange";
          String TOKEN_EXCHANGE = OIDC_ACCESS_ROOT + TOKEN_EXCHANGE_RELATIVE;
          String LOGOUT_REQUEST_RELATIVE = "/logout";
          String LOGOUT_REQUEST = OIDC_ACCESS_ROOT + LOGOUT_REQUEST_RELATIVE;
          String LOGOUT_CALLBACK_RELATIVE = "/logoutCallback";
          String LOGOUT_CALLBACK = OIDC_ACCESS_ROOT + LOGOUT_CALLBACK_RELATIVE;
      }
      

      We were trying to execute the API

      /access/oidc/token

      to no avail only to realize no such API is exposed.

      Attachments

        Issue Links

          Activity

            People

              exceptionfactory David Handermann
              dheerajjoshim Dheeraj Joshi
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 0.5h
                  0.5h