IRPCExtensionAuthentications.StoreExtensionAuthenticationSpecialCredentials
Vault API / standard write session returns metadata structure version
Stores vault-wide credentials for an external system: the common, background or permission-reading account. Used by vault administration tools.
| Service | Extension authentications MFiles.IRPCExtensionAuthentications |
|---|---|
| gRPC method | /MFiles.IRPCExtensionAuthentications/StoreExtensionAuthenticationSpecialCredentials |
| HTTP (mf-http-grpc) | POST /grpc/v1/store-extension-authentication-special-credentials |
| Request | StoreExtensionAuthenticationSpecialCredentialsRequest |
| Response | StoreExtensionAuthenticationSpecialCredentialsResponse |
| Book and level | Vault API, standard |
| Kind | write |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Remarks
- Requires full control of the vault; other users get "Access denied.".
- The credentials must be encrypted in a format internal to the M-Files clients; data that the server cannot decrypt fails with "The parameter is incorrect.".
Request: StoreExtensionAuthenticationSpecialCredentialsRequest
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 |
|---|---|---|
eeasut | ExtensionAuthenticationSpecialUserType | Which vault-wide account to set: EXTENSION_AUTHENTICATION_SPECIAL_USER_TYPE_COMMON, EXTENSION_AUTHENTICATION_SPECIAL_USER_TYPE_BACKGROUND or EXTENSION_AUTHENTICATION_SPECIAL_USER_TYPE_PERMISSIONS.Values: EXTENSION_AUTHENTICATION_SPECIAL_USER_TYPE_NORMAL (0), EXTENSION_AUTHENTICATION_SPECIAL_USER_TYPE_COMMON (1), EXTENSION_AUTHENTICATION_SPECIAL_USER_TYPE_BACKGROUND (2), EXTENSION_AUTHENTICATION_SPECIAL_USER_TYPE_PERMISSIONS (3). |
target | string | The id of the target. |
ear_data_encrypted | bytes | The credentials, encrypted with the server's public key in a format internal to the M-Files clients. |
Response: StoreExtensionAuthenticationSpecialCredentialsResponse
No fields.