Class: Cerca::Resources::OAuth

Inherits:

Object

• Object
• Cerca::Resources::OAuth

Defined in:

lib/cerca/resources/oauth.rb

Instance Method Summary

• #connect(provider, owner:, return_origin:, scopes: nil, request_options: {}) ⇒ Cerca::Models::OAuthConnectResponse

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

• #initialize(client:) ⇒ OAuth constructor private

  A new instance of OAuth.

Constructor Details

#initialize(client:) ⇒ OAuth

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of OAuth.

Parameters:

• client (Cerca::Client)

# File 'lib/cerca/resources/oauth.rb', line 40

def initialize(client:)
  @client = client
end

Instance Method Details

#connect(provider, owner:, return_origin:, scopes: nil, request_options: {}) ⇒ Cerca::Models::OAuthConnectResponse

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

Start OAuth authorization

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>) —

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

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

Returns:

• (Cerca::Models::OAuthConnectResponse)

See Also:

• Models::OAuthConnectParams

# File 'lib/cerca/resources/oauth.rb', line 26

def connect(provider, params)
  parsed, options = Cerca::OAuthConnectParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["oauth/connect/%1$s", provider],
    body: parsed,
    model: Cerca::OAuthConnectResponse,
    options: options
  )
end