Privicore
  1. Policy
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
    • OAuth Application Management
    • 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
    • Public and Private Key Management
    • Generate your private and public keys
    • Register public key
    • Retrieve public key
    • Retrieve CAB public key
  • Data Token
    • Data Token Management
    • 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
    • Device Management
    • 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
    • Storage Device Management
    • Register storage device
    • List storage devices
    • Synchronize device
    • Remove storage
  • Verified authenticator
    • Authenticator and Voting Management
    • Register authenticator
    • List verified authenticators
    • Retrieve voting strategy
    • Set quorum size
    • Set quorum strategy
    • Set voting time limit
    • Set maximum voting attempts
    • Remove authenticator
    • Register voting configuration
    • Update voting configuration
    • List voting configurations
    • Retrieve voting configuration
  • Policy
    • Policy Management
    • List policy templates
      GET
    • Register policy
      POST
    • List active policies
      GET
    • List inactive policies
      GET
    • Activate policy
      POST
    • Deactivate policy
      POST
    • Delete policy
      POST
    • List registered policies
      GET
    • Retrieve registered policy
      GET
  • Voting
    • Voting Operations
    • Create voting
    • Check pool status
  • Schemas
    • Response
      • CommandAccepted
      • Unauthorized
      • ValidationErrors
    • Schemas
    • profileId
    • deviceIdentifier
    • directoryId
    • directoryName
    • directoryShortName
    • givenName
    • familyName
    • createdAt
    • meta
  1. Policy

Retrieve registered policy

GET
/policy/retrieve-policy/{identifier}

Overview#

Retrieve detailed information about a specific registered policy by its identifier or name.

Retrieve Registered Policy#

Endpoint: GET /policy/retrieve-policy/{identifier}
Authentication: Required (Authorization token obtained from the step)

Path Parameters#

ParameterTypeRequiredDescription
identifierstringYesPolicy ID or policy name

Use Case#

Use this endpoint to retrieve complete details for a specific policy. You can retrieve by either:
Policy ID: The unique identifier assigned during registration
Policy Name: The human-readable name provided during registration
The response includes all policy configuration:
Policy identifier and name
Active/inactive status
Template used to create the policy
Events that trigger the policy
Configuration parameters and their values
Associated voting configuration
Voting attributes from the template
This is useful for:
Verifying policy configuration before activation
Debugging unexpected voting triggers
Documenting authorization requirements
Retrieving policy details for updates or modifications
Understanding why specific operations triggered voting
Identifier can be either policy ID or policy name
Use policy name for human-readable lookups
Use policy ID for programmatic access
Response includes complete configuration details
Policy must be registered under your profile

Request

Authorization
API Key
Add parameter in header
X-DPT-AUTHORIZATION
Example:
X-DPT-AUTHORIZATION: ********************
or
Path Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://sandbox.privicore.com:9009/policy/retrieve-policy/' \
--header 'X-DPT-AUTHORIZATION: <api-key>'

Responses

🟢200Success
application/json
OK
Body

Example
{
    "id": "df15ac75-5d07-47ac-b97c-b7fa47f6a224",
    "name": "default",
    "profile": "5f1c2741-7d88-42aa-8386-7e4115b0a0de",
    "policyId": "b04d823e-f76f-4fcf-9beb-270bff1a7bb2",
    "votingConfigurationId": "f4754e31-8a90-4642-90f4-86a19f93a34f",
    "configuration": [
        "string"
    ],
    "applyingEventIds": [
        "string"
    ],
    "active": true,
    "createdAt": "2025-02-10T10:03:06+00:00"
}
🟠401401
🟠404404
Modified at 2025-12-31 12:21:34
Previous
List registered policies
Next
Voting Operations
Built with