> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nebius.com/llms.txt
> Use this file to discover all available pages before exploring further.

# update

<div>
  <h2>Name</h2>

  <p style={{ paddingLeft: "4ch" }}>
    <code>nebius iam federation update</code>
  </p>

  <p style={{ paddingLeft: "7ch" }}>
    Updates a federation.
  </p>
</div>

<div>
  <h2>Synopsis</h2>

  <p style={{ paddingLeft: "4ch" }}>
    ```
    nebius iam federation update [id]
      --active
      --id
      --labels
      --labels-add
      --labels-remove
      --name
      --parent-id
      --resource-version
      --saml-settings-force-authn
      --saml-settings-idp-issuer
      --saml-settings-sso-url
      --status-certificates-count
      --status-state
      --status-users-count
      --user-account-auto-creation
      --async
      --clear-mask
      --diff
      --full
      --patch
    ```
  </p>
</div>

<div>
  <h2>Positional Arguments</h2>

  <p style={{ paddingLeft: "4ch" }}>
    <code>id</code>
  </p>

  <p style={{ paddingLeft: "8ch" }}>
    Identifier for the resource, unique for its resource type.
  </p>
</div>

<div>
  <h2>Options</h2>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--active` (bool)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Specifies if the federation in active state.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--id` (string)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Identifier for the resource, unique for its resource type.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--labels` (string->string)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Labels associated with the resource.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--labels-add` (string->string)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Add values to Labels associated with the resource.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--labels-remove` (string array)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Remove values from Labels associated with the resource.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--name` (string)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Human readable name for the resource.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--parent-id` (string)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Identifier of the parent resource to which the resource belongs.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--resource-version` (int64)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Version of the resource for safe concurrent modifications and consistent reads.<br />
      Positive and monotonically increases on each resource spec change (but *not* on each change of the<br />
      resource's container(s) or status).<br />
      Service allows zero value or current.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--saml-settings-force-authn` (bool)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      If "true", the identity provider MUST authenticate the presenter directly rather than rely on a previous security context.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--saml-settings-idp-issuer` (string)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      The unique identifier of the SAML Identity Provider. It usually matches the entityID from the IdP metadata.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--saml-settings-sso-url` (string)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Identity Provider’s Single Sign-On endpoint. This is the URL where the user is redirected to start SAML login.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--status-certificates-count` (int32)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Number of certificates attached to the SAML federation for verifying SAML responses.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--status-state` (string)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Federation state.
    </p>

    <p style={{ paddingLeft: "4ch" }}>A value must be one of:</p>

    <ul style={{ paddingLeft: "8ch" }}>
      <li>
        <code>unspecified</code>
      </li>

      <li>
        <code>active</code>
      </li>

      <li>
        <code>inactive</code>
      </li>
    </ul>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--status-users-count` (int32)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Number of users registered in the IAM federation. This value may differ from the number of users in the identity provider.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--user-account-auto-creation` (bool)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      If false, users with access to the federation cannot sign in automatically<br />
      and user accounts for them must be pre-created by a federation administrator.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--async` (bool)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      If set, returns operation id. Otherwise, waits for the operation to complete and returns its resource.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--clear-mask` (string array)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Reset-mask field paths to clear in patch mode. Can be repeated.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--diff` (bool)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Show diff of resource before commiting update.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--full` (bool)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Update full resource state. Automatically set to true if the --file or argument provided.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--patch` (bool)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Update only specified fields.
    </p>
  </div>
</div>

<div>
  <h2>Global Options</h2>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `-h, --help` (bool)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Show this message.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `-p, --profile` (string)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Set a profile for interacting with the cloud.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--format` (string)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Output format. Supported values: yaml|json|jsonpath|table|text.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `-f, --file` (string)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Input file. For 'update' commands automatically set --full=true.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `-c, --config` (string)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Provide path to config file.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--debug` (bool)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Enable debug logs.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--color` (bool)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Enable colored output.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--no-browser` (bool)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Do not open browser automatically on auth.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--insecure` (bool)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Disable transport security.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--auth-timeout` (duration: 2h30m10s)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Set the timeout for the request including authentication process, default is 15m0s.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--per-retry-timeout` (duration: 2h30m10s)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Set the timeout for each retry attempt, default is 20s.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--retries` (uint)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Set the number of retry attempts, 1 is disable retries, default is 3.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--timeout` (duration: 2h30m10s)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Set the timeout for the main request, default is 1m0s.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--no-check-update` (bool)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Suppress check for updates.
    </p>
  </div>

  <div style={{ paddingLeft: "4ch" }}>
    <p>
      `--no-progress` (bool)
    </p>

    <p style={{ paddingLeft: "4ch" }}>
      Suppress progress indicators and spinners.
    </p>
  </div>
</div>

<Expandable title="Input argument JSON Schema">
  <Tabs>
    <Tab title="Full">
      ```json theme={null}
      {              
        "metadata": {                // Federation resource metadata.
          "id": string,              // [identifier]
                                     // Identifier for the resource, unique for its resource type.
          "labels": {                // [map]
                                     // Labels associated with the resource.
            string: string                  
          },
          "name": string,            // Human readable name for the resource.
          "parent_id": string,       // [required]
                                     // Identifier of the parent resource to which the resource belongs.
          "resource_version": int64  // Version of the resource for safe concurrent modifications and consistent reads.
                                     // Positive and monotonically increases on each resource spec change (but *not* on each change of the
                                     // resource's container(s) or status).
                                     // Service allows zero value or current.
        },
        "spec": {                             // Federation resource specification.
          "active": bool,                     // [deprecated]
                                              // 'active' field ignored. Use 'Activate/Deactivate' methods to manage federation state. A newly created federation is always active by default. Specifies if the federation in active state.
          "saml_settings": {      // SAML federation settings.
            "force_authn": bool,  // If "true", the identity provider MUST authenticate the presenter directly rather than rely on a previous security context.
            "idp_issuer": string, // The unique identifier of the SAML Identity Provider. It usually matches the entityID from the IdP metadata.
            "sso_url": string     // Identity Provider’s Single Sign-On endpoint. This is the URL where the user is redirected to start SAML login.
          },
          "user_account_auto_creation": bool  // If false, users with access to the federation cannot sign in automatically
                                              // and user accounts for them must be pre-created by a federation administrator.
        },
        "status": {                    // [deprecated]
                                       // 'status' is ignored for update requests.
          "certificates_count": int32, // Number of certificates attached to the SAML federation for verifying SAML responses.
          "state": enum(   // Federation state.
            "UNSPECIFIED",
            "ACTIVE",     
            "INACTIVE"    
          ),
          "users_count": int32         // Number of users registered in the IAM federation. This value may differ from the number of users in the identity provider.
        }
      }
      ```
    </Tab>

    <Tab title="CopyPaste Friendly">
      ```json theme={null}
      nebius iam federation update '
      {              
        "metadata": {           
          "id": "",             
          "labels": {           
            "": ""                  
          },
          "name": "",           
          "parent_id": "",      
          "resource_version": 0 
        },
        "spec": {                             
          "active": false,                    
          "saml_settings": {     
            "force_authn": false,
            "idp_issuer": "",    
            "sso_url": ""        
          },
          "user_account_auto_creation": false 
        },
        "status": {                                 
          "certificates_count": 0,                  
          "state": "unspecified"|"active"|"inactive",
          "users_count": 0                          
        }
      }
      '
      ```
    </Tab>
  </Tabs>
</Expandable>

<strong>Auto generated on 19-May-2026</strong>