user login - ROCKITPLAY API

This endpoint allows a user to obtain a session token. The session token is valid for 24h. It is used to create short-time auth tokens which will grant access to the protected endpoints of the ROCKIT Edge API.
On success the endpoint returns the session token as well as the permissions to the individual resources of ROCKIT Edge. These are

apps
ROCKIT-enabled Apps

beUsers
Backend users

tasks
Compute tasks

If the ROCKIT Edge is working together with ROCKIT StreamInstaller the following additional resources are relevant:

dependencies
3rd-party dependencies which should be installed by the ROCKIT StreamInstaller prior to the game start.

keys
Access keys to authenticate CDN downloads.

The endpoint returns the permissions to each resource, i.e.

create
(apps, beUsers, dependencies, keys)

read
(apps, beUsers, tasks, dependencies, keys)

update
(apps, beUsers, tasks, dependencies, keys)

delete
(apps, beUsers, tasks, dependencies, keys)

execute
(tasks)

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

Example

{
    "status": "success",
    "session": {
        "token": "eyJhbGci...",
        "expires": 1731749654,
        "permissions": {
            "apps": [
                "create",
                "read",
                "update",
                "delete"
            ],
            "beUsers": [
                "create",
                "read",
                "update",
                "delete"
            ],
            "dependencies": [
                "create",
                "read",
                "update",
                "delete"
            ],
            "keys": [
                "create",
                "read",
                "update",
                "delete"
            ],
            "roles": [
                "create",
                "read",
                "update",
                "delete"
            ],
            "subscriptions": [
                "create",
                "read",
                "update",
                "delete"
            ],
            "users": [
                "create",
                "read",
                "update",
                "delete"
            ],
            "tasks": [
                "read",
                "delete",
                "execute"
            ],
            "consumption": [
                "read"
            ]
        }
    }
}

🟠400Invalid Param

🟠401Unauthorized