Class: Grafana::Api::V1::SsoSettings

Inherits:
Object
  • Object
show all
Defined in:
lib/grafana-api/api/v1/sso_settings.rb

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ SsoSettings

Returns a new instance of SsoSettings.



5
6
7
 
# File 'lib/grafana-api/api/v1/sso_settings.rb', line 5

def initialize(connection)
  @connection = connection
end

Instance Method Details

#delete(key:) ⇒ Object

Raises:

  • (ArgumentError) 


9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/grafana-api/api/v1/sso_settings.rb', line 9

def delete(key:)
  raise ArgumentError, 'key is required' if key.nil?

  @connection.call(
    :DELETE,
    '/v1/sso-settings/{key}'
      .gsub('{key}', ERB::Util.url_encode(key.to_s)),
    type: Grafana::Api::Models::SuccessResponseBody,
    auth: ['api_key', 'basic']
  )
end

#get(key:) ⇒ Object

Raises:

  • (ArgumentError) 


21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/grafana-api/api/v1/sso_settings.rb', line 21

def get(key:)
  raise ArgumentError, 'key is required' if key.nil?

  @connection.call(
    :GET,
    '/v1/sso-settings/{key}'
      .gsub('{key}', ERB::Util.url_encode(key.to_s)),
    type: Grafana::Api::Models::ListAllProvidersSettings200ResponseInner,
    auth: ['api_key', 'basic']
  )
end

#list ⇒ Object 



33
34
35
36
37
38
39
40
 
# File 'lib/grafana-api/api/v1/sso_settings.rb', line 33

def list
  @connection.call(
    :GET,
    '/v1/sso-settings',
    type: [Grafana::Api::Models::ListAllProvidersSettings200ResponseInner],
    auth: ['api_key', 'basic']
  )
end

#partial_update(key:, patch_provider_settings_request:) ⇒ Object

Raises:

  • (ArgumentError) 


42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/grafana-api/api/v1/sso_settings.rb', line 42

def partial_update(key:, patch_provider_settings_request:)
  raise ArgumentError, 'key is required' if key.nil?
  raise ArgumentError, 'patch_provider_settings_request is required' if patch_provider_settings_request.nil?

  @connection.call(
    :PATCH,
    '/v1/sso-settings/{key}'
      .gsub('{key}', ERB::Util.url_encode(key.to_s)),
    type: Grafana::Api::Models::SuccessResponseBody,
    auth: ['api_key', 'basic'],
    body: patch_provider_settings_request
  )
end

#update(key:, update_provider_settings_request:) ⇒ Object

Raises:

  • (ArgumentError) 


56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/grafana-api/api/v1/sso_settings.rb', line 56

def update(key:, update_provider_settings_request:)
  raise ArgumentError, 'key is required' if key.nil?
  raise ArgumentError, 'update_provider_settings_request is required' if update_provider_settings_request.nil?

  @connection.call(
    :PUT,
    '/v1/sso-settings/{key}'
      .gsub('{key}', ERB::Util.url_encode(key.to_s)),
    type: Grafana::Api::Models::SuccessResponseBody,
    auth: ['api_key', 'basic'],
    body: update_provider_settings_request
  )
end