Search
K
Cipherscale API

Cipherscale API

1.0OAS 3.0

A comprehensive Zero Trust Network Access (ZTNA) platform API that provides secure, policy-based access control for users, devices, and resources. The API enables organizations to manage network policies, user authentication, device management, and resource access through a centralized control plane.

API Base URL
  • Server 1:https://public-api.cipherscale.com/qa

    Cipherscale Public API Server

Security
ApiKeyAuth (apiKey)

An API key is a token that you provide when making API calls. Include the token in a header parameter called apikey.

Example: apikey: 123

Additional Information
Contact Cipherscale Support (support@cipherscale.com)

Users

User account management and authentication

Get User Details

Retrieves comprehensive details of a specific user including their profile information, assigned roles, group memberships, associated devices, and connection status. This endpoint is essential for user management and access control operations.

get
https://public-api.cipherscale.com/qa/tenants/users/{id}

Path Parameters

idstring(uuid)required

The unique identifier (UUID) of the user

Example:123e4567-e89b-12d3-a456-426614174000

Response

application/json

Successfully retrieved the user

User

Complete user profile with authentication, authorization, and device information

idstring(uuid)required

Unique identifier for the user

createdAtstring(date-time)required

Timestamp when the user account was created

updatedAtstring(date-time)required

Timestamp when the user account was last modified

lastConnectionstring(date-time)

Timestamp of the user’s last network connection

emailstring

User’s email address used for authentication

statusstringrequired

Current status of the user account (active, inactive, pending, etc.)

firstNamestring

User’s first name

lastNamestring

User’s last name

isOwnerbooleanrequired

Whether this user is the tenant owner

maxDevicesnumber | nullrequired

Maximum number of devices this user can register

imagestring

URL or path to the user’s profile image

rolesarray[object]required

User role definition with specific permissions and capabilities

Show Child Parameters
groupsarray[object]required

User group information with role assignments and member management

Example:{"id":"550e8400-e29b-41d4-a716-446655440000","name":"Engineering Team","description":"Software engineering team with access to development resources","createdAt":"2023-01-15T10:30:00Z","updatedAt":"2023-01-15T10:30:00Z"}

Show Child Parameters
devicesarray[object]required

Device information including connection status, user association, and security posture

Show Child Parameters
get/tenants/users/{id}
 
application/json