Class: Anthropic::Models::Organization::Federation::FederationRule

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/anthropic/models/organization/federation/federation_rule.rb,
sig/anthropic/models/organization/federation/federation_rule.rbs

Overview

See Also:

  • Anthropic::Resources::Organization::Federation::Rules#create

Instance Attribute Summary collapse

Instance Method Summary collapse

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 ⇒ void 



66
 
# File 'sig/anthropic/models/organization/federation/federation_rule.rbs', line 66

def initialize: (

Instance Attribute Details

#applies_to_all_workspaces ⇒ Boolean

When true, this rule is enabled for every workspace in the org (including ones created after the rule). workspace_ids is ignored at exchange time.

Parameters:

Returns:



20
 
# File 'lib/anthropic/models/organization/federation/federation_rule.rb', line 20

required :applies_to_all_workspaces, Anthropic::Internal::Type::Boolean

#archived_at ⇒ Time?

If set, this rule is archived and rejects token exchange.

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


26
 
# File 'lib/anthropic/models/organization/federation/federation_rule.rb', line 26

required :archived_at, Time, nil?: true

#archived_by_actor_id ⇒ String?

Tagged ID (user_/svac_) of the actor that archived this rule.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


32
 
# File 'lib/anthropic/models/organization/federation/federation_rule.rb', line 32

required :archived_by_actor_id, String, nil?: true

#created_at ⇒ Time

When this rule was created.

Parameters:

  • value (Time)

Returns:

  • (Time) 


38
 
# File 'lib/anthropic/models/organization/federation/federation_rule.rb', line 38

required :created_at, Time

#created_by_actor_id ⇒ String?

Tagged ID (user_/svac_) of the actor that created this rule.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


44
 
# File 'lib/anthropic/models/organization/federation/federation_rule.rb', line 44

required :created_by_actor_id, String, nil?: true

#description ⇒ String?

Optional free-text description.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


50
 
# File 'lib/anthropic/models/organization/federation/federation_rule.rb', line 50

required :description, String, nil?: true

#id ⇒ String

Tagged ID of the federation rule.

Parameters:

  • value (String)

Returns:

  • (String) 


13
 
# File 'lib/anthropic/models/organization/federation/federation_rule.rb', line 13

required :id, String

#issuer_id ⇒ String

Tagged ID of the issuer whose tokens this rule accepts.

Parameters:

  • value (String)

Returns:

  • (String) 


56
 
# File 'lib/anthropic/models/organization/federation/federation_rule.rb', line 56

required :issuer_id, String

#issuer_name ⇒ String?

Issuer's display name at read time.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


62
 
# File 'lib/anthropic/models/organization/federation/federation_rule.rb', line 62

required :issuer_name, String, nil?: true

#match ⇒ Anthropic::Models::Organization::Federation::FederationRuleMatch

Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass.

Parameters:

  • value (Anthropic::Organization::Federation::FederationRuleMatch)

Returns:



69
 
# File 'lib/anthropic/models/organization/federation/federation_rule.rb', line 69

required :match, -> { Anthropic::Organization::Federation::FederationRuleMatch }

#name ⇒ String

Admin-chosen slug identifier.

Parameters:

  • value (String)

Returns:

  • (String) 


75
 
# File 'lib/anthropic/models/organization/federation/federation_rule.rb', line 75

required :name, String

#oauth_scope ⇒ String

Space-separated OAuth scopes granted on the minted token.

Parameters:

  • value (String)

Returns:

  • (String) 


81
 
# File 'lib/anthropic/models/organization/federation/federation_rule.rb', line 81

required :oauth_scope, String

#target ⇒ Anthropic::Models::Organization::Federation::ServiceAccountTarget

Identity that tokens minted via this rule act as. Currently always a service_account target.

Parameters:

  • value (Anthropic::Organization::Federation::ServiceAccountTarget)

Returns:



88
 
# File 'lib/anthropic/models/organization/federation/federation_rule.rb', line 88

required :target, -> { Anthropic::Organization::Federation::ServiceAccountTarget }

#token_lifetime_seconds ⇒ Integer

Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at max(60, min(this value, 2 × remaining assertion validity)) seconds.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


95
 
# File 'lib/anthropic/models/organization/federation/federation_rule.rb', line 95

required :token_lifetime_seconds, Integer

#type ⇒ Symbol, :federation_rule

Parameters:

  • value (:federation_rule)

Returns:

  • (Symbol, :federation_rule) 


100
 
# File 'lib/anthropic/models/organization/federation/federation_rule.rb', line 100

required :type, const: :federation_rule

#updated_at ⇒ Time

When this rule was last updated.

Parameters:

  • value (Time)

Returns:

  • (Time) 


106
 
# File 'lib/anthropic/models/organization/federation/federation_rule.rb', line 106

required :updated_at, Time

#updated_by_actor_id ⇒ String?

Tagged ID (user_/svac_) of the actor that last updated this rule.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


112
 
# File 'lib/anthropic/models/organization/federation/federation_rule.rb', line 112

required :updated_by_actor_id, String, nil?: true

#workspace_ids ⇒ Array<String>

Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy workspace_id binding. Ignored at exchange time when applies_to_all_workspaces is true (the list may still be non-empty).

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


120
 
# File 'lib/anthropic/models/organization/federation/federation_rule.rb', line 120

required :workspace_ids, Anthropic::Internal::Type::ArrayOf[String]

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


87
 
# File 'sig/anthropic/models/organization/federation/federation_rule.rbs', line 87

def to_hash: -> {