User

Endpoints

Create new user

/users

Description

Returns created user.

Parameters

Type Name Schema

Body

body
required

Responses

HTTP Code Description Schema

201

Successfully created

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get user list

/users

Description

Returns users.

Parameters

Type Name Description Schema

Query

page
optional

Page index

integer (int32)

Query

size
optional

Entity count per page

integer (int32)

Responses

HTTP Code Description Schema

200

Successfull

< User > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import user list

/users/import

Parameters

Type Name Schema

Body

body
required

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get one user

/users/{login}

Description

Returns retrieved user.

Parameters

Type Name Description Schema Business Rules

Path

login
required

User login

string

email address

Responses

HTTP Code Description Schema

200

Successful

404

Entity not found

No Content

500

Internal server error

No Content

Produces

  • application/json

Delete user

/users/{login}

Description

Disable this user.

Parameters

Type Name Description Schema Business Rules

Path

login
required

User login

string

email address

Responses

HTTP Code Description Schema

204

Succefully deleted

No Content

400

Functionnal error

No Content

500

Internal server error

No Content

Data structure

User

User data structure.

Name Description Value Business Rules

login
required

login

string

email address

lastName
required

Last Name

string

firstName
required

First Name

string

companyCode
required

Company code

string

2 characters max

establishmentCode
required

Establishment code

string

2 characters max

licenseType
optional

License type

string

IN(RW, OP)

languageCode
optional

Language code

string

2 characters max (ISO-639)

localeRegion
optional

Locale region

string

2 characters max (ISO-639)

authorizations
optional

Authorization List

List of Authorization

If this attribute is null, keep the existing authorizations for the user.

Authorization

Authorization data structure.

Name Description Value Business Rules

roleCode
required

Role Code

string

Existing role code in AdminHub

companyCode
optional

Company code

string

2 characters max

establishmentCode
optional

Establishment code

string

2 characters max

ImportUserList

Name Value

callback
optional

string

data
optional

User list