manual:api:reference:token:delete

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

manual:api:reference:token:delete [2021/01/27 21:18] (current)
Line 1: Line 1:
 +===== token.delete =====
  
 +==== Description ====
 +
 +''​object token.delete(array **tokenids**)''​
 +
 +This method allows to delete tokens.
 +
 +<​note>​Only //Super admin// user type is allowed to manage tokens for other users.</​note>​
 +
 +==== Parameters ====
 +
 +''​(array)''​ IDs of the tokens to delete.
 +
 +==== Return values ====
 +
 +''​(object)''​ Returns an object containing the IDs of the deleted tokens under the ''​tokenids''​ property.
 +
 +==== Examples ====
 +
 +=== Delete multiple tokens ===
 +
 +Delete two tokens.
 +
 +Request:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​method":​ "​token.delete",​
 +    "​params":​ [
 +        "​188",​
 +        "​192"​
 +    ],
 +    "​auth":​ "​3a57200802b24cda67c4e4010b50c065",​
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +Response:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​result":​ {
 +        "​tokenids":​ [
 +            "​188",​
 +            "​192"​
 +        ]
 +    },
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +==== Source ====
 +
 +CToken::​delete() in //​ui/​include/​classes/​api/​services/​CToken.php//​.