Skip to content

Get Authentication Info

client.auth.retrieveInfo(?): AuthRetrieveInfoResponse { apiKey, type }

GET/auth/info

Returns information about the authentication credentials being used to access the API

ReturnsExpand Collapse

AuthRetrieveInfoResponse { apiKey, type }

apiKey: APIKey { created, issuing_user, name, 2 more }

Information about the API key credentials

created: string

When the client credentials were created

formatdate-time

issuing_user: IssuingUser { id, email, name }

Information about the user who created the credentials

id: string

The user ID

email: string

The user's email

formatemail

name: string

The user's name

name: string

The name of the credential

project: Project { id, name, plan_type }

Information about the project

id: string

The project ID

name: string

The name of the project

plan_type: string

The plan type for the project

public_key: string

The public key of the client credentials

type: "apiKey"

The type of authentication being used

Get Authentication Info

import TigerCloud from 'tiger-cloud';

const client = new TigerCloud({
  apiKey: process.env['TIGER_CLOUD_API_KEY'], // This is the default and can be omitted
});

const response = await client.auth.retrieveInfo();

console.log(response.apiKey);

{
  "apiKey": {
    "created": "2024-01-15T10:30:00Z",
    "issuing_user": {
      "id": "user123",
      "email": "john.doe@example.com",
      "name": "John Doe"
    },
    "name": "my-production-token",
    "project": {
      "id": "rp1pz7uyae",
      "name": "My Production Project",
      "plan_type": "FREE"
    },
    "public_key": "tskey_abc123"
  },
  "type": "apiKey"
}

Returns Examples

{
  "apiKey": {
    "created": "2024-01-15T10:30:00Z",
    "issuing_user": {
      "id": "user123",
      "email": "john.doe@example.com",
      "name": "John Doe"
    },
    "name": "my-production-token",
    "project": {
      "id": "rp1pz7uyae",
      "name": "My Production Project",
      "plan_type": "FREE"
    },
    "public_key": "tskey_abc123"
  },
  "type": "apiKey"
}