const response = await client.profiles.search({ search: { name: 'John' } });{
"items": [
{
"userIdentifier": "abcd",
"lastUpdatedTime": 1730204346000,
"givenName": "Jane",
"surname": "Doe",
"email": "jane.doe@example.com",
"displayName": "Jane Doe",
"jobTitle": "Software Engineer",
"identityType": "USER"
}
]
}Required capabilities:
userProfilesAcl:READ
Deprecated in favor of the List principals endpoint.
Search user profiles in the current project. The result set ordering and match criteria threshold may change over time. This operation does not support pagination.
const response = await client.profiles.search({ search: { name: 'John' } });{
"items": [
{
"userIdentifier": "abcd",
"lastUpdatedTime": 1730204346000,
"givenName": "Jane",
"surname": "Doe",
"email": "jane.doe@example.com",
"displayName": "Jane Doe",
"jobTitle": "Software Engineer",
"identityType": "USER"
}
]
}Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Query for user profile search.
List of matched user profiles. If no user profile matches, you'll receive an empty set.
Show child attributes
Was this page helpful?