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.



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

def initialize(client:)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



19
20
21
 
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 19

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:



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

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, result: 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



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

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



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

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 certficate authority

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

Parameters:

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

    a resource identifier

Returns:



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

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

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

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

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

Parameters:

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

    a resource identifier

Returns:



112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 112

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, result: result)
end

#list(before_id: nil, limit: 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)
  • url (string) (defaults to: nil) —

    optional and mutually exclusive from before_id and limit

Returns:



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 133

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::CertificateAuthority
  )
end

#list!(before_id: nil, limit: 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)
  • url (string) (defaults to: nil) —

    optional and mutually exclusive from before_id and limit

Returns:



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 163

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::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:



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 194

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, result: 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:



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 220

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, result: result)
end