All URIs are relative to http://localhost/nifi-api
| Method | HTTP request | Description |
|---|---|---|
| createAccessToken | POST /access/token | Creates a token for accessing the REST API via username/password |
| createAccessTokenFromTicket | POST /access/kerberos | Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation |
| getAccessStatus | GET /access | Gets the status the client's access |
| getAccessTokenExpiration | GET /access/token/expiration | Get expiration for current Access Token |
| getLoginConfig | GET /access/config | Retrieves the access configuration for this NiFi |
| knoxCallback | GET /access/knox/callback | Redirect/callback URI for processing the result of the Apache Knox login sequence. |
| knoxLogout | GET /access/knox/logout | Performs a logout in the Apache Knox. |
| knoxRequest | GET /access/knox/request | Initiates a request to authenticate through Apache Knox. |
| logOut | DELETE /access/logout | Performs a logout for other providers that have been issued a JWT. |
| logOutComplete | GET /access/logout/complete | Completes the logout sequence by removing the cached Logout Request and Cookie if they existed and redirects to /nifi/login. |
String createAccessToken(username, password)
Creates a token for accessing the REST API via username/password
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. It is stored in the browser as a cookie, but also returned inthe response body to be stored/used by third party client scripts.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AccessApi;
AccessApi apiInstance = new AccessApi();
String username = "username_example"; // String |
String password = "password_example"; // String |
try {
String result = apiInstance.createAccessToken(username, password);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccessApi#createAccessToken");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| username | String | [optional] | |
| password | String | [optional] |
String
No authorization required
- Content-Type: application/x-www-form-urlencoded
- Accept: text/plain
String createAccessTokenFromTicket()
Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation
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>'. It is also stored in the browser as a cookie.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AccessApi;
AccessApi apiInstance = new AccessApi();
try {
String result = apiInstance.createAccessTokenFromTicket();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccessApi#createAccessTokenFromTicket");
e.printStackTrace();
}This endpoint does not need any parameter.
String
No authorization required
- Content-Type: text/plain
- Accept: text/plain
AccessStatusEntity getAccessStatus()
Gets the status the client's access
Note: This endpoint is subject to change as NiFi and it's REST API evolve.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AccessApi;
AccessApi apiInstance = new AccessApi();
try {
AccessStatusEntity result = apiInstance.getAccessStatus();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccessApi#getAccessStatus");
e.printStackTrace();
}This endpoint does not need any parameter.
No authorization required
- Content-Type: /
- Accept: application/json
AccessTokenExpirationEntity getAccessTokenExpiration()
Get expiration for current Access Token
Note: This endpoint is subject to change as NiFi and it's REST API evolve.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AccessApi;
AccessApi apiInstance = new AccessApi();
try {
AccessTokenExpirationEntity result = apiInstance.getAccessTokenExpiration();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccessApi#getAccessTokenExpiration");
e.printStackTrace();
}This endpoint does not need any parameter.
No authorization required
- Content-Type: Not defined
- Accept: application/json
AccessConfigurationEntity getLoginConfig()
Retrieves the access configuration for this NiFi
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AccessApi;
AccessApi apiInstance = new AccessApi();
try {
AccessConfigurationEntity result = apiInstance.getLoginConfig();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccessApi#getLoginConfig");
e.printStackTrace();
}This endpoint does not need any parameter.
No authorization required
- Content-Type: /
- Accept: application/json
knoxCallback()
Redirect/callback URI for processing the result of the Apache Knox login sequence.
Note: This endpoint is subject to change as NiFi and it's REST API evolve.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AccessApi;
AccessApi apiInstance = new AccessApi();
try {
apiInstance.knoxCallback();
} catch (ApiException e) {
System.err.println("Exception when calling AccessApi#knoxCallback");
e.printStackTrace();
}This endpoint does not need any parameter.
null (empty response body)
No authorization required
- Content-Type: /
- Accept: /
knoxLogout()
Performs a logout in the Apache Knox.
Note: This endpoint is subject to change as NiFi and it's REST API evolve.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AccessApi;
AccessApi apiInstance = new AccessApi();
try {
apiInstance.knoxLogout();
} catch (ApiException e) {
System.err.println("Exception when calling AccessApi#knoxLogout");
e.printStackTrace();
}This endpoint does not need any parameter.
null (empty response body)
No authorization required
- Content-Type: /
- Accept: /
knoxRequest()
Initiates a request to authenticate through Apache Knox.
Note: This endpoint is subject to change as NiFi and it's REST API evolve.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AccessApi;
AccessApi apiInstance = new AccessApi();
try {
apiInstance.knoxRequest();
} catch (ApiException e) {
System.err.println("Exception when calling AccessApi#knoxRequest");
e.printStackTrace();
}This endpoint does not need any parameter.
null (empty response body)
No authorization required
- Content-Type: /
- Accept: /
logOut()
Performs a logout for other providers that have been issued a JWT.
Note: This endpoint is subject to change as NiFi and it's REST API evolve.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AccessApi;
AccessApi apiInstance = new AccessApi();
try {
apiInstance.logOut();
} catch (ApiException e) {
System.err.println("Exception when calling AccessApi#logOut");
e.printStackTrace();
}This endpoint does not need any parameter.
null (empty response body)
No authorization required
- Content-Type: /
- Accept: /
logOutComplete()
Completes the logout sequence by removing the cached Logout Request and Cookie if they existed and redirects to /nifi/login.
Note: This endpoint is subject to change as NiFi and it's REST API evolve.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AccessApi;
AccessApi apiInstance = new AccessApi();
try {
apiInstance.logOutComplete();
} catch (ApiException e) {
System.err.println("Exception when calling AccessApi#logOutComplete");
e.printStackTrace();
}This endpoint does not need any parameter.
null (empty response body)
No authorization required
- Content-Type: /
- Accept: /