Class: Anthropic::Models::Organization::Federation::RuleCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/anthropic/models/organization/federation/rule_create_params.rb,
sig/anthropic/models/organization/federation/rule_create_params.rbs

Overview

See Also:

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

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Anthropic

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(issuer_id:, match:, name:, oauth_scope:, target:, applies_to_all_workspaces: nil, description: nil, token_lifetime_seconds: nil, workspace_id: nil, request_options: {}) ⇒ void

Some parameter documentations has been truncated, see Anthropic::Models::Organization::Federation::RuleCreateParams for more details.

Parameters:

  • issuer_id (String) —

    Tagged ID of the federation issuer.

  • match (Anthropic::Models::Organization::Federation::FederationRuleMatch) —

    Conditions the verified JWT must satisfy for this rule to apply. At least one of

  • name (String) —

    Slug identifier (lowercase, digits, hyphens). Unique within the organization; a

  • oauth_scope (String) —

    Space-separated OAuth scopes. OAuth callers may only set workspace:developer o

  • target (Anthropic::Models::Organization::Federation::ServiceAccountTarget) —

    Identity that tokens minted via this rule act as. Currently always a `service_ac

  • applies_to_all_workspaces (Boolean) (defaults to: nil) —

    When true, enable this rule for every workspace in the org (including workspaces

  • description (String, nil) (defaults to: nil) —

    Optional free-text description.

  • token_lifetime_seconds (Integer) (defaults to: nil) —

    Lifetime in seconds for access tokens minted via this rule (60-86400). Defaults

  • workspace_id (String, nil) (defaults to: nil) —

    Tagged ID of the workspace to enable this rule for. Required unless `appliesto

  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/anthropic/models/organization/federation/rule_create_params.rb', line 77

Instance Attribute Details

#applies_to_all_workspaces ⇒ Boolean?

When true, enable this rule for every workspace in the org (including workspaces created later).

Parameters:

Returns:



53
 
# File 'lib/anthropic/models/organization/federation/rule_create_params.rb', line 53

optional :applies_to_all_workspaces, Anthropic::Internal::Type::Boolean

#description ⇒ String?

Optional free-text description.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


59
 
# File 'lib/anthropic/models/organization/federation/rule_create_params.rb', line 59

optional :description, String, nil?: true

#issuer_id ⇒ String

Tagged ID of the federation issuer.

Parameters:

  • value (String)

Returns:

  • (String) 


16
 
# File 'lib/anthropic/models/organization/federation/rule_create_params.rb', line 16

required :issuer_id, String

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

Conditions the verified JWT must satisfy for this rule to apply. At least one of subject_prefix (other than a wildcard-only value like *), claims, or condition is required; audience alone is not sufficient.

Parameters:

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

Returns:



24
 
# File 'lib/anthropic/models/organization/federation/rule_create_params.rb', line 24

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

#name ⇒ String

Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409.

Parameters:

  • value (String)

Returns:

  • (String) 


31
 
# File 'lib/anthropic/models/organization/federation/rule_create_params.rb', line 31

required :name, String

#oauth_scope ⇒ String

Space-separated OAuth scopes. OAuth callers may only set workspace:developer or workspace:inference; other scopes (such as org:admin) require a Console session.

Parameters:

  • value (String)

Returns:

  • (String) 


39
 
# File 'lib/anthropic/models/organization/federation/rule_create_params.rb', line 39

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:



46
 
# File 'lib/anthropic/models/organization/federation/rule_create_params.rb', line 46

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

#token_lifetime_seconds ⇒ Integer?

Lifetime in seconds for access tokens minted via this rule (60-86400). Defaults to 3600 (1h). Minted tokens are capped at max(60, min(this value, 2 × remaining assertion validity)) seconds.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


67
 
# File 'lib/anthropic/models/organization/federation/rule_create_params.rb', line 67

optional :token_lifetime_seconds, Integer

#workspace_id ⇒ String?

Tagged ID of the workspace to enable this rule for. Required unless applies_to_all_workspaces is true. Additional workspaces can be added via the /federation_rules/{federation_rule_id}/workspaces sub-resource.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :workspace_id, String, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


58
 
# File 'sig/anthropic/models/organization/federation/rule_create_params.rbs', line 58

def to_hash: -> {