UpdateItems

Updates group mapping items for a specified federation Errors:

• if federation is not found
• if internal group in the mapping added does not exist In case of any error, no changes are applied to existing group mapping

This call is idempotent. The following actions do nothing:

• adding group mapping items that are already present
• removing group mapping items that are not present Such parts of request will be ignored. Others will be applied.

TypeScript

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

const GroupMappingItemDelta_Action =
  cloudApi.organizationmanager.group_mapping_service
    .GroupMappingItemDelta_Action;
const UpdateGroupMappingItemsRequest =
  cloudApi.organizationmanager.group_mapping_service
    .UpdateGroupMappingItemsRequest;
const UpdateGroupMappingItemsResponse =
  cloudApi.organizationmanager.group_mapping_service
    .UpdateGroupMappingItemsResponse;

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

  const operation = await client.updateItems(
    UpdateGroupMappingItemsRequest.fromPartial({
      federationId: "federationId",
      // groupMappingItemDeltas: [{
      // item: {
      // externalGroupId: "externalGroupId",
      // internalGroupId: "internalGroupId"
      // },
      // action: GroupMappingItemDelta_Action.ADD
      // }]
    })
  );
  const finishedOp = await waitForOperation(operation, session);

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

Python

import os
import grpc
import yandexcloud

from yandex.cloud.organizationmanager.v1.group_mapping_pb2 import GroupMappingItem
from yandex.cloud.organizationmanager.v1.group_mapping_service_pb2 import GroupMappingItemDelta
from yandex.cloud.organizationmanager.v1.group_mapping_service_pb2_grpc import (
    GroupMappingServiceStub,
)
from yandex.cloud.organizationmanager.v1.group_mapping_service_pb2 import (
    UpdateGroupMappingItemsMetadata,
)
from yandex.cloud.organizationmanager.v1.group_mapping_service_pb2 import (
    UpdateGroupMappingItemsRequest,
)
from yandex.cloud.organizationmanager.v1.group_mapping_service_pb2 import (
    UpdateGroupMappingItemsResponse,
)

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(GroupMappingServiceStub)
operation = service.UpdateItems(
    UpdateGroupMappingItemsRequest(
        federation_id="federationId",
        # group_mapping_item_deltas = [GroupMappingItemDelta(
        # item = GroupMappingItem(
        # external_group_id = "externalGroupId",
        # internal_group_id = "internalGroupId"
        # ),
        # action = GroupMappingItemDelta.Action.ADD
        # )]
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=UpdateGroupMappingItemsResponse,
    meta_type=UpdateGroupMappingItemsMetadata,
)
print(operation_result)

UpdateGroupMappingItemsRequest

Request for updating group mapping configuration

federationId : string

Federation the group mapping update is requested

groupMappingItemDeltas : GroupMappingItemDelta

A collection of mapping items to add or remove (ignores update_fields).

GroupMappingItemDelta

Message describes the user's request to change (add or remove) a single group mapping.

Action

• ACTION_UNSPECIFIED

• ADD

  Group mapping item is to be added

• REMOVE

  Group mapping item is to be removed

item : GroupMappingItem

action : Action

GroupMappingItem

Group mapping represents which external (federated) groups should match which internal (cloud) groups

externalGroupId : string

External group id (received from identity provider)

internalGroupId : string

Internal cloud group id

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.

---