IRPCExtensionAuthentications.StoreExtensionAuthenticationCredentials
Vault API / standard write session returns metadata structure version
Logs the caller in to an external system by storing the caller's credentials for it.
| Service | Extension authentications MFiles.IRPCExtensionAuthentications |
|---|---|
| gRPC method | /MFiles.IRPCExtensionAuthentications/StoreExtensionAuthenticationCredentials |
| HTTP (mf-http-grpc) | POST /grpc/v1/store-extension-authentication-credentials |
| Request | StoreExtensionAuthenticationCredentialsRequest |
| Response | StoreExtensionAuthenticationCredentialsResponse |
| 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 a vault session of a user; anonymous sessions fail.
targetmust not be empty ("The parameter is incorrect. (Invalid target name.)"). - Replaces credentials already stored for the caller and the target.
- The credentials travel in clear text inside the message. Use this method only over TLS.
- Use this method rather than LoginWithExtensionAuthentication, which expects encrypted data.
Request: StoreExtensionAuthenticationCredentialsRequest
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 |
|---|---|---|
target | string | The id of the target, from GetExtensionAuthenticationTargets. |
authentication_data | ExtensionAuthenticationResponse | The credentials. See ExtensionAuthenticationResponse. |
authentication_data.plugin_configuration | string | The name of the authentication method, from the target's supported_plugins. |
authentication_data.data[] | repeated NamedValue | The credentials as named text values, as the authentication method expects them. For a user name and password, M-Files clients send username and password; for tokens, Token and RefreshToken. |
authentication_data.data[].key | string | The name of the value. |
authentication_data.data[].value | TypedValue | The value as a serialized bytearray. |
Response: StoreExtensionAuthenticationCredentialsResponse
No fields.
Related methods
- LoginWithExtensionAuthentication -- Logs the caller in to an external system with encrypted credentials.