Class: Inttegro::SecretKey

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/secret_key/secret_key.rb,
lib/inttegro/secret_key/base.rb,
lib/inttegro/secret_key/page.rb,
lib/inttegro/secret_key/usage.rb,
lib/inttegro/secret_key/status.rb,
lib/inttegro/secret_key/generated.rb,
lib/inttegro/secret_key/usage_row.rb,
lib/inttegro/secret_key/token_type.rb,
lib/inttegro/secret_key/usage_page.rb,
lib/inttegro/secret_key/auth_result.rb,
lib/inttegro/secret_key/page_request.rb,
lib/inttegro/secret_key/page_response.rb,
lib/inttegro/secret_key/usage_request.rb,
lib/inttegro/secret_key/lookup_request.rb,
lib/inttegro/secret_key/update_request.rb,
lib/inttegro/secret_key/destroy_request.rb,
lib/inttegro/secret_key/lookup_response.rb,
lib/inttegro/secret_key/update_response.rb,
lib/inttegro/secret_key/destroy_response.rb,
lib/inttegro/secret_key/generate_request.rb,
lib/inttegro/secret_key/generate_response.rb

Overview

Public secret key metadata. The bearer token is never returned by read or mutation endpoints.

This generated model is immutable. Construct it with .new, or decode a string-keyed API payload with .from_hash. #serialize produces a string-keyed hash using the original wire field names and serialized enum values.

Defined Under Namespace

Classes: AuthResult, DestroyRequest, DestroyResponse, GenerateRequest, GenerateResponse, Generated, LookupRequest, LookupResponse, Page, PageRequest, PageResponse, Status, TokenType, UpdateRequest, UpdateResponse, Usage, UsagePage, UsageRequest, UsageRow

Instance Attribute Summary collapse

Instance Attribute Details

#active ⇒ Boolean (readonly)

Value of the active field in the Inttegro API payload.

Required in the API payload. Wire name: active.

Returns:

  • (Boolean) 


85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/inttegro/secret_key/secret_key.rb', line 85

class SecretKey
  const :id, String
  const :label, T.nilable(String), default: nil
  const :token_type, Inttegro::SecretKey::TokenType
  const :issued_at, Time
  const :updated_at, T.nilable(Time), default: nil
  const :expires_at, T.nilable(Time), default: nil
  const :status, Inttegro::SecretKey::Status
  const :active, T::Boolean
  const :revoked_at, T.nilable(Time), default: nil
  const :last_used_at, T.nilable(Time), default: nil
  const :usage_count, T.nilable(Integer), default: nil
end

#expires_at ⇒ Time? (readonly)

Omitted for keys without a fixed expiry.

Optional in the API payload; omitted values default to nil. Wire name: expires_at.

Returns:

  • (Time, nil) 


85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/inttegro/secret_key/secret_key.rb', line 85

class SecretKey
  const :id, String
  const :label, T.nilable(String), default: nil
  const :token_type, Inttegro::SecretKey::TokenType
  const :issued_at, Time
  const :updated_at, T.nilable(Time), default: nil
  const :expires_at, T.nilable(Time), default: nil
  const :status, Inttegro::SecretKey::Status
  const :active, T::Boolean
  const :revoked_at, T.nilable(Time), default: nil
  const :last_used_at, T.nilable(Time), default: nil
  const :usage_count, T.nilable(Integer), default: nil
end

#id ⇒ String (readonly)

Application-scoped secret key identifier.

Required in the API payload. Wire name: id.

Returns:

  • (String) 


85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/inttegro/secret_key/secret_key.rb', line 85

class SecretKey
  const :id, String
  const :label, T.nilable(String), default: nil
  const :token_type, Inttegro::SecretKey::TokenType
  const :issued_at, Time
  const :updated_at, T.nilable(Time), default: nil
  const :expires_at, T.nilable(Time), default: nil
  const :status, Inttegro::SecretKey::Status
  const :active, T::Boolean
  const :revoked_at, T.nilable(Time), default: nil
  const :last_used_at, T.nilable(Time), default: nil
  const :usage_count, T.nilable(Integer), default: nil
end

#issued_at ⇒ Time (readonly)

Value of the issued_at field in the Inttegro API payload.

Required in the API payload. Wire name: issued_at.

Returns:

  • (Time) 


85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/inttegro/secret_key/secret_key.rb', line 85

class SecretKey
  const :id, String
  const :label, T.nilable(String), default: nil
  const :token_type, Inttegro::SecretKey::TokenType
  const :issued_at, Time
  const :updated_at, T.nilable(Time), default: nil
  const :expires_at, T.nilable(Time), default: nil
  const :status, Inttegro::SecretKey::Status
  const :active, T::Boolean
  const :revoked_at, T.nilable(Time), default: nil
  const :last_used_at, T.nilable(Time), default: nil
  const :usage_count, T.nilable(Integer), default: nil
end

#label ⇒ String? (readonly)

Optional human-readable label for the secret key.

Optional in the API payload; omitted values default to nil. Wire name: label.

Returns:

  • (String, nil) 


85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/inttegro/secret_key/secret_key.rb', line 85

class SecretKey
  const :id, String
  const :label, T.nilable(String), default: nil
  const :token_type, Inttegro::SecretKey::TokenType
  const :issued_at, Time
  const :updated_at, T.nilable(Time), default: nil
  const :expires_at, T.nilable(Time), default: nil
  const :status, Inttegro::SecretKey::Status
  const :active, T::Boolean
  const :revoked_at, T.nilable(Time), default: nil
  const :last_used_at, T.nilable(Time), default: nil
  const :usage_count, T.nilable(Integer), default: nil
end

#last_used_at ⇒ Time? (readonly)

Most recent recorded authentication when available; otherwise omitted.

Optional in the API payload; omitted values default to nil. Wire name: last_used_at.

Returns:

  • (Time, nil) 


85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/inttegro/secret_key/secret_key.rb', line 85

class SecretKey
  const :id, String
  const :label, T.nilable(String), default: nil
  const :token_type, Inttegro::SecretKey::TokenType
  const :issued_at, Time
  const :updated_at, T.nilable(Time), default: nil
  const :expires_at, T.nilable(Time), default: nil
  const :status, Inttegro::SecretKey::Status
  const :active, T::Boolean
  const :revoked_at, T.nilable(Time), default: nil
  const :last_used_at, T.nilable(Time), default: nil
  const :usage_count, T.nilable(Integer), default: nil
end

#revoked_at ⇒ Time? (readonly)

Omitted until the key is revoked.

Optional in the API payload; omitted values default to nil. Wire name: revoked_at.

Returns:

  • (Time, nil) 


85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/inttegro/secret_key/secret_key.rb', line 85

class SecretKey
  const :id, String
  const :label, T.nilable(String), default: nil
  const :token_type, Inttegro::SecretKey::TokenType
  const :issued_at, Time
  const :updated_at, T.nilable(Time), default: nil
  const :expires_at, T.nilable(Time), default: nil
  const :status, Inttegro::SecretKey::Status
  const :active, T::Boolean
  const :revoked_at, T.nilable(Time), default: nil
  const :last_used_at, T.nilable(Time), default: nil
  const :usage_count, T.nilable(Integer), default: nil
end

#status ⇒ Inttegro::SecretKey::Status (readonly)

Value of the status field in the Inttegro API payload.

Required in the API payload. Wire name: status.

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/inttegro/secret_key/secret_key.rb', line 85

class SecretKey
  const :id, String
  const :label, T.nilable(String), default: nil
  const :token_type, Inttegro::SecretKey::TokenType
  const :issued_at, Time
  const :updated_at, T.nilable(Time), default: nil
  const :expires_at, T.nilable(Time), default: nil
  const :status, Inttegro::SecretKey::Status
  const :active, T::Boolean
  const :revoked_at, T.nilable(Time), default: nil
  const :last_used_at, T.nilable(Time), default: nil
  const :usage_count, T.nilable(Integer), default: nil
end

#token_type ⇒ Inttegro::SecretKey::TokenType (readonly)

Value of the token_type field in the Inttegro API payload.

Required in the API payload. Wire name: token_type.

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/inttegro/secret_key/secret_key.rb', line 85

class SecretKey
  const :id, String
  const :label, T.nilable(String), default: nil
  const :token_type, Inttegro::SecretKey::TokenType
  const :issued_at, Time
  const :updated_at, T.nilable(Time), default: nil
  const :expires_at, T.nilable(Time), default: nil
  const :status, Inttegro::SecretKey::Status
  const :active, T::Boolean
  const :revoked_at, T.nilable(Time), default: nil
  const :last_used_at, T.nilable(Time), default: nil
  const :usage_count, T.nilable(Integer), default: nil
end

#updated_at ⇒ Time? (readonly)

Omitted until the label is changed.

Optional in the API payload; omitted values default to nil. Wire name: updated_at.

Returns:

  • (Time, nil) 


85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/inttegro/secret_key/secret_key.rb', line 85

class SecretKey
  const :id, String
  const :label, T.nilable(String), default: nil
  const :token_type, Inttegro::SecretKey::TokenType
  const :issued_at, Time
  const :updated_at, T.nilable(Time), default: nil
  const :expires_at, T.nilable(Time), default: nil
  const :status, Inttegro::SecretKey::Status
  const :active, T::Boolean
  const :revoked_at, T.nilable(Time), default: nil
  const :last_used_at, T.nilable(Time), default: nil
  const :usage_count, T.nilable(Integer), default: nil
end

#usage_count ⇒ Integer? (readonly)

Number of recorded authentications when available; omitted when zero.

Optional in the API payload; omitted values default to nil. Wire name: usage_count.

Returns:

  • (Integer, nil) 


85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/inttegro/secret_key/secret_key.rb', line 85

class SecretKey
  const :id, String
  const :label, T.nilable(String), default: nil
  const :token_type, Inttegro::SecretKey::TokenType
  const :issued_at, Time
  const :updated_at, T.nilable(Time), default: nil
  const :expires_at, T.nilable(Time), default: nil
  const :status, Inttegro::SecretKey::Status
  const :active, T::Boolean
  const :revoked_at, T.nilable(Time), default: nil
  const :last_used_at, T.nilable(Time), default: nil
  const :usage_count, T.nilable(Integer), default: nil
end