Get User by USERNAME
GET /obp/v7.0.0/users/provider/PROVIDER/username/USERNAME
OBPv5.1.0-getUserByProviderAndUsername Roles: CanGetAnyUser User
Get user by PROVIDER and USERNAME
Get a User by their authentication provider and username.
URL Parameters:
- PROVIDER - The authentication provider (e.g., http://127.0.0.1:8080, google.com, OBP)
- USERNAME - The username at that provider (e.g., obpstripe, john.doe)
Important: The PROVIDER parameter can contain special characters like slashes and colons. For example, if the provider is "http://127.0.0.1:8080", the full URL would be:
GET /obp/v5.1.0/users/provider/http://127.0.0.1:8080/username/obpstripe
The API will correctly parse the provider value even with these special characters.
To find valid providers, use the GET /obp/v6.0.0/providers endpoint (available in API version 6.0.0).
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
CanGetAnyUser entitlement is required.
URL Parameters:
PROVIDER: ETHEREUM
USERNAME: felixsmith
JSON response body fields (21)
- account_id
- 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
- bank_id
- gh.29.uk
- felixsmith@example.com
- entitlement_id
- entitlements
- first_name
- Tom
- is_deleted
- is_deleted
- is_locked
- is_locked
- last_name
- Smith
- list
- provider
- ETHEREUM
- provider_id
- role_name
- text
- type
- user_id
- 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
- username
- felixsmith
- view_id
- owner
- agreements
- agreements
- last_marketing_agreement_signed_date
- last_marketing_agreement_signed_date
- views
Example success response
{
"user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"email": "felixsmith@example.com",
"provider_id": "Chris",
"provider": "http://127.0.0.1:8080",
"username": "felixsmith",
"first_name": "Tom",
"last_name": "Smith",
"entitlements": {
"list": [
{
"entitlement_id": "6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name": "CanQueryOtherUser",
"bank_id": "gh.29.uk"
}
]
},
"views": {
"list": [
{
"bank_id": "gh.29.uk",
"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"view_id": "owner"
}
]
},
"agreements": [
{
"type": "",
"text": ""
}
],
"is_deleted": false,
"last_marketing_agreement_signed_date": "1100-01-01T00:00:00Z",
"is_locked": false
}Possible errors (4)
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-20027: User not found by provider and username.
- OBP-50000: Unknown Error.