Create User For Actor API

Create a user and link it to an actor.

If user_name is omitted, the display name defaults to New User. Returns the
actor including the new user.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 10 and 256

Unique actor identifier.

Body Params

User fields to create and link to this actor.

string

The user ID

string

The user name

string

The user email

string

The user's first name

string

The user's last name

string

The user's display name

string

The user's city

string

The user's state

string

The user's country code

string

The user's postal address

string

The user's organization

string

The user's department

string

The user's division

credential_types
array of strings
Defaults to []

Credential types available on this user

Credential Types
string

The source identity provider

string

The raw provider status for the user

string

Integration that supplied this user (for example Okta or API).

string
length ≤ 64

Your organization ID.

Last login timestamp (UTC).

When the user was activated in the identity provider (UTC).

When the user profile was last updated (UTC).

When the user was created in the identity provider (UTC).

When this user record was created (UTC).

When this user record was last updated (UTC).

array | null

Optional tags applied to this user.

array | null

Groups or roles from the identity provider.

group_ids
array of strings
Defaults to []

Group/OU identifiers for correlation

Group Ids
group_names
array of strings
Defaults to []

Group display names

Group Names
string

Manager user ID for hierarchy

string

Manager display name or login

string

Job title

string

Employee number

string

Cost center

boolean
Defaults to false

When true, marks this user as high risk for correlation and review workflows.

Headers
string
required

Your API Key ID

string

Your API Key Secret

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json