Class: Comet::OidcConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/oidc_config.rb

Overview

OidcConfig is a typed class wrapper around the underlying Comet Server API data structure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ OidcConfig

Returns a new instance of OidcConfig.



54
55
56
 
# File 'lib/comet/models/oidc_config.rb', line 54

def initialize
  clear
end

Instance Attribute Details

#azure_adv2op_tenant_id ⇒ Object

Returns the value of attribute azure_adv2op_tenant_id.



46
47
48
 
# File 'lib/comet/models/oidc_config.rb', line 46

def azure_adv2op_tenant_id
  @azure_adv2op_tenant_id
end

#client_id ⇒ Object

Returns the value of attribute client_id.



28
29
30
 
# File 'lib/comet/models/oidc_config.rb', line 28

def client_id
  @client_id
end

#client_secret ⇒ Object

Returns the value of attribute client_secret.



31
32
33
 
# File 'lib/comet/models/oidc_config.rb', line 31

def client_secret
  @client_secret
end

#display_name ⇒ Object

Returns the value of attribute display_name.



16
17
18
 
# File 'lib/comet/models/oidc_config.rb', line 16

def display_name
  @display_name
end

#generic_op_discovery_document_url ⇒ Object

Returns the value of attribute generic_op_discovery_document_url.



43
44
45
 
# File 'lib/comet/models/oidc_config.rb', line 43

def generic_op_discovery_document_url
  @generic_op_discovery_document_url
end

#google_op_hosted_domain ⇒ Object

Returns the value of attribute google_op_hosted_domain.



49
50
51
 
# File 'lib/comet/models/oidc_config.rb', line 49

def google_op_hosted_domain
  @google_op_hosted_domain
end

#hosts ⇒ Object

Returns the value of attribute hosts.



19
20
21
 
# File 'lib/comet/models/oidc_config.rb', line 19

def hosts
  @hosts
end

#organization_id ⇒ Object

Returns the value of attribute organization_id.



22
23
24
 
# File 'lib/comet/models/oidc_config.rb', line 22

def organization_id
  @organization_id
end

#provider ⇒ Object

Returns the value of attribute provider.



25
26
27
 
# File 'lib/comet/models/oidc_config.rb', line 25

def provider
  @provider
end

#required_claims ⇒ Object

Returns the value of attribute required_claims.



40
41
42
 
# File 'lib/comet/models/oidc_config.rb', line 40

def required_claims
  @required_claims
end

#scopes ⇒ Object

Returns the value of attribute scopes.



37
38
39
 
# File 'lib/comet/models/oidc_config.rb', line 37

def scopes
  @scopes
end

#skip_mfa ⇒ Object

Returns the value of attribute skip_mfa.



34
35
36
 
# File 'lib/comet/models/oidc_config.rb', line 34

def skip_mfa
  @skip_mfa
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



52
53
54
 
# File 'lib/comet/models/oidc_config.rb', line 52

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/comet/models/oidc_config.rb', line 58

def clear
  @display_name = ''
  @hosts = []
  @organization_id = ''
  @provider = ''
  @client_id = ''
  @client_secret = ''
  @scopes = []
  @required_claims = []
  @generic_op_discovery_document_url = ''
  @azure_adv2op_tenant_id = ''
  @google_op_hosted_domain = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/comet/models/oidc_config.rb', line 81

def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'DisplayName'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @display_name = v
    when 'Hosts'
      if v.nil?
        @hosts = []
      else
        @hosts = Array.new(v.length)
        v.each_with_index do |v1, i1|
          raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String

          @hosts[i1] = v1
        end
      end
    when 'OrganizationID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @organization_id = v
    when 'Provider'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @provider = v
    when 'ClientID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @client_id = v
    when 'ClientSecret'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @client_secret = v
    when 'SkipMFA'
      @skip_mfa = v
    when 'Scopes'
      if v.nil?
        @scopes = []
      else
        @scopes = Array.new(v.length)
        v.each_with_index do |v1, i1|
          raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String

          @scopes[i1] = v1
        end
      end
    when 'RequiredClaims'
      if v.nil?
        @required_claims = []
      else
        @required_claims = Array.new(v.length)
        v.each_with_index do |v1, i1|
          @required_claims[i1] = Comet::OidcClaim.new
          @required_claims[i1].from_hash(v1)
        end
      end
    when 'DiscoveryDocumentURL'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @generic_op_discovery_document_url = v
    when 'AzureTenantID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @azure_adv2op_tenant_id = v
    when 'GoogleHostedDomain'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @google_op_hosted_domain = v
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


74
75
76
77
78
 
# File 'lib/comet/models/oidc_config.rb', line 74

def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end

#to_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



194
195
196
 
# File 'lib/comet/models/oidc_config.rb', line 194

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/comet/models/oidc_config.rb', line 159

def to_hash
  ret = {}
  ret['DisplayName'] = @display_name
  unless @hosts.nil?
    ret['Hosts'] = @hosts
  end
  unless @organization_id.nil?
    ret['OrganizationID'] = @organization_id
  end
  ret['Provider'] = @provider
  ret['ClientID'] = @client_id
  ret['ClientSecret'] = @client_secret
  ret['SkipMFA'] = @skip_mfa
  unless @scopes.nil?
    ret['Scopes'] = @scopes
  end
  unless @required_claims.nil?
    ret['RequiredClaims'] = @required_claims
  end
  unless @generic_op_discovery_document_url.nil?
    ret['DiscoveryDocumentURL'] = @generic_op_discovery_document_url
  end
  unless @azure_adv2op_tenant_id.nil?
    ret['AzureTenantID'] = @azure_adv2op_tenant_id
  end
  unless @google_op_hosted_domain.nil?
    ret['GoogleHostedDomain'] = @google_op_hosted_domain
  end
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



199
200
201
 
# File 'lib/comet/models/oidc_config.rb', line 199

def to_json(options = {})
  to_hash.to_json(options)
end