laravel-printing
PrintNode
Whoami Service
On this page
Introduction
The WhoamiService
can be used to fetch the account information of your PrintNode account. It can also be used to verify your api key is working for api requests to PrintNode.
All methods are callable from the PrintNodeClient
class.
$whoami = $client->whoami->check();
See the API Overview for more information on interacting with the PrintNode API.
Reference
Methods
check
Rawilk\Printing\Api\PrintNode\Resources\Whoami
Retrieve the account information based on the current api key.
param | type | default |
---|---|---|
$opts |
null|array|RequestOptions | null |
Whoami Resource
Rawilk\Printing\Api\PrintNode\Resources\Whoami
The Whoami
object represents the account information related to a given API key.
Properties
id
int
The account's ID.
firstname
string
The account holder's first name.
lastname
string
The account holder's last name.
string
The account holder's email address.
canCreateSubAccounts
bool
Indicates if this account can create sub-accounts, e.g., you have an integrator account.
creatorEmail
?string
The email address of the account that created this sub-account.
creatorRef
?string
The creation reference set when the sub-account was created.
childAccounts
array
Any child accounts present on this account.
credits
?int
The number of print credits remaining on this account.
numComputers
int
The number of computers active on this account.
totalPrints
int
Total number of prints made on this account.
versions
array
A collection of versions set on this account.
connected
array
A collection of computer IDs signed in on this account.
Tags
array
A collection of tags set on this account.
ApiKeys
array
A collection of all the api keys set on this account.
state
string
The status of the account.
permissions
array
The permissions set on this account.
Methods
isActive
bool
Indicates true
if the account is considered active.