\AccessApi

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.
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.
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.
SamlLocalLogout	Get /access/saml/local-logout	Local logout when SAML is enabled, does not communicate with the IDP.
SamlLoginExchange	Post /access/saml/login/exchange	Retrieves a JWT following a successful login sequence using the configured SAML identity provider.
SamlLoginHttpPostConsumer	Post /access/saml/login/consumer	Processes the SSO response from the SAML identity provider for HTTP-POST binding.
SamlLoginHttpRedirectConsumer	Get /access/saml/login/consumer	Processes the SSO response from the SAML identity provider for HTTP-REDIRECT binding.
SamlLoginRequest	Get /access/saml/login/request	Initiates an SSO request to the configured SAML identity provider.
SamlMetadata	Get /access/saml/metadata	Retrieves the service provider metadata.
SamlSingleLogoutHttpPostConsumer	Post /access/saml/single-logout/consumer	Processes a SingleLogout message from the configured SAML identity provider using the HTTP-POST binding.
SamlSingleLogoutHttpRedirectConsumer	Get /access/saml/single-logout/consumer	Processes a SingleLogout message from the configured SAML identity provider using the HTTP-REDIRECT binding.
SamlSingleLogoutRequest	Get /access/saml/single-logout/request	Initiates a logout request using the SingleLogout service of the configured SAML identity provider.

CreateAccessToken

string CreateAccessToken(ctx).Username(username).Password(password).Execute()

Creates a token for accessing the REST API via username/password

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    username := "username_example" // string |  (optional)
    password := "password_example" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AccessApi.CreateAccessToken(context.Background()).Username(username).Password(password).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessApi.CreateAccessToken``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateAccessToken`: string
    fmt.Fprintf(os.Stdout, "Response from `AccessApi.CreateAccessToken`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreateAccessTokenRequest struct via the builder pattern

Name	Type	Description	Notes
username	string
password	string

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateAccessTokenFromTicket

string CreateAccessTokenFromTicket(ctx).Execute()

Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AccessApi.CreateAccessTokenFromTicket(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessApi.CreateAccessTokenFromTicket``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateAccessTokenFromTicket`: string
    fmt.Fprintf(os.Stdout, "Response from `AccessApi.CreateAccessTokenFromTicket`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiCreateAccessTokenFromTicketRequest struct via the builder pattern

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateDownloadToken

string CreateDownloadToken(ctx).Execute()

Creates a single use access token for downloading FlowFile content.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AccessApi.CreateDownloadToken(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessApi.CreateDownloadToken``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateDownloadToken`: string
    fmt.Fprintf(os.Stdout, "Response from `AccessApi.CreateDownloadToken`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiCreateDownloadTokenRequest struct via the builder pattern

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateUiExtensionToken

string CreateUiExtensionToken(ctx).Execute()

Creates a single use access token for accessing a NiFi UI extension.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AccessApi.CreateUiExtensionToken(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessApi.CreateUiExtensionToken``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateUiExtensionToken`: string
    fmt.Fprintf(os.Stdout, "Response from `AccessApi.CreateUiExtensionToken`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiCreateUiExtensionTokenRequest struct via the builder pattern

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAccessStatus

AccessStatusEntity GetAccessStatus(ctx).Execute()

Gets the status the client's access

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AccessApi.GetAccessStatus(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessApi.GetAccessStatus``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetAccessStatus`: AccessStatusEntity
    fmt.Fprintf(os.Stdout, "Response from `AccessApi.GetAccessStatus`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetAccessStatusRequest struct via the builder pattern

Return type

AccessStatusEntity

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLoginConfig

AccessConfigurationEntity GetLoginConfig(ctx).Execute()

Retrieves the access configuration for this NiFi

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AccessApi.GetLoginConfig(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessApi.GetLoginConfig``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetLoginConfig`: AccessConfigurationEntity
    fmt.Fprintf(os.Stdout, "Response from `AccessApi.GetLoginConfig`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetLoginConfigRequest struct via the builder pattern

Return type

AccessConfigurationEntity

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

KnoxCallback

KnoxCallback(ctx).Execute()

Redirect/callback URI for processing the result of the Apache Knox login sequence.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AccessApi.KnoxCallback(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessApi.KnoxCallback``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiKnoxCallbackRequest struct via the builder pattern

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

KnoxLogout

KnoxLogout(ctx).Execute()

Performs a logout in the Apache Knox.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AccessApi.KnoxLogout(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessApi.KnoxLogout``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiKnoxLogoutRequest struct via the builder pattern

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

KnoxRequest

KnoxRequest(ctx).Execute()

Initiates a request to authenticate through Apache Knox.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AccessApi.KnoxRequest(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessApi.KnoxRequest``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiKnoxRequestRequest struct via the builder pattern

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LogOut

LogOut(ctx).Execute()

Performs a logout for other providers that have been issued a JWT.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AccessApi.LogOut(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessApi.LogOut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiLogOutRequest struct via the builder pattern

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LogOutComplete

LogOutComplete(ctx).Execute()

Completes the logout sequence by removing the cached Logout Request and Cookie if they existed and redirects to /nifi/login.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AccessApi.LogOutComplete(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessApi.LogOutComplete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiLogOutCompleteRequest struct via the builder pattern

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OidcCallback

OidcCallback(ctx).Execute()

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

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AccessApi.OidcCallback(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessApi.OidcCallback``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiOidcCallbackRequest struct via the builder pattern

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OidcExchange

string OidcExchange(ctx).Execute()

Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AccessApi.OidcExchange(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessApi.OidcExchange``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `OidcExchange`: string
    fmt.Fprintf(os.Stdout, "Response from `AccessApi.OidcExchange`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiOidcExchangeRequest struct via the builder pattern

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OidcLogout

OidcLogout(ctx).Execute()

Performs a logout in the OpenId Provider.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AccessApi.OidcLogout(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessApi.OidcLogout``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiOidcLogoutRequest struct via the builder pattern

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OidcLogoutCallback

OidcLogoutCallback(ctx).Execute()

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

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AccessApi.OidcLogoutCallback(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessApi.OidcLogoutCallback``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiOidcLogoutCallbackRequest struct via the builder pattern

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OidcRequest

OidcRequest(ctx).Execute()

Initiates a request to authenticate through the configured OpenId Connect provider.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AccessApi.OidcRequest(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessApi.OidcRequest``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiOidcRequestRequest struct via the builder pattern

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SamlLocalLogout

SamlLocalLogout(ctx).Execute()

Local logout when SAML is enabled, does not communicate with the IDP.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AccessApi.SamlLocalLogout(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessApi.SamlLocalLogout``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiSamlLocalLogoutRequest struct via the builder pattern

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SamlLoginExchange

string SamlLoginExchange(ctx).Execute()

Retrieves a JWT following a successful login sequence using the configured SAML identity provider.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AccessApi.SamlLoginExchange(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessApi.SamlLoginExchange``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SamlLoginExchange`: string
    fmt.Fprintf(os.Stdout, "Response from `AccessApi.SamlLoginExchange`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiSamlLoginExchangeRequest struct via the builder pattern

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SamlLoginHttpPostConsumer

SamlLoginHttpPostConsumer(ctx).Execute()

Processes the SSO response from the SAML identity provider for HTTP-POST binding.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AccessApi.SamlLoginHttpPostConsumer(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessApi.SamlLoginHttpPostConsumer``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiSamlLoginHttpPostConsumerRequest struct via the builder pattern

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SamlLoginHttpRedirectConsumer

SamlLoginHttpRedirectConsumer(ctx).Execute()

Processes the SSO response from the SAML identity provider for HTTP-REDIRECT binding.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AccessApi.SamlLoginHttpRedirectConsumer(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessApi.SamlLoginHttpRedirectConsumer``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiSamlLoginHttpRedirectConsumerRequest struct via the builder pattern

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SamlLoginRequest

SamlLoginRequest(ctx).Execute()

Initiates an SSO request to the configured SAML identity provider.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AccessApi.SamlLoginRequest(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessApi.SamlLoginRequest``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiSamlLoginRequestRequest struct via the builder pattern

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SamlMetadata

SamlMetadata(ctx).Execute()

Retrieves the service provider metadata.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AccessApi.SamlMetadata(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessApi.SamlMetadata``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiSamlMetadataRequest struct via the builder pattern

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SamlSingleLogoutHttpPostConsumer

SamlSingleLogoutHttpPostConsumer(ctx).Execute()

Processes a SingleLogout message from the configured SAML identity provider using the HTTP-POST binding.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AccessApi.SamlSingleLogoutHttpPostConsumer(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessApi.SamlSingleLogoutHttpPostConsumer``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiSamlSingleLogoutHttpPostConsumerRequest struct via the builder pattern

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SamlSingleLogoutHttpRedirectConsumer

SamlSingleLogoutHttpRedirectConsumer(ctx).Execute()

Processes a SingleLogout message from the configured SAML identity provider using the HTTP-REDIRECT binding.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AccessApi.SamlSingleLogoutHttpRedirectConsumer(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessApi.SamlSingleLogoutHttpRedirectConsumer``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiSamlSingleLogoutHttpRedirectConsumerRequest struct via the builder pattern

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SamlSingleLogoutRequest

SamlSingleLogoutRequest(ctx).Execute()

Initiates a logout request using the SingleLogout service of the configured SAML identity provider.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AccessApi.SamlSingleLogoutRequest(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessApi.SamlSingleLogoutRequest``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiSamlSingleLogoutRequestRequest struct via the builder pattern

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

AccessApi.md

Latest commit

History

AccessApi.md

File metadata and controls

\AccessApi

CreateAccessToken

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateAccessTokenFromTicket

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateDownloadToken

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateUiExtensionToken

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetAccessStatus

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetLoginConfig

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

KnoxCallback

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

KnoxLogout

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

KnoxRequest

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

LogOut

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

LogOutComplete

Example

Path Parameters