token.create

Beschreibung

object token.create(object/array tokens)

Diese Methode ermöglicht es Ihnen, neue Tokens zu erstellen.

Die Berechtigung API-Tokens verwalten ist erforderlich, damit die Benutzerrolle Tokens für andere Benutzer verwalten kann.

Ein mit dieser Methode erstelltes Token muss außerdem generiert werden, bevor es verwendet werden kann.

Parameter

(object/array) Zu erstellende Token.

Die Methode akzeptiert Token mit den Standard-Token-Eigenschaften.

Rückgabewerte

(object) Gibt ein Objekt zurück, das die IDs der erstellten Token unter der Eigenschaft tokenids enthält. Die Reihenfolge der zurückgegebenen IDs entspricht der Reihenfolge der übergebenen Token.

Beispiele

Ein Token erstellen

Erstellen Sie ein aktiviertes Token, das nie abläuft und den Benutzer mit der ID 2 authentifiziert.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "token.create",
    "params": {
        "name": "Your token",
        "userid": "2"
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": {
        "tokenids": [
            "188"
        ]
    },
    "id": 1
}

Erstellen Sie ein deaktiviertes Token, das am 21. Januar 2021 abläuft. Dieses Token authentifiziert den aktuellen Benutzer.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "token.create",
    "params": {
        "name": "Your token",
        "status": "1",
        "expires_at": "1611238072"
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": {
        "tokenids": [
            "189"
        ]
    },
    "id": 1
}

Quelle

CToken::create() in ui/include/classes/api/services/CToken.php.