Skip to content
English
  • There are no suggestions because the search field is empty.

Eyemagnet Auth API - Getting Started

To integrate with Eyemagnet Auth, send GraphQL requests over HTTPS using the base URL and credentials supplied by Eyemagnet.

This guide is for partners integrating an application or backend with Eyemagnet Auth. The API is GraphQL over HTTPS. It issues signed JWTs that can be used both with this API and with services that trust Eyemagnet Auth.

The API is a GraphQL authentication service, not an OAuth or OpenID Connect authorization-code endpoint. Keep client secrets in a trusted backend; do not embed them in a browser, mobile app, desktop app, or published source code.


Before You Start

Eyemagnet will provide an API base URL plus credentials for the integration:

Value Purpose Keep secret?
API base URL Base path for GraphQL and the supporting HTTP endpoints No
Client ID and client secret Identifies the application requesting tokens Yes — backend only
Key ID and key secret, if applicable Identifies a machine or service principal Yes — backend only
Allowed scopes and teams Defines the actions and tenant context the integration may use No

In the examples below, replace https://auth.example.com/auth/v2 with the API base URL supplied for your environment. The GraphQL endpoint is the base URL itself (a trailing slash is also accepted).

Endpoint Method Purpose
{base} POST GraphQL operations
{base}/.well-known/jwks.json GET Public signing keys for JWT validation
{base}/_health GET Health check; returns HEALTHY

The configured base path is environment-specific, so construct the JWKS and health URLs from the supplied base URL rather than hard-coding a path.