Director Authentication

Director supports two authentication methods: JWT-based login through the Director Console and session-based login through LPSM. API access requires an authentication token, which allows authorized users and admins to perform administrative actions on Fabric-enabled Logpoints.

Through Director Console

User authentication in Director Console occurs through token-based authentication using JSON Web Tokens (JWT).

Through LPSM

User authentication in LPSM occurs through session-based authentication, where sessions for each user are stored in browser cookies.

Get Authentication Token

You need an authentication token to use APIs. An API Authentication Token acts as the authorization key that lets you access the Director Console API. You can perform administrative tasks in Fabric-enabled Logpoints using the tokens.

Only admins and users can generate tokens.

chevron-rightGenerating a Tokenhashtag

You can create multiple tokens with the same Token Identifier.

  1. Click the Profile icon at the top of the page.

  2. In Generate Token, enter a Token Identifier and your Password.

  3. Enable Always Active to generate a token that does not expire. If disabled, the token expires after 8 hours.

  4. Click Generate Token.

The Token and the Secret Key are generated only once for a Token Identifier. We recommend you make a copy and store it in a secure location. Click the Copy icon to copy the Token and the Secret Key.

Copying the Token and the Secret Key
circle-info
chevron-rightInvalidating a Tokenhashtag
  1. Click the Profile icon at the top of the page.

  2. Click the Delete icon under Actions.

  3. Click OK.

chevron-rightRefreshing a Token from APIhashtag

You can use a secret key to refresh a token at any time. Refreshing generates a new token and secret key pair. The token expires after 8 hours.

circle-info

Note: You must refresh the token within 72 hours.

If you use an expired token to execute an API command, you will get:

{
    "status": "Error",
    "message": "Invalid Token"
}

To refresh a token, send a POST request to /refreshToken with the expired token in the Authorization header and a JSON payload including the secretKey:

POST example:

POST /refreshToken HTTP/1.1
Host: api-server-host-name
Content-Type: application/json
Authorization: current-api-token-string

{
   "secretKey": "secret-key-associated-with-the-current-token"
}

Success response:

{
    "status": "Success",
    tokenDetails: {
        "token": "eyJhbGciOiJIUzI1NiIXVCJ9.eyJ1zQ0LCJleHAiOjE1MzE3NDMxNDR9.Zk05wiJuBpeEnMYE3AFkPtw",
        "secretKey": "7ac18dd3-aca9-478e-822c-b931e3b849ab"
    }
}

Common error responses while requesting a new token:

  1. When no secret key is provided:

    {
    
        "status": "Error",
        "message": "No secret key provided"
    
    }
  2. When the secret key is not the same as the generated secret key:

    {
    
        "status": "Error",
        "message": "Invalid secret key"
    
    }
  3. When the authorization token is invalid:

    {
    
        "status": "Error",
        "message": "Invalid Token"
    
    }
  4. When the authorization token is empty:

    {
    
        "status": "Error"
        "message": "Missing authentication"
    
    }
  5. When the authorization token is random words:

    {
    
        "status": "Error"
        "message": "Invalid token format"
    

Last updated

Was this helpful?