Class: OCI::Oda::Models::CreateAuthenticationProviderDetails
- Inherits:
-
Object
- Object
- OCI::Oda::Models::CreateAuthenticationProviderDetails
- Defined in:
- lib/oci/oda/models/create_authentication_provider_details.rb
Overview
Properties required to create a new Authentication Provider.
Constant Summary collapse
- GRANT_TYPE_ENUM =
[ GRANT_TYPE_CLIENT_CREDENTIALS = 'CLIENT_CREDENTIALS'.freeze, GRANT_TYPE_AUTHORIZATION_CODE = 'AUTHORIZATION_CODE'.freeze ].freeze
- IDENTITY_PROVIDER_ENUM =
[ IDENTITY_PROVIDER_GENERIC = 'GENERIC'.freeze, IDENTITY_PROVIDER_OAM = 'OAM'.freeze, IDENTITY_PROVIDER_GOOGLE = 'GOOGLE'.freeze, IDENTITY_PROVIDER_MICROSOFT = 'MICROSOFT'.freeze ].freeze
Instance Attribute Summary collapse
-
#authorization_endpoint_url ⇒ String
The IDPs URL for the page that users authenticate with by entering the user name and password.
-
#client_id ⇒ String
[Required] The client ID for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration.
-
#client_secret ⇒ String
[Required] The client secret for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Usage of predefined tag keys.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type, or scope.
-
#grant_type ⇒ String
[Required] The grant type for the Authentication Provider.
-
#identity_provider ⇒ String
[Required] Which type of Identity Provider (IDP) you are using.
-
#is_visible ⇒ BOOLEAN
Whether this Authentication Provider is visible in the ODA UI.
-
#name ⇒ String
[Required] A name to identify the Authentication Provider.
-
#redirect_url ⇒ String
The OAuth Redirect URL.
-
#refresh_token_retention_period_in_days ⇒ Integer
The number of days to keep the refresh token in the Digital Assistant cache.
-
#revoke_token_endpoint_url ⇒ String
If you want to revoke all the refresh tokens and access tokens of the logged-in user from a dialog flow, then you need the IDP's revoke refresh token URL.
-
#scopes ⇒ String
[Required] A space-separated list of the scopes that must be included when Digital Assistant requests an access token from the provider.
-
#short_authorization_code_request_url ⇒ String
A shortened version of the authorization URL, which you can get from a URL shortener service (one that allows you to send query parameters).
-
#subject_claim ⇒ String
The access-token profile claim to use to identify the user.
-
#token_endpoint_url ⇒ String
[Required] The IDPs URL for requesting access tokens.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ CreateAuthenticationProviderDetails
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ CreateAuthenticationProviderDetails
Initializes the object
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 |
# File 'lib/oci/oda/models/create_authentication_provider_details.rb', line 174 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.grant_type = attributes[:'grantType'] if attributes[:'grantType'] raise 'You cannot provide both :grantType and :grant_type' if attributes.key?(:'grantType') && attributes.key?(:'grant_type') self.grant_type = attributes[:'grant_type'] if attributes[:'grant_type'] self.identity_provider = attributes[:'identityProvider'] if attributes[:'identityProvider'] raise 'You cannot provide both :identityProvider and :identity_provider' if attributes.key?(:'identityProvider') && attributes.key?(:'identity_provider') self.identity_provider = attributes[:'identity_provider'] if attributes[:'identity_provider'] self.name = attributes[:'name'] if attributes[:'name'] self.token_endpoint_url = attributes[:'tokenEndpointUrl'] if attributes[:'tokenEndpointUrl'] raise 'You cannot provide both :tokenEndpointUrl and :token_endpoint_url' if attributes.key?(:'tokenEndpointUrl') && attributes.key?(:'token_endpoint_url') self.token_endpoint_url = attributes[:'token_endpoint_url'] if attributes[:'token_endpoint_url'] self. = attributes[:'authorizationEndpointUrl'] if attributes[:'authorizationEndpointUrl'] raise 'You cannot provide both :authorizationEndpointUrl and :authorization_endpoint_url' if attributes.key?(:'authorizationEndpointUrl') && attributes.key?(:'authorization_endpoint_url') self. = attributes[:'authorization_endpoint_url'] if attributes[:'authorization_endpoint_url'] self. = attributes[:'shortAuthorizationCodeRequestUrl'] if attributes[:'shortAuthorizationCodeRequestUrl'] raise 'You cannot provide both :shortAuthorizationCodeRequestUrl and :short_authorization_code_request_url' if attributes.key?(:'shortAuthorizationCodeRequestUrl') && attributes.key?(:'short_authorization_code_request_url') self. = attributes[:'short_authorization_code_request_url'] if attributes[:'short_authorization_code_request_url'] self.revoke_token_endpoint_url = attributes[:'revokeTokenEndpointUrl'] if attributes[:'revokeTokenEndpointUrl'] raise 'You cannot provide both :revokeTokenEndpointUrl and :revoke_token_endpoint_url' if attributes.key?(:'revokeTokenEndpointUrl') && attributes.key?(:'revoke_token_endpoint_url') self.revoke_token_endpoint_url = attributes[:'revoke_token_endpoint_url'] if attributes[:'revoke_token_endpoint_url'] self.client_id = attributes[:'clientId'] if attributes[:'clientId'] raise 'You cannot provide both :clientId and :client_id' if attributes.key?(:'clientId') && attributes.key?(:'client_id') self.client_id = attributes[:'client_id'] if attributes[:'client_id'] self.client_secret = attributes[:'clientSecret'] if attributes[:'clientSecret'] raise 'You cannot provide both :clientSecret and :client_secret' if attributes.key?(:'clientSecret') && attributes.key?(:'client_secret') self.client_secret = attributes[:'client_secret'] if attributes[:'client_secret'] self.scopes = attributes[:'scopes'] if attributes[:'scopes'] self.subject_claim = attributes[:'subjectClaim'] if attributes[:'subjectClaim'] raise 'You cannot provide both :subjectClaim and :subject_claim' if attributes.key?(:'subjectClaim') && attributes.key?(:'subject_claim') self.subject_claim = attributes[:'subject_claim'] if attributes[:'subject_claim'] self.refresh_token_retention_period_in_days = attributes[:'refreshTokenRetentionPeriodInDays'] if attributes[:'refreshTokenRetentionPeriodInDays'] raise 'You cannot provide both :refreshTokenRetentionPeriodInDays and :refresh_token_retention_period_in_days' if attributes.key?(:'refreshTokenRetentionPeriodInDays') && attributes.key?(:'refresh_token_retention_period_in_days') self.refresh_token_retention_period_in_days = attributes[:'refresh_token_retention_period_in_days'] if attributes[:'refresh_token_retention_period_in_days'] self.redirect_url = attributes[:'redirectUrl'] if attributes[:'redirectUrl'] raise 'You cannot provide both :redirectUrl and :redirect_url' if attributes.key?(:'redirectUrl') && attributes.key?(:'redirect_url') self.redirect_url = attributes[:'redirect_url'] if attributes[:'redirect_url'] self.is_visible = attributes[:'isVisible'] unless attributes[:'isVisible'].nil? self.is_visible = true if is_visible.nil? && !attributes.key?(:'isVisible') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isVisible and :is_visible' if attributes.key?(:'isVisible') && attributes.key?(:'is_visible') self.is_visible = attributes[:'is_visible'] unless attributes[:'is_visible'].nil? self.is_visible = true if is_visible.nil? && !attributes.key?(:'isVisible') && !attributes.key?(:'is_visible') # rubocop:disable Style/StringLiterals self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] end |
Instance Attribute Details
#authorization_endpoint_url ⇒ String
The IDPs URL for the page that users authenticate with by entering the user name and password.
41 42 43 |
# File 'lib/oci/oda/models/create_authentication_provider_details.rb', line 41 def @authorization_endpoint_url end |
#client_id ⇒ String
[Required] The client ID for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration. With Microsoft identity platform, use the application ID.
61 62 63 |
# File 'lib/oci/oda/models/create_authentication_provider_details.rb', line 61 def client_id @client_id end |
#client_secret ⇒ String
[Required] The client secret for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration. With Microsoft identity platform, use the application secret.
67 68 69 |
# File 'lib/oci/oda/models/create_authentication_provider_details.rb', line 67 def client_secret @client_secret end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}
102 103 104 |
# File 'lib/oci/oda/models/create_authentication_provider_details.rb', line 102 def @defined_tags end |
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type, or scope. Example: {\"bar-key\": \"value\"}
96 97 98 |
# File 'lib/oci/oda/models/create_authentication_provider_details.rb', line 96 def @freeform_tags end |
#grant_type ⇒ String
[Required] The grant type for the Authentication Provider.
25 26 27 |
# File 'lib/oci/oda/models/create_authentication_provider_details.rb', line 25 def grant_type @grant_type end |
#identity_provider ⇒ String
[Required] Which type of Identity Provider (IDP) you are using.
29 30 31 |
# File 'lib/oci/oda/models/create_authentication_provider_details.rb', line 29 def identity_provider @identity_provider end |
#is_visible ⇒ BOOLEAN
Whether this Authentication Provider is visible in the ODA UI.
90 91 92 |
# File 'lib/oci/oda/models/create_authentication_provider_details.rb', line 90 def is_visible @is_visible end |
#name ⇒ String
[Required] A name to identify the Authentication Provider.
33 34 35 |
# File 'lib/oci/oda/models/create_authentication_provider_details.rb', line 33 def name @name end |
#redirect_url ⇒ String
The OAuth Redirect URL.
86 87 88 |
# File 'lib/oci/oda/models/create_authentication_provider_details.rb', line 86 def redirect_url @redirect_url end |
#refresh_token_retention_period_in_days ⇒ Integer
The number of days to keep the refresh token in the Digital Assistant cache.
82 83 84 |
# File 'lib/oci/oda/models/create_authentication_provider_details.rb', line 82 def refresh_token_retention_period_in_days @refresh_token_retention_period_in_days end |
#revoke_token_endpoint_url ⇒ String
If you want to revoke all the refresh tokens and access tokens of the logged-in user from a dialog flow, then you need the IDP's revoke refresh token URL. If you provide this URL, then you can use the System.OAuth2ResetTokens component to revoke the user's tokens for this service.
55 56 57 |
# File 'lib/oci/oda/models/create_authentication_provider_details.rb', line 55 def revoke_token_endpoint_url @revoke_token_endpoint_url end |
#scopes ⇒ String
[Required] A space-separated list of the scopes that must be included when Digital Assistant requests an access token from the provider. Include all the scopes that are required to access the resources. If refresh tokens are enabled, include the scope thatu2019s necessary to get the refresh token (typically offline_access).
74 75 76 |
# File 'lib/oci/oda/models/create_authentication_provider_details.rb', line 74 def scopes @scopes end |
#short_authorization_code_request_url ⇒ String
A shortened version of the authorization URL, which you can get from a URL shortener service (one that allows you to send query parameters). You might need this because the generated authorization-code-request URL could be too long for SMS and older smart phones.
48 49 50 |
# File 'lib/oci/oda/models/create_authentication_provider_details.rb', line 48 def @short_authorization_code_request_url end |
#subject_claim ⇒ String
The access-token profile claim to use to identify the user.
78 79 80 |
# File 'lib/oci/oda/models/create_authentication_provider_details.rb', line 78 def subject_claim @subject_claim end |
#token_endpoint_url ⇒ String
[Required] The IDPs URL for requesting access tokens.
37 38 39 |
# File 'lib/oci/oda/models/create_authentication_provider_details.rb', line 37 def token_endpoint_url @token_endpoint_url end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 |
# File 'lib/oci/oda/models/create_authentication_provider_details.rb', line 105 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'grant_type': :'grantType', 'identity_provider': :'identityProvider', 'name': :'name', 'token_endpoint_url': :'tokenEndpointUrl', 'authorization_endpoint_url': :'authorizationEndpointUrl', 'short_authorization_code_request_url': :'shortAuthorizationCodeRequestUrl', 'revoke_token_endpoint_url': :'revokeTokenEndpointUrl', 'client_id': :'clientId', 'client_secret': :'clientSecret', 'scopes': :'scopes', 'subject_claim': :'subjectClaim', 'refresh_token_retention_period_in_days': :'refreshTokenRetentionPeriodInDays', 'redirect_url': :'redirectUrl', 'is_visible': :'isVisible', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
# File 'lib/oci/oda/models/create_authentication_provider_details.rb', line 129 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'grant_type': :'String', 'identity_provider': :'String', 'name': :'String', 'token_endpoint_url': :'String', 'authorization_endpoint_url': :'String', 'short_authorization_code_request_url': :'String', 'revoke_token_endpoint_url': :'String', 'client_id': :'String', 'client_secret': :'String', 'scopes': :'String', 'subject_claim': :'String', 'refresh_token_retention_period_in_days': :'Integer', 'redirect_url': :'String', 'is_visible': :'BOOLEAN', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 |
# File 'lib/oci/oda/models/create_authentication_provider_details.rb', line 294 def ==(other) return true if equal?(other) self.class == other.class && grant_type == other.grant_type && identity_provider == other.identity_provider && name == other.name && token_endpoint_url == other.token_endpoint_url && == other. && == other. && revoke_token_endpoint_url == other.revoke_token_endpoint_url && client_id == other.client_id && client_secret == other.client_secret && scopes == other.scopes && subject_claim == other.subject_claim && refresh_token_retention_period_in_days == other.refresh_token_retention_period_in_days && redirect_url == other.redirect_url && is_visible == other.is_visible && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 |
# File 'lib/oci/oda/models/create_authentication_provider_details.rb', line 339 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) public_method("#{key}=").call( attributes[self.class.attribute_map[key]] .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? public_method("#{key}=").call( OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]) ) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(other) ⇒ Boolean
319 320 321 |
# File 'lib/oci/oda/models/create_authentication_provider_details.rb', line 319 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
328 329 330 |
# File 'lib/oci/oda/models/create_authentication_provider_details.rb', line 328 def hash [grant_type, identity_provider, name, token_endpoint_url, , , revoke_token_endpoint_url, client_id, client_secret, scopes, subject_claim, refresh_token_retention_period_in_days, redirect_url, is_visible, , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
372 373 374 375 376 377 378 379 380 381 |
# File 'lib/oci/oda/models/create_authentication_provider_details.rb', line 372 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = public_method(attr).call next if value.nil? && !instance_variable_defined?("@#{attr}") hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
366 367 368 |
# File 'lib/oci/oda/models/create_authentication_provider_details.rb', line 366 def to_s to_hash.to_s end |