Cloud Organization API, gRPC: GroupMappingService
RPC service dedicated for federation group mapping.
Call | Description |
---|---|
Get | Returns a group mapping configured for the specific federation If a federation does not exist this call will return an error NOT_FOUND will be returned If a federation exist, but has not ever been configured for group mapping the call FAILED_PRECONDITION will be returned. |
Create | Adds a group mapping for a federation If mapping already exist, ALREADY_EXISTS will be returned |
Update | Updates an existing group mapping for a federation Errors: - if federation is not found In case of any error, no changes are applied to existing group mapping This call is idempotent. |
Delete | Deletes a group mapping. |
ListItems | Returns all the group mappings items Filtering is only supported by external_group_id or internal_group_id |
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. |
Calls GroupMappingService
Get
Returns a group mapping configured for the specific federation If a federation does not exist this call will return an error NOT_FOUND will be returned If a federation exist, but has not ever been configured for group mapping the call FAILED_PRECONDITION will be returned.
rpc Get (GetGroupMappingRequest) returns (GetGroupMappingResponse)
GetGroupMappingRequest
Field | Description |
---|---|
federation_id | string Required. The maximum string length in characters is 50. |
GetGroupMappingResponse
Field | Description |
---|---|
group_mapping | GroupMapping |
GroupMapping
Field | Description |
---|---|
federation_id | string Federation id |
enabled | bool Flag to show whether group synchronization should be enabled for this federation. |
Create
Adds a group mapping for a federation If mapping already exist, ALREADY_EXISTS will be returned
rpc Create (CreateGroupMappingRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateGroupMappingMetadata
Operation.response:GroupMapping
CreateGroupMappingRequest
Field | Description |
---|---|
federation_id | string Required. Federation the group mapping will be created for The maximum string length in characters is 50. |
enabled | bool Synchronization status. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
CreateGroupMappingMetadata
Field | Description |
---|---|
federation_id | string |
GroupMapping
Field | Description |
---|---|
federation_id | string Federation id |
enabled | bool Flag to show whether group synchronization should be enabled for this federation. |
Update
Updates an existing group mapping for a federation Errors:
- if federation is not found
This call is idempotent. The following actions do nothing:
- enabling when already enabled
- disabling when disabled
rpc Update (UpdateGroupMappingRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateGroupMappingMetadata
Operation.response:GroupMapping
UpdateGroupMappingRequest
Field | Description |
---|---|
federation_id | string Required. Federation the group mapping update is requested The maximum string length in characters is 50. |
update_mask | google.protobuf.FieldMask A set of fields that should be updated |
enabled | bool A new state of synchronization to update (if mentioned in update_mask). |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateGroupMappingMetadata
Field | Description |
---|---|
federation_id | string |
GroupMapping
Field | Description |
---|---|
federation_id | string Federation id |
enabled | bool Flag to show whether group synchronization should be enabled for this federation. |
Delete
Deletes a group mapping. This will remove all the mapping items cascade.
rpc Delete (DeleteGroupMappingRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteGroupMappingMetadata
Operation.response:google.protobuf.Empty
DeleteGroupMappingRequest
Field | Description |
---|---|
federation_id | string Required. Federation the group mapping deletion is requested The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteGroupMappingMetadata
Field | Description |
---|---|
federation_id | string |
ListItems
Returns all the group mappings items
Filtering is only supported by external_group_id or internal_group_id
rpc ListItems (ListGroupMappingItemsRequest) returns (ListGroupMappingItemsResponse)
ListGroupMappingItemsRequest
Field | Description |
---|---|
federation_id | string Required. The maximum string length in characters is 50. |
page_size | int64 Acceptable values are 0 to 1000, inclusive. |
page_token | string The maximum string length in characters is 2000. |
filter | string The maximum string length in characters is 1000. |
ListGroupMappingItemsResponse
Field | Description |
---|---|
group_mapping_items[] | GroupMappingItem |
next_page_token | string |
GroupMappingItem
Field | Description |
---|---|
external_group_id | string Required. External group id (received from identity provider) The maximum string length in characters is 1000. |
internal_group_id | string Required. Internal cloud group id The maximum string length in characters is 50. |
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
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
rpc UpdateItems (UpdateGroupMappingItemsRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateGroupMappingItemsMetadata
Operation.response:UpdateGroupMappingItemsResponse
UpdateGroupMappingItemsRequest
Field | Description |
---|---|
federation_id | string Required. Federation the group mapping update is requested The maximum string length in characters is 50. |
group_mapping_item_deltas[] | GroupMappingItemDelta A collection of mapping items to add or remove (ignores update_fields). The number of elements must be in the range 1-1000. |
GroupMappingItemDelta
Field | Description |
---|---|
item | GroupMappingItem |
action | enum Action
|
GroupMappingItem
Field | Description |
---|---|
external_group_id | string Required. External group id (received from identity provider) The maximum string length in characters is 1000. |
internal_group_id | string Required. Internal cloud group id The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateGroupMappingItemsMetadata
Field | Description |
---|---|
federation_id | string |
UpdateGroupMappingItemsResponse
Field | Description |
---|---|
group_mapping_item_deltas[] | GroupMappingItemDelta Effective changes that were applied |