Class: DockerEngineAPI::Resources::Auth

Inherits:

Object

• Object
• DockerEngineAPI::Resources::Auth

Defined in:

lib/docker_engine_api/resources/auth.rb

Instance Method Summary

• #initialize(client:) ⇒ Auth constructor private

  A new instance of Auth.

• #login(password: nil, serveraddress: nil, username: nil, request_options: {}) ⇒ DockerEngineAPI::Models::AuthResponse

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

Constructor Details

#initialize(client:) ⇒ Auth

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Auth.

Parameters:

• client (DockerEngineAPI::Client)

# File 'lib/docker_engine_api/resources/auth.rb', line 33

def initialize(client:)
  @client = client
end

Instance Method Details

#login(password: nil, serveraddress: nil, username: nil, request_options: {}) ⇒ DockerEngineAPI::Models::AuthResponse

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

Parameters:

• password (String)
• serveraddress (String)
• username (String)
• request_options (DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (DockerEngineAPI::Models::AuthResponse)

See Also:

• Models::AuthLoginParams

# File 'lib/docker_engine_api/resources/auth.rb', line 19

def login(params = {})
  parsed, options = DockerEngineAPI::AuthLoginParams.dump_request(params)
  @client.request(
    method: :post,
    path: "auth",
    body: parsed,
    model: DockerEngineAPI::AuthResponse,
    options: options
  )
end