IRPCSubstituteUsers.GetSubstituteUsers
Vault API / standard read session idempotent returns metadata structure version
Gets the substitutes of the calling user.
| Service | Substitute users MFiles.IRPCSubstituteUsers |
|---|---|
| gRPC method | /MFiles.IRPCSubstituteUsers/GetSubstituteUsers |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-substitute-users |
| Request | GetSubstituteUsersRequest |
| Response | GetSubstituteUsersResponse |
| 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 a vault session. No special vault rights are needed.
- The list contains users and user groups, in no specified order. It is empty when the user has no substitutes or substitution is turned off on the server.
Request: GetSubstituteUsersRequest
No fields.
Response: GetSubstituteUsersResponse
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 (USER_TYPE_USER) and user groups (USER_TYPE_USER_GROUP) who substitute for the caller. |
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
- GetSubstituteUsersOfUser -- Gets the substitutes of any user (administration).