Skip to main content
GET
/
scim
/
v2
/
embed
/
users
/
{userId}
Retrieve embed user
curl --request GET \
  --url https://{instance}.omniapp.co/api/scim/v2/embed/users/{userId} \
  --header 'Authorization: Bearer <token>'
{
  "active": true,
  "displayName": "Blobby",
  "emails": [
    {
      "primary": true,
      "value": "embed-user-i_4TrNwyVTu34bZaC35VJVD3-pknp4YF7V8_Bi4TMdw@blobsrus.embed-exploreomni.co"
    }
  ],
  "groups": [
    {
      "display": "All Embed Users",
      "value": "4GcvQ2D9"
    },
    {
      "display": "Omni",
      "value": "nqGuU_uh"
    }
  ],
  "id": "2212aecf-a2ba-4d99-b23b-f615bc4c6522",
  "meta": {
    "created": "2024-09-30T20:25:01.822Z",
    "lastModified": "2024-09-30T20:51:47.558Z",
    "resourceType": "User"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "userName": "embed-user-i_4TrNwyVTu34bZaC35VJVD3-pknp4YF7V8_Bi4TMdw@blobsrus.embed-exploreomni.co",
  "embedEmail": null,
  "embedEntity": "omni",
  "embedExternalId": "blobby-manager"
}

Authorizations

Authorization
string
header
required

Requires an Organization API Key. Personal Access Tokens (PATs) are not supported for this endpoint.

Include in the Authorization header as: Bearer ORGANIZATION_API_KEY

Path Parameters

userId
string
required

The ID of the embed user to be retrieved

Response

Embed user details

An embed user object (SCIM 2.0)

id
string

Unique identifier for the user

userName
string

The user's email address

displayName
string

The user's display name

active
boolean

Whether the user is active

emails
object[]

The user's email addresses

groups
object[]

User groups that the user belongs to

meta
object
schemas
string[]

SCIM information about the type of schemas used in the API. For example, urn:ietf:params:scim:schemas:core:2.0:User

embedEmail
string | null

The embed user's email address

embedEntity
string

The embed entity identifier

embedExternalId
string

The external ID for the embed user