Class: Cerca::Models::OAuthConnectParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Cerca::Models::OAuthConnectParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/cerca/models/oauth_connect_params.rb

Overview

See Also:

• Resources::OAuth#connect

Instance Attribute Summary

• #owner ⇒ Cerca::Models::ConnectionOwner::OrganizationConnectionOwner, Cerca::Models::ConnectionOwner::FleetConnectionOwner

  Public owner for a reusable connection.

• #provider ⇒ String
• #return_origin ⇒ String

  HTTP(S) origin that receives the OAuth completion message.

• #scopes ⇒ Array<String>^?

  Provider-specific OAuth scopes.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(provider:, owner:, return_origin:, scopes: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see OAuthConnectParams for more details.

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(provider:, owner:, return_origin:, scopes: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Cerca::Models::OAuthConnectParams for more details.

Parameters:

• provider (String)
• owner (Cerca::Models::ConnectionOwner::OrganizationConnectionOwner, Cerca::Models::ConnectionOwner::FleetConnectionOwner) —

  Public owner for a reusable connection. Organization owners use the authenticate

• return_origin (String) —

  HTTP(S) origin that receives the OAuth completion message.

• scopes (Array<String>) (defaults to: nil) —

  Provider-specific OAuth scopes. Empty entries are ignored after trimming.

• request_options (Cerca::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/cerca/models/oauth_connect_params.rb', line 34

Instance Attribute Details

#owner ⇒ Cerca::Models::ConnectionOwner::OrganizationConnectionOwner, Cerca::Models::ConnectionOwner::FleetConnectionOwner

Public owner for a reusable connection. Organization owners use the authenticated organization; fleet owners add a fleetId.

Returns:

• (Cerca::Models::ConnectionOwner::OrganizationConnectionOwner, Cerca::Models::ConnectionOwner::FleetConnectionOwner)

# File 'lib/cerca/models/oauth_connect_params.rb', line 20

required :owner, union: -> { Cerca::ConnectionOwner }

#provider ⇒ String

Returns:

• (String)

# File 'lib/cerca/models/oauth_connect_params.rb', line 13

required :provider, String

#return_origin ⇒ String

HTTP(S) origin that receives the OAuth completion message.

Returns:

• (String)

# File 'lib/cerca/models/oauth_connect_params.rb', line 26

required :return_origin, String, api_name: :returnOrigin

#scopes ⇒ Array<String>^?

Provider-specific OAuth scopes. Empty entries are ignored after trimming.

Returns:

• (Array<String>, nil)

# File 'lib/cerca/models/oauth_connect_params.rb', line 32

optional :scopes, Cerca::Internal::Type::ArrayOf[String]