splinterd API (0.7.1)

Download OpenAPI specification:Download

REST API for the Splinter daemon

Biome

Routes supporting user management in Splinter applications. Optionally compiled.

Create new user with username and password credent

Create new user with username and password credentials

header Parameters
SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Request Body schema: application/json
username
required
any

username of a new user

hashed_password
required
any

Hashed password to be used for user authentication

Responses

Request samples

Content type
application/json
{
  • "username": "alice@acme.com",
  • "hashed_password": "F4AABE0B40C9ABB8B6FD2EEACB39C965"
}

Response samples

Content type
application/json
{
  • "message": "User created successfully",
  • "data": {
    }
}

Authenticates a user with username and password cr

Authenticates a user with username and password credentials

header Parameters
SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Request Body schema: application/json
username
required
any

username of user

hashed_password
required
any

Hashed password to be used for user authentication

Responses

Request samples

Content type
application/json
{
  • "username": "alice@acme.com",
  • "hashed_password": "8945622435187243046536949706b5272644c71336c7254563679727565494b376d4b3554696b734662685962652f6v52562e437a70462f6552489c8b"
}

Response samples

Content type
application/json
{
  • "message": "Successful login",
  • "user_id": "f35aacc1-a9cd-4eda-b6d0-2efaddf0c8a4",
  • "token": "Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2VsZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD_AEVPEUXY70Ehc",
  • "refresh_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2VsZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD_AEVPEUXY70Ehc"
}

Removes access tokens associated with a user

Removes access tokens associated with a user

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "message": "User successfully logged out"
}

Issues a new access token

Issues a new access token

header Parameters
SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Request Body schema: application/json
refresh_token
required
any

a refresh token issues by biome

Responses

Request samples

Content type
application/json
{
  • "refresh_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2VsZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD_AEVPEUXY70Ehc"
}

Response samples

Content type
application/json
{
  • "token": "Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2VsZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD_AEVPEUXY70Ehc"
}

Verifies a user with username and password credent

Verifies a user with username and password credentials

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Request Body schema: application/json
username
required
any

username of user

hashed_password
required
any

Hashed password to be used for user authentication

Responses

Request samples

Content type
application/json
{
  • "username": "alice@acme.com",
  • "hashed_password": "8945622435187243046536949706b5272644c71336c7254563679727565494b376d4b3554696b734662685962652f6v52562e437a70462f6552489c8b"
}

Response samples

Content type
application/json
{
  • "message": "Successful verification",
  • "user_id": "f35aacc1-a9cd-4eda-b6d0-2efaddf0c8a4"
}

Lists all users This endpoint requires the permis

Lists all users

This endpoint requires the permission "biome.user.read".

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Fetch a user by ID This endpoint requires the per

Fetch a user by ID

This endpoint requires the permission "biome.user.read".

path Parameters
user_id
required
string
Example: f35aacc1-a9cd-4eda-b6d0-2efaddf0c8a4

ID of the user

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "username": "alice@acme.com",
  • "user_id": "f35aacc1-a9cd-4eda-b6d0-2efaddf0c8a4"
}

Update a user This endpoint requires the permissi

Update a user

This endpoint requires the permission "biome.user.write".

path Parameters
user_id
required
string
Example: f35aacc1-a9cd-4eda-b6d0-2efaddf0c8a4

ID of the user

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Request Body schema: application/json
username
required
string

Existing username of user

hashed_password
required
string

Hashed password to be used for user authentication

new_password
string

Hash of the new password to be used for user authentication

Array of objects (BiomeNewUserKey)

Responses

Request samples

Content type
application/json
{
  • "username": "alice@acme.com",
  • "hashed_password": "8945622435187243046536949706b5272644c71336c7254563679727565494b376d4b3554696b734662685962652f6v52562e437a70462f6552489c8b"
}

Response samples

Content type
application/json
{
  • "message": "Credentials and key updated successfully",
  • "data": [
    ]
}

Delete a user This endpoint requires the permissi

Delete a user

This endpoint requires the permission "biome.user.write".

path Parameters
user_id
required
string
Example: f35aacc1-a9cd-4eda-b6d0-2efaddf0c8a4

ID of the user

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "message": "User deleted successfully"
}

List all user profiles This endpoint requires the

List all user profiles

This endpoint requires the permission "biome.profile.read".

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
[]

Fetch a profile by ID This endpoint requires the

Fetch a profile by ID

This endpoint requires the permission "biome.profile.read".

path Parameters
user_id
required
string
Example: f35aacc1-a9cd-4eda-b6d0-2efaddf0c8a4

ID of the user

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{}

Get the profile of the authenticated user

Get the profile of the authenticated user

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{}

List keys of a user

List keys of a user

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Replace all keys for the user

Replace all keys for the user

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Request Body schema: application/json
Array
display_name
string

Display name for key

encrypted_private_key
string

Encrypted private key

public_key
string

Public key

user_id
string

Internal unique identifier for the user

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "Keys replaced successfully"
}

Update a key's display name

Update a key's display name

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Request Body schema: application/json
public_key
required
string

Public key

new_display_name
required
string

Updated display name for the key

Responses

Request samples

Content type
application/json
{
  • "public_key": "026c889058c2d22558ead2c61b321634b74e705c42f890e6b7bc2c80abb4713118",
  • "new_display_name": "Admin key pair"
}

Response samples

Content type
application/json
{
  • "message": "Key updated successfully"
}

Add a new key for user

Add a new key for user

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Request Body schema: application/json
display_name
string

Display name for key

encrypted_private_key
string

Encrypted private key

public_key
string

Public key

user_id
string

Internal unique identifier for the user

Responses

Request samples

Content type
application/json
{
  • "display_name": "Biome Admin Key",
  • "encrypted_private_key": "XNzIjoic2VsZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD_AEVPEUXY70Ehc",
  • "public_key": "026c889058c2d22558ead2c61b321634b74e705c42f890e6b7bc2c80abb4713118",
  • "user_id": "f35aacc1-a9cd-4eda-b6d0-2efaddf0c8a4"
}

Response samples

Content type
application/json
{
  • "message": "Key added successfully",
  • "data": {
    }
}

Fetch key of a user

Fetch key of a user

path Parameters
public_key
required
string
Example: 026c889058c2d22558ead2c61b321634b74e705c42f890e6b7bc2c80abb4713118

Public key of the user

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete key of a user

Delete key of a user

path Parameters
public_key
required
string
Example: 026c889058c2d22558ead2c61b321634b74e705c42f890e6b7bc2c80abb4713118

Public key of the user

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "message": "User deleted successfully",
  • "data": {
    }
}

Proposals

Fetches a list of pending circuit proposals for this node

This endpoint can be used to view all of the circuit proposals that the node is a proposed member of. If a circuit management type is provided via the "management_type" query parameter, only circuit proposals that have the given circuit management type will be returned. If a node ID is provided via the "member" query parameter, only circuit proposals that have the given node as a member will be returned. If no filter is provided, all of the node's circuit proposals will be returned.

This endpoint requires the permission "circuit.read".

query Parameters
offset
integer
Default: 0

paging offset

limit
integer
Default: 100

maximum number of items to return (max 100)

management_type
string

Only show proposed circuits matching the given circuit management type

member
string

Only show proposed circuits that have a member with the given node ID

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "paging": {
    }
}

Fetches a circuit proposal by the circuit's ID

This endpoint can be used to view a specific circuit proposal that the node is a proposed member of.

This endpoint requires the permission "circuit.read".

path Parameters
circuit_id
required
string

Circuit ID of the proposal to fetch

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "proposal_type": "Create",
  • "circuit_id": "01234-ABCDE",
  • "circuit_hash": "8ce518770b962429a953b10220905ac9adf86a855f0b085695f444edf991b8ca",
  • "circuit": {
    },
  • "votes": [
    ],
  • "requester": "026c889058c2d22558ead2c61b321634b74e705c42f890e6b7bc2c80abb4713118",
  • "requester_node_id": "alpha-node-000"
}

Admin Service

Send circuit management payload in bytes to admin

Send circuit management payload in bytes to admin service

This endpoint requires the permission "circuit.write".

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Request Body schema: application/octet-stream
string <binary>

Responses

Response samples

Content type
application/json
{
  • "message": "DatabaseError({description})"
}

Register the handler for a circuit management type

Register the handler for a circuit management type

This endpoint requires the permission "circuit.read".

path Parameters
type
required
string

The circuit management type is the type of circuit the handler will manage

query Parameters
last
integer
Default: 0

A timestamp in milliseconds from the Unix Epoch, indicating the last received event.

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "circuit_management_type": "gameroom",
  • "error_reason": "string"
}

Circuits

Fetches a list of circuits that the node belongs to

This endpoint can be used to view all or some of the circuits that the node is a member of. If a node ID is provided via the "filter" query parameter, only circuits that have the given node ID as a member will be returned. If a circuit status is provided via the "status" query parameter, only circuits that have the given circuit status will be returned; if no filter is provided, all of the node's Active circuits will be returned.

This endpoint requires the permission "circuit.read".

query Parameters
offset
integer
Default: 0

paging offset

limit
integer
Default: 100

maximum number of items to return (max 100)

filter
string

Node ID that must be present in the returned circuits

status
string

Circuit status of the returned circuits

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "paging": {
    }
}

Fetches a circuit by its ID

This endpoint can be used to view a specific circuit that the node is a member of.

This endpoint requires the permission "circuit.read".

path Parameters
circuit_id
required
string

ID of the circuit to fetch

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "id": "01234-ABCDE",
  • "members": [
    ],
  • "roster": [
    ],
  • "management_type": "gameroom",
  • "display_name": "string",
  • "circuit_status": "Active"
}

Authorization

Get all assignments

Gets all assignments.

This endpoint requires the permission "authorization.rbac.read".

query Parameters
required
object

An offset and limit for paginated results.

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a new assignment

Adds a new assignment This endpoint requires the permission "authorization.rbac.write".

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Request Body schema: application/json
object (IdentityPayload)
roles
Array of strings

Responses

Request samples

Content type
application/json
{
  • "identity": {
    },
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "400",
  • "message": "Invalid assignment payload"
}

Get assignment

Gets the assignment associated with the identity.

This endpoint requires the permission "authorization.rbac.read".

path Parameters
identity_type
required
string
Enum: "key" "user"

Enum of possible identity types.

identity
required
string

The unique identity string.

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update assignment.

Updates the assignment associated with the identity.

This endpoint requires the permission "authorization.rbac.write".

path Parameters
identity_type
required
string
Enum: "key" "user"

Enum of possible identity types.

identity
required
string

The unique identity string.

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Request Body schema: application/json
roles
Array of strings

Responses

Request samples

Content type
application/json
{
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "404",
  • "message": "Identity not found"
}

Removes the assignment associated with the identit

Removes the assignment associated with the identity and identity_type.

This endpoint requires the permission "authorization.rbac.write".

path Parameters
identity_type
required
string
Enum: "key" "user"

Enum of possible identity types.

identity
required
string

The unique identity string.

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "code": "500",
  • "message": "Internal Server Error"
}

Checks whether or not maintenance mode is enabled

Checks whether or not maintenance mode is enabled

This endpoint requires the permission "authorization.maintenance.read".

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Sets whether or not maintenance mode is enabled T

Sets whether or not maintenance mode is enabled

This endpoint requires the permission "authorization.maintenance.write".

query Parameters
enabled
required
boolean

If "true", maintenance mode will be enabled; if "false", maintenance mode will be disabled.

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "message": "DatabaseError({description})"
}

Fetches the list of all REST API permissions This

Fetches the list of all REST API permissions

This endpoint requires the permission "authorization.permissions.read".

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Fetches a list of roles

This endpoint can be used to view all of the available roles configured for the node. These roles control access to various permissions in the system.

This endpoint requires the permission "authorization.rbac.read".

query Parameters
offset
integer
Default: 0

paging offset

limit
integer
Default: 100

maximum number of items to return (max 100)

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "paging": {
    }
}

Add a role

This endpoint can be used to add a new role to the Splinter Role-based authorization system. The role must conform to the role schema and have unique "role_id" value.

This endpoint requires the permission "authorization.rbac.write".

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Request Body schema: application/json
role_id
string

Unique identifier for the role

display_name
string

A human readable name of the role.

permissions
Array of strings

An array of permissions included with this role.

Responses

Request samples

Content type
application/json
{
  • "role_id": "circuit-administrator",
  • "display_name": "Circuit Administrator",
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "DatabaseError({description})"
}

Permissions

Fetches the list of all REST API permissions This

Fetches the list of all REST API permissions

This endpoint requires the permission "authorization.permissions.read".

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Fetches a list of roles

This endpoint can be used to view all of the available roles configured for the node. These roles control access to various permissions in the system.

This endpoint requires the permission "authorization.rbac.read".

query Parameters
offset
integer
Default: 0

paging offset

limit
integer
Default: 100

maximum number of items to return (max 100)

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "paging": {
    }
}

Add a role

This endpoint can be used to add a new role to the Splinter Role-based authorization system. The role must conform to the role schema and have unique "role_id" value.

This endpoint requires the permission "authorization.rbac.write".

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Request Body schema: application/json
role_id
string

Unique identifier for the role

display_name
string

A human readable name of the role.

permissions
Array of strings

An array of permissions included with this role.

Responses

Request samples

Content type
application/json
{
  • "role_id": "circuit-administrator",
  • "display_name": "Circuit Administrator",
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "DatabaseError({description})"
}

Roles

Fetches a list of roles

This endpoint can be used to view all of the available roles configured for the node. These roles control access to various permissions in the system.

This endpoint requires the permission "authorization.rbac.read".

query Parameters
offset
integer
Default: 0

paging offset

limit
integer
Default: 100

maximum number of items to return (max 100)

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "paging": {
    }
}

Add a role

This endpoint can be used to add a new role to the Splinter Role-based authorization system. The role must conform to the role schema and have unique "role_id" value.

This endpoint requires the permission "authorization.rbac.write".

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Request Body schema: application/json
role_id
string

Unique identifier for the role

display_name
string

A human readable name of the role.

permissions
Array of strings

An array of permissions included with this role.

Responses

Request samples

Content type
application/json
{
  • "role_id": "circuit-administrator",
  • "display_name": "Circuit Administrator",
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "DatabaseError({description})"
}

Fetches a role by its ID

This endpoint can be used to view a specific role.

This endpoint requires the permission "authorization.rbac.read".

path Parameters
role_id
required
string

ID of the role to fetch

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

RBAC

Fetches a list of roles

This endpoint can be used to view all of the available roles configured for the node. These roles control access to various permissions in the system.

This endpoint requires the permission "authorization.rbac.read".

query Parameters
offset
integer
Default: 0

paging offset

limit
integer
Default: 100

maximum number of items to return (max 100)

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "paging": {
    }
}

Add a role

This endpoint can be used to add a new role to the Splinter Role-based authorization system. The role must conform to the role schema and have unique "role_id" value.

This endpoint requires the permission "authorization.rbac.write".

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Request Body schema: application/json
role_id
string

Unique identifier for the role

display_name
string

A human readable name of the role.

permissions
Array of strings

An array of permissions included with this role.

Responses

Request samples

Content type
application/json
{
  • "role_id": "circuit-administrator",
  • "display_name": "Circuit Administrator",
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "DatabaseError({description})"
}

Splinter Registry

Add a node to the registry

This endpoint can be used to add a new node to the Splinter registry. The node must be valid (see the Splinter registry documentation for details on node validity).

This endpoint requires the permission "registry.write".

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Request Body schema: application/json
identity
string
endpoints
Array of strings
display_name
string
keys
Array of strings
metadata
object

Responses

Request samples

Content type
application/json
{
  • "identity": "node-123123-asdf",
  • "endpoints": [
    ],
  • "display_name": "Cargill - Node 1",
  • "keys": [
    ],
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "message": "DatabaseError({description})"
}

List nodes in the registry

This endpoint can be used to view all or some of the nodes in the registry. If metadata filters are provided via the "filter" query parameter, only nodes that match the given filters will be returned. See the Splinter registry documentation for details on metadata filters.

This endpoint requires the permission "registry.read".

query Parameters
offset
integer
Default: 0

paging offset

limit
integer
Default: 100

maximum number of items to return (max 100)

filter
string
Example: filter=%7B%22company%22%3A%5B%22%3D%22%2C%22Cargill%22%5D%7D

url-encodeded stringified JSON containing property filters on the node's metadata properties in the format {METADATA_PROPERTY:[{"operator":OPERATOR,"value":VALUE}]}

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "paging": {
    }
}

Fetch a node in the registry by its identity

This endpoint can be used to view a specific nodes in the registry.

This endpoint requires the permission "registry.read".

path Parameters
identity
required
string

identity of node to fetch

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Add or replace a node in the registry

This endpoint can be used to add a new node to the registry, or replace an existing node. When replacing an existing node, the node identity cannot be changed. This action is idempotent.

This endpoint requires the permission "registry.write".

path Parameters
identity
required
string

identity of node to add/replace

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Request Body schema: application/json
identity
string
endpoints
Array of strings
display_name
string
keys
Array of strings
metadata
object

Responses

Request samples

Content type
application/json
{
  • "identity": "node-123123-asdf",
  • "endpoints": [
    ],
  • "display_name": "Cargill - Node 1",
  • "keys": [
    ],
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "message": "DatabaseError({description})"
}

Delete a node from the registry

This endpoint can be used to remove a node from the registry.

This endpoint requires the permission "registry.write".

path Parameters
identity
required
string

identity of node to delete

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "message": "DatabaseError({description})"
}

Scabbard

Submit a list of batches to the Scabbard service

This endpoint can be used to submit batches to a Scabbard service. The body of the request must be a list of valid Sabre batches. If the batches are submitted successfully, the response will contain a link for checking the status of the submitted batches.

This endpoint requires the permission "scabbard.write".

path Parameters
circuit
required
string

Circuit the targeted service belongs to

service_id
required
string

ID of the targeted service

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "link": "/scabbard/abcde-01234/ABCD/batch_statuses?ids=6ff35474a572087e08fd6a54d563bd8172951b363e5c9731f1a40a855e14bba45dac515364a08d8403f4fb5d4a206174b7f63c29e4f4e425dc71b95494b8a798"
}

Get the statuses of a list of batches

This endpoint can be used to check the status of one or more batches that were submitted to a Scabbard service. The IDs of the batches to check should be specified with the ids query parameter. The wait query parameter requests that the server wait for the given number of seconds for the batches to be committed; however, this wait time is not guaranteed.

This endpoint requires the permission "scabbard.read".

path Parameters
circuit
required
string

Circuit the targeted service belongs to

service_id
required
string

ID of the targeted service

query Parameters
ids
required
string

Comma-separated list of batch IDs

wait
integer
Default: 300

Time (in seconds) to wait for batches to be committed. If not provided, the server will return the batch statuses immediately. If the parameter is provided without a value, the default time (300 seconds) will be used.

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of entries from a Scabbard service's state

This endpoint can be used to fetch a list of entries from a Scabbard service's state. The entries can be filtered using an address prefix provided with the prefix query parameter.

This endpoint requires the permission "scabbard.read".

path Parameters
circuit
required
string

Circuit the targeted service belongs to

service_id
required
string

ID of the targeted service

query Parameters
prefix
string
Example: prefix=00ec01

An address prefix for filtering state entries. If no prefix is specified, all state entries will be returned.

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the value at an address in a Scabbard service's state

This endpoint can be used to fetch the value at a specific address in a Scabbard service's state.

This endpoint requires the permission "scabbard.read".

path Parameters
circuit
required
string

Circuit the targeted service belongs to

service_id
required
string

ID of the targeted service

address
required
string
Example: 000000a87cb5eafdcca6a814e4add97c4b517d3c530c2f44b31d18e3b0c44298fc1c14

The address of the value to retrieve from state

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
[
  • 0
]

OAuth

Provides a redirect to the node's configured OAuth

Provides a redirect to the node's configured OAuth provider to authenticate the user.

query Parameters
redirect_url
string

The URL the client will be redirected to once the OAuth authentication process has been completed. If this parameter is not provided, Splinter will attempt to retrieve the referer header of the request. If this header value is also not available and the redirect_url does not have a value, Splinter will respond with 400 Bad Request.

header Parameters
SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "message": "DatabaseError({description})"
}

Receives an authorization code from the OAuth prov

Receives an authorization code from the OAuth provider to create an access token for the user. Redirects to a URL provided by the client when the OAuth authentication process was initiated.

header Parameters
SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "message": "DatabaseError({description})"
}

Removes a user's access and refresh tokens from st

Removes a user's access and refresh tokens from storage.

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "message": "User successfully logged out"
}

Lists all OAuth users This endpoint requires the

Lists all OAuth users

This endpoint requires the permission "oauth.user.read".

query Parameters
offset
integer
Default: 0

paging offset

limit
integer
Default: 100

maximum number of items to return (max 100)

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "paging": {
    }
}

Diagnostics

Used to check if server is successfully running T

Used to check if server is successfully running

This endpoint requires the permission "status.read".

header Parameters
Authorization
required
string
Examples:
  • Bearer Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lk\ IjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2V\ sZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD\ _AEVPEUXY70Ehc - Biome example
  • Bearer Cylinder:eyJhbGciOiJzZWNwMjU2azEiLCJ0eXAiOiJjeWxpbmR\ lcitqd3QifQ==.eyJpc3MiOiIwMjc5YmU2NjdlZjlkY2JiYWM1NWEwNjI5NWNlODcwY\ jA3MDI5YmZjZGIyZGNlMjhkOTU5ZjI4MTViMTZmODE3OTgifQ==.71Vw3+m9R4b8iZU\ zhRHOAtX/hO5WYA9PgMe27/CeZ6NhIXFYkBBzreoIGpHbfJ8UxT+1MLUgjsQB8TISaf\ neRA== - Cylinder example
  • Bearer OAuth2:55eeea7ce2b472d69d406990939baa698e34e955 - OAuth2 example

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersion
integer
Example: 2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Responses

Response samples

Content type
application/json
{
  • "version": "0.7.1",
  • "node_id": "node-009",
  • "display_name": "Cargill Node 009",
  • "service_endpoint": "tcp://foo.bar.biz",
  • "network_endpoints": [
    ],
  • "advertised_endpoints": [
    ]
}