Foundry API

<back to all web services

ResetTwoFactorAuthenticationRequest

Requires Authentication
The following routes are available for this service:
PUT/users/2fa/reset
import Foundation
import ServiceStack

public class ResetTwoFactorAuthenticationRequest : PutOperationTenanted<ResetTwoFactorAuthenticationResponse>
{
    public var targetUserId:String?
    public var callerCode:String?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case targetUserId
        case callerCode
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        targetUserId = try container.decodeIfPresent(String.self, forKey: .targetUserId)
        callerCode = try container.decodeIfPresent(String.self, forKey: .callerCode)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if targetUserId != nil { try container.encode(targetUserId, forKey: .targetUserId) }
        if callerCode != nil { try container.encode(callerCode, forKey: .callerCode) }
    }
}

public class PutOperationTenanted<TResponse : Codable> : PutOperationUnTenanted<TResponse>, ITenantedRequest
{
    public var organisationId:String?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case organisationId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        organisationId = try container.decodeIfPresent(String.self, forKey: .organisationId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if organisationId != nil { try container.encode(organisationId, forKey: .organisationId) }
    }
}

public class PutOperationUnTenanted<TResponse : Codable> : IPut, Codable
{
    required public init(){}
}

public class ResetTwoFactorAuthenticationResponse : Codable
{
    public var responseStatus:ResponseStatus?

    required public init(){}
}


Swift 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"}}}