Class: NgrokAPI::Services::SSHCredentialsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/ngrokapi/services/ssh_credentials_client.rb

Overview

SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.

ngrok.com/docs/api#api-ssh-credentials

Constant Summary collapse

PATH =

The API path for the requests

'/ssh_credentials'
LIST_PROPERTY =

The List Property from the resulting API for list calls

'ssh_credentials'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ SSHCredentialsClient

Returns a new instance of SSHCredentialsClient.



18
19
20
 
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 18

def initialize(client:)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



16
17
18
 
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 16

def client
  @client
end

Instance Method Details

#create(description: "", metadata: "", acl: [], public_key:) ⇒ NgrokAPI::Models::SSHCredential

Create a new ssh_credential from an uploaded public SSH key. This ssh credential can be used to start new tunnels via ngrok's SSH gateway.

ngrok.com/docs/api#api-ssh-credentials-create

Parameters:

  • description (string) (defaults to: "") —

    human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.

  • metadata (string) (defaults to: "") —

    arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.

  • acl (List<string>) (defaults to: []) —

    optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the bind rule. The bind rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule bind:example.ngrok.io. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of bind:*.example.com which will allow x.example.com, y.example.com, *.example.com, etc. A rule of '*' is equivalent to no acl at all and will explicitly permit all actions.

  • public_key (string) —

    the PEM-encoded public key of the SSH keypair that will be used to authenticate

Returns:



33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 33

def create(description: "", metadata: "", acl: [], public_key:)
  path = '/ssh_credentials'
  replacements = {
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:acl] = acl if acl
  data[:public_key] = public_key if public_key
  result = @client.post(path % replacements, data: data)
  NgrokAPI::Models::SSHCredential.new(client: self, result: result)
end

#delete(id: "") ⇒ NgrokAPI::Models::Empty

Delete an ssh_credential by ID

ngrok.com/docs/api#api-ssh-credentials-delete

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



53
54
55
56
57
58
59
 
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 53

def delete(id: "")
  path = '/ssh_credentials/%{id}'
  replacements = {
    id: id,
  }
  @client.delete(path % replacements)
end

#delete!(id: "") ⇒ NgrokAPI::Models::Empty

Delete an ssh_credential by ID Throws an exception if API error.

ngrok.com/docs/api#api-ssh-credentials-delete

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



69
70
71
72
73
74
75
 
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 69

def delete!(id: "")
  path = '/ssh_credentials/%{id}'
  replacements = {
    id: id,
  }
  @client.delete(path % replacements, danger: true)
end

#get(id: "") ⇒ NgrokAPI::Models::SSHCredential

Get detailed information about an ssh_credential

ngrok.com/docs/api#api-ssh-credentials-get

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:



84
85
86
87
88
89
90
91
92
 
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 84

def get(id: "")
  path = '/ssh_credentials/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  result = @client.get(path % replacements, data: data)
  NgrokAPI::Models::SSHCredential.new(client: self, result: result)
end

#get!(id: "") ⇒ NgrokAPI::Models::SSHCredential

Get detailed information about an ssh_credential Throws an exception if API error.

ngrok.com/docs/api#api-ssh-credentials-get

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:



102
103
104
105
106
107
108
109
110
 
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 102

def get!(id: "")
  path = '/ssh_credentials/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  result = @client.get(path % replacements, data: data, danger: true)
  NgrokAPI::Models::SSHCredential.new(client: self, result: result)
end

#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable

List all ssh credentials on this account

ngrok.com/docs/api#api-ssh-credentials-list

Parameters:

  • before_id (string) (defaults to: nil)
  • limit (string) (defaults to: nil)
  • url (string) (defaults to: nil) —

    optional and mutually exclusive from before_id and limit

Returns:



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 121

def list(before_id: nil, limit: nil,
         url: nil)
  result = @client.list(
    before_id: before_id,
    limit: limit,
    url: url,
    path: PATH
  )

  NgrokAPI::Models::Listable.new(
    client: self,
    result: result,
    list_property: LIST_PROPERTY,
    klass: NgrokAPI::Models::SSHCredential
  )
end

#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable

List all ssh credentials on this account Throws an exception if API error.

ngrok.com/docs/api#api-ssh-credentials-list

Parameters:

  • before_id (string) (defaults to: nil)
  • limit (string) (defaults to: nil)
  • url (string) (defaults to: nil) —

    optional and mutually exclusive from before_id and limit

Returns:



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 148

def list!(before_id: nil, limit: nil,
          url: nil)
  result = @client.list(
    before_id: before_id,
    limit: limit,
    danger: true,
    url: url,
    path: PATH
  )

  NgrokAPI::Models::Listable.new(
    client: self,
    result: result,
    list_property: LIST_PROPERTY,
    klass: NgrokAPI::Models::SSHCredential,
    danger: true
  )
end

#update(id: "", description: nil, metadata: nil, acl: nil) ⇒ NgrokAPI::Models::SSHCredential

Update attributes of an ssh_credential by ID

ngrok.com/docs/api#api-ssh-credentials-update

Parameters:

  • id (string) (defaults to: "")
  • description (string) (defaults to: nil) —

    human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.

  • metadata (string) (defaults to: nil) —

    arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.

  • acl (List<string>) (defaults to: nil) —

    optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the bind rule. The bind rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule bind:example.ngrok.io. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of bind:*.example.com which will allow x.example.com, y.example.com, *.example.com, etc. A rule of '*' is equivalent to no acl at all and will explicitly permit all actions.

Returns:



177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 177

def update(id: "", description: nil, metadata: nil, acl: nil)
  path = '/ssh_credentials/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:acl] = acl if acl
  result = @client.patch(path % replacements, data: data)
  NgrokAPI::Models::SSHCredential.new(client: self, result: result)
end

#update!(id: "", description: nil, metadata: nil, acl: nil) ⇒ NgrokAPI::Models::SSHCredential

Update attributes of an ssh_credential by ID Throws an exception if API error.

ngrok.com/docs/api#api-ssh-credentials-update

Parameters:

  • id (string) (defaults to: "")
  • description (string) (defaults to: nil) —

    human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.

  • metadata (string) (defaults to: nil) —

    arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.

  • acl (List<string>) (defaults to: nil) —

    optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the bind rule. The bind rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule bind:example.ngrok.io. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of bind:*.example.com which will allow x.example.com, y.example.com, *.example.com, etc. A rule of '*' is equivalent to no acl at all and will explicitly permit all actions.

Returns:



201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 201

def update!(id: "", description: nil, metadata: nil, acl: nil)
  path = '/ssh_credentials/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:acl] = acl if acl
  result = @client.patch(path % replacements, data: data, danger: true)
  NgrokAPI::Models::SSHCredential.new(client: self, result: result)
end