Topics

| pdf version

Splunk > The IT Search Company

  • Search and navigate IT data from applications, servers and network devices in real-time.
  • Download Splunk

Localized Splunk documentation

Looking for Splunk documentation in other languages?

Authentication endpoints

This documentation applies to the following versions of Splunk: 4.0 , 4.0.1 , 4.0.2 , 4.0.3 , 4.0.4 , 4.0.5 , 4.0.6

Authentication endpoints

The authentication endpoints are available from ../services/authentication/. Use these for getting an auth token.

Authentication

/services/authentication provides administrative control for the auth system

POST

Sends a control signal to the auth subsystem

Form Arguments

action

   [ restart | setactiveprovider ]

target

   The target of the action. Only required when action=setactiveprovider

Response Status

200

   User successfully authenticated

400

   Did not provide target argument (with setactiveprovider)

403

   User doesn't have sufficient privileges to perform action

Response Body

Sample response to restart:

<response>
    <messages>
        <msg type="INFO">Auth system was restarted</msg>
    </messages>
</response>

// sample response to setactiveprovider

<response>

   <messages>
       <msg type="INFO">Auth system changed to foo</msg>
   </messages>

</response>

login

/services/authentication/login provides user authentication

POST

Returns a session key to be used when making REST calls to splunkd

Form Arguments

username

   The Splunk account username

password

   The corresponding password

Response Status

200

   User successfully authenticated

400

   username or password not provided

401

   Login credentials failed

Response Body

Sample response to /services/authentication/login

<response>

   <sessionKey>87ad615df536e3</sessionKey>

</response>

Revision: 207 | Contact | Privacy Policy | Terms of Use | Community content licensed under Creative Commons