Skip to content
Search ⌘K
Get started
API Reference

Auth

Authentication and authorization information.

Get Authentication Info
GET/auth/info
ModelsExpand Collapse
AuthRetrieveInfoResponse object { type, apiKey, oauth }

Information about the authentication credentials being used. Exactly one of apiKey or oauth is populated; the type field discriminates.

type: "apiKey" or "oauth"

Discriminator for the credential shape. apiKey for PAT callers; oauth for OAuth user callers.

One of the following:
"apiKey"
"oauth"
apiKey: optional object { created, issuing_user, name, 2 more }

Information about the API key credentials (PAT).

created: string

When the client credentials were created.

formatdate-time
issuing_user: object { 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: object { 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.

oauth: optional object { user }

OAuth user details. Present for OAuth user callers.

user: object { id, email, name }

The authenticated OAuth user.

id: string

The numeric user ID.

email: string

The user’s email.

formatemail
name: string

The user’s name.