Get a user profile

post

https://{hostname}/entity

Returns the specified user profile. By default, this endpoint returns all the attributes associated with the user profile. However, it’s also possible to return just a specified subset of attributes.

Form Data

attribute_name

string

Attribute to be returned. This member returns values only for the specified attribute.

attributes

array of strings

Attributes for the user profile.

attributes

created

string

Timestamp indicating when the entity (user profile) was created. If the provided value is incorrect, the call fails.

password_attribute

string

Path to the schema attribute that stores a user's password. To verify a password, the password referenced by the password_attribute member needs to match the plain-text password you provide by using the password_value member.

password_value

string

Plaintext value used to verify a password. The password_value attribute is matched against the password referenced in the password_attribute member. If the two match the user information is returned. If they don't match, the operation fails.

integer

Unique identifier of the user record. This member is optional if you specify the uuid member or the key_attribute member.

uuid

string

Unique identifier of the user record. Required unless you use the id member or the key_attribute member.

key_attribute

string

Name of a unique attribute in the schema. This member is required unless you use the uuid member or the id parameter. If you use key_attribute to locate a user account your operation also needs to use the key_value member. The key_attribute member specifies the attribute you're searching on and key_value specifies the value you're searching for.

key_value

string

Value assigned to the key_attribute member. The key_attribute member provides a way to locate a user account without using the id member or the uuid member. Enclose any string values in quotes.

Response

200Successful response