Identity Hub API, gRPC: 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.
gRPC request
rpc Get (GetGroupMappingRequest) returns (GetGroupMappingResponse)
GetGroupMappingRequest
{
"federation_id": "string"
}
|
Field |
Description |
|
federation_id |
string Required field. The maximum string length in characters is 50. |
GetGroupMappingResponse
{
"group_mapping": {
"federation_id": "string",
"enabled": "bool"
}
}
|
Field |
Description |
|
group_mapping |
GroupMapping
Group synchronization status for a specific federation
Absence of this object for a federation means that there is no group synchronization set of for the federation.
|
Field |
Description |
|
federation_id |
string Federation id |
|
enabled |
bool Flag to show whether group synchronization should be enabled for this federation. |