Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Cloud Organization API, gRPC: GroupMappingService.UpdateItems

Written by
Updated at October 17, 2024

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.

gRPC request

rpc UpdateItems (UpdateGroupMappingItemsRequest) returns (operation.Operation)

UpdateGroupMappingItemsRequest

{
  "federationId": "string",
  "groupMappingItemDeltas": [
    {
      "item": {
        "externalGroupId": "string",
        "internalGroupId": "string"
      },
      "action": "Action"
    }
  ]
}

Request for updating group mapping configuration

Field

Description

federationId

string

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

Field

Description

item

GroupMappingItem

action

enum Action

  • ACTION_UNSPECIFIED
  • ADD: Group mapping item is to be added
  • REMOVE: Group mapping item is to be removed

GroupMappingItem

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

Field

Description

externalGroupId

string

Required field. External group id (received from identity provider)

internalGroupId

string

Required field. Internal cloud group id

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "federationId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "groupMappingItemDeltas": [
      {
        "item": {
          "externalGroupId": "string",
          "internalGroupId": "string"
        },
        "action": "Action"
      }
    ]
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

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

UpdateGroupMappingItemsMetadata

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.

error

google.rpc.Status

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

Includes only one of the fields error, response.

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.

response

UpdateGroupMappingItemsResponse

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.

Includes only one of the fields error, response.

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.

UpdateGroupMappingItemsMetadata

Field

Description

federationId

string

UpdateGroupMappingItemsResponse

Field

Description

groupMappingItemDeltas[]

GroupMappingItemDelta

Effective changes that were applied

GroupMappingItemDelta

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

Field

Description

item

GroupMappingItem

action

enum Action

  • ACTION_UNSPECIFIED
  • ADD: Group mapping item is to be added
  • REMOVE: Group mapping item is to be removed

GroupMappingItem

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

Field

Description

externalGroupId

string

Required field. External group id (received from identity provider)

internalGroupId

string

Required field. Internal cloud group id
Previous
ListItems
Next
Overview