Class: Infrawrench::AuthNamespace

Inherits:
Object
  • Object
show all
Defined in:
lib/infrawrench/client.rb,
sig/infrawrench/sdk.rbs

Overview

client.auth

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ AuthNamespace

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 AuthNamespace.

Parameters:



1498
1499
1500
 
# File 'lib/infrawrench/client.rb', line 1498

def initialize(transport)
  @transport = transport
end

Instance Method Details

#me(request_options: nil) ⇒ Hash

Current session + onboarding status

GET /api/auth/me

Raises on 401: Unauthenticated

Parameters:

  • request_options (Hash, nil) (defaults to: nil) —

    Per-call :headers, :timeout and :open_timeout.

  • request_options: (Hash[Symbol, untyped], nil) (defaults to: nil)

Returns:

  • (Hash) —

    Parsed JSON, shaped as Session — see sig/infrawrench/sdk.rbs.

Raises:



1511
1512
1513
1514
1515
1516
1517
 
# File 'lib/infrawrench/client.rb', line 1511

def me(request_options: nil)
  @transport.request(
    http_method: "GET",
    path: "/api/auth/me",
    request_options: request_options
  )
end

#orgs(request_options: nil) ⇒ Array<Hash>

Organizations the current user belongs to

GET /api/auth/orgs

Raises on 401: Unauthenticated

Parameters:

  • request_options (Hash, nil) (defaults to: nil) —

    Per-call :headers, :timeout and :open_timeout.

  • request_options: (Hash[Symbol, untyped], nil) (defaults to: nil)

Returns:

  • (Array<Hash>) —

    Parsed JSON, shaped as Array<OrgMembership> — see sig/infrawrench/sdk.rbs.

Raises:



1529
1530
1531
1532
1533
1534
1535
 
# File 'lib/infrawrench/client.rb', line 1529

def orgs(request_options: nil)
  @transport.request(
    http_method: "GET",
    path: "/api/auth/orgs",
    request_options: request_options
  )
end