Foundry API

<back to all web services

ResetTwoFactorAuthenticationRequest

Requires Authentication
The following routes are available for this service:
PUT/users/2fa/reset
import 'package:servicestack/servicestack.dart';

abstract class PutOperationUnTenanted<TResponse> implements IPut
{
    PutOperationUnTenanted();
    PutOperationUnTenanted.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "PutOperationUnTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

abstract class PutOperationTenanted<TResponse> extends PutOperationUnTenanted<TResponse> implements ITenantedRequest
{
    String? organisationId;

    PutOperationTenanted({this.organisationId});
    PutOperationTenanted.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        organisationId = json['organisationId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'organisationId': organisationId
    });

    getTypeName() => "PutOperationTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

class ResetTwoFactorAuthenticationResponse implements IConvertible
{
    ResponseStatus? responseStatus;

    ResetTwoFactorAuthenticationResponse({this.responseStatus});
    ResetTwoFactorAuthenticationResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "ResetTwoFactorAuthenticationResponse";
    TypeContext? context = _ctx;
}

class ResetTwoFactorAuthenticationRequest extends PutOperationTenanted<ResetTwoFactorAuthenticationResponse> implements IConvertible
{
    String? targetUserId;
    String? callerCode;

    ResetTwoFactorAuthenticationRequest({this.targetUserId,this.callerCode});
    ResetTwoFactorAuthenticationRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        targetUserId = json['targetUserId'];
        callerCode = json['callerCode'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'targetUserId': targetUserId,
        'callerCode': callerCode
    });

    getTypeName() => "ResetTwoFactorAuthenticationRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'foundrystage_api_app.azurewebsites.net', types: <String, TypeInfo> {
    'PutOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'PutOperationTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'ResetTwoFactorAuthenticationResponse': TypeInfo(TypeOf.Class, create:() => ResetTwoFactorAuthenticationResponse()),
    'ResetTwoFactorAuthenticationRequest': TypeInfo(TypeOf.Class, create:() => ResetTwoFactorAuthenticationRequest()),
});

Dart ResetTwoFactorAuthenticationRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /users/2fa/reset HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"targetUserId":"String","callerCode":"String","organisationId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}