Plentymarkets interface documentation
Authorization
Contracts
AuthorizedUserRepositoryContract
service to get current authorized user
Namespace
Plenty\Modules\Authorization\Contracts
Methods
Return type: AuthorizedUser
Exception
AuthorizationException
Class AuthorizationException
Namespace
Plenty\Modules\Authorization\Exception
Methods
public __construct($message = "", $code, $previous = null):voidName |
Type |
Description |
|
The exception message |
|
|
The exception code |
|
|
public missingPermissions():Illuminate\Support\CollectionReturn type: Collection
public addMissingPermission($permissionKey):voidName |
Type |
Description |
|
The permission key |
public jsonSerialize():voidModels
AuthorizedUser
The current authorized user
Namespace
Plenty\Modules\Authorization\Models
| Name | Type | Description |
|---|---|---|
realName |
The real name of the authorized user |
|
lang |
The back end language used by the authorized user |
|
isSupportUser |
Shows whether the authorized user is a support user |
|
user |
Further information about the user’s class, roles and rights |
|
oauthAccessTokensId |
The access token for OAUTH authentication |
Methods
public toArray()Returns this model as an array.
Permission
The authentication Permission (REST) model
Namespace
Plenty\Modules\Authorization\Models
| Name | Type | Description |
|---|---|---|
id |
permission id |
|
permissionKey |
permission key |
|
roles |
Methods
public toArray()Returns this model as an array.
Role
The Role authentication model
Namespace
Plenty\Modules\Authorization\Models
| Name | Type | Description |
|---|---|---|
id |
role id |
|
name |
role name |
|
holdParents |
hold parents if there is a new child |
|
hidden |
hidden status for internal roles |
|
uuid |
role uuid |
|
private_user_id |
Private user id of that role |
|
users |
||
permissions |
||
permissionKeys |
||
legacyPermissionKeys |
||
isLinkedWithUsers |
||
accessControl |
||
resourceAccess |
||
visibilities |
Methods
public toArray()Returns this model as an array.