@Parameter(description="Type of the Rule Node",schema=@Schema(allowableValues="ENRICHMENT,FILTER,TRANSFORMATION,ACTION,EXTERNAL",required=true))
@Parameter(description="Type of the Rule Node",schema=@Schema(allowableValues="ENRICHMENT,FILTER,TRANSFORMATION,ACTION,EXTERNAL",requiredMode=Schema.RequiredMode.REQUIRED))
publicTwoFaAccountConfiggenerateTwoFaAccountConfig(@Parameter(description="2FA provider type to generate new account config for",schema=@Schema(defaultValue="TOTP",required=true))
publicTwoFaAccountConfiggenerateTwoFaAccountConfig(@Parameter(description="2FA provider type to generate new account config for",schema=@Schema(defaultValue="TOTP",requiredMode=Schema.RequiredMode.REQUIRED))
@ -38,7 +38,7 @@ public class OAuth2BasicMapperConfig {
@Length(fieldName="lastNameAttributeKey",max=31)
@Schema(description="Last name attribute key")
privatefinalStringlastNameAttributeKey;
@Schema(description="Tenant naming strategy. For DOMAIN type, domain for tenant name will be taken from the email (substring before '@')",required=true)
@Schema(description="Tenant naming strategy. For DOMAIN type, domain for tenant name will be taken from the email (substring before '@')",requiredMode=Schema.RequiredMode.REQUIRED)
@ -32,7 +32,7 @@ public class OAuth2MapperConfig {
privatebooleanallowUserCreation;
@Schema(description="Whether user credentials should be activated when user is created after successful authentication")
privatebooleanactivateUser;
@Schema(description="Type of OAuth2 mapper. Depending on this param, different mapper config fields must be specified",required=true)
@Schema(description="Type of OAuth2 mapper. Depending on this param, different mapper config fields must be specified",requiredMode=Schema.RequiredMode.REQUIRED)
privateMapperTypetype;
@Valid
@Schema(description="Mapper config for BASIC and GITHUB mapper types")
@Schema(required=true,description="Index of rule node in the 'nodes' array of the RuleChainMetaData. Indicates the 'from' part of the connection.")
@Schema(requiredMode=Schema.RequiredMode.REQUIRED,description="Index of rule node in the 'nodes' array of the RuleChainMetaData. Indicates the 'from' part of the connection.")
privateintfromIndex;
@Schema(required=true,description="Index of rule node in the 'nodes' array of the RuleChainMetaData. Indicates the 'to' part of the connection.")
@Schema(requiredMode=Schema.RequiredMode.REQUIRED,description="Index of rule node in the 'nodes' array of the RuleChainMetaData. Indicates the 'to' part of the connection.")
privateinttoIndex;
@Schema(required=true,description="Type of the relation. Typically indicated the result of processing by the 'from' rule node. For example, 'Success' or 'Failure'")
@Schema(requiredMode=Schema.RequiredMode.REQUIRED,description="Type of the relation. Typically indicated the result of processing by the 'from' rule node. For example, 'Success' or 'Failure'")
@Schema(required=true,description="Index of rule node in the 'nodes' array of the RuleChainMetaData. Indicates the 'from' part of the connection.")
@Schema(requiredMode=Schema.RequiredMode.REQUIRED,description="Index of rule node in the 'nodes' array of the RuleChainMetaData. Indicates the 'from' part of the connection.")
privateintfromIndex;
@Schema(required=true,description="JSON object with the Rule Chain Id.")
@Schema(requiredMode=Schema.RequiredMode.REQUIRED,description="JSON object with the Rule Chain Id.")
privateRuleChainIdtargetRuleChainId;
@Schema(required=true,description="JSON object with the additional information about the connection.")
@Schema(requiredMode=Schema.RequiredMode.REQUIRED,description="JSON object with the additional information about the connection.")
privateJsonNodeadditionalInfo;
@Schema(required=true,description="Type of the relation. Typically indicated the result of processing by the 'from' rule node. For example, 'Success' or 'Failure'")
@Schema(requiredMode=Schema.RequiredMode.REQUIRED,description="Type of the relation. Typically indicated the result of processing by the 'from' rule node. For example, 'Success' or 'Failure'")
@Schema(required=true,description="JSON object with Rule Chain Id.",accessMode=Schema.AccessMode.READ_ONLY)
@Schema(requiredMode=Schema.RequiredMode.REQUIRED,description="JSON object with Rule Chain Id.",accessMode=Schema.AccessMode.READ_ONLY)
privateRuleChainIdruleChainId;
@Schema(required=true,description="Index of the first rule node in the 'nodes' list")
@Schema(requiredMode=Schema.RequiredMode.REQUIRED,description="Index of the first rule node in the 'nodes' list")
privateIntegerfirstNodeIndex;
@Schema(required=true,description="List of rule node JSON objects")
@Schema(requiredMode=Schema.RequiredMode.REQUIRED,description="List of rule node JSON objects")
privateList<RuleNode>nodes;
@Schema(required=true,description="List of JSON objects that represent connections between rule nodes")
@Schema(requiredMode=Schema.RequiredMode.REQUIRED,description="List of JSON objects that represent connections between rule nodes")
privateList<NodeConnectionInfo>connections;
@Schema(required=true,description="List of JSON objects that represent connections between rule nodes and other rule chains.")
@Schema(requiredMode=Schema.RequiredMode.REQUIRED,description="List of JSON objects that represent connections between rule nodes and other rule chains.")
@Schema(required=true,accessMode=Schema.AccessMode.READ_ONLY,description="The Id is automatically generated during device creation. "+
@Schema(requiredMode=Schema.RequiredMode.REQUIRED,accessMode=Schema.AccessMode.READ_ONLY,description="The Id is automatically generated during device creation. "+
"Use 'getDeviceCredentialsByDeviceId' to obtain the id based on device id. "+
"Use 'updateDeviceCredentials' to update device credentials. ",example="784f394c-42b6-435a-983c-b7beff2784f9")
@Override
@ -61,7 +61,7 @@ public class DeviceCredentials extends BaseData<DeviceCredentialsId> implements
returnsuper.getCreatedTime();
}
@Schema(required=true,description="JSON object with the device Id.")
@Schema(requiredMode=Schema.RequiredMode.REQUIRED,description="JSON object with the device Id.")
publicDeviceIdgetDeviceId(){
returndeviceId;
}
@ -80,7 +80,7 @@ public class DeviceCredentials extends BaseData<DeviceCredentialsId> implements
this.credentialsType=credentialsType;
}
@Schema(required=true,description="Unique Credentials Id per platform instance. "+
@Schema(requiredMode=Schema.RequiredMode.REQUIRED,description="Unique Credentials Id per platform instance. "+