Users

get

Return information about the current user (based on JWT token) including permissions

🔒 Requires the read:users permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Information about the current user with permissions

application/json

Information about the current user with permissions

idstringRequired

The user's unique ID e.g. prov0|1234567890

Example: prov0|1234567890

namestringRequired

The user's full name

Example: John Doe

emailstringRequired

The user's email address

Example: [email protected]

picturestringOptional

The user's profile picture

Example: https://example.com/profile.jpg

first_namestringOptional

The user's first name

Example: John

last_namestringOptional

The user's last name

Example: Doe

nicknamestringOptional

The user's nickname

Example: JD

created_atstring · date-timeOptional

The date and time the resource was created e.g. 2022-01-01T00:00:00.000Z

permissionsstring[]Required

Array of user's permissions

Example: read:users

pylonEmailHashstringOptional

HMAC SHA-256 hash of the user email for Pylon identity verification

Example: a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6

400

Failed to fetch user information

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:users permission

application/json

404

User not found

application/json

429

Too many requests

application/json

get

/api/v1/user/me

GET /api/v1/user/me HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "prov0|1234567890",
  "name": "John Doe",
  "email": "[email protected]",
  "picture": "https://example.com/profile.jpg",
  "role": {
    "id": "rol_abCdeFghIjklMnmP",
    "name": "Admin",
    "description": "Role for managing Admin permissions"
  },
  "first_name": "John",
  "last_name": "Doe",
  "nickname": "JD",
  "created_at": "2026-03-03T01:20:41.747Z",
  "permissions": [
    "read:users"
  ],
  "pylonEmailHash": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6"
}

get

Return basic information about user by ID

🔒 Requires the read:users permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The user's unique ID e.g. prov0|1234567890

Example: prov0|1234567890

Responses

200

Information about user

application/json

Information about user

idstringRequired

The user's unique ID e.g. prov0|1234567890

Example: prov0|1234567890

namestringRequired

The user's full name

Example: John Doe

emailstringRequired

The user's email address

Example: [email protected]

picturestringOptional

The user's profile picture

Example: https://example.com/profile.jpg

first_namestringOptional

The user's first name

Example: John

last_namestringOptional

The user's last name

Example: Doe

nicknamestringOptional

The user's nickname

Example: JD

created_atstring · date-timeOptional

The date and time the resource was created e.g. 2022-01-01T00:00:00.000Z

400

Failed to fetch user information

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:users permission

application/json

404

User not found

application/json

429

Too many requests

application/json

get

/api/v1/user/{id}

GET /api/v1/user/{id} HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "prov0|1234567890",
  "name": "John Doe",
  "email": "[email protected]",
  "picture": "https://example.com/profile.jpg",
  "roles": [
    {
      "id": "rol_abCdeFghIjklMnmP",
      "name": "Admin",
      "description": "Role for managing Admin permissions"
    }
  ],
  "first_name": "John",
  "last_name": "Doe",
  "nickname": "JD",
  "created_at": "2026-03-03T01:20:41.747Z"
}

post

Update roles to user by id

🔒 Requires the update:users permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The user's unique ID e.g. prov0|1234567890

Example: prov0|1234567890

Body

rolesstring[]RequiredExample: ["rol_abCdeFghIjklMnmP"]

addbooleanOptional

If true, add the new role to an existing one. If false, override an existing role

Responses

200

User roles updated successfully

application/json

User roles updated successfully

idstringRequired

The user's unique ID e.g. prov0|1234567890

Example: prov0|1234567890

namestringRequired

The user's full name

Example: John Doe

emailstringRequired

The user's email address

Example: [email protected]

picturestringOptional

The user's profile picture

Example: https://example.com/profile.jpg

400

Failed to update user roles

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the update:users permission

application/json

404

User not found

application/json

429

Too many requests

application/json

post

/api/v1/user/{id}/roles

POST /api/v1/user/{id}/roles HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "roles": [
    "rol_abCdeFghIjklMnmP"
  ],
  "add": true
}

{
  "id": "prov0|1234567890",
  "name": "John Doe",
  "email": "[email protected]",
  "picture": "https://example.com/profile.jpg",
  "roles": [
    {
      "id": "rol_abCdeFghIjklMnmP",
      "name": "Admin",
      "description": "Role for managing Admin permissions"
    }
  ],
  "assigned_collections": [
    {
      "id": "f27d96be-c486-4075-a926-0ee96775119e",
      "slug": "production-europe",
      "name": "Production Europe",
      "color": "#0000ff",
      "allow_pre_release": false,
      "is_default": true,
      "enabled_policies": [
        "require_owner_approval"
      ],
      "is_active": true,
      "is_deleted": true,
      "created": "2026-03-03T01:20:41.747Z",
      "cloud_account": null
    }
  ]
}

PreviousTasks NextWebhooks

Last updated 3 months ago

Was this helpful?