Create User

Create User

Request Body — REQUIRED
external_id string — REQUIRED This is the identifier which corresponds to the user in your database.
email string — REQUIRED This is the email address for the user. An email will be sent to the user to enable them to enrol in Beyond Identity.
user_name string — REQUIRED Internal field to identify the user. When signing in, this will be returned as the subject field of the ID token.
display_name string — REQUIRED Internal field to identify the user's name.
binding_token_delivery_method string — REQUIRED Delivery method of the binding token. Can only be 'email'

Responses

200 A successful response. Schema internal_id string This is the internal ID of the user within your Beyond Identity directory. external_id string This is the external ID passed in the user creation call, generally a unique identifier into an external directory of users. email string This is the email address of the user passed in the user creation call. user_name string This is the user name of the user passed in the user creation call. display_name string This is the display name of the user passed in the user creation call. date_created date-time This is the timestamp for when the user was originally created. date_modified date-time This is the timestamp for the last update to the user entry. status string Possible values: [USER_STATUS_UNSET, USER_STATUS_ACTIVE, USER_STATUS_SUSPENDED, USER_STATUS_DELETED] One of USER_STATUS_ACTIVE, USER_STATUS_SUSPENDED, or USER_STATUS_DELETED. New users are always created with the status USER_STATUS_ACTIVE.