Class: VitableConnect::Resources::Auth

Inherits:

Object

• Object
• VitableConnect::Resources::Auth

Defined in:

lib/vitable_connect/resources/auth.rb

Overview

Issue short-lived access tokens for scoped API access

Instance Method Summary

• #initialize(client:) ⇒ Auth constructor private

  A new instance of Auth.

• #issue_access_token(grant_type:, bound_entity: nil, request_options: {}) ⇒ VitableConnect::Models::AuthIssueAccessTokenResponse

  Issues a short-lived access token from the authenticated API key.

Constructor Details

#initialize(client:) ⇒ Auth

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 Auth.

Parameters:

• client (VitableConnect::Client)

# File 'lib/vitable_connect/resources/auth.rb', line 36

def initialize(client:)
  @client = client
end

Instance Method Details

#issue_access_token(grant_type:, bound_entity: nil, request_options: {}) ⇒ VitableConnect::Models::AuthIssueAccessTokenResponse

Issues a short-lived access token from the authenticated API key. Access tokens can optionally be bound to a specific employer or employee for scoped access. Tokens expire after 15 minutes.

Parameters:

• grant_type (Symbol, VitableConnect::Models::AuthIssueAccessTokenParams::GrantType) —

  • ‘client_credentials` - client_credentials

• bound_entity (VitableConnect::Models::AuthIssueAccessTokenParams::BoundEntity, nil) —

  Optional entity to bind the token to for scoped access

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

Returns:

• (VitableConnect::Models::AuthIssueAccessTokenResponse)

See Also:

• Models::AuthIssueAccessTokenParams

# File 'lib/vitable_connect/resources/auth.rb', line 22

def issue_access_token(params)
  parsed, options = VitableConnect::AuthIssueAccessTokenParams.dump_request(params)
  @client.request(
    method: :post,
    path: "v1/auth/access-tokens",
    body: parsed,
    model: VitableConnect::Models::AuthIssueAccessTokenResponse,
    options: options
  )
end