/users

POST {{base-api-url}}/users

By default, a user is created as a manager. Be careful, it means as an assistant and not as a administrator.

Here are the 3 different levels of permissions:

  • Manager: He's able to create procedures.
  • Signer: Manager's permissions + he's able to sign procedures.
  • Admin: Signer's permissions + he's able to acces to admin menu (user management, API keys, branding, ...).

Request Body

{"firstname"=>"John", "lastname"=>"Doe", "email"=>"api@yousign.fr", "title"=>"API teacher", "phone"=>"+33612345678"}

HEADERS

KeyDatatypeRequiredDescription
AuthorizationstringThis value is a secret and needs to be replaced by your API Key (Bearer).
Content-TypestringThis header specifies the format of the exchanges in JSON.

RESPONSES

status: Created

{"id":"/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","firstname":"John","lastname":"Doe","email":"api@yousign.fr","title":"API teacher","phone":"+33612345678","status":"not_activated","organization":"/organizations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","workspaces":[{"id":"/workspaces/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","name":"Acme"}],"permission":"ROLE_MANAGER","group":{"id":"/user_groups/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","name":"Gestionnaire","permissions":["procedure_write","procedure_template_write","procedure_create_from_template","contact","archive"]},"createdAt":"2018-12-03T07:33:01+01:00","updatedAt":"2018-12-03T07:33:01+01:00","deleted":false,"deletedAt":null,"config":[],"inweboUserRequest":null,"samlNameId":null,"defaultSignImage":null,"notifications":{"procedure":true},"fastSign":false,"fullName":"John Doe"}