The   support the following methods of authentication.

Required Permissions

Authenticating user must be a valid user of the deployed instance of the .

API Access Token Authentication

API access tokens can be acquired and applied to your requests to obscure sensitive Personally Identifiable Information (PII) and are compliant with common privacy and security standards. These tokens last for a preconfigured time period and can be renewed as needed.

Tip: API access tokens are the preferred method of authentication.

NOTE: This feature may need to be enabled in your instance of the . For more information, see Enable API Access Tokens.

Basic Steps:

  1. You submit a request to create a new access token.
    1. You can create and delete access tokens through the Settings area of the . See Access Tokens Page.
    2. You can create access tokens through the REST API endpoint.
      1. If you do not have a valid access token, you must submit your request to the endpoint using one of the other forms of authentication.
      2. If you do have a valid access token, you can use it with your submission to generate a new access token.
      3. See API AccessTokens Create v4.
  2. With each request, you submit the token as part of the Authorization header. 
  3. Continue using the token. As needed, you can create and use additional tokens. There is no limit to the number of tokens you can create.

Tip: API access tokens work seamlessly with platform-native SAML and LDAP SSO authentication. They do not work with the reverse proxy method of SSO authentication. Details are below.


For more information on this process, see Manage API Access Tokens.

Basic Authentication

As request parameters, you can submit username/password under Basic Auth to any REST API endpoint. 

NOTE: You must submit authentication credentials with each request to the platform.

NOTE: The user must have permissions to execute the endpoint action.


This example submits authentication requirements over HTTP, including the username and password (

$ curl  -u \
    -b ~/cookies.txt -c ~/cookies.txt \


-u username and password.
-b and -cRequired paths and filenames for storage of send and receive HTTP cookies.

Fully qualified name of the host of the


Port number through which to access the . Default is 3005.


SSO Authentication

You can use the APIs in SSO environments. Below, you can review the best method of authenticating to the APIs based on your SSO environment:

SSO TypeAPI Auth
Platform-native SAMLAPI access tokens work seamlessly. Basic auth does not work.
Platform-native LDAP-ADAPI access tokens work seamlessly. Basic auth does not work.
Reverse proxy SAMLUse basic auth described below. Additional configuration may be required.
Reverse proxy LDAP-ADUse basic auth described below. Additional configuration may be required.

In a single sign-on environment, you can use basic authentication to interact with the APIs.

NOTE: Enabling SSO integration with the  requires additional configuration. See Configure SSO for AD-LDAP.


However, some changes are required:


$ curl  -u -x http://<platform_host>:<platform_port_number> \
    -b ~/cookies.txt -c ~/cookies.txt \

NOTE: For the protocol identifier, you can also use https if SSL is enabled. See Install SSL Certificate.

ParameterDescription principal and password associated with that username.

For more information, see Configure SSO for AD-LDAP.

Kerberos Authentication

In a Kerberos environment, credentials must be submitted with each request using the SPNEGO Auth method.

Credentials are authenticated by the KDC for each request. 

NOTE: SPNEGO must be enabled and configured for your REST client or programming library.

Example 1 - Embedded in Java:

SPNEGO requires a custom client. The following SPNEGO client enables submission of URL-based authentication parameters from within Java:

Example 2 - Using cURL:

To use cURL:

  1. Verify that your version of cURL supports GSS:

    $ curl -V
    curl 7.51.0 (x86_64-apple-darwin16.0) libcurl/7.51.0 SecureTransport zlib/1.2.8
    Protocols: dict file ftp ftps gopher http https imap imaps ldap ldaps pop3 pop3s rtsp smb smbs smtp smtps telnet tftp
    Features: AsynchDNS IPv6 Largefile GSS-API Kerberos SPNEGO NTLM NTLM_WB SSL libz UnixSockets
  2. Verify that GSS-API and SPNEGO are in the output.
  3. Run kinit and authenticate using the Hadoop principal:

    $ kinit
    Please enter the password for [hadoop.user.principal]@localhost:
  4. Access using cURL

    $ curl --negotiate -u anything \
        -b ~/cookies.txt -c ~/cookies.txt \


    --negotiateEnables SPNEGO use in cURL. This option requires a library built with GSS-API or SSPI support. If this option is used several times, only the first one is used. Use --proxy-negotiate to enable Negotiate (SPNEGO) for proxy authentication.
    -u anythingRequired username. However, this username is ignored. Instead, the principal used in kinit is applied.

For more information:


Since each request requires credentials, logging out is not required.