Authkey.state

Returns the state of an authkey, the nonce key associated to it and optionally the user quota of the the authorizing user.

Info

• Component name: authkey.state
• Signature: Requires signature using the sharedkey's private key
• Timestamp: Requires ztime parameter

Parameters

• authkey*: The authkey to query about
• userquota: Show the user quota of the the authorizing user. (true|false)
• sharedkey*: Your application shared key
• ztime*: Z-Timestamp

* Required parameter

Returns

• authkeystate
  • authkey: authkey
  • authorized: Indicates if the authkey has been authorized (true|false)
  • level: Authorization level (GET|ADD|MANAGE)
  • usercode: Safe Creative code of the authorizing user
  • username: Full name of the authorizing user
  • noncekey: Nonce key associated to the authkey

If userquota parameter is true the quota info is added:

• userquota
  • diskUsage: Disk usage in bytes
  • diskQuota: Disk quota in bytes
  • monthlyRegistrations: Number of registrations in current month
  • monthlyRegistrationsQuota: Maximum number of registrations per month

Example

REQUEST:

https://api.safecreative.org/v2/
?authkey=23j22wtpoguzgzk0fag39sey6
&component=authkey.state
&sharedkey=zy9x4ol0ctg3btyswq7b5wi9
&ztime=1271749822816
&signature=7d6ec7ad668da907286ee2901448af8e3581e37e

RESPONSE (not authorized):

<?xml version="1.0" encoding="UTF-8"?>
<authkeystate>
  <authkey>23j22wtpoguzgzk0fag39sey6</authkey>
  <authorized>false</authorized>
</authkeystate>

RESPONSE (authorized):

<?xml version="1.0" encoding="UTF-8"?>
<authkeystate>
  <authkey>23j22wtpoguzgzk0fag39sey6</authkey>
  <authorized>true</authorized>
  <level>MANAGE</level>
  <usercode>0907300000160</usercode>
  <username>Test User</username>
  <noncekey>4vrghpn0n8jxrrvoi3b7zta1c</noncekey>
</authkeystate>

REQUEST (with quota):

https://api.safecreative.org/v2/
?authkey=23j22wtpoguzgzk0fag39sey6
&component=authkey.state
&sharedkey=zy9x4ol0ctg3btyswq7b5wi9
&userquota=true
&ztime=1271749822816
&signature=7d6ec7ad668da907286ee2901448af8e3581e37e

RESPONSE (with quota):

<?xml version="1.0" encoding="UTF-8"?>
<authkeystate>
  <authkey>23j22wtpoguzgzk0fag39sey6</authkey>
  <authorized>true</authorized>
  <level>MANAGE</level>
  <usercode>0907300000160</usercode>
  <username>Test User</username>
  <noncekey>4vrghpn0n8jxrrvoi3b7zta1c</noncekey>
  <userquota>
    <diskUsage>26342745810</diskUsage>
    <diskQuota>100000000000</diskQuota>
    <monthlyRegistrations>1553</monthlyRegistrations>
    <monthlyRegistrationsQuota>5000</monthlyRegistrationsQuota>
  </userquota>
</authkeystate>