Skip to main content

Update

Updates the specified federation.

import {
  cloudApi,
  decodeMessage,
  serviceClients,
  Session,
  waitForOperation,
} from "@yandex-cloud/nodejs-sdk";

const Federation = cloudApi.iam.workload_oidc_federation.Federation;
const UpdateFederationRequest =
  cloudApi.iam.workload_oidc_federation_service.UpdateFederationRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.FederationServiceClient);

  const operation = await client.update(
    UpdateFederationRequest.fromPartial({
      federationId: "federationId",
      // updateMask: {
      // paths: ["paths"]
      // },
      // name: "name",
      // description: "description",
      // disabled: true,
      // audiences: ["audiences"],
      // jwksUrl: "jwksUrl",
      // labels: {"key": "labels"}
    })
  );
  const finishedOp = await waitForOperation(operation, session);

  if (finishedOp.response) {
    const result = decodeMessage<typeof Federation>(finishedOp.response);
    console.log(result);
  }
})();

UpdateFederationRequest​

federationId : string​

ID of the federation to update. To get the federation ID, make a FederationService.List request.

updateMask : google.protobuf.FieldMask​

Field mask that specifies which fields of the federation are going to be updated.

name : string​

Name of the federation. The name must be unique within the organization.

description : string​

Description of the federation.

cookieMaxAge : google.protobuf.Duration​

Browser cookie lifetime in seconds. If the cookie is still valid, the management console authenticates the user immediately and redirects them to the home page. The default value is 8h.

autoCreateAccountOnLogin : bool​

Add new users automatically on successful authentication. The user becomes member of the organization automatically, but you need to grant other roles to them.

If the value is false, users who aren't added to the organization can't log in, even if they have authenticated on your server.

issuer : string​

ID of the IdP server to be used for authentication. The IdP server also responds to IAM with this ID after the user authenticates.

ssoBinding : BindingType​

Single sign-on endpoint binding type. Most Identity Providers support the POST binding type.

SAML Binding is a mapping of a SAML protocol message onto standard messaging formats and/or communications protocols.

ssoUrl : string​

Single sign-on endpoint URL. Specify the link to the IdP login page here.

securitySettings : FederationSecuritySettings​

Federation security settings.

caseInsensitiveNameIds : bool​

Use case insensitive name ids.

labels : string​

Resource labels as key:value pairs.

FederationSecuritySettings​

Federation security settings.

encryptedAssertions : bool​

Enable encrypted assertions.

forceAuthn : bool​

Value parameter ForceAuthn in SAMLRequest.

Operation​

An Operation resource. For more information, see Operation.

id : string​

ID of the operation.

description : string​

Description of the operation. 0-256 characters long.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

createdBy : string​

ID of the user or service account who initiated the operation.

modifiedAt : google.protobuf.Timestamp​

The time when the Operation resource was last modified.

done : bool​

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadata : google.protobuf.Any​

Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.

One of result​

The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.

  • error : google.rpc.Status​

    The error result of the operation in case of failure or cancellation.

  • response : google.protobuf.Any​
    The normal response of the operation in case of success.

    If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.