IRPCSubstituteUsers.GetSubstituteUsersOfUser
Vault API / standard read session idempotent returns metadata structure version
Gets the substitutes of any user (administration).
| Service | Substitute users MFiles.IRPCSubstituteUsers |
|---|---|
| gRPC method | /MFiles.IRPCSubstituteUsers/GetSubstituteUsersOfUser |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-substitute-users-of-user |
| Request | GetSubstituteUsersOfUserRequest |
| Response | GetSubstituteUsersOfUserResponse |
| Book and level | Vault API, standard |
| Kind | read |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Remarks
- Requires the vault right
manage_users; other users get "Access denied.". - An unknown user ID returns an empty list.
Request: GetSubstituteUsersOfUserRequest
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_id | int32 | The ID of the user whose substitutes are wanted. |
Response: GetSubstituteUsersOfUserResponse
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 |
|---|---|---|
substitutes[] | repeated UserOrUserGroupID | The users and user groups who substitute for that user. |
substitutes[].type | UserType | User type.Values: USER_TYPE_UNKNOWN (0), USER_TYPE_USER (1), USER_TYPE_USER_GROUP (2), USER_TYPE_WORKFLOW_STATE_PSEUDO_USER (3), USER_TYPE_PROPERTY_BASED_PSEUDO_USER (4). |
substitutes[].id | int32 | User or user group. |
Related methods
- GetSubstituteUsers -- Gets the substitutes of the calling user.