Plentymarkets interface documentation

Authorization

Contracts

AuthorizedUserRepositoryContract

service to get current authorized user

Namespace

Plenty\Modules\Authorization\Contracts

Methods
public getCurrentAuthorizedUser():Plenty\Modules\Authorization\Models\AuthorizedUser
Return type: AuthorizedUser

Exception

AuthorizationException

Class AuthorizationException

Namespace

Plenty\Modules\Authorization\Exception

Methods
public __construct($message = "", $code, $previous = null):void
Parameters

Name

Type

Description

$message

string

The exception message

$code

int

The exception code

$previous

public missingPermissions():Illuminate\Support\Collection
Return type: Collection
public addMissingPermission($permissionKey):void
Parameters

Name

Type

Description

$permissionKey

string

The permission key

public jsonSerialize():void

Models

AuthorizedUser

The current authorized user

Namespace

Plenty\Modules\Authorization\Models

Properties
Name Type Description

realName

string

The real name of the authorized user

lang

string

The back end language used by the authorized user

isSupportUser

string

Shows whether the authorized user is a support user

user

User

Further information about the user’s class, roles and rights

oauthAccessTokensId

string

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

Properties
Name Type Description

id

int

permission id

permissionKey

string

permission key

roles

array

Methods
public toArray()

Returns this model as an array.

Role

The Role authentication model

Namespace

Plenty\Modules\Authorization\Models

Properties
Name Type Description

id

int

role id

name

string

role name

holdParents

bool

hold parents if there is a new child

hidden

bool

hidden status for internal roles

users

array

permissions

array

accessControl

array

Methods
public toArray()

Returns this model as an array.

Services

AuthHelper

Service to process unguarded php code

Namespace

Plenty\Modules\Authorization\Services

Methods
public processUnguarded($callable):void
Parameters

Name

Type

Description

$callable

callable