Class: Infrawrench::SshKeysNamespace

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

Overview

client.ssh_keys

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ SshKeysNamespace

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

Parameters:



4907
4908
4909
 
# File 'lib/infrawrench/client.rb', line 4907

def initialize(transport)
  @transport = transport
end

Instance Method Details

#create(body:, org_id: nil, request_options: nil) ⇒ Hash

Generate a new Ed25519 keypair (private key returned once)

Requires permission: ssh-keys:write.

POST /api/org/orgId/ssh-keys

Raises on 400: Bad request

Parameters:

  • org_id (String, nil) (defaults to: nil) —

    Organization id. Defaults to the org_id the client was constructed with.

  • body (Hash) —

    Request body, shaped as GenerateSshKeyRequest.

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

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

  • body: (generate_ssh_key_request)
  • org_id: (String, nil) (defaults to: nil)
  • request_options: (Hash[Symbol, untyped], nil) (defaults to: nil)

Returns:

  • (Hash) —

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

Raises:



4925
4926
4927
4928
4929
4930
4931
4932
4933
 
# File 'lib/infrawrench/client.rb', line 4925

def create(body:, org_id: nil, request_options: nil)
  @transport.request(
    http_method: "POST",
    path: "/api/org/{orgId}/ssh-keys",
    path_params: { "orgId" => org_id },
    body: body,
    request_options: request_options
  )
end

#delete(id:, org_id: nil, request_options: nil) ⇒ Hash

Delete an SSH key (owner only)

Requires permission: ssh-keys:write.

DELETE /api/org/orgId/ssh-keys/id

Parameters:

  • org_id (String, nil) (defaults to: nil) —

    Organization id. Defaults to the org_id the client was constructed with.

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

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

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

Returns:

  • (Hash) —

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

Raises:



4947
4948
4949
4950
4951
4952
4953
4954
 
# File 'lib/infrawrench/client.rb', line 4947

def delete(id:, org_id: nil, request_options: nil)
  @transport.request(
    http_method: "DELETE",
    path: "/api/org/{orgId}/ssh-keys/{id}",
    path_params: { "orgId" => org_id, "id" => id },
    request_options: request_options
  )
end

#import(body:, org_id: nil, request_options: nil) ⇒ Hash

Import an existing public key

Requires permission: ssh-keys:write.

POST /api/org/orgId/ssh-keys/import

Raises on 400: Bad request

Parameters:

  • org_id (String, nil) (defaults to: nil) —

    Organization id. Defaults to the org_id the client was constructed with.

  • body (Hash) —

    Request body, shaped as ImportSshKeyRequest.

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

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

  • body: (import_ssh_key_request)
  • org_id: (String, nil) (defaults to: nil)
  • request_options: (Hash[Symbol, untyped], nil) (defaults to: nil)

Returns:

  • (Hash) —

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

Raises:



4970
4971
4972
4973
4974
4975
4976
4977
4978
 
# File 'lib/infrawrench/client.rb', line 4970

def import(body:, org_id: nil, request_options: nil)
  @transport.request(
    http_method: "POST",
    path: "/api/org/{orgId}/ssh-keys/import",
    path_params: { "orgId" => org_id },
    body: body,
    request_options: request_options
  )
end

#list(org_id: nil, request_options: nil) ⇒ Array<Hash>

List org SSH keys

Requires permission: ssh-keys:read.

GET /api/org/orgId/ssh-keys

Parameters:

  • org_id (String, nil) (defaults to: nil) —

    Organization id. Defaults to the org_id the client was constructed with.

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

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

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

Returns:

  • (Array<Hash>) —

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

Raises:



4992
4993
4994
4995
4996
4997
4998
4999
 
# File 'lib/infrawrench/client.rb', line 4992

def list(org_id: nil, request_options: nil)
  @transport.request(
    http_method: "GET",
    path: "/api/org/{orgId}/ssh-keys",
    path_params: { "orgId" => org_id },
    request_options: request_options
  )
end