Class: NgrokAPI::Services::CertificateAuthoritiesClient

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

Overview

Certificate Authorities are x509 certificates that are used to sign other x509 certificates. Attach a Certificate Authority to the Mutual TLS module to verify that the TLS certificate presented by a client has been signed by this CA. Certificate Authorities are used only for mTLS validation only and thus a private key is not included in the resource.

ngrok.com/docs/api#api-certificate-authorities

Constant Summary collapse

PATH =

The API path for the requests

'/certificate_authorities'
LIST_PROPERTY =

The List Property from the resulting API for list calls

'certificate_authorities'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ CertificateAuthoritiesClient

Returns a new instance of CertificateAuthoritiesClient.



23
24
25
 
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 23

def initialize(client:)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



21
22
23
 
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 21

def client
  @client
end

Instance Method Details

#create(description: "", metadata: "", ca_pem:) ⇒ NgrokAPI::Models::CertificateAuthority

Upload a new Certificate Authority

ngrok.com/docs/api#api-certificate-authorities-create

Parameters:

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

    human-readable description of this Certificate Authority. optional, max 255 bytes.

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

    arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.

  • ca_pem (string) —

    raw PEM of the Certificate Authority

Returns:



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 36

def create(description: "", metadata: "", ca_pem:)
  path = '/certificate_authorities'
  replacements = {
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:ca_pem] = ca_pem if ca_pem
  result = @client.post(path % replacements, data: data)
  NgrokAPI::Models::CertificateAuthority.new(client: self, attrs: result)
end

#create!(description: "", metadata: "", ca_pem:) ⇒ NgrokAPI::Models::CertificateAuthority

Upload a new Certificate Authority Throws an exception if API error.

ngrok.com/docs/api#api-certificate-authorities-create

Parameters:

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

    human-readable description of this Certificate Authority. optional, max 255 bytes.

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

    arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.

  • ca_pem (string) —

    raw PEM of the Certificate Authority

Returns:



58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 58

def create!(description: "", metadata: "", ca_pem:)
  path = '/certificate_authorities'
  replacements = {
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:ca_pem] = ca_pem if ca_pem
  result = @client.post(path % replacements, data: data, danger: true)
  NgrokAPI::Models::CertificateAuthority.new(client: self, attrs: result)
end

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

Delete a Certificate Authority

ngrok.com/docs/api#api-certificate-authorities-delete

Parameters:

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

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



77
78
79
80
81
82
83
 
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 77

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

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

Delete a Certificate Authority Throws an exception if API error.

ngrok.com/docs/api#api-certificate-authorities-delete

Parameters:

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

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



93
94
95
96
97
98
99
 
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 93

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

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

Get detailed information about a certificate authority

ngrok.com/docs/api#api-certificate-authorities-get

Parameters:

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

    a resource identifier

Returns:



108
109
110
111
112
113
114
115
116
 
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 108

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

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

Get detailed information about a certificate authority Throws an exception if API error.

ngrok.com/docs/api#api-certificate-authorities-get

Parameters:

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

    a resource identifier

Returns:



126
127
128
129
130
131
132
133
134
 
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 126

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

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

List all Certificate Authority on this account

ngrok.com/docs/api#api-certificate-authorities-list

Parameters:

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

    optional and mutually exclusive from before_id and limit

Returns:



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

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

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

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

List all Certificate Authority on this account Throws an exception if API error.

ngrok.com/docs/api#api-certificate-authorities-list

Parameters:

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

    optional and mutually exclusive from before_id and limit

Returns:



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 179

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

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

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

Update attributes of a Certificate Authority by ID

ngrok.com/docs/api#api-certificate-authorities-update

Parameters:

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

    human-readable description of this Certificate Authority. optional, max 255 bytes.

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

    arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.

Returns:



212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 212

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

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

Update attributes of a Certificate Authority by ID Throws an exception if API error.

ngrok.com/docs/api#api-certificate-authorities-update

Parameters:

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

    human-readable description of this Certificate Authority. optional, max 255 bytes.

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

    arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.

Returns:



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

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