CAcargill
Biome

GET /biome/profiles/{user_id}

Changed on

Fetch a profile by ID

This endpoint requires the permission "biome.profile.read".

Request

  • Base URL
    http://localhost:9000/api
  • URL
    http://localhost:9000/api/biome/profiles/{user_id}
  • Auth
    none declared. Required headers: Authorization

Path parameters

user_idstring required
Example:f35aacc1-a9cd-4eda-b6d0-2efaddf0c8a4

ID of the user

Headers

Authorizationstring required

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersioninteger
Example:2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Response

User profile

user_idstring

Internal unique identifier for the user

subjectstring

Oauth provider's unique identifier for the user

namestring

User's name

given_namestring

The given name of the user

family_namestring

The family name of the user

emailstring

The email address of the user

picturestring

The profile picture for the user's account

Example response

{
  "user_id": "f35aacc1-a9cd-4eda-b6d0-2efaddf0c8a4",
  "subject": "129367690558975733497",
  "name": "Alice Foo",
  "given_name": "Alice",
  "family_name": "Foo",
  "email": "alice@gmail.com",
  "picture": "https://lh6.googleusercontent.com/AMZpcempiaceeiA/s96-c/photo.jpg"
}

Changes

  • 991afbb88f2eRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • ae1b615e5ce1Revision changes
    • info

      endpoint added