v2

latestSwagger 2.0raw.githubusercontent.com2025-09-17107133447.6 KB
System

Check auth configuration

Validate credentials for a registry and, if available, get an identity token for accessing the registry without password.

post/auth

Request body

usernamestring
passwordstring
emailstring

Email is an optional value associated with the username.

Deprecated: This field is deprecated since docker 1.11 (API v1.23) and will be removed in a future release.

serveraddressstring

Example request

{
  "username": "hannibal",
  "password": "xxxx",
  "serveraddress": "https://index.docker.io/v1/"
}

Response

An identity token was generated successfully.

Statusstring required

The status of the authentication

IdentityTokenstring

An opaque token used to authenticate a user after a successful login