Lookup User By Username

loading...

POST

/xeonr.auth.api.v1.UsersService/LookupUserByUsername

Send

Authorization

Header

Body

Resolves a username to its user within the caller's organisation — the reverse of BatchGetUsers, for surfaces addressed by username (public profiles). Unlike BatchGetUsers this is organisation-scoped rather than enrollment-scoped: the person being looked up need not have used the calling application. Usernames are not uniquely indexed; an ambiguous username answers not_found.

Required scopes: profile or auth:users:lookup

Header Parameters

Response Body

curl -X POST "https://auth.xeonr.io/xeonr.auth.api.v1.UsersService/LookupUserByUsername" \  -H "Connect-Protocol-Version: 1" \  -H "Connect-Timeout-Ms: 1000" \  -H "Content-Type: application/json" \  -d '{}'

{
  "user": {
    "userId": "urn:xeonr:auth:uid:user:123",
    "username": "johndoe",
    "avatarUrl": "https://cdn.example.com/avatars/abc123",
    "createdAt": "2023-01-15T01:30:15.01Z",
    "isAdmin": true
  }
}

{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}