REST User

UserController

/rest/backend/users

Success 200

Field Type Description
id Int
user String
realName String
lang String
ipLimit String
ustatus Bool
memberId Int
timestamp String
email String
timezone String
googleEmail String
skype String
ical String
psConfig Bool
psItem Bool
psEbay Bool
psStock Bool
psCustomer Bool
psOrder Bool
psStats Bool
psData Bool
pcConfig Bool
pcContent Bool
pcNewsletter Bool
pcLayout Bool
pcDialog Bool
pcStats Bool
pcData Bool
pcBlog Bool
signature String
color String
eks Bool
payments Bool
acceptAgb Int
api Bool
image String
delOrder Bool
delArticle Bool
delRecord Bool
plentystat Bool
plentyconnect Bool
webspaceAccess Bool
accessControlList String
plentymarketsShippingOrderId Bool
plentymarketsShippingItem Bool
plentymarketsShippingAuto Bool
plentymarketsShippingLabel Bool
plentymarketsShippingConfig Bool
warehouseId Int
calendar Bool
orderStatus String
warehouseRepairId Int
project Bool
ticket Bool
order Bool
blog Bool
lead Bool
customer Bool
totalVacationDays Float
roleId Int
salutation String
dataLang String
disabled Bool
scheduler Bool
item Bool
incomingItems Bool
backendPluginSetId Int The ID of the user's selected backend set

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Find all users having a name or username like the given one.

/rest/backend/users/search_name/{name}

Parameters

Field Type Description
name String The name to search for

Success 200

Field Type Description
id Int
user String
realName String
lang String
ipLimit String
ustatus Bool
memberId Int
timestamp String
email String
timezone String
googleEmail String
skype String
ical String
psConfig Bool
psItem Bool
psEbay Bool
psStock Bool
psCustomer Bool
psOrder Bool
psStats Bool
psData Bool
pcConfig Bool
pcContent Bool
pcNewsletter Bool
pcLayout Bool
pcDialog Bool
pcStats Bool
pcData Bool
pcBlog Bool
signature String
color String
eks Bool
payments Bool
acceptAgb Int
api Bool
image String
delOrder Bool
delArticle Bool
delRecord Bool
plentystat Bool
plentyconnect Bool
webspaceAccess Bool
accessControlList String
plentymarketsShippingOrderId Bool
plentymarketsShippingItem Bool
plentymarketsShippingAuto Bool
plentymarketsShippingLabel Bool
plentymarketsShippingConfig Bool
warehouseId Int
calendar Bool
orderStatus String
warehouseRepairId Int
project Bool
ticket Bool
order Bool
blog Bool
lead Bool
customer Bool
totalVacationDays Float
roleId Int
salutation String
dataLang String
disabled Bool
scheduler Bool
item Bool
incomingItems Bool
backendPluginSetId Int The ID of the user's selected backend set

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

/rest/backend/user/{userId}

Parameters

Field Type Description
userId Int The UserId

Success 200

Field Type Description
id Int
user String
realName String
lang String
ipLimit String
ustatus Bool
memberId Int
timestamp String
email String
timezone String
googleEmail String
skype String
ical String
psConfig Bool
psItem Bool
psEbay Bool
psStock Bool
psCustomer Bool
psOrder Bool
psStats Bool
psData Bool
pcConfig Bool
pcContent Bool
pcNewsletter Bool
pcLayout Bool
pcDialog Bool
pcStats Bool
pcData Bool
pcBlog Bool
signature String
color String
eks Bool
payments Bool
acceptAgb Int
api Bool
image String
delOrder Bool
delArticle Bool
delRecord Bool
plentystat Bool
plentyconnect Bool
webspaceAccess Bool
accessControlList String
plentymarketsShippingOrderId Bool
plentymarketsShippingItem Bool
plentymarketsShippingAuto Bool
plentymarketsShippingLabel Bool
plentymarketsShippingConfig Bool
warehouseId Int
calendar Bool
orderStatus String
warehouseRepairId Int
project Bool
ticket Bool
order Bool
blog Bool
lead Bool
customer Bool
totalVacationDays Float
roleId Int
salutation String
dataLang String
disabled Bool
scheduler Bool
item Bool
incomingItems Bool
backendPluginSetId Int The ID of the user's selected backend set

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

get the backend plugin set for user

/rest/user/backend_pluginset

Success 200

Field Type Description
id Int
hash String
parentPluginSetId Int
name String

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

set the backend plugin set for user

/rest/user/backend_pluginset

Success 200

Field Type Description
contentType String response content type
contentLength Int response content length
content String response content

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

get all User with a secret value

/rest/user/pin_users

Success 200

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Is this article helpful?

 

Thank you for your Feedback

you can close this field now!