• alternateName: string
  User's altername name that may be used in the user screens.
• defaultlocale: string
  The default locale of the user. If not provided then a default value of "en_US" will be used.
• displayName: string
  User's display name that may be used in the user screens.
• factorsRegistered: array factorsRegistered
  Array of factor registration data for user.
• groupId: string
  GroupId / ApplicationId of the user whose preferences data is required. If this parameter is not present a value of "Default" is used.
• imageReference: string
  Location of the secureImage. Example:/images/secureImage01.jpg. If system is configured to return the image path as a full URL, then following two properties need to be configured. 1.)oaa.preferences.prependBasePath = true (default is false), 2.)oaa.preferences.imageBasePath=. If system property oaa.preferences.prependBasePath = false, then only the location of the secureImage is returned as is. For set(post) only the relative path should be used and for get full URL will be returned if configured as above.
• phraseString: string
  User preferred phrase string ex Hello World!
• uniqueUserId: string
  Canonical ID of the user. If this is present, then it takes precedence over userId + groupId combination.
• userId: string
  Identifier of the user. May be further qualified by groupId.

{
    "type":"object",
    "description":"Information about the user and user's challenge registration for each type of challenge factor.",
    "required":[
        "userId|groupId"
    ],
    "properties":{
        "userId":{
            "description":"Identifier of the user. May be further qualified by groupId.",
            "type":"string"
        },
        "groupId":{
            "type":"string",
            "description":"GroupId / ApplicationId of the user whose preferences data is required. If this parameter is not present a value of \"Default\" is used."
        },
        "uniqueUserId":{
            "type":"string",
            "description":"Canonical ID of the user. If this is present, then it takes precedence over userId + groupId combination."
        },
        "defaultlocale":{
            "type":"string",
            "description":"The default locale of the user. If not provided then a default value of \"en_US\" will be used."
        },
        "displayName":{
            "type":"string",
            "description":"User's display name that may be used in the user screens."
        },
        "alternateName":{
            "type":"string",
            "description":"User's altername name that may be used in the user screens."
        },
        "imageReference":{
            "type":"string",
            "description":"Location of the secureImage. Example:/images/secureImage01.jpg.\nIf system is configured to return the image path as a full URL, then following two properties need to be configured. \n1.)oaa.preferences.prependBasePath = true (default is false),\n2.)oaa.preferences.imageBasePath=<base path of the URL>.\nIf system property oaa.preferences.prependBasePath = false, then only the location of the secureImage is returned as is.\nFor set(post) only the relative path should be used and for get full URL will be returned if configured as above.\n"
        },
        "phraseString":{
            "type":"string",
            "description":"User preferred phrase string ex Hello World!"
        },
        "factorsRegistered":{
            "description":"Array of factor registration data for user.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FactorRegData"
            }
        }
    }
}

• Array of: object FactorRegData
  Entry containing a factorName and map of keys and a values. Map of keys and values will contain attributes specific to that factor.

{
    "description":"Array of factor registration data for user.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FactorRegData"
    }
}

• factorAttributes: array factorAttributes
  Collection of attributes for a factor for this user.
• factorKey: string
  Key of the factor. This is the name that should map to one of the available factors in the OAA system. This should be one of the enum name in challenge.type.enum. Examples are ChallengeEmail, ChallengeSMS, ChallengeOMATOTP, ChallangeYOTP and ChallengeFIDO2.
• factorName: string
  This is the name that should map to one of the available factors in the OAA system. This should be one of the enum name in challenge.type.enum. For Example if factor is email then factorName should be Email Challenge. Examples are Email Challenge, SMS Challenge, OMA TOTP Challenge, Yubikey OTP Challange and FIDO2 Challenge.
• isPreferred: boolean
  Is the factor is preferred factor for the user to challenge.

{
    "type":"object",
    "required":[
        "factorName|factorAttributes"
    ],
    "description":"Entry containing a factorName and map of keys and a values.  Map of keys and values will contain attributes specific to that factor.",
    "properties":{
        "isPreferred":{
            "type":"boolean",
            "description":"Is the factor is preferred factor for the user to challenge."
        },
        "factorName":{
            "type":"string",
            "description":"This is the name that should map to one of the available factors in the OAA system. This should be one of the enum name in challenge.type.enum.  For Example if factor is email then factorName should be Email Challenge. Examples are Email Challenge, SMS Challenge, OMA TOTP Challenge, Yubikey OTP Challange and FIDO2 Challenge."
        },
        "factorKey":{
            "type":"string",
            "description":"Key of the factor. This is the name that should map to one of the available factors in the OAA system. This should be one of the enum name in challenge.type.enum. Examples are ChallengeEmail, ChallengeSMS, ChallengeOMATOTP, ChallangeYOTP and ChallengeFIDO2."
        },
        "factorAttributes":{
            "type":"array",
            "description":"Collection of attributes for a factor for this user.",
            "items":{
                "$ref":"#/components/schemas/PrefFactorAttribute"
            }
        }
    }
}

• Array of: object PrefFactorAttribute
  A map represented as an array of entries.

{
    "type":"array",
    "description":"Collection of attributes for a factor for this user.",
    "items":{
        "$ref":"#/components/schemas/PrefFactorAttribute"
    }
}

• factorAttributeName: string
  Name of factor specific attribute.
• factorAttributeValue: array factorAttributeValue
  Value of factor specific attribute. Multiple values can be specified in the array.

{
    "type":"object",
    "description":"A map represented as an array of entries.",
    "properties":{
        "factorAttributeName":{
            "type":"string",
            "description":"Name of factor specific attribute."
        },
        "factorAttributeValue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PrefFactorAttributeValue"
            },
            "description":"Value of factor specific attribute. Multiple values can be specified in the array."
        }
    }
}

• Array of: object PrefFactorAttributeValue
  Attribute value of the factor.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PrefFactorAttributeValue"
    },
    "description":"Value of factor specific attribute. Multiple values can be specified in the array."
}

• createTime: string (date-time)
  "Date time string in the format rfc3339 sec 5.6. https://tools.ietf.org/html/rfc3339#section-5.6"
• isEnabled: boolean
  Indicates if the factor attribute is enabled or not. By default, it is set as true.
• isPreferred: boolean
  Indicates if the value of the attribute is preferred over other similar values in the array.
• isValidated: boolean
  Default Value: true

  Indicates if the given attribute is validated. Some attributes do not require validation hence this field is optional.
• isVerified: boolean
  Default Value: true

  Indicates if the given attribute is verified. Some attributes do not require verification hence this field is optional.
• name: string
  Friendly name of the device.
• value: string
  Value of the factor attribute.

{
    "type":"object",
    "required":[
        "value|name"
    ],
    "description":"Attribute value of the factor.",
    "properties":{
        "value":{
            "type":"string",
            "description":"Value of the factor attribute."
        },
        "isPreferred":{
            "type":"boolean",
            "description":"Indicates if the value of the attribute is preferred over other similar values in the array."
        },
        "isVerified":{
            "type":"boolean",
            "default":true,
            "description":"Indicates if the given attribute is verified. Some attributes do not require verification hence this field is optional."
        },
        "isValidated":{
            "type":"boolean",
            "default":true,
            "description":"Indicates if the given attribute is validated. Some attributes do not require validation hence this field is optional."
        },
        "name":{
            "type":"string",
            "description":"Friendly name of the device."
        },
        "isEnabled":{
            "type":"boolean",
            "description":"Indicates if the factor attribute is enabled or not. By default, it is set as true."
        },
        "createTime":{
            "$ref":"#/components/schemas/DateTime",
            "description":"Time of factor creation."
        }
    }
}

• responseCode: string
• responseMessage: string

{
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}