# IRPCUserGroupsAdmin.GetUserGroupSyncStatus

Location: [gRPC API](https://developer.m-files.com/APIs/gRPC-API/index.md) > [Administration API](https://developer.m-files.com/APIs/gRPC-API/admin/index.md) > [User groups](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCUserGroupsAdmin/index.md)

HTML version: https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCUserGroupsAdmin/GetUserGroupSyncStatus/

Badges: `Administration API / specialized` `admin` `session`

Gets the result of the last synchronization of an external Windows group.

- **Service:** [User groups](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCUserGroupsAdmin/index.md) `MFiles.IRPCUserGroupsAdmin`
- **gRPC method:** `/MFiles.IRPCUserGroupsAdmin/GetUserGroupSyncStatus`
- **HTTP (mf-http-grpc):** `POST /grpc/v1/get-user-group-sync-status`
- **Request:** [`GetUserGroupSyncStatusRequest`](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCUserGroupsAdmin/GetUserGroupSyncStatus/index.md#request)
- **Response:** [`GetUserGroupSyncStatusResponse`](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCUserGroupsAdmin/GetUserGroupSyncStatus/index.md#response)
- **Book and level:** Administration API, specialized
- **Kind:** admin
- **Session:** Required: the session ID from LogIn in the mfiles-session-id-bin metadata.
- **Idempotent:** no
- **Returns metadata structure version:** no
- **Streaming:** none (unary)

<a id="remarks"></a>

## Remarks

- Requires the vault right `manage_users`.
- The response has no `status` when nothing has been recorded for the group, including groups
  that are not external Windows groups and unknown IDs; it does not fail.

<a id="request"></a>

## Request: GetUserGroupSyncStatusRequest

Request structure for the GetUserGroupSyncStatus method.

> Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

| Field | Type | Description |
|---|---|---|
| `user_group` | `int32` | The ID of the user group. |

<a id="response"></a>

## Response: GetUserGroupSyncStatusResponse

Response structure for the GetUserGroupSyncStatus method.

> Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

| Field | Type | Description |
|---|---|---|
| `status` | [`UserGroupSyncStatus`](https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/MFiles.UserGroupSyncStatus/index.md) | The last synchronization: time, synchronized and skipped user counts, and errors. Unset if none is recorded. |
| `status.user_group_id` | `int32` | The ID of the user group. |
| `status.last_run_timestamp` | [`google.protobuf.Timestamp`](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp) | The last run timestamp. |
| `status.synchronized_user_count` | `int32` | The count of synchronized users. |
| `status.skipped_user_count` | `int32` | The count of skipped users. |
| `status.last_errors` | `string` | Error string from the last run (if any). |