Docs/Admin API/Users/Report event

Report event

Preview

POST/admin/v1/users/{userId}:event

Report a user event.

If the <externalId>@<connectionId> user identifier syntax is used and the user doesn't exist, they will be imported.

By default, the event is processed asynchronously.

path parameters

userId
string
Required
The identifier of the user.
This can be in the format <externalId>@<connectionId> where externalId is the identity provider user identifier and and connectionId is the User provider connection identifier.

body parameters

type
enum
The event type.
If not specified, this defaults to CHANGED.
Possible values:
CHANGEDSIGNINSIGNUP
wait
boolean
Process the user action synchronously.
Otherwise the action is processed in the background and errors won't be returned.

Returns

No response data.

code
enum
The general error code (e.g. INVALID_ARGUMENT).
Possible values:
OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
message
string
A developer-facing error message.
reason
string
A reason code for the error (e.g. USER_PENDING_DELETION).
param
string
The parameter path related to the error (e.g. member.userId).
metadata
string
Additional metadata related to the error.
localeMessage
string
A user-facing error message.

curl https://api.userhub.com/admin/v1/users/auth0%7C123456789@conn_26yEiYymqy6ZmG:event \
  -H "Authorization: Bearer $USERHUB_ADMIN_KEY" \
  --json '{
    "type": "SIGNIN"
  }'

const res = await adminApi.users.reportEvent(
  "auth0|123456789@conn_26yEiYymqy6ZmG",
  {
    type: "SIGNIN",
  },
);

res, err := adminApi.Users().ReportEvent(
    context.Background(),
    "auth0|123456789@conn_26yEiYymqy6ZmG",
    &adminapi.UserReportEventInput{
        Type: "SIGNIN",
    },
)

$res = $adminApi->users->reportEvent(
    userId: 'auth0|123456789@conn_26yEiYymqy6ZmG',
    type: 'SIGNIN',
);

res = admin_api.users.report_event(
    user_id="auth0|123456789@conn_26yEiYymqy6ZmG",
    type="SIGNIN",
)

PreviousImport a user

NextCreate an API session

Report event

.css-10iahqc{text-transform:capitalize;}path parameters

body parameters

Returns

path parameters