Skip to main content
POST
/
oauth2
/
{auth}
/
v1
/
token
Request Access Token
import requests

url = "https://identity.lucidworks.com/oauth2/{auth}/v1/token"

headers = {
    "Cache-Control": "<cache-control>",
    "Accept": "<accept>",
    "Content-Type": "<content-type>",
    "Authorization": "Basic <encoded-value>"
}

response = requests.post(url, headers=headers)

print(response.json())
{
  "token_type": "Bearer",
  "expires_in": 3600,
  "access_token": "eyJraW...",
  "scope": "machinelearning.predict"
}

Authorizations

​
Authorization
string
header
required

The Authentication API is used by multiple Lucidworks products such as Lucidworks AI. The scope value in the request is unique to the product accessing the API.

The Client ID is used for the Username value, and the Client Secret is used for the Password value.

How do I regenerate my client secret?

Contact support if you need to regenerate your client secret.

Headers

​
Cache-Control
enum<string>
required

The no-cache request directive asks caches to validate the response with the origin server before reuse.

Available options:
no-cache
​
Accept
enum<string>
required

The Accept request HTTP header indicates which content types the client can understand.

Available options:
application/json
​
Content-Type
enum<string>
required

The Content-Type header indicates the original media type of the resource.

Available options:
application/x-www-form-urlencoded

Path Parameters

​
auth
enum<string>
required

The authorization code used to generate an access token.

Available options:
ausao8uveaPmyhv0v357

Query Parameters

​
scope
enum<string>
required

The value defines the scope of access requested. For the token used by the Lucidworks AI API usecase, prediction, async-prediction, and async-chunking endpoints, use "scope": "machinelearning.predict". For the token used by the Lucidworks AI API model endpoint, use "scope": "machinelearning.model".

Available options:
machinelearning.predict,
machinelearning.model
​
grant_type
enum<string>
required

The client_credentials grant type is used by clients to obtain an access token in the context of the client itself, not the user.

Available options:
client_credentials

Response

OK

The token response object, which contains the ACCESS_TOKEN required by operation APIs.

​
token_type
enum<string>
required

The token type, which is always a bearer token.

Available options:
Bearer
​
expires_in
enum<integer>
required

The number of seconds before the ACCESS_TOKEN expires. Auth tokens expire in 1 hour. A new token is required after that time.

Available options:
3600
​
access_token
string
required

This value is used for the Token parameter required by the API.

Required string length: 500 - 1000
​
scope
enum<string>
required

The value defines the scope of access granted and matches the scope value from the request.

For the token used by the Lucidworks AI API usecase, prediction, async-prediction, and async-chunking endpoints, use "scope": "machinelearning.predict".

For the token used by the Lucidworks AI API model endpoint, use "scope": "machinelearning.model".

Available options:
machinelearning.predict,
machinelearning.model