Privicore
  1. Profile
Privicore
  • Privicore API
  • Utility
    • Utility
    • Check server health
      GET
    • Request command id status
      GET
  • Profile
    • Profile Model and Authentication Workflow
    • Register new profile
      POST
    • Authenticate
      POST
    • Retrieve profile id
      GET
    • Change password
      POST
    • Generate qr token for authorization
      POST
    • Reauthorize authorization token
      POST
    • Revoke authorization token
      POST
    • Retrieve token expiry
      POST
  • OAuth Application
    • Register OAuth Application
      POST
    • Retrieve OAuth app configuration
      POST
    • Request OAuth app authorization code
      GET
    • Retrieve OAuth app authorization code
      POST
    • Obtain OAuth app access token
      POST
    • OAuth application list
      GET
    • Retrieve OAuth application scope
      GET
    • Refresh OAuth app access token
      POST
  • Public key
    • Generate your private and public keys
      GET
    • Register public key
      POST
    • Retrieve public key
      GET
    • Retrieve CAB public key
      GET
  • Data Token
    • Reserve token space
    • Retrieve temporary data token
    • Exchange data for token
    • Upstream file via stream auth
    • Request data via token
    • Download data
    • Configure information security risk meta
    • Configure file meta
    • List data tokens
    • Update data token
    • Delete data
  • Device
    • Request unique identifier (i.e. Register new device)
    • Retrieve unique identifier
    • Retrieve profile devices
    • Configure device meta
    • Approve device
    • Reject device
    • Retrieve device configuration
    • Remove device
  • Storage
    • Register storage device
    • List storage devices
    • Synchronize device
    • Remove storage
  • Verified authenticator
    • Register authenticator
    • List verified authenticators
    • Retrieve voting strategy
    • Set quorum size
    • Set quorum strategy
    • Set voting time limit
    • Set maximum voting attempts
    • Remove authenticator
  • Policy
    • List policy templates
    • Register policy
    • List active policies
    • List inactive policies
    • Activate policy
    • Deactivate policy
    • Delete policy
  • Directory
    • Register Directory
    • Retrieve owned Directories
    • Retrieve assigned directories
    • Retrieve Directory
    • Create Directory User
    • Update user information
    • Invite Profile
    • Set profile password
    • List Directory Invites
    • Process Invitation
    • Retrieve directory profile
    • List directory users
    • Directory profiles info
    • Create profile device
    • Add storage device to profile
    • List directory devices
    • Create directory voting pool
    • Store directory meta information
  • Voting
    • Create voting
    • Check pool status
  1. Profile

Profile Model and Authentication Workflow

A Profile represents an external actor that interacts with the system via authenticated API calls. Each profile encapsulates the following core attributes:
username: Unique identifier used for authentication
password: Secret credential associated with the username
publicKey: A registered cryptographic public key used for verifying request signatures and securing communication
Current actors are:
user: Profile that is using the system for uploading/downloading data, registering devices etc..
device: Storage or Authenticator that is registered under profile

Profile Activation Requirements#

For a profile to become an active and fully functional identity within the system, its associated publicKey must be successfully registered. The absence of a registered key renders the profile incomplete and unable to initiate system-level operations.
Note: Public key registration is a mandatory step in the provisioning process. Until this is completed, the profile cannot participate in any authenticated workflow.

Authentication and Token Acquisition#

Before a profile can perform any interaction with protected system resources, it must obtain a valid authorization token. This is achieved through an authentication request using the profile's credentials.
The access_token must be included as a X-DPT-AUTHORIZATION header of all subsequent API requests and as token for all messages that are sent.

Summary#

A profile must be provisioned with a username, password, and public key.
Public key registration is required for the profile to become operational.
Upon successful authentication, the system issues a token.
The token must accompany all authorized API requests made by the profile as part of header or in case of messages as part of auth.
Modified at 2025-04-09 14:45:17
Previous
Request command id status
Next
Register new profile
Built with