Skip to main content

User Authentication Info

A user-authentication-info represents a user. This object contains information, such as the name and email address, and has sub-resources for each mechanism that the user can use to log in. For example, if an OpenID Connect Profile profile is configured in the Authentication Realm and the user is configured to authenticate through that profile, then the user-authentication-info object is associated with a User Authentication OpenID Connect Profile Info subresource.

The User Authentication Info Object

AttributeTypeDescription
idstringThe unique identifier for the user_authentication_info object.
namestringThe name used for the user_authentication_info object.
emailstringThe email address used for the user_authentication_info object.
metaobjectAdditional information for this user_authentication_info object. For more information, see The meta object section.
typestringThe type of the object returned. Always user_authentication_info.

Sample Object

{
"data": {
"id": "787af9a4-83e1-4216-bc60-df076daef0c5",
"name": "John Doe",
"email": "john.doe@banks.com",
"meta": {
"created_at": "2021-06-02T18:44:07.617Z",
"updated_at": "2021-06-02T18:44:07.617Z",
"creation_status": "COMPLETE"
},
"type": "user_authentication_info"
},
"links": {
"self": "https://useast.api.elasticpath.com/v2/authentication-realms/b6cf44b5-5d52-46b8-ae6f-7f28847fb269/user-authentication-info/787af9a4-83e1-4216-bc60-df076daef0c5"
}
}

The meta Object

AttributeTypeDescription
meta.created_atstringThe creation date of this user-authentication-info object.
meta.updated_atstringThe last updated date of this user-authentication-info object. This value also changes if subresources such as the user-authentication-oidc-profile-info, or user-authentication-password-profile-info change.
meta.creation_statusstringThe status of the creation of this user-authentication-info object. The options are IN_PROGRESS or COMPLETED.

Filtering

The following operators and attributes are available for filtering user authentication infos:

OperatorDescription
eqChecks whether the values of two operands are equal. If the values are equal, the condition is true.
likeChecks if the operand contains the specified string. You can use wildcard characters in operand.
AttributeTypeOperatorExample
namestringeq / likelike(name,Brad*)
emailstringeq / likelike(email,*@elasticpath.com)