Search
K
Cipherscale API

UpdateUser

object

Data for updating user profile information

firstNamestring

User’s first name

Example:Jane

lastNamestring

User’s last name

Example:Smith

imagestring

URL or path to the user’s profile image

Example:https://example.com/avatars/jane-smith.jpg

Example
{
  "firstName": "Jane",
  "lastName": "Smith",
  "image": "https://example.com/avatars/jane-smith.jpg"
}

UpdateUserRoles

object

Data for adding or removing roles from a user

addedRolesarray[string]required

Array of role IDs to add to the user

Example:550e8400-e29b-41d4-a716-446655440000

removedRolesarray[string]required

Array of role IDs to remove from the user

Example:550e8400-e29b-41d4-a716-446655440001

Example
{
  "addedRoles": [
    "550e8400-e29b-41d4-a716-446655440000"
  ],
  "removedRoles": [
    "550e8400-e29b-41d4-a716-446655440001"
  ]
}

CreateGateway

object

Data required to create a new network gateway

namestringrequired

Human-readable name for the gateway

Example:US-East Gateway

descriptionstring

Detailed description of the gateway’s purpose and location

Example:Primary gateway for US East region data center

wireguardPortstringrequired

WireGuard VPN port number for this gateway

Example:51820

endpointstring

Network endpoint address for the gateway

Example:gateway-us-east.company.com

Example
{
  "name": "US-East Gateway",
  "description": "Primary gateway for US East region data center",
  "wireguardPort": "51820",
  "endpoint": "gateway-us-east.company.com"
}

GatewayResource

object

Resource information accessible through a gateway

idstring(uuid)required

Unique identifier for the resource

Example:550e8400-e29b-41d4-a716-446655440000

namestringrequired

Human-readable name for the resource

Example:Internal Web Server

Example
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Internal Web Server"
}

Gateway

object

Network gateway configuration and status information

idstring(uuid)required

Unique identifier for the gateway

createdAtstring(date-time)required

Timestamp when the gateway was created

updatedAtstring(date-time)required

Timestamp when the gateway was last updated

namestringrequired

Human-readable name for the gateway

descriptionstring

Detailed description of the gateway’s purpose and location

wireguardPortstringrequired

WireGuard VPN port number for this gateway

statusstringrequired

Current operational status of the gateway

Allowed values:PENDINGONLINEOFFLINEMAINTENANCEERROR

errorstring

Error message if the gateway is in ERROR status

tokenstringrequired

Authentication token for gateway communication

lastOnlinestring(date-time)

Timestamp when the gateway was last online

relayEnabledboolean

Whether the gateway can relay traffic between network segments

endpointstring

Network endpoint address for the gateway

autoDiscoverEndpointbooleanrequired

Whether the gateway endpoint is automatically discovered

resourcesarray[object]

Resource information accessible through a gateway

Example:{"id":"550e8400-e29b-41d4-a716-446655440000","name":"Internal Web Server"}

Show Child Parameters
Example
{
  "id": "id",
  "createdAt": "createdAt",
  "updatedAt": "updatedAt",
  "name": "name",
  "description": "description",
  "wireguardPort": "wireguardPort",
  "status": "PENDING",
  "error": "error",
  "token": "token",
  "lastOnline": "lastOnline",
  "relayEnabled": false,
  "endpoint": "endpoint",
  "autoDiscoverEndpoint": false,
  "resources": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Internal Web Server"
    }
  ]
}