SecretConfig examples for API/Resource/Record

Aron_Semle · October 29, 2025, 6:32pm

Is there an 8.3 example for using a password in a SettingsRecord and SettingsResource through the API? I want the user to be able to configure a token (password) for my module. My SettingsRecord uses an EncodedStringField type. Currently my SettingsResource treats the token as a String (which is probably wrong).

Using chrome debug I was able to figure out to call the /data/api/v1/encryption/encrypt endpoint to encrypt the token. I then send via a PUT to update my record over the API and I get a 422. I’m pretty sure I need to change my SettingsResource to pass the JSON through to the record… but I am struggling. Any examples of custom records –> API –> react app would be hugely useful.

paul-griffith · October 29, 2025, 6:53pm

EncodedStringField/XResource are all legacy and are only relevant for migration in 8.3.
The thing to use now is SecretConfig.

SDK guide:

Example:

github.com/inductiveautomation/ignition-sdk-examples

user-source-profile/user-source-gateway/src/main/java/com/inductiveautomation/ignition/examples/usersource/mongodb/MongoDbUserSourceResource.java

f9aa67377

package com.inductiveautomation.ignition.examples.usersource.mongodb;

import com.inductiveautomation.ignition.common.resourcecollection.ResourceType;
import com.inductiveautomation.ignition.gateway.config.ResourceTypeMeta;
import com.inductiveautomation.ignition.gateway.dataroutes.openapi.annotations.*;
import com.inductiveautomation.ignition.gateway.secrets.SecretConfig;
import com.inductiveautomation.ignition.gateway.web.nav.FormFieldType;
import org.apache.commons.lang3.StringUtils;

/**
 * Configuration for a MongoDB user source profile. This resource will be persisted to disk as part of the user
 * source profile config.
 */
public record MongoDbUserSourceResource(
        @FormCategory("CUSTOM SETTINGS")
        @Label("Connection String")
        @FormField(FormFieldType.TEXT)
        @DefaultValue("mongodb://localhost:27017")
        @Required
//        @DescriptionKey("MongoDbUserSourceResource.connectionString.Desc")

This file has been truncated. show original

Aron_Semle · October 29, 2025, 7:16pm

Got it and thank you! Does this mean the old Records are gone? Said another way, using the resource alone the properties are persisted in the modules data/config/resources/core/your_namespace/your_settings_bucket/config.json file?

Aron_Semle · October 29, 2025, 8:12pm

That looks to be the case. Thanks again. One last question, is there a JavaScript helper you have to handle the SecretConfig form & API call?

Kevin.Herron · October 29, 2025, 8:17pm

I have no idea how anything front end is documented or supposed to be discoverable, but I think there's a PasswordInput react component in the public web UI stuff that is meant to be used with SecretConfig on the backend.

Kevin.Herron · October 29, 2025, 8:18pm

Hmm, not listed here...

ayu · November 6, 2025, 10:47pm

Hi @Aron_Semle,

Like Kevin mentioned above, we use the React component PasswordInput under the hood when the decorator @FormField(FormFieldType.SECRET) is applied to your class field. Currently the React component is not available for public consumption, but we are taking steps to get those components ready. Thanks.