Class: NgrokAPI::Services::CredentialsClient

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

Overview

Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok agent to connect the ngrok service as your account. They are installed with the ngrok config add-authtoken command or by specifying it in the ngrok.yml configuration file with the authtoken property.

ngrok.com/docs/api#api-credentials

Constant Summary collapse

PATH =

The API path for the requests

'/credentials'
LIST_PROPERTY =

The List Property from the resulting API for list calls

'credentials'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ CredentialsClient

Returns a new instance of CredentialsClient.



22
23
24
 
# File 'lib/ngrokapi/services/credentials_client.rb', line 22

def initialize(client:)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



20
21
22
 
# File 'lib/ngrokapi/services/credentials_client.rb', line 20

def client
  @client
end

Instance Method Details

#create(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil) ⇒ NgrokAPI::Models::Credential

Create a new tunnel authtoken credential. This authtoken credential can be used to start a new tunnel session. The response to this API call is the only time the generated token is available. If you need it for future use, you must save it securely yourself.

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

Parameters:

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

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

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

    arbitrary user-defined machine-readable data of this 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, addresses, and labels 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 for domains 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. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of bind:*=example which will allow x=example, y=example, etc. A rule of '*' is equivalent to no acl at all and will explicitly permit all actions.

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

    If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.

Returns:



39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/ngrokapi/services/credentials_client.rb', line 39

def create(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil)
  path = '/credentials'
  replacements = {
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:acl] = acl if acl
  data[:owner_id] = owner_id if owner_id
  result = @client.post(path % replacements, data: data)
  NgrokAPI::Models::Credential.new(client: self, attrs: result)
end

#create!(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil) ⇒ NgrokAPI::Models::Credential

Create a new tunnel authtoken credential. This authtoken credential can be used to start a new tunnel session. The response to this API call is the only time the generated token is available. If you need it for future use, you must save it securely yourself. Throws an exception if API error.

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

Parameters:

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

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

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

    arbitrary user-defined machine-readable data of this 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, addresses, and labels 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 for domains 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. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of bind:*=example which will allow x=example, y=example, etc. A rule of '*' is equivalent to no acl at all and will explicitly permit all actions.

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

    If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/ngrokapi/services/credentials_client.rb', line 66

def create!(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil)
  path = '/credentials'
  replacements = {
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:acl] = acl if acl
  data[:owner_id] = owner_id if owner_id
  result = @client.post(path % replacements, data: data, danger: true)
  NgrokAPI::Models::Credential.new(client: self, attrs: result)
end

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

Delete a tunnel authtoken credential by ID

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

Parameters:

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

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



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

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

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

Delete a tunnel authtoken credential by ID Throws an exception if API error.

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

Parameters:

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

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



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

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

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

Get detailed information about a tunnel authtoken credential

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

Parameters:

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

    a resource identifier

Returns:



117
118
119
120
121
122
123
124
125
 
# File 'lib/ngrokapi/services/credentials_client.rb', line 117

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

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

Get detailed information about a tunnel authtoken credential Throws an exception if API error.

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

Parameters:

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

    a resource identifier

Returns:



135
136
137
138
139
140
141
142
143
 
# File 'lib/ngrokapi/services/credentials_client.rb', line 135

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

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

List all tunnel authtoken credentials on this account

ngrok.com/docs/api#api-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:



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/ngrokapi/services/credentials_client.rb', line 154

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,
    attrs: result,
    list_property: LIST_PROPERTY,
    klass: NgrokAPI::Models::Credential
  )
end

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

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

ngrok.com/docs/api#api-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:



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/ngrokapi/services/credentials_client.rb', line 180

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,
    attrs: result,
    list_property: LIST_PROPERTY,
    klass: NgrokAPI::Models::Credential,
    danger: true
  )
end

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

Update attributes of an tunnel authtoken credential by ID

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

Parameters:

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

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

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

    arbitrary user-defined machine-readable data of this 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, addresses, and labels 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 for domains 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. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of bind:*=example which will allow x=example, y=example, etc. A rule of '*' is equivalent to no acl at all and will explicitly permit all actions.

Returns:



208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/ngrokapi/services/credentials_client.rb', line 208

def update(id: "", description: nil, metadata: nil, acl: nil)
  path = '/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::Credential.new(client: self, attrs: result)
end

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

Update attributes of an tunnel authtoken credential by ID Throws an exception if API error.

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

Parameters:

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

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

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

    arbitrary user-defined machine-readable data of this 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, addresses, and labels 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 for domains 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. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of bind:*=example which will allow x=example, y=example, etc. A rule of '*' is equivalent to no acl at all and will explicitly permit all actions.

Returns:



232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/ngrokapi/services/credentials_client.rb', line 232

def update!(id: "", description: nil, metadata: nil, acl: nil)
  path = '/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::Credential.new(client: self, attrs: result)
end