GUgupy
Company Users

Creating an user

Changed on

Creates a new company user.

post/users

Request

  • Base URL
    https://api.gupy.io/api/v1
  • URL
    https://api.gupy.io/api/v1/users
  • Auth
    HTTP bearer

Request body

namestring required

User name

emailstring required

User email

profileTestEnabledboolean

Flag to set if tests are enabled

accessProfileIdnumber

Id from access profile to be bound

departmentIdnumber

Id from department to be bound

roleIdnumber

Id from user role

codestring

User identifier code

taxpayerRegistrystring

User taxpayer registry

countryOfOriginstring

User origin country

branchIdsnumber[]

Ids from branches to be bound

Response

The created user

idinteger required

User ID

namestring required

User name

emailstring

User email

departmentIdinteger

Id from department from whose the user belongs

roleIdinteger

Id from role from whose the user belongs

profileTestEnabledboolean

Checks if user must make profile tests

type'root' | 'owner' | 'guest'

Kind of user

codestring required

User identifier

taxpayerRegistrystring

User taxpayer registry

countryOfOriginstring

User origin country

accessProfileIdnumber

Id from access profile

branchIdsinteger[]

List of company branches IDs associated to the user

createdAtstring date-time required

Data of creation

updatedAtstring date-time required

Date of update

Changes