Get Users by Email Address
GET /obp/v7.0.0/users/USER_EMAIL
OBPv2.0.0-getUser Roles: CanGetAnyUser UserOld-Style
Get users by email address
Login is required. CanGetAnyUser entitlement is required,
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
USER_EMAIL: USER_EMAIL
JSON response body fields (11)
Example success response
{
"users": [
{
"user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"email": "felixsmith@example.com",
"provider_id": "Chris",
"provider": "http://127.0.0.1:8080",
"username": "felixsmith",
"entitlements": {
"list": [
{
"entitlement_id": "6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name": "CanQueryOtherUser",
"bank_id": "gh.29.uk"
}
]
}
}
]
}Possible errors (4)
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-20007: User not found by email.
- OBP-50000: Unknown Error.