Skip to main content

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.

​
Name

nebius iam federation update

Updates a federation.

​
Synopsis

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

​
Positional Arguments

id

Identifier for the resource, unique for its resource type.

​
Options

--active (bool)

Specifies if the federation in active state.

--id (string)

Identifier for the resource, unique for its resource type.

--labels (string->string)

Labels associated with the resource.

--labels-add (string->string)

Add values to Labels associated with the resource.

--labels-remove (string array)

Remove values from Labels associated with the resource.

--name (string)

Human readable name for the resource.

--parent-id (string)

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.

--saml-settings-force-authn (bool)

If “true”, the identity provider MUST authenticate the presenter directly rather than rely on a previous security context.

--saml-settings-idp-issuer (string)

The unique identifier of the SAML Identity Provider. It usually matches the entityID from the IdP metadata.

--saml-settings-sso-url (string)

Identity Provider’s Single Sign-On endpoint. This is the URL where the user is redirected to start SAML login.

--status-certificates-count (int32)

Number of certificates attached to the SAML federation for verifying SAML responses.

--status-state (string)

Federation state.

A value must be one of:

  • unspecified
  • active
  • inactive

--status-users-count (int32)

Number of users registered in the IAM federation. This value may differ from the number of users in the identity provider.

--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.

--async (bool)

If set, returns operation id. Otherwise, waits for the operation to complete and returns its resource.

--clear-mask (string array)

Reset-mask field paths to clear in patch mode. Can be repeated.

--diff (bool)

Show diff of resource before commiting update.

--full (bool)

Update full resource state. Automatically set to true if the —file or argument provided.

--patch (bool)

Update only specified fields.

​
Global Options

-h, --help (bool)

Show this message.

-p, --profile (string)

Set a profile for interacting with the cloud.

--format (string)

Output format. Supported values: yaml|json|jsonpath|table|text.

-f, --file (string)

Input file. For ‘update’ commands automatically set —full=true.

-c, --config (string)

Provide path to config file.

--debug (bool)

Enable debug logs.

--color (bool)

Enable colored output.

--no-browser (bool)

Do not open browser automatically on auth.

--insecure (bool)

Disable transport security.

--auth-timeout (duration: 2h30m10s)

Set the timeout for the request including authentication process, default is 15m0s.

--per-retry-timeout (duration: 2h30m10s)

Set the timeout for each retry attempt, default is 20s.

--retries (uint)

Set the number of retry attempts, 1 is disable retries, default is 3.

--timeout (duration: 2h30m10s)

Set the timeout for the main request, default is 1m0s.

--no-check-update (bool)

Suppress check for updates.

--no-progress (bool)

Suppress progress indicators and spinners.