IRPCExtensionAuthentications.StoreExtensionAuthenticationCredentials

View as Markdown

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.

ServiceExtension authentications MFiles.IRPCExtensionAuthentications
gRPC method/MFiles.IRPCExtensionAuthentications/StoreExtensionAuthenticationCredentials
HTTP (mf-http-grpc)POST /grpc/v1/store-extension-authentication-credentials
RequestStoreExtensionAuthenticationCredentialsRequest
ResponseStoreExtensionAuthenticationCredentialsResponse
Book and levelVault API, standard
Kindwrite
SessionRequired: the session ID from LogIn in the mfiles-session-id-bin metadata.
Idempotentno
Returns metadata structure versionyes (in the mfiles-metadata-version-bin trailer)
Streamingnone (unary)

Remarks

Request: StoreExtensionAuthenticationCredentialsRequest

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

FieldTypeDescription
targetstringThe id of the target, from GetExtensionAuthenticationTargets.
authentication_dataExtensionAuthenticationResponseThe credentials. See ExtensionAuthenticationResponse.
authentication_data.plugin_configurationstringThe name of the authentication method, from the target's supported_plugins.
authentication_data.data[]repeated NamedValueThe 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[].keystringThe name of the value.
authentication_data.data[].valueTypedValueThe value as a serialized bytearray.

Response: StoreExtensionAuthenticationCredentialsResponse

No fields.