<Info icon="fa-light fa-lock" className="permission-callout"> <div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div>

User + Create

<div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge></div> </Info>

Creates a user which is not active and has no password assigned. The URL to get the user details is provided as Location Header in the response.

ACTIVATION

Upon creation, the user account undergoes an activation process (see services below ) in which she receives an email with activation link. Following this link the user is asked to set the password and upon successful completion of this process, the account becomes active and operational.

Provided fields:

• username (String required) - has to be the email of this user
• name (String required)
• organisation (Object optional) - may be provided by regular user, but is required for master user.
• roles (List of Objects optional) - List of one or more role Ids to be assigned at once. If missing, a default role is assigned

Notes

• Password is not provided. Separate calls provide password management.
• When the organisation of the new user is not specified in the request, it is inherited from the user creating the account.

A regular user is allowed to specify only organisations which are direct children of his/her own organisation, or his/her own organisation.

• The status field is not user editable at account creation time - the default imposed by server is ACTIVATION_PENDING.