Get command-line client auth configuration

Changed on

The OAuth client configuration for logging a user in from a native client: the layer command-line interface, or an application plugin built on it. Read this before starting a login: it names the public client id to use and the device login endpoints. Start a device login at device_authorization_endpoint, poll token_endpoint for its tokens, refresh them there, and revoke the refresh token at revocation_endpoint on sign-out.

An empty client_id means this deployment has no sign-in configured for that client; use a personal access token instead.

get/cli-auth

Request

  • Base URL: https://api.app.layer.ai/api
  • URL: https://api.app.layer.ai/api/cli-auth
  • Auth: none required

Query parameters

client'cli' | 'blender' | 'unity' | 'godot'

Which native client is signing in.

Each is its own Auth0 application, so Auth0 can tell them apart in its logs, metrics and grants, and a client-level change to one never reaches the other.

The client signing in. Each has an OAuth application of its own.

Response

Successful Response

issuerstring required

Authorization server that issues tokens for this API.

client_idstring required

Public OAuth client id to authenticate as. Not a secret.

audiencestring required

Audience to request, so the token is accepted by this API.

scopesstring[] required

Scopes to request. offline_access is what keeps the login alive.

grant_typesstring[] required

Grant types this client may use, most preferred first.

loopback_portsinteger[] required

Ports registered as loopback callbacks, for releases that sign in with the authorization code flow at issuer. A current client signs in with device_authorization_endpoint instead.

redirect_pathstring required

Path component of the registered loopback callback URLs, for the same older releases.

device_authorization_endpointstring required

Where to start a device login (RFC 8628 section 3.1). Sign in with this, not the issuer.

token_endpointstring required

Where to poll for the device login's tokens, and to refresh them.

revocation_endpointstring required

Where to revoke the refresh token on sign-out.

Changes

  • 0581965f4bc0Revision changes
    • info

      added the new enum value godot to the query request parameter client

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 03b26298cd2aRevision changes
    • info

      added the new enum value unity to the query request parameter client