Skip to main content
GET
/
user
cURL
curl --request GET \
  --url https://api.opal.dev/v1/user \
  --header 'Authorization: Bearer <token>'
{
  "user_id": "29827fb8-f2dd-4e80-9576-28e31e9934ac",
  "email": "[email protected]",
  "full_name": "John Doe",
  "first_name": "John",
  "last_name": "Doe",
  "position": "Engineer"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
user_id
string<uuid>

The user ID of the user.

​
email
string

The email of the user. If both user ID and email are provided, user ID will take precedence. If neither are provided, an error will occur.

Response

200 - application/json

The user object associated with the passed-in email or ID.

User Object

Description

The User object is used to represent a user.

Usage Example

Fetch from the LIST Sessions endpoint.

​
user_id
string<uuid>
required

The ID of the user.

Example:

"h0z968412-2451-4bbd-42h4-057l715d917m"

​
email
string
required

The email of the user.

Example:

"[email protected]"

​
full_name
string
required

The full name of the user.

Example:

"John Doe"

​
first_name
string
required

The first name of the user.

Example:

"John"

​
last_name
string
required

The last name of the user.

Example:

"Doe"

​
position
string
required

The user's position.

Example:

"Senior Engineer"

​
hr_idp_status
enum<string>

User status pulled from an HR/IDP provider.

Available options:
ACTIVE,
SUSPENDED,
DEPROVISIONED,
DELETED,
NOT_FOUND
Example:

"ACTIVE"