Class: Anthropic::Models::Beta::Organization::Federation::RuleUpdateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Anthropic::Models::Beta::Organization::Federation::RuleUpdateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/anthropic/models/beta/organization/federation/rule_update_params.rb,
sig/anthropic/models/beta/organization/federation/rule_update_params.rbs

Overview

See Also:

• Anthropic::Resources::Beta::Organization::Federation::Rules#update

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Anthropic

Instance Attribute Summary

• #applies_to_all_workspaces ⇒ Boolean^?

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

• #attributes ⇒ Hash{Symbol=>String}^?

  Replaces the CEL expressions {name: expr} extracting named values from claims.

• #betas ⇒ Array<String, Symbol, Anthropic::Models::AnthropicBeta>^?

  Optional header to specify the beta version(s) you want to use.

• #description ⇒ String^?

  Replaces the description.

• #federation_rule_id ⇒ String

  ID of the federation rule to update.

• #match ⇒ Anthropic::Models::Beta::Organization::Federation::BetaFederationRuleMatch^?

  Does the incoming JWT qualify?.

• #name ⇒ String^?

  Replaces the slug identifier (lowercase, digits, hyphens).

• #oauth_scope ⇒ String^?

  Replaces the space-separated OAuth scopes granted on minted tokens.

• #target ⇒ Anthropic::Models::Beta::Organization::Federation::BetaServiceAccountTarget^?

  Bind to a fixed service account by ID.

• #token_lifetime_seconds ⇒ Integer^?

  Replaces the lifetime in seconds for access tokens minted via this rule (60-86400).

• #workspace_id ⇒ String^?

  Replaces the existing single workspace enablement (the previous one is removed).

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(federation_rule_id:, applies_to_all_workspaces: nil, attributes: nil, description: nil, match: nil, name: nil, oauth_scope: nil, target: nil, token_lifetime_seconds: nil, workspace_id: nil, betas: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see RuleUpdateParams for more details.

• #to_hash ⇒ {

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

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

Parameters:

• federation_rule_id (String) —

  ID of the federation rule to update.

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

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

• attributes (Hash{Symbol=>String}, nil) (defaults to: nil) —

  Replaces the CEL expressions {name: expr} extracting named values from claims.

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

  Replaces the description. Omit to leave unchanged; send null to clear (the fie

• match (Anthropic::Models::Beta::Organization::Federation::BetaFederationRuleMatch, nil) (defaults to: nil) —

  Does the incoming JWT qualify?

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

  Replaces the slug identifier (lowercase, digits, hyphens). Unique within the org

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

  Replaces the space-separated OAuth scopes granted on minted tokens. OAuth caller

• target (Anthropic::Models::Beta::Organization::Federation::BetaServiceAccountTarget, nil) (defaults to: nil) —

  Bind to a fixed service account by ID.

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

  Replaces the lifetime in seconds for access tokens minted via this rule (60-8640

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

  Replaces the existing single workspace enablement (the previous one is removed).

• betas (Array<String, Symbol, Anthropic::Models::AnthropicBeta>) (defaults to: nil) —

  Optional header to specify the beta version(s) you want to use.

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

# File 'lib/anthropic/models/beta/organization/federation/rule_update_params.rb', line 104

Instance Attribute Details

#applies_to_all_workspaces ⇒ Boolean^?

When true, enables this rule for every workspace in the org (including workspaces created later). Setting false is rejected with 400 if no workspace would remain enabled; a rule with only a legacy workspace_id binding continues to mint.

Parameters:

• value (Boolean, nil)

Returns:

• (Boolean, nil)

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

optional :applies_to_all_workspaces, Anthropic::Internal::Type::Boolean, nil?: true

#attributes ⇒ Hash{Symbol=>String}^?

Replaces the CEL expressions {name: expr} extracting named values from claims. Send null to clear them. Not yet supported; any non-empty value is rejected with 400.

Parameters:

• value (::Hash[Symbol, String], nil)

Returns:

• (Hash{Symbol=>String}, nil)

# File 'lib/anthropic/models/beta/organization/federation/rule_update_params.rb', line 34

optional :attributes, Anthropic::Internal::Type::HashOf[String], nil?: true

#betas ⇒ Array<String, Symbol, Anthropic::Models::AnthropicBeta>^?

Optional header to specify the beta version(s) you want to use.

Returns:

• (Array<String, Symbol, Anthropic::Models::AnthropicBeta>, nil)

# File 'lib/anthropic/models/beta/organization/federation/rule_update_params.rb', line 102

optional :betas, -> { Anthropic::Internal::Type::ArrayOf[union: Anthropic::AnthropicBeta] }

#description ⇒ String^?

Replaces the description. Omit to leave unchanged; send null to clear (the field is stored as an empty string).

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/anthropic/models/beta/organization/federation/rule_update_params.rb', line 41

optional :description, String, nil?: true

#federation_rule_id ⇒ String

ID of the federation rule to update.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/anthropic/models/beta/organization/federation/rule_update_params.rb', line 17

required :federation_rule_id, String

#match ⇒ Anthropic::Models::Beta::Organization::Federation::BetaFederationRuleMatch^?

Does the incoming JWT qualify?

All populated fields must pass; omitted fields are skipped. 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::Beta::Organization::Federation::BetaFederationRuleMatch, nil)

Returns:

• (Anthropic::Models::Beta::Organization::Federation::BetaFederationRuleMatch, nil)

# File 'lib/anthropic/models/beta/organization/federation/rule_update_params.rb', line 51

optional :match,
-> {
  Anthropic::Beta::Organization::Federation::BetaFederationRuleMatch
},
nil?: true

#name ⇒ String^?

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

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :name, String, nil?: true

#oauth_scope ⇒ String^?

Replaces the space-separated OAuth scopes granted on minted tokens. OAuth callers may only set workspace:developer or workspace:inference; other scopes (such as org:admin) require a Console session.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/anthropic/models/beta/organization/federation/rule_update_params.rb', line 70

optional :oauth_scope, String, nil?: true

#target ⇒ Anthropic::Models::Beta::Organization::Federation::BetaServiceAccountTarget^?

Bind to a fixed service account by ID.

Parameters:

• value (Anthropic::Beta::Organization::Federation::BetaServiceAccountTarget, nil)

Returns:

• (Anthropic::Models::Beta::Organization::Federation::BetaServiceAccountTarget, nil)

# File 'lib/anthropic/models/beta/organization/federation/rule_update_params.rb', line 76

optional :target,
-> {
  Anthropic::Beta::Organization::Federation::BetaServiceAccountTarget
},
nil?: true

#token_lifetime_seconds ⇒ Integer^?

Replaces the lifetime in seconds for access tokens minted via this rule (60-86400). Minted tokens are capped at max(60, min(this value, 2 × remaining assertion validity)) seconds.

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

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

optional :token_lifetime_seconds, Integer, nil?: true

#workspace_id ⇒ String^?

Replaces the existing single workspace enablement (the previous one is removed). Rejected with 400 if the rule is enabled for more than one workspace; use the /federation_rules/{federation_rule_id}/workspaces sub-resource instead.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/anthropic/models/beta/organization/federation/rule_update_params.rb', line 96

optional :workspace_id, String, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/anthropic/models/beta/organization/federation/rule_update_params.rbs', line 67

def to_hash: -> {