AccessApi

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

5. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

6. def createAccessToken(username: Option[String] = None, password: Option[String] = None): ApiRequestT[String]

   

   The token returned is formatted as a JSON Web Token (JWT).

   The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer <token>'.

   Expected answers: code 200 : String (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 403 : (Client is not authorized to make this request.) code 409 : (Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support username/password login.) code 500 : (Unable to create access token because an unexpected error occurred.)

7. def createAccessTokenFromTicket(): ApiRequestT[String]

   

   The token returned is formatted as a JSON Web Token (JWT).

   The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer <token>'.

   Expected answers: code 200 : String (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (NiFi was unable to complete the request because it did not contain a valid Kerberos ticket in the Authorization header. Retry this request after initializing a ticket with kinit and ensuring your browser is configured to support SPNEGO.) code 409 : (Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support Kerberos login.) code 500 : (Unable to create access token because an unexpected error occurred.)

8. def createDownloadToken(): ApiRequestT[String]

   

   The token returned is a base64 encoded string.

   The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.

   Expected answers: code 200 : String (successful operation) code 403 : (Client is not authorized to make this request.) code 409 : (Unable to create the download token because NiFi is not in the appropriate state. (i.e. may not have any tokens to grant or be configured to support username/password login)) code 500 : (Unable to create download token because an unexpected error occurred.)

9. def createUiExtensionToken(): ApiRequestT[String]

   

   The token returned is a base64 encoded string.

   The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.

   Expected answers: code 200 : String (successful operation) code 403 : (Client is not authorized to make this request.) code 409 : (Unable to create the download token because NiFi is not in the appropriate state. (i.e. may not have any tokens to grant or be configured to support username/password login)) code 500 : (Unable to create download token because an unexpected error occurred.)

10. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

11. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

12. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

13. def getAccessStatus(): ApiRequestT[AccessStatusEntity]

    

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Expected answers: code 200 : AccessStatusEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Unable to determine access status because the client could not be authenticated.) code 403 : (Unable to determine access status because the client is not authorized to make this request.) code 409 : (Unable to determine access status because NiFi is not in the appropriate state.) code 500 : (Unable to determine access status because an unexpected error occurred.)

14. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

15. def getLoginConfig(): ApiRequestT[AccessConfigurationEntity]

    

    Expected answers: code 200 : AccessConfigurationEntity (successful operation)

16. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

17. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

18. def knoxCallback(): ApiRequestT[Unit]

    

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Expected answers: code 0 : (successful operation)

19. def knoxLogout(): ApiRequestT[Unit]

    

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Expected answers: code 0 : (successful operation)

20. def knoxRequest(): ApiRequestT[Unit]

    

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Expected answers: code 0 : (successful operation)

21. def logOut(): ApiRequestT[Unit]

    

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Expected answers: code 200 : (User was logged out successfully.) code 401 : (Authentication token provided was empty or not in the correct JWT format.) code 500 : (Client failed to log out.)

22. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

23. final def notify(): Unit

    

    Definition Classes

    AnyRef

24. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

25. def oidcCallback(): ApiRequestT[Unit]

    

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Expected answers: code 0 : (successful operation)

26. def oidcExchange(): ApiRequestT[String]

    

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Expected answers: code 200 : String (successful operation)

27. def oidcLogout(): ApiRequestT[Unit]

    

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Expected answers: code 0 : (successful operation)

28. def oidcRequest(): ApiRequestT[Unit]

    

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Expected answers: code 0 : (successful operation)

29. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

30. def toString(): String

    

    Definition Classes

    AnyRef → Any

31. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

32. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

33. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )