Skip to content

AccessoidcApi.md

Latest commit

 

History

History
214 lines (145 loc) · 4.93 KB

AccessoidcApi.md

File metadata and controls

214 lines (145 loc) · 4.93 KB

AccessoidcApi

All URIs are relative to http://localhost/nifi-api

Method HTTP request Description
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.
oidcLogoutCallback GET /access/oidc/logoutCallback Redirect/callback URI for processing the result of the OpenId Connect logout sequence.
oidcRequest GET /access/oidc/request Initiates a request to authenticate through the configured OpenId Connect provider.

oidcCallback

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.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AccessoidcApi;


AccessoidcApi apiInstance = new AccessoidcApi();
try {
    apiInstance.oidcCallback();
} catch (ApiException e) {
    System.err.println("Exception when calling AccessoidcApi#oidcCallback");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: /

oidcExchange

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.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AccessoidcApi;


AccessoidcApi apiInstance = new AccessoidcApi();
try {
    String result = apiInstance.oidcExchange();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AccessoidcApi#oidcExchange");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: text/plain

oidcLogout

oidcLogout()

Performs a logout in the OpenId Provider.

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

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AccessoidcApi;


AccessoidcApi apiInstance = new AccessoidcApi();
try {
    apiInstance.oidcLogout();
} catch (ApiException e) {
    System.err.println("Exception when calling AccessoidcApi#oidcLogout");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: /

oidcLogoutCallback

oidcLogoutCallback()

Redirect/callback URI for processing the result of the OpenId Connect logout sequence.

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

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AccessoidcApi;


AccessoidcApi apiInstance = new AccessoidcApi();
try {
    apiInstance.oidcLogoutCallback();
} catch (ApiException e) {
    System.err.println("Exception when calling AccessoidcApi#oidcLogoutCallback");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: /

oidcRequest

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.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AccessoidcApi;


AccessoidcApi apiInstance = new AccessoidcApi();
try {
    apiInstance.oidcRequest();
} catch (ApiException e) {
    System.err.println("Exception when calling AccessoidcApi#oidcRequest");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: /