Skip to content

Commit 258bbb7

Browse files
committed
docfix resource doc for Get user by PROVIDER AND USERNAME
1 parent 5054164 commit 258bbb7

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

obp-api/src/main/scala/code/api/v5_1_0/APIMethods510.scala

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2468,10 +2468,26 @@ trait APIMethods510 {
24682468
"/users/provider/PROVIDER/username/USERNAME",
24692469
"Get User by USERNAME",
24702470
s"""Get user by PROVIDER and USERNAME
2471+
|
2472+
|Get a User by their authentication provider and username.
2473+
|
2474+
|**URL Parameters:**
2475+
|
2476+
|* PROVIDER - The authentication provider (e.g., http://127.0.0.1:8080, google.com, OBP)
2477+
|* USERNAME - The username at that provider (e.g., obpstripe, john.doe)
2478+
|
2479+
|**Important:** The PROVIDER parameter can contain special characters like slashes and colons.
2480+
|For example, if the provider is "http://127.0.0.1:8080", the full URL would be:
2481+
|
2482+
|`GET /obp/v5.1.0/users/provider/http://127.0.0.1:8080/username/obpstripe`
2483+
|
2484+
|The API will correctly parse the provider value even with these special characters.
2485+
|
2486+
|**To find valid providers**, use the GET /providers endpoint.
24712487
|
24722488
|${userAuthenticationMessage(true)}
24732489
|
2474-
|CanGetAnyUser entitlement is required,
2490+
|CanGetAnyUser entitlement is required.
24752491
|
24762492
""".stripMargin,
24772493
EmptyBody,

0 commit comments

Comments
 (0)