Class: Rallio::SignOnToken

Inherits:
Base
  • Object
show all
Defined in:
lib/rallio/sign_on_token.rb

Overview

Represents a sign on token object as it comes from Rallio.

Instance Attribute Summary collapse

Class Method Summary collapse

Methods inherited from Base

app_credentials

Instance Attribute Details

#expires_at ⇒ DateTime

Returns DateTime token and url will become invalid.

Returns:

  • (DateTime) —

    DateTime token and url will become invalid.



10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/rallio/sign_on_token.rb', line 10

class SignOnToken < Base
  attribute :token, String
  attribute :expires_at, DateTime
  attribute :url, String

  # Creates new sign on token for user_id.
  #
  # @param user_id [Integer]
  # @return [Rallio::SignOnToken]
  def self.create(user_id:, params: {})
    response = self.post("/users/#{user_id}/sign_on_tokens", headers: app_credentials, query: params)
    new response.parsed_response['sign_on_token']
  end
end

#token ⇒ String

Returns token for SSO url.

Returns:

  • (String) —

    token for SSO url



10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/rallio/sign_on_token.rb', line 10

class SignOnToken < Base
  attribute :token, String
  attribute :expires_at, DateTime
  attribute :url, String

  # Creates new sign on token for user_id.
  #
  # @param user_id [Integer]
  # @return [Rallio::SignOnToken]
  def self.create(user_id:, params: {})
    response = self.post("/users/#{user_id}/sign_on_tokens", headers: app_credentials, query: params)
    new response.parsed_response['sign_on_token']
  end
end

#url ⇒ String

Returns url to redirect user to for SSO with token embedded.

Returns:

  • (String) —

    url to redirect user to for SSO with token embedded



10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/rallio/sign_on_token.rb', line 10

class SignOnToken < Base
  attribute :token, String
  attribute :expires_at, DateTime
  attribute :url, String

  # Creates new sign on token for user_id.
  #
  # @param user_id [Integer]
  # @return [Rallio::SignOnToken]
  def self.create(user_id:, params: {})
    response = self.post("/users/#{user_id}/sign_on_tokens", headers: app_credentials, query: params)
    new response.parsed_response['sign_on_token']
  end
end

Class Method Details

.create(user_id:, params: {}) ⇒ Rallio::SignOnToken

Creates new sign on token for user_id.

Parameters:

  • user_id (Integer)

Returns:



19
20
21
22
 
# File 'lib/rallio/sign_on_token.rb', line 19

def self.create(user_id:, params: {})
  response = self.post("/users/#{user_id}/sign_on_tokens", headers: app_credentials, query: params)
  new response.parsed_response['sign_on_token']
end