Sign in

Get command-line client auth configuration

The OAuth client configuration for logging a user in from a command-line client. Read this before starting a login: it names the authorization server, the public client id to use, and the loopback ports that are registered as callbacks.

Authorization-code logins must use PKCE — the client is public, so the code verifier is what proves the token request came from the client that started the flow.

get/cli-auth

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. Bind the first one that is free and redirect to http://127.0.0.1:<port>{redirect_path}. The authorization server does not accept a port outside this list, so fall back to the device-code grant when every one is taken.

redirect_pathstring required

Path component of the registered loopback callback URLs.

Changes