Sign in
latestOpenAPI 3.0.12026-08-11284749.9 KB

58e231ca118e

Users

Invite user

This endpoint invites a new user as an employee. To update user's role, check out this article.

post/v2/users

Headers

Idempotency-Keystring nullable

Request body

first_namestring required
last_namestring required
emailstring email required
manager_idstring nullable
department_idstring nullable
location_idstring nullable
title_idstring nullable
metadataobject nullable

The metadata or customized attributes of the user. Maximum number of entries: 100

Response

createUser 200 response

idstring required
first_namestring required

First name of the user

last_namestring required

Last name of the user

emailstring required

Email address of the user

status'INVITED' | 'ACTIVE' | 'CLOSED' | 'DISABLED' | 'DELETED' | 'PENDING_ACTIVATION' | 'INACTIVE' | 'ARCHIVED'

Status of the user

manager_idstring nullable

The user id of the manager of this user

department_idstring nullable
location_idstring nullable
title_idstring nullable
metadataobject nullable

The metadata or customized attributes of the user. Maximum number of entries: 100

remote_display_idstring nullable

Identifier that is displayed on the IDP or HR system, eg, if OKTA identifies you as user xyz