ROCKITPLAY API
  1. ROCKIT Edge - Backend API
ROCKITPLAY API
  • ROCKIT Edge - Admin API
    • Minimal Tests
      • ping
      • submit test task
    • Admin Edge Organizations
      • Create Organization
      • Delete Organization
  • ROCKIT Edge - Backend API
    • Backend Edge Organizations
      • Create Organization
      • Delete Organization
    • Authentication
      • user login
      • authentication
    • Account Management
      • get user details
      • list users
      • Modify user
      • delete users
      • Create User / Create Machine User
    • Deployments
      • Creating Deployments
      • Get Deployments
      • Get Deployment Details
      • Modify Deployment
      • Deleting Deployments
    • Apps
      • Creating Apps
      • Import native builds
      • App Details
      • List Apps
      • patch app
      • Delete Apps
    • Triggers
      • Process Traces
      • Retry Task
    • Tasks
      • Listing Tasks
      • Task Details
      • Acknowledge Warning / Expire Task
    • Subscriptions
      • Subscribe
      • List Subscriptions
      • Unsubscribe
    • Roles
      • List Roles
      • Create Role
      • Patch Role
      • Role Details
      • Delete Roles
  • Changelog
    • Changelog
  1. ROCKIT Edge - Backend API

Authentication

The ROCKIT Edge Backend API supports two authentication methods:
1.
Token-based authentication for users accounts.
2.
API key-based authentication for machine accounts.
The token-based authentication is typically being applied for interactive clients such as graphical user interfaces while the API-key based authentication method is preferable for integrating the ROCKIT Edge Backend API into existing workflows using machine accounts.
The two authentication methods are described in the following.

Token-based authentication#

The ROCKIT Edge API employes header tokens to authenticate endpoint access. ROCKIT Edge uses the following tokens
TokenLifetimeDescription
x-rockit-besession-token24hObtained by POST /be/v1/login
x-rockit-beauth-token5mObtained by POST /be/v1/auth

API key-based authentication#

In order to use the ROCKIT Edge Backend API in an automated environment in most cases it is simpler to create a ROCKIT Edge Backend machine account with the minimum set of necessary permissions for the intended tasks. The returned API Key can than be used for invoking the endpoints along with the username of the machine account as well as the organization name. In addition to the required request header keys of the individual endpoint simply add the following data:
KeyDescription
x-rockit-orgnameUnique and immutable organization identifier obtained from the ROCKIT Edge administrator.
x-rockit-usernameThe unique and immutable username of the machine account.
x-rockit-api-keyThe ROCKIT Edge Backend API key obtained when creating the machine user, see POST /be/v1/users.
Note, that the API key-based authentication does not work for endpoints designed for user accounts only, such as
POST /be/v1/login or
POST /be/v1/auth.
Modified at 2024-12-17 14:26:10
Previous
Delete Organization
Next
user login
Built with