API Document ​

interface Schema
{ 
  params: { 
    user: { 
      // User account
      name: string 

      // User name
      displayName: string 
    } 
    authenticatorSelection: {
      // Option describe authenticator type
      // 'cross-platform': For authenticator able to work on all supoort platform. Such as USB Security Key
      // 'platform': For authenticator is bundle with devices. Such as Windows Hello and iOS touchID
      authenticatorAttachment: 'cross-platform' | 'platform'

      // 'required' - authenticator must create a client side resident private key when authenticator support this feature. If authenticator not support, this will rais an error when calling navigator.credentials.create()
      // 'preferred' - authenticator will create a client side resident private key when authenticator support this feature.
      // 'discouraged' - not create client side resident private key
      residentKey: 'required' | 'preferred' | 'discouraged' 

      // When the requireResidentKey attribute is true, the authenticator must create a client side resident private key
      requireResidentKey: boolean

      // A WebAuthn Relying Party may require user verification for some of its operations but not for others, and may use this type to express its needs
      // 'required' - This value indicates that the Relying Party requires user verification for the operation and will fail the operation if the response does not have the UV flag set
      // 'preferred' - This value indicates that the Relying Party prefers user verification for the operation if possible, but will not fail the operation if the response does not have the UV flag set
      // 'discouraged' - This value indicates that the Relying Party does not want user verification employed during the operation (e.g., in the interest of minimizing disruption to the user interaction flow)
      userVerification: 'required' | 'preferred' | 'discouraged' 
    } 
    // Relying Parties may use AttestationConveyancePreference to specify their preference regarding attestation conveyance during credential generation
    // 'none': This value indicates that the Relying Party is not interested in authenticator attestation
    // 'indirect': This value indicates that the Relying Party prefers an attestation conveyance yielding verifiable attestation statements, but allows the client to decide how to obtain such attestation statements. The client MAY replace the authenticator-generated attestation statements with attestation statements generated by an Anonymization CA, in order to protect the user’s privacy, or to assist Relying Parties with attestation verification in a heterogeneous ecosystem
    // 'direct': This value indicates that the Relying Party wants to receive the attestation statement as generated by the authenticator
    attestation: 'none' | 'indirect' | 'direct' 
  }
}

interface Schema
{ 
  params: { 
    user: { 
      // User account
      name: string 

      // User name
      displayName: string 
    } 
    authenticatorSelection: {
      // Option describe authenticator type
      // 'cross-platform': For authenticator able to work on all supoort platform. Such as USB Security Key
      // 'platform': For authenticator is bundle with devices. Such as Windows Hello and iOS touchID
      authenticatorAttachment: 'cross-platform' | 'platform'

      // 'required' - authenticator must create a client side resident private key when authenticator support this feature. If authenticator not support, this will rais an error when calling navigator.credentials.create()
      // 'preferred' - authenticator will create a client side resident private key when authenticator support this feature.
      // 'discouraged' - not create client side resident private key
      residentKey: 'required' | 'preferred' | 'discouraged' 

      // When the requireResidentKey attribute is true, the authenticator must create a client side resident private key
      requireResidentKey: boolean

      // A WebAuthn Relying Party may require user verification for some of its operations but not for others, and may use this type to express its needs
      // 'required' - This value indicates that the Relying Party requires user verification for the operation and will fail the operation if the response does not have the UV flag set
      // 'preferred' - This value indicates that the Relying Party prefers user verification for the operation if possible, but will not fail the operation if the response does not have the UV flag set
      // 'discouraged' - This value indicates that the Relying Party does not want user verification employed during the operation (e.g., in the interest of minimizing disruption to the user interaction flow)
      userVerification: 'required' | 'preferred' | 'discouraged' 
    } 
    // Relying Parties may use AttestationConveyancePreference to specify their preference regarding attestation conveyance during credential generation
    // 'none': This value indicates that the Relying Party is not interested in authenticator attestation
    // 'indirect': This value indicates that the Relying Party prefers an attestation conveyance yielding verifiable attestation statements, but allows the client to decide how to obtain such attestation statements. The client MAY replace the authenticator-generated attestation statements with attestation statements generated by an Anonymization CA, in order to protect the user’s privacy, or to assist Relying Parties with attestation verification in a heterogeneous ecosystem
    // 'direct': This value indicates that the Relying Party wants to receive the attestation statement as generated by the authenticator
    attestation: 'none' | 'indirect' | 'direct' 
  }
}

interface Schema
{
  // API result status code
  code: number
  fido_register_request: {
    rp: {
      // RP domain name
      id: string

      // website name
      name: string
    }
    user: {
      // base64-url format user ID byte array source
      id: string

      // User account. Usually email format
      name: string

      // User name
      displayName: string
    }
    // base64-url format display byte array source
    challenge: string
    pubKeyCredParams: {
      // Defines the valid credential types
      type: 'public-key'

      // COSE Algorithms registry
      alg: number
    }[]
    // This member specifies a time, in milliseconds, that the caller is willing to wait for the call to complete
    timeout: number
    excludeCredentials: {
      // Defines the valid credential types
      type: 'public-key'

      // Credential ID in UTF8 string type
      id: string
    }[]
    // This member contains additional parameters requesting additional processing by the client and authenticator
    extensions: { [x: string]: any }
    authenticatorSelection: {
      // Option describe authenticator type
      // 'cross-platform': For authenticator able to work on all supoort platform. Such as USB Security Key
      // 'platform': For authenticator is bundle with devices. Such as Windows Hello and iOS touchID
      authenticatorAttachment: 'cross-platform' | 'platform'

      // 'required' - authenticator must create a client side resident private key when authenticator support this feature. If authenticator not support, this will rais an error when calling navigator.credentials.create()
      // 'preferred' - authenticator will create a client side resident private key when authenticator support this feature
      // 'discouraged' - not create client side resident private key
      residentKey: 'required' | 'preferred' | 'discouraged'

      // When the requireResidentKey attribute is true, the authenticator must create a client side resident private key
      requireResidentKey: boolean

      // A WebAuthn Relying Party may require user verification for some of its operations but not for others, and may use this type to express its needs
      // 'required' - This value indicates that the Relying Party requires user verification for the operation and will fail the operation if the response does not have the UV flag set
      // 'preferred' - This value indicates that the Relying Party prefers user verification for the operation if possible, but will not fail the operation if the response does not have the UV flag set
      // 'discouraged' - This value indicates that the Relying Party does not want user verification employed during the operation (e.g., in the interest of minimizing disruption to the user interaction flow)
      userVerification: 'required' | 'preferred' | 'discouraged'
    }
    // Relying Parties may use AttestationConveyancePreference to specify their preference regarding attestation conveyance during credential generation
    // 'none': This value indicates that the Relying Party is not interested in authenticator attestation
    // 'indirect': This value indicates that the Relying Party prefers an attestation conveyance yielding verifiable attestation statements, but allows the client to decide how to obtain such attestation statements. The client MAY replace the authenticator-generated attestation statements with attestation statements generated by an Anonymization CA, in order to protect the user’s privacy, or to assist Relying Parties with attestation verification in a heterogeneous ecosystem
    // 'direct': This value indicates that the Relying Party wants to receive the attestation statement as generated by the authenticator
    attestation: 'none' | 'indirect' | 'direct'
  }
}

interface Schema
{
  // API result status code
  code: number
  fido_register_request: {
    rp: {
      // RP domain name
      id: string

      // website name
      name: string
    }
    user: {
      // base64-url format user ID byte array source
      id: string

      // User account. Usually email format
      name: string

      // User name
      displayName: string
    }
    // base64-url format display byte array source
    challenge: string
    pubKeyCredParams: {
      // Defines the valid credential types
      type: 'public-key'

      // COSE Algorithms registry
      alg: number
    }[]
    // This member specifies a time, in milliseconds, that the caller is willing to wait for the call to complete
    timeout: number
    excludeCredentials: {
      // Defines the valid credential types
      type: 'public-key'

      // Credential ID in UTF8 string type
      id: string
    }[]
    // This member contains additional parameters requesting additional processing by the client and authenticator
    extensions: { [x: string]: any }
    authenticatorSelection: {
      // Option describe authenticator type
      // 'cross-platform': For authenticator able to work on all supoort platform. Such as USB Security Key
      // 'platform': For authenticator is bundle with devices. Such as Windows Hello and iOS touchID
      authenticatorAttachment: 'cross-platform' | 'platform'

      // 'required' - authenticator must create a client side resident private key when authenticator support this feature. If authenticator not support, this will rais an error when calling navigator.credentials.create()
      // 'preferred' - authenticator will create a client side resident private key when authenticator support this feature
      // 'discouraged' - not create client side resident private key
      residentKey: 'required' | 'preferred' | 'discouraged'

      // When the requireResidentKey attribute is true, the authenticator must create a client side resident private key
      requireResidentKey: boolean

      // A WebAuthn Relying Party may require user verification for some of its operations but not for others, and may use this type to express its needs
      // 'required' - This value indicates that the Relying Party requires user verification for the operation and will fail the operation if the response does not have the UV flag set
      // 'preferred' - This value indicates that the Relying Party prefers user verification for the operation if possible, but will not fail the operation if the response does not have the UV flag set
      // 'discouraged' - This value indicates that the Relying Party does not want user verification employed during the operation (e.g., in the interest of minimizing disruption to the user interaction flow)
      userVerification: 'required' | 'preferred' | 'discouraged'
    }
    // Relying Parties may use AttestationConveyancePreference to specify their preference regarding attestation conveyance during credential generation
    // 'none': This value indicates that the Relying Party is not interested in authenticator attestation
    // 'indirect': This value indicates that the Relying Party prefers an attestation conveyance yielding verifiable attestation statements, but allows the client to decide how to obtain such attestation statements. The client MAY replace the authenticator-generated attestation statements with attestation statements generated by an Anonymization CA, in order to protect the user’s privacy, or to assist Relying Parties with attestation verification in a heterogeneous ecosystem
    // 'direct': This value indicates that the Relying Party wants to receive the attestation statement as generated by the authenticator
    attestation: 'none' | 'indirect' | 'direct'
  }
}

interface Schema
{
  fido_register_response: {
    // base64-url format string of credential ID byte array. This should equal to base64-url encode rawId content. Response from authenticator
    id: string

    // base64-url format string of credential ID byte array. Response from authenticator. Need convert by client web or server
    rawId: string

    // Defines the valid credential types
    type: 'public-key'
  }
  response: {
    // base64-url format string of attestationObject byte array. Response from authenticator. Need convert by client web or server
    attestationObject: string

    // base64-url format string of clientDataJSON byte array. Response from authenticator. Need convert by client web or server
    clientDataJSON: string
  }
}

interface Schema
{
  fido_register_response: {
    // base64-url format string of credential ID byte array. This should equal to base64-url encode rawId content. Response from authenticator
    id: string

    // base64-url format string of credential ID byte array. Response from authenticator. Need convert by client web or server
    rawId: string

    // Defines the valid credential types
    type: 'public-key'
  }
  response: {
    // base64-url format string of attestationObject byte array. Response from authenticator. Need convert by client web or server
    attestationObject: string

    // base64-url format string of clientDataJSON byte array. Response from authenticator. Need convert by client web or server
    clientDataJSON: string
  }
}

interface Schema
{
  // API result status code
  code: number

  // base64-url format user ID byte array source
  uid: string
  key_info: {
    // human readable ID string to identify credential in security key
    credential_id: string

    // counter for FIDO2 authentication
    counter: number

    // Human easily readble name to identify Security Key
    name: string
    
    // UTC time when the credential was create
    create_time: number

    // UTC time when the information in credential was update
    update_time: number
  }
}

interface Schema
{
  // API result status code
  code: number

  // base64-url format user ID byte array source
  uid: string
  key_info: {
    // human readable ID string to identify credential in security key
    credential_id: string

    // counter for FIDO2 authentication
    counter: number

    // Human easily readble name to identify Security Key
    name: string
    
    // UTC time when the credential was create
    create_time: number

    // UTC time when the information in credential was update
    update_time: number
  }
}

interface Schema
{
  params: {
    // A WebAuthn Relying Party may require user verification for some of its operations but not for others, and may use this type to express its needs
    // 'required' - This value indicates that the Relying Party requires user verification for the operation and will fail the operation if the response does not have the UV flag set
    // 'preferred' - This value indicates that the Relying Party prefers user verification for the operation if possible, but will not fail the operation if the response does not have the UV flag set
    // 'discouraged' - This value indicates that the Relying Party does not want user verification employed during the operation (e.g., in the interest of minimizing disruption to the user interaction flow)
    userVerification: 'required' | 'preferred' | 'discouraged'
  }
}

interface Schema
{
  params: {
    // A WebAuthn Relying Party may require user verification for some of its operations but not for others, and may use this type to express its needs
    // 'required' - This value indicates that the Relying Party requires user verification for the operation and will fail the operation if the response does not have the UV flag set
    // 'preferred' - This value indicates that the Relying Party prefers user verification for the operation if possible, but will not fail the operation if the response does not have the UV flag set
    // 'discouraged' - This value indicates that the Relying Party does not want user verification employed during the operation (e.g., in the interest of minimizing disruption to the user interaction flow)
    userVerification: 'required' | 'preferred' | 'discouraged'
  }
}

interface Schema
{
  // API result status code
  code: number
  fido_login_request: {
    // base64-url format display byte array source
    challenge: string

    // This member specifies a time, in milliseconds, that the caller is willing to wait for the call to complete
    timeout: number,

    // RP domain name
    rpId: string
    allowCredentials: {
      // Defines the valid credential types
      type: 'public-key'

      // Credential ID in UTF8 string type
      id: string
    }[]

    // A WebAuthn Relying Party may require user verification for some of its operations but not for others, and may use this type to express its needs
    // 'required' - This value indicates that the Relying Party requires user verification for the operation and will fail the operation if the response does not have the UV flag set
    // 'preferred' - This value indicates that the Relying Party prefers user verification for the operation if possible, but will not fail the operation if the response does not have the UV flag set
    // 'discouraged' - This value indicates that the Relying Party does not want user verification employed during the operation (e.g., in the interest of minimizing disruption to the user interaction flow)
    userVerification: 'required' | 'preferred' | 'discouraged'

    // This member contains additional parameters requesting additional processing by the client and authenticator
    extensions: { [x: string]: any }
  }
}

interface Schema
{
  // API result status code
  code: number
  fido_login_request: {
    // base64-url format display byte array source
    challenge: string

    // This member specifies a time, in milliseconds, that the caller is willing to wait for the call to complete
    timeout: number,

    // RP domain name
    rpId: string
    allowCredentials: {
      // Defines the valid credential types
      type: 'public-key'

      // Credential ID in UTF8 string type
      id: string
    }[]

    // A WebAuthn Relying Party may require user verification for some of its operations but not for others, and may use this type to express its needs
    // 'required' - This value indicates that the Relying Party requires user verification for the operation and will fail the operation if the response does not have the UV flag set
    // 'preferred' - This value indicates that the Relying Party prefers user verification for the operation if possible, but will not fail the operation if the response does not have the UV flag set
    // 'discouraged' - This value indicates that the Relying Party does not want user verification employed during the operation (e.g., in the interest of minimizing disruption to the user interaction flow)
    userVerification: 'required' | 'preferred' | 'discouraged'

    // This member contains additional parameters requesting additional processing by the client and authenticator
    extensions: { [x: string]: any }
  }
}

interface Schema
{
  fido_login_response: {
    // base64-url format string of credential ID byte array. This should equal to base64-url encode rawId content. Response from authenticator
    id: string

    // base64-url format string of credential ID byte array. Response from authenticator. Need convert by client web or server
    rawId: string
    
    // Defines the valid credential types
    type: 'public-key'
    response: {
      // base64-url format string of authenticatorData byte array. Response from authenticator. Need convert by client web or server
      authenticatorData: string

      // base64-url format string of signature byte array. Response from authenticator. Need convert by client web or server
      signature: string
      
      // base64-url format string of userHandle byte array. Response from authenticator. Need convert by client web or server. In some case value will be null object
      userHandle: string
      
      // base64-url format string of clientDataJSON byte array. Response from authenticator. Need convert by client web or server
      clientDataJSON: string
    }
    // content with FIDO2 extions
    getClientExtensionResults: { [x: string]: any }
  }
}

interface Schema
{
  fido_login_response: {
    // base64-url format string of credential ID byte array. This should equal to base64-url encode rawId content. Response from authenticator
    id: string

    // base64-url format string of credential ID byte array. Response from authenticator. Need convert by client web or server
    rawId: string
    
    // Defines the valid credential types
    type: 'public-key'
    response: {
      // base64-url format string of authenticatorData byte array. Response from authenticator. Need convert by client web or server
      authenticatorData: string

      // base64-url format string of signature byte array. Response from authenticator. Need convert by client web or server
      signature: string
      
      // base64-url format string of userHandle byte array. Response from authenticator. Need convert by client web or server. In some case value will be null object
      userHandle: string
      
      // base64-url format string of clientDataJSON byte array. Response from authenticator. Need convert by client web or server
      clientDataJSON: string
    }
    // content with FIDO2 extions
    getClientExtensionResults: { [x: string]: any }
  }
}

interface Schema
{
  // API result status code
  code: number,
  user: {
    // base64-url format user ID byte array source
    id: string

    // User account. Usually email format
    name: string
  }
  key_info: {
    // human readable ID string to identify credential in security key
    credential_id: string

    // counter for FIDO2 authentication
    counter: number

    // Human easily readble name to identify Security Key
    name: string,
    
    // UTC time when the credential was create
    create_time: number

    // UTC time when the information in credential was update
    update_time: number
  }
}

interface Schema
{
  // API result status code
  code: number,
  user: {
    // base64-url format user ID byte array source
    id: string

    // User account. Usually email format
    name: string
  }
  key_info: {
    // human readable ID string to identify credential in security key
    credential_id: string

    // counter for FIDO2 authentication
    counter: number

    // Human easily readble name to identify Security Key
    name: string,
    
    // UTC time when the credential was create
    create_time: number

    // UTC time when the information in credential was update
    update_time: number
  }
}

interface Schema
{
  // User account. Usually email format
  uId: string
  params: {
    // A WebAuthn Relying Party may require user verification for some of its operations but not for others, and may use this type to express its needs
    // 'required' - This value indicates that the Relying Party requires user verification for the operation and will fail the operation if the response does not have the UV flag set
    // 'preferred' - This value indicates that the Relying Party prefers user verification for the operation if possible, but will not fail the operation if the response does not have the UV flag set
    // 'discouraged' - This value indicates that the Relying Party does not want user verification employed during the operation (e.g., in the interest of minimizing disruption to the user interaction flow)
    userVerification: 'required' | 'preferred' | 'discouraged'
  }
}

interface Schema
{
  // User account. Usually email format
  uId: string
  params: {
    // A WebAuthn Relying Party may require user verification for some of its operations but not for others, and may use this type to express its needs
    // 'required' - This value indicates that the Relying Party requires user verification for the operation and will fail the operation if the response does not have the UV flag set
    // 'preferred' - This value indicates that the Relying Party prefers user verification for the operation if possible, but will not fail the operation if the response does not have the UV flag set
    // 'discouraged' - This value indicates that the Relying Party does not want user verification employed during the operation (e.g., in the interest of minimizing disruption to the user interaction flow)
    userVerification: 'required' | 'preferred' | 'discouraged'
  }
}

interface Schema
{
  // API result status code
  code: number,
  fido_auth_request: {
    // base64-url format display byte array source
    challenge: string

    // This member specifies a time, in milliseconds, that the caller is willing to wait for the call to complete
    timeout: number

    // RP domain name
    rpId: string
    allowCredentials: {
      // Defines the valid credential types
      type: 'public-key'

      // Credential ID in UTF8 string type
      id: string
    }[]
    // A WebAuthn Relying Party may require user verification for some of its operations but not for others, and may use this type to express its needs
    // 'required' - This value indicates that the Relying Party requires user verification for the operation and will fail the operation if the response does not have the UV flag set
    // 'preferred' - This value indicates that the Relying Party prefers user verification for the operation if possible, but will not fail the operation if the response does not have the UV flag set
    // 'discouraged' - This value indicates that the Relying Party does not want user verification employed during the operation (e.g., in the interest of minimizing disruption to the user interaction flow)
    userVerification: 'required' | 'preferred' | 'discouraged'

    // This member contains additional parameters requesting additional processing by the client and authenticator
    extensions: { [x: string]: any }
  }
}

interface Schema
{
  // API result status code
  code: number,
  fido_auth_request: {
    // base64-url format display byte array source
    challenge: string

    // This member specifies a time, in milliseconds, that the caller is willing to wait for the call to complete
    timeout: number

    // RP domain name
    rpId: string
    allowCredentials: {
      // Defines the valid credential types
      type: 'public-key'

      // Credential ID in UTF8 string type
      id: string
    }[]
    // A WebAuthn Relying Party may require user verification for some of its operations but not for others, and may use this type to express its needs
    // 'required' - This value indicates that the Relying Party requires user verification for the operation and will fail the operation if the response does not have the UV flag set
    // 'preferred' - This value indicates that the Relying Party prefers user verification for the operation if possible, but will not fail the operation if the response does not have the UV flag set
    // 'discouraged' - This value indicates that the Relying Party does not want user verification employed during the operation (e.g., in the interest of minimizing disruption to the user interaction flow)
    userVerification: 'required' | 'preferred' | 'discouraged'

    // This member contains additional parameters requesting additional processing by the client and authenticator
    extensions: { [x: string]: any }
  }
}

interface Schema
{
  fido_auth_response: {
    // base64-url format string of credential ID byte array. This should equal to base64-url encode rawId content. Response from authenticator
    id: string

    // base64-url format string of credential ID byte array. Response from authenticator. Need convert by client web or server
    rawId: string

    // Defines the valid credential types
    type: 'public-key'
    response: {
      // base64-url format string of authenticatorData byte array. Response from authenticator. Need convert by client web or server
      authenticatorData: string

      // base64-url format string of signature byte array. Response from authenticator. Need convert by client web or server
      signature: string

      // base64-url format string of userHandle byte array. Response from authenticator. Need convert by client web or server. In some case value will be null object
      userHandle: string

      // base64-url format string of clientDataJSON byte array. Response from authenticator. Need convert by client web or server
      clientDataJSON: string
    }

    // content with FIDO2 extions
    getClientExtensionResults: { [x: string]: any }
  }
}

interface Schema
{
  fido_auth_response: {
    // base64-url format string of credential ID byte array. This should equal to base64-url encode rawId content. Response from authenticator
    id: string

    // base64-url format string of credential ID byte array. Response from authenticator. Need convert by client web or server
    rawId: string

    // Defines the valid credential types
    type: 'public-key'
    response: {
      // base64-url format string of authenticatorData byte array. Response from authenticator. Need convert by client web or server
      authenticatorData: string

      // base64-url format string of signature byte array. Response from authenticator. Need convert by client web or server
      signature: string

      // base64-url format string of userHandle byte array. Response from authenticator. Need convert by client web or server. In some case value will be null object
      userHandle: string

      // base64-url format string of clientDataJSON byte array. Response from authenticator. Need convert by client web or server
      clientDataJSON: string
    }

    // content with FIDO2 extions
    getClientExtensionResults: { [x: string]: any }
  }
}

interface Schema
{
  // API result status code
  code: number

  // base64-url format user ID byte array source
  uid: string
  key_info: {
    // human readable ID string to identify credential in security key
    credential_id: string

    // counter for FIDO2 authentication
    counter: number

    // Human easily readble name to identify Security Key
    name: string

    // UTC time when the credential was create
    create_time: number

    // UTC time when the information in credential was update
    update_time: number
  }
}

interface Schema
{
  // API result status code
  code: number

  // base64-url format user ID byte array source
  uid: string
  key_info: {
    // human readable ID string to identify credential in security key
    credential_id: string

    // counter for FIDO2 authentication
    counter: number

    // Human easily readble name to identify Security Key
    name: string

    // UTC time when the credential was create
    create_time: number

    // UTC time when the information in credential was update
    update_time: number
  }
}

interface Schema
{
  // API result status code
  code: number

  // Number of register users
  total: number
  users: {
    // User ID in AuthFi server
    id: string

    // User name
    name: string

    // User status of permission use FIDO2 authentication
    state: 'activate' | 'suspend'

    // UTC time when user information registered on AuthFi
    create_time: number
    
    // UTC time when user information updated on AuthFi
    update_time: number
  }[]
}

interface Schema
{
  // API result status code
  code: number

  // Number of register users
  total: number
  users: {
    // User ID in AuthFi server
    id: string

    // User name
    name: string

    // User status of permission use FIDO2 authentication
    state: 'activate' | 'suspend'

    // UTC time when user information registered on AuthFi
    create_time: number
    
    // UTC time when user information updated on AuthFi
    update_time: number
  }[]
}

interface Schema
{
  // New status for user
  status: 'activate' | 'suspend'
}

interface Schema
{
  // New status for user
  status: 'activate' | 'suspend'
}

interface Schema
{
  // API result status code
  code: number
  user: {
    // User ID in AuthFi server
    id: string

    // User name
    name: string

    // User status of permission use FIDO2 authentication
    state: 'activate' | 'suspend'

    // UTC time when user information registered on AuthFi
    create_time: number

    // UTC time when user information updated on AuthFi
    update_time: number
  }
}

interface Schema
{
  // API result status code
  code: number
  user: {
    // User ID in AuthFi server
    id: string

    // User name
    name: string

    // User status of permission use FIDO2 authentication
    state: 'activate' | 'suspend'

    // UTC time when user information registered on AuthFi
    create_time: number

    // UTC time when user information updated on AuthFi
    update_time: number
  }
}

interface Schema
{
  // API result status code
  code: number
  deleteUser: {
    // User ID in AuthFi server
    id: string

    // User name
    name: string
  }

  // Number of delete user register keys was deleted
  deleteUserRegisterKeys: number
}

interface Schema
{
  // API result status code
  code: number
  deleteUser: {
    // User ID in AuthFi server
    id: string

    // User name
    name: string
  }

  // Number of delete user register keys was deleted
  deleteUserRegisterKeys: number
}

interface Schema
{
  // API result status code
  code: number

  // key count, max size 10
  total: number
  keys: {
    // human readable ID string to identify credential in security key
    credential_id: string

    // counter for FIDO2 authentication
    counter: number

    // Human easily readble name to identify Security Key
    name: string

    // UTC time when the credential was create
    create_time: number

    // UTC time when the information in credential was update
    update_time: number
  }[]
}

interface Schema
{
  // API result status code
  code: number

  // key count, max size 10
  total: number
  keys: {
    // human readable ID string to identify credential in security key
    credential_id: string

    // counter for FIDO2 authentication
    counter: number

    // Human easily readble name to identify Security Key
    name: string

    // UTC time when the credential was create
    create_time: number

    // UTC time when the information in credential was update
    update_time: number
  }[]
}

interface Schema
{
  // for human friendly reading to specify securty key
  name: string
}

interface Schema
{
  // for human friendly reading to specify securty key
  name: string
}

interface Schema
{
  // API result status code
  code: number,
  key_info: {
    // human readable ID string to identify credential in security key
    credential_id: string

    // counter for FIDO2 authentication
    counter: number

    // Human easily readble name to identify Security Key
    name: string

    // UTC time when the credential was create
    create_time: number

    // UTC time when the information in credential was update
    update_time: number
  }
}

interface Schema
{
  // API result status code
  code: number,
  key_info: {
    // human readable ID string to identify credential in security key
    credential_id: string

    // counter for FIDO2 authentication
    counter: number

    // Human easily readble name to identify Security Key
    name: string

    // UTC time when the credential was create
    create_time: number

    // UTC time when the information in credential was update
    update_time: number
  }
}

interface Schema
{
  // API result status code
  code: number
  
  // delete register keys count
  deleteKeys: number
}

interface Schema
{
  // API result status code
  code: number
  
  // delete register keys count
  deleteKeys: number
}

interface Schema
{
  params: {
    // The user email to register with authenticator app
    user: string

    // The path to access mobile register page, ex: /app/register.html
    path: string
  }
}

interface Schema
{
  params: {
    // The user email to register with authenticator app
    user: string

    // The path to access mobile register page, ex: /app/register.html
    path: string
  }
}

interface Schema
{
  // API result status code
  code: number

  // QRCode ID
  token: string

  // base64 form string to present QRCode in PNG image file
  image: string
  
  // UTC time value in future that QRCode will expire
  expire_at: number
}

interface Schema
{
  // API result status code
  code: number

  // QRCode ID
  token: string

  // base64 form string to present QRCode in PNG image file
  image: string
  
  // UTC time value in future that QRCode will expire
  expire_at: number
}

interface Schema
{
  // API result status code
  code: number

  // authenticator app registration result
  // 0: authenticator register success
  // 1: wait for authenticator app to finish register
  // 2: authenticator register fail
  app_result: 0 | 1 | 2
}

interface Schema
{
  // API result status code
  code: number

  // authenticator app registration result
  // 0: authenticator register success
  // 1: wait for authenticator app to finish register
  // 2: authenticator register fail
  app_result: 0 | 1 | 2
}

interface Schema
{
  params: {
    // QRCode ID
    token: string
    user: {
      // User account
      name: string

      // User name
      displayName: string
    }
    authenticatorSelection: {
      // Option describe authenticator type
      // 'cross-platform': For authenticator able to work on all supoort platform. Such as USB Security Key
      // 'platform': For authenticator is bundle with devices. Such as Windows Hello and iOS touchID
      authenticatorAttachment: 'cross-platform' | 'platform'

      //  When the requireResidentKey attribute is true, the authenticator must create a client side resident private key
      requireResidentKey: boolean

      // A WebAuthn Relying Party may require user verification for some of its operations but not for others, and may use this type to express its needs
      // 'required' - This value indicates that the Relying Party requires user verification for the operation and will fail the operation if the response does not have the UV flag set
      // 'preferred' - This value indicates that the Relying Party prefers user verification for the operation if possible, but will not fail the operation if the response does not have the UV flag set
      // 'discouraged' - This value indicates that the Relying Party does not want user verification employed during the operation (e.g., in the interest of minimizing disruption to the user interaction flow)
      userVerification: 'required' | 'preferred' | 'discouraged'
    },
    // Relying Parties may use AttestationConveyancePreference to specify their preference regarding attestation conveyance during credential generation
    // 'none': This value indicates that the Relying Party is not interested in authenticator attestation
    // 'indirect': This value indicates that the Relying Party prefers an attestation conveyance yielding verifiable attestation statements, but allows the client to decide how to obtain such attestation statements. The client MAY replace the authenticator-generated attestation statements with attestation statements generated by an Anonymization CA, in order to protect the user’s privacy, or to assist Relying Parties with attestation verification in a heterogeneous ecosystem
    // 'direct': This value indicates that the Relying Party wants to receive the attestation statement as generated by the authenticator
    attestation: 'none' | 'indirect' | 'direct'
  }
}

interface Schema
{
  params: {
    // QRCode ID
    token: string
    user: {
      // User account
      name: string

      // User name
      displayName: string
    }
    authenticatorSelection: {
      // Option describe authenticator type
      // 'cross-platform': For authenticator able to work on all supoort platform. Such as USB Security Key
      // 'platform': For authenticator is bundle with devices. Such as Windows Hello and iOS touchID
      authenticatorAttachment: 'cross-platform' | 'platform'

      //  When the requireResidentKey attribute is true, the authenticator must create a client side resident private key
      requireResidentKey: boolean

      // A WebAuthn Relying Party may require user verification for some of its operations but not for others, and may use this type to express its needs
      // 'required' - This value indicates that the Relying Party requires user verification for the operation and will fail the operation if the response does not have the UV flag set
      // 'preferred' - This value indicates that the Relying Party prefers user verification for the operation if possible, but will not fail the operation if the response does not have the UV flag set
      // 'discouraged' - This value indicates that the Relying Party does not want user verification employed during the operation (e.g., in the interest of minimizing disruption to the user interaction flow)
      userVerification: 'required' | 'preferred' | 'discouraged'
    },
    // Relying Parties may use AttestationConveyancePreference to specify their preference regarding attestation conveyance during credential generation
    // 'none': This value indicates that the Relying Party is not interested in authenticator attestation
    // 'indirect': This value indicates that the Relying Party prefers an attestation conveyance yielding verifiable attestation statements, but allows the client to decide how to obtain such attestation statements. The client MAY replace the authenticator-generated attestation statements with attestation statements generated by an Anonymization CA, in order to protect the user’s privacy, or to assist Relying Parties with attestation verification in a heterogeneous ecosystem
    // 'direct': This value indicates that the Relying Party wants to receive the attestation statement as generated by the authenticator
    attestation: 'none' | 'indirect' | 'direct'
  }
}

interface Schema
{
  // API result status code
  code: number
  fido_register_request: {
    rp: {
      // RP domain name
      id: string

      //  website name
      name: string
    }
    user: {
      // base64-url format user ID byte array source
      id: string

      // User account. Usually email format
      name: string

      // User name.
      displayName: string
    }
    // base64-url format display byte array source
    challenge: string,
    pubKeyCredParams: {
      // Defines the valid credential types
      type: 'public-key'

      // COSE Algorithms registry
      alg: number
    }[]
    // This member specifies a time, in milliseconds, that the caller is willing to wait for the call to complete
    timeout: number
    excludeCredentials: {
      // Defines the valid credential types
      type: 'public-key'

      // Credential ID in UTF8 string type
      id: string
    }[]
    // This member contains additional parameters requesting additional processing by the client and authenticator
    extensions: { [x: string]: any }
    authenticatorSelection: {
      // Option describe authenticator type
      // 'cross-platform': For authenticator able to work on all supoort platform. Such as USB Security Key
      // 'platform': For authenticator is bundle with devices. Such as Windows Hello and iOS touchID
      authenticatorAttachment: 'cross-platform' | 'platform'

      // When the requireResidentKey attribute is true, the authenticator must create a client side resident private key
      requireResidentKey: boolean
      
      // A WebAuthn Relying Party may require user verification for some of its operations but not for others, and may use this type to express its needs
      // 'required' - This value indicates that the Relying Party requires user verification for the operation and will fail the operation if the response does not have the UV flag set
      // 'preferred' - This value indicates that the Relying Party prefers user verification for the operation if possible, but will not fail the operation if the response does not have the UV flag set
      // 'discouraged' - This value indicates that the Relying Party does not want user verification employed during the operation (e.g., in the interest of minimizing disruption to the user interaction flow)
      userVerification: 'required' | 'preferred' | 'discouraged'
    }
    // Relying Parties may use AttestationConveyancePreference to specify their preference regarding attestation conveyance during credential generation
    // 'none': This value indicates that the Relying Party is not interested in authenticator attestation
    // 'indirect': This value indicates that the Relying Party prefers an attestation conveyance yielding verifiable attestation statements, but allows the client to decide how to obtain such attestation statements. The client MAY replace the authenticator-generated attestation statements with attestation statements generated by an Anonymization CA, in order to protect the user’s privacy, or to assist Relying Parties with attestation verification in a heterogeneous ecosystem
    // 'direct': This value indicates that the Relying Party wants to receive the attestation statement as generated by the authenticator
    attestation: 'none' | 'indirect' | 'direct'
  }
}