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 |
| CreateDownloadToken | POST /access/download-token | Creates a single use access token for downloading FlowFile content. |
| CreateUiExtensionToken | POST /access/ui-extension-token | Creates a single use access token for accessing a NiFi UI extension. |
| GetAccessStatus | GET /access | Gets the status the client's access |
| 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. |
| OidcCallback | GET /access/oidc/callback | Redirect/callback URI for processing the result of the OpenId Connect login sequence. |
| OidcExchange | POST /access/oidc/exchange | Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider. |
| OidcLogout | GET /access/oidc/logout | Performs a logout in the OpenId Provider. |
| OidcRequest | GET /access/oidc/request | Initiates a request to authenticate through the configured OpenId Connect provider. |
string CreateAccessToken (string username = null, string password = null)
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. The token can be used in the Authorization header in the format 'Authorization: Bearer '.
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class CreateAccessTokenExample
{
public void main()
{
var apiInstance = new AccessApi();
var username = username_example; // string | (optional)
var password = password_example; // string | (optional)
try
{
// Creates a token for accessing the REST API via username/password
string result = apiInstance.CreateAccessToken(username, password);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AccessApi.CreateAccessToken: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| username | string | [optional] | |
| password | string | [optional] |
string
No authorization required
- Content-Type: application/x-www-form-urlencoded
- Accept: text/plain
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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 '.
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class CreateAccessTokenFromTicketExample
{
public void main()
{
var apiInstance = new AccessApi();
try
{
// Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation
string result = apiInstance.CreateAccessTokenFromTicket();
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AccessApi.CreateAccessTokenFromTicket: " + e.Message );
}
}
}
}This endpoint does not need any parameter.
string
No authorization required
- Content-Type: text/plain
- Accept: text/plain
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string CreateDownloadToken ()
Creates a single use access token for downloading FlowFile content.
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'.
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class CreateDownloadTokenExample
{
public void main()
{
var apiInstance = new AccessApi();
try
{
// Creates a single use access token for downloading FlowFile content.
string result = apiInstance.CreateDownloadToken();
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AccessApi.CreateDownloadToken: " + e.Message );
}
}
}
}This endpoint does not need any parameter.
string
No authorization required
- Content-Type: application/x-www-form-urlencoded
- Accept: text/plain
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string CreateUiExtensionToken ()
Creates a single use access token for accessing a NiFi UI extension.
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'.
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class CreateUiExtensionTokenExample
{
public void main()
{
var apiInstance = new AccessApi();
try
{
// Creates a single use access token for accessing a NiFi UI extension.
string result = apiInstance.CreateUiExtensionToken();
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AccessApi.CreateUiExtensionToken: " + e.Message );
}
}
}
}This endpoint does not need any parameter.
string
No authorization required
- Content-Type: application/x-www-form-urlencoded
- Accept: text/plain
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AccessStatusEntity GetAccessStatus ()
Gets the status the client's access
Note: This endpoint is subject to change as NiFi and it's REST API evolve.
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class GetAccessStatusExample
{
public void main()
{
var apiInstance = new AccessApi();
try
{
// Gets the status the client's access
AccessStatusEntity result = apiInstance.GetAccessStatus();
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AccessApi.GetAccessStatus: " + e.Message );
}
}
}
}This endpoint does not need any parameter.
No authorization required
- Content-Type: /
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AccessConfigurationEntity GetLoginConfig ()
Retrieves the access configuration for this NiFi
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class GetLoginConfigExample
{
public void main()
{
var apiInstance = new AccessApi();
try
{
// Retrieves the access configuration for this NiFi
AccessConfigurationEntity result = apiInstance.GetLoginConfig();
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AccessApi.GetLoginConfig: " + e.Message );
}
}
}
}This endpoint does not need any parameter.
No authorization required
- Content-Type: /
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void 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.
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class KnoxCallbackExample
{
public void main()
{
var apiInstance = new AccessApi();
try
{
// Redirect/callback URI for processing the result of the Apache Knox login sequence.
apiInstance.KnoxCallback();
}
catch (Exception e)
{
Debug.Print("Exception when calling AccessApi.KnoxCallback: " + e.Message );
}
}
}
}This endpoint does not need any parameter.
void (empty response body)
No authorization required
- Content-Type: /
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void KnoxLogout ()
Performs a logout in the Apache Knox.
Note: This endpoint is subject to change as NiFi and it's REST API evolve.
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class KnoxLogoutExample
{
public void main()
{
var apiInstance = new AccessApi();
try
{
// Performs a logout in the Apache Knox.
apiInstance.KnoxLogout();
}
catch (Exception e)
{
Debug.Print("Exception when calling AccessApi.KnoxLogout: " + e.Message );
}
}
}
}This endpoint does not need any parameter.
void (empty response body)
No authorization required
- Content-Type: /
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void KnoxRequest ()
Initiates a request to authenticate through Apache Knox.
Note: This endpoint is subject to change as NiFi and it's REST API evolve.
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class KnoxRequestExample
{
public void main()
{
var apiInstance = new AccessApi();
try
{
// Initiates a request to authenticate through Apache Knox.
apiInstance.KnoxRequest();
}
catch (Exception e)
{
Debug.Print("Exception when calling AccessApi.KnoxRequest: " + e.Message );
}
}
}
}This endpoint does not need any parameter.
void (empty response body)
No authorization required
- Content-Type: /
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void OidcCallback ()
Redirect/callback URI for processing the result of the OpenId Connect login sequence.
Note: This endpoint is subject to change as NiFi and it's REST API evolve.
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class OidcCallbackExample
{
public void main()
{
var apiInstance = new AccessApi();
try
{
// Redirect/callback URI for processing the result of the OpenId Connect login sequence.
apiInstance.OidcCallback();
}
catch (Exception e)
{
Debug.Print("Exception when calling AccessApi.OidcCallback: " + e.Message );
}
}
}
}This endpoint does not need any parameter.
void (empty response body)
No authorization required
- Content-Type: /
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string OidcExchange ()
Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.
Note: This endpoint is subject to change as NiFi and it's REST API evolve.
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class OidcExchangeExample
{
public void main()
{
var apiInstance = new AccessApi();
try
{
// Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.
string result = apiInstance.OidcExchange();
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AccessApi.OidcExchange: " + e.Message );
}
}
}
}This endpoint does not need any parameter.
string
No authorization required
- Content-Type: /
- Accept: text/plain
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void OidcLogout ()
Performs a logout in the OpenId Provider.
Note: This endpoint is subject to change as NiFi and it's REST API evolve.
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class OidcLogoutExample
{
public void main()
{
var apiInstance = new AccessApi();
try
{
// Performs a logout in the OpenId Provider.
apiInstance.OidcLogout();
}
catch (Exception e)
{
Debug.Print("Exception when calling AccessApi.OidcLogout: " + e.Message );
}
}
}
}This endpoint does not need any parameter.
void (empty response body)
No authorization required
- Content-Type: /
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void OidcRequest ()
Initiates a request to authenticate through the configured OpenId Connect provider.
Note: This endpoint is subject to change as NiFi and it's REST API evolve.
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class OidcRequestExample
{
public void main()
{
var apiInstance = new AccessApi();
try
{
// Initiates a request to authenticate through the configured OpenId Connect provider.
apiInstance.OidcRequest();
}
catch (Exception e)
{
Debug.Print("Exception when calling AccessApi.OidcRequest: " + e.Message );
}
}
}
}This endpoint does not need any parameter.
void (empty response body)
No authorization required
- Content-Type: /
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]