๐Ÿ“–
Managed Guardian Service Documentation
HomeSupportContact UsAbout
  • ๐Ÿ‘‹The Next Generation of Registry Systems
  • Overview
    • ๐ŸŒŽQuick Start - MGS
    • ๐ŸŒQuick Start - Indexer
      • ๐ŸŒExisting MGS Account Users
      • ๐ŸŒNew User Without an MGS Account
    • โœจKey Features of Managed Guardian Service (MGS)
    • ๐Ÿค–Custom MGS ChatGPT Assistant
  • LEARN
    • ๐ŸŽฌImportant Concepts
      • โ˜บ๏ธTypes of Users
      • โ›“๏ธAbout the Trust Chain
      • ๐Ÿ“‚About Schemas
      • ๐Ÿ”ƒAbout Policies
      • ๐ŸŽฎAbout Dry Run
      • โš–๏ธAbout Retirement
      • ๐Ÿ”About MGS Vault
    • ๐Ÿ“ฝ๏ธMethodology Breakdown
  • ๐Ÿ†•WHAT'S NEW
    • Changelog
      • Beta v1
      • Beta v2
      • Beta v3
      • Beta v3.1
      • Beta v3.2
      • Beta v4
      • Beta v5
      • Beta v5.1
      • Beta v6
      • Beta v7
      • Beta v8
      • Beta v9
      • Beta v10
      • Beta v10.1
      • Beta v10.2
  • TECHNICAL INFORMATION
    • ๐Ÿ“ฏTenant Admins
      • ๐Ÿ—ƒ๏ธIPFS Storage Providers
        • โ˜‘๏ธCompatible IPFS Storage Providers
        • โ˜๏ธManaged IPFS Node
          • ๐Ÿ—ƒ๏ธIntegrating Managed IPFS Node with MGS Tenants
        • โ˜๏ธWeb3.Storage
          • ๐Ÿ”How to Generate Web3.Storage Key and Proof
          • ๐Ÿ—ƒ๏ธIntegrating Web3.Storage with MGS Tenants
        • โ˜๏ธfilebase
          • ๐Ÿ”Setting up filebase
          • ๐Ÿ—ƒ๏ธIntegrating filebase with MGS Tenants
      • ๐Ÿ› ๏ธTenant Operations
        • โš™๏ธTenant APIs
          • Return Tenants
          • Return user Tenants
          • Create New Tenant
          • Return Tenant Related Settings
          • Send Invite Link
          • Delete Tenant
          • Return Users for Tenant
          • Delete Tenant User
          • Reorder Tenants
      • ๐Ÿ–ฅ๏ธCreating Tenants using the UI
    • ๐Ÿ‘จโ€๐Ÿ’ปUsers
      • ๐ŸซStandard Registry Users, Schemas, and Policies
        • ๐Ÿ› ๏ธSchemas
          • ๐Ÿ“‚Available Schema Types
          • ๐Ÿ“Property Glossary
          • โ„น๏ธSystem / Policy Schemas
          • ๐Ÿ–ฅ๏ธCreating a System Schema using the UI
          • ๐Ÿ–ฅ๏ธCreating a Policy Schema using the UI
          • ๐Ÿ’ปCreating Tag Schemas using UI
          • โš™๏ธSchema Creation Using APIs
            • Listing of Schema
            • Publishing schema based on schema ID
            • Updating Schema
            • Deleting a Schema
            • Schema Preview from IPFS
            • Schema Preview from Zip
            • Export message IDs of Schema
            • Export Files from Schema
            • Creation of Schema related to the topic
            • Returns all Schemas related to the topic
            • Importing Zip file containing Schema
            • Import schema from Zip
            • Returning Schema by SchemaID
          • โš™๏ธSystem Schemas APIs
            • Creates New System Schema
            • Returns Schema by Type
            • Returns Schema by Username
            • Updates the Schema
            • Delete System Schema
            • Publishes the Schema
            • Schema Type
          • โš™๏ธSchema Related APIs for Asynchronous Execution
            • Creation of Schema
            • Publishing Schema
            • Previews the Schema from IPFS
            • Importing Schema from IPFS
            • Importing Schema from .zip
          • ๐Ÿ“Schema Tree
            • ๐Ÿ’ปSchema Tree UI
            • โš™๏ธReturning Schema Tree API
          • ๐Ÿ“Example Data
            • ๐Ÿ’ปAdding Example data using UI
          • ๐Ÿ“Schema Differentiation
            • ๐Ÿ’ปSchema Differentiation using UI
            • โš™๏ธSchema Differentiation APIs
              • Returns Result of Schema comparison
              • Exports Schema Differentiation Results
          • ๐Ÿ“Tag Schema
            • โš™๏ธTag Schema APIs
              • Returning all Schema Tags
              • Creating new Schema Tag
              • Deleting Schema Tag
              • Updating Schema Tag
              • Publishing Schema
              • Returning list of published schemas
          • Schema Predefined Values
          • Schema Rules
            • Defining Schema Rules using UI
            • APIs related to Schema Rules
              • Creation of the new schema rule
              • Retrieve the schema rules
              • Retrieve the configuration of the rule by its ID
              • Update the configuration of the rule with the corresponding ID
              • Delete the rule by its ID
              • Activate the rule with the specified ID
              • Deactivate the rule with the specified ID
              • List all the schemas and policy relevant to the rule with the specified ID
              • Retrieve all the data needed for evaluating the rules
              • Create a new rule from the file
              • Load the file and return its preview
              • Export the selected rule (by ID) into the file
        • ๐Ÿ› ๏ธPolicies
          • ๐ŸŽ“Policy Glossary
          • ๐Ÿ”„Available Policy Workflow Blocks
            • InterfaceContainerBlock
            • PolicyRolesBlock
            • InterfaceStepBlock
            • requestVCDocumentBlock
            • sendToGuardianBlock
            • reassigningBlock
            • InformationBlock
            • InterfaceDocumentsSourceBlock
            • paginationAddon
            • DocumentsSourceAddOn
            • filtersAddOnBlock
            • InterfaceActionBlock
            • externalDataBlock
            • retirementDocumentBlock
            • wipeDocumentBlock
            • calculateMathAddOnBlock
            • reportBlock & reportItemBlock
            • switchBlock
            • TimerBlock
            • aggregateDocumentBlock
            • revocationBlock
            • setRelationshipsBlock
            • Button Block
            • documentValidatorBlock
            • tokenActionBlock
            • tokenConfirmationBlock
            • mintDocumentBlock
            • groupManagerBlock
            • multiSignBlock
            • customLogicBlock
            • splitBlock
            • create Token Block
            • Impact Addon
            • Http Request Block
            • historyAddOn
            • selectiveAttributes Block
            • tagsManagerBlock
            • extractDataBlock
            • externalTopicBlock
            • Events
          • ๐Ÿ’ปCreating Policy using UI
          • ๐Ÿ–ฅ๏ธCreating a Policy using Policy Configurator
            • Getting Started with the Policy Workflows
            • Policy Workflow Step 1
            • Policy Workflow Step 2
            • Policy Workflow Step 3
            • Policy Workflow Step 4
            • Policy Workflow Step 5
            • Policy Workflow Step 6
            • Policy Workflow Step 7
            • Policy Workflow Step 8
            • Policy Workflow Step 9
            • Policy Workflow Step 10
            • Policy Workflow Step 11
            • Policy Workflow Step 12
            • Policy Workflow Step 13
            • Policy Workflow Step 14
            • Policy Workflow Step 15
            • Policy Workflow Step 16
            • Policy Workflow Step 17
            • Policy Workflow Step 18
            • Policy Workflow Step 19
            • Policy Workflow Step 20
            • Policy Workflow Step 21
            • Policy Workflow Step 22
            • Policy Workflow Step 23
            • Policy Workflow Step 24
            • Policy Workflow Step 25
            • Policy Workflow Wrap Up
          • โš™๏ธCreating a Policy using APIs
            • Prerequesite Steps
            • Creation of a Policy
            • Policy Listing
            • Policy from IPFS
            • Policy Preview from IPFS
            • Retrieves Policy Configuration
            • Updates Policy Configuration
            • Publish a Policy
            • Policy Validation
            • Retrieval of Data from Root Policy Block
            • Request Block Data
            • Sends Data to Specified Block
            • Sends Data to specified Block by Tag
            • Returns Block ID by tag
            • Retrieves Block Data by Tag
            • Exporting Message ID
            • Export to zip file
            • Import from zip file
            • Returns list of Groups of a particular user
            • Make the selected Group active
            • Creating link between policies
            • Requesting Multi Policy Config
            • Imports open sourced policy
            • Allowed open sources list for import
            • Returns Open Source File URL
            • Returns OpenSourced policies list for import
          • ๐Ÿ“‚Dry Run
            • ๐Ÿ–ฅ๏ธDry Run Mode using the UI
              • Dry Run Operations Guide
            • โš™๏ธDry Run Mode using APIs
              • Running Policy without making any changes
              • Returning all Virtual Users
              • Creating Virtual Account
              • Logging Virtual User
              • Restarting the execution of Policy
              • Returns List of Transactions
              • Returns List of Artifacts
              • Returns List of IPFS Files
              • Returning Policy to Editing
              • Create Savepoint
              • Returns Savepoint State
              • Restoring SavePoint
              • Deletes SavePoint
          • ๐Ÿ“Record/Replay
            • ๐Ÿ’ปPolicy execution record and replay using UI
            • โš™๏ธRecord/Replay APIs
              • Get Recording
              • Start Recording
              • Stop Recording
              • Get Recorded Actions
              • Run record from zip file
              • Stop Running
              • Get Running Results
              • Fast Forward
              • Retry Step
              • Skip Step
          • ๐ŸชŸExternal Events
            • โš™๏ธSend Data using the External Data APIs
              • Sends Data from External Source
          • โš™๏ธTrustchain APIs
            • Requesting
            • Building and returning
          • โš™๏ธPolicy Related APIs for Asynchronous Execution
            • Creates new Policy
            • Publishing a Policy
            • Importing a Policy from IPFS
            • Importing a Policy from File
            • Policy Review
          • ๐Ÿง‘โ€๐Ÿคโ€๐Ÿง‘Roles and Groups
            • ๐Ÿ’ปCreating Roles and Groups using Policy Configurator UI
          • ๐Ÿ“‚Modules
            • ๐Ÿ’ปModules using UI
            • โš™๏ธModules APIs
              • Returns all Modules
              • Creating new Module
              • Returns Module Menu
              • Retrieves Module Configuration
              • Updates Module Configuration
              • Delete the module
              • Publishing Module onto IPFS
              • Returns Hedera ID for specific Module
              • Exporting Module in zip format
              • Import Module from IPFS
              • Import module from zip file
              • Preview Module from IPFS
              • Preview Module from zip file
              • Validates Module
          • ๐Ÿ“‚Tools
            • ๐Ÿ’ปTools using UI
            • โš™๏ธTools APIs
              • Creating new Tool
              • Returns list of tools
              • Creating new tool asynchronously
              • Deletes the tool
              • Retrieves Tool Configuration
              • Updates Tool Configuration
              • Publishes Tool onto IPFS
              • Publishes Tool into IPFS asynchronously
              • Validates Selected Tool
              • Returns Tools and its artifacts in zip format
              • Retrieves Hedera Message ID
              • Previews Imported Tool from IPFS
              • Imported Tool from IPFS
              • Previews Imported Tool from Zip
              • Importing Tool from Zip
              • Imports new tool from Zip Asynchronously
              • Imports new tool from IPFS Asynchronously
              • Returns List of Tools
          • ๐Ÿ”‘Selective Disclosure
            • ๐Ÿ“”User Guide
            • ๐Ÿ’ปSelective Disclosure Demo
          • ๐Ÿ“‚Policy Differentiation
            • ๐Ÿ’ปGlobal search and comparison UI
            • ๐Ÿ’ปPolicy Differentiation using UI
            • โš™๏ธPolicy Differentiation APIs
              • Comparing Policies
              • Searching Policies
              • Exports Comparison results
          • ๐Ÿ“‚Block/Policy Search
            • ๐Ÿ’ปBlock Search using UI
            • โš™๏ธBlock Search APIs
              • Searching Same Blocks
            • ๐Ÿ’ปPolicy Search using UI
            • โš™๏ธPolicy Search APIs
              • Search Policies
          • ๐Ÿ“‚Document Comparison
            • ๐Ÿ’ปDocument Comparison using UI
            • โš™๏ธDocument Comparison APIs
              • Compare Documents
              • Export of Comparison Result
          • ๐Ÿ“‚Tagging
            • ๐Ÿ’ปTagging using UI
            • โš™๏ธTagging APIs
              • Creating Tag
              • Searching Tag
              • Deleting Tag
              • Synchronization of Tags
          • ๐Ÿค–Auto Suggestion
            • ๐Ÿ’ปDemo using UI
            • โš™๏ธAuto Suggestion APIs
              • Get next and nested suggested block types
              • Get suggestions configuration
              • Set suggestions configuration
          • ๐Ÿ“‚Themes
            • ๐Ÿ’ปThemes using UI
            • โš™๏ธThemes APIs
              • Returning all themes
              • Creating theme
              • Updating theme Configuration
              • Deleting theme
              • Returning zip file containing themes
              • Importing theme
          • ๐Ÿ“‚Policy Wizard
            • ๐Ÿ’ปDemo using UI
            • โš™๏ธPolicy Wizard APIs
              • Creating new Policy
              • Getting Policy Configuration
          • ๐Ÿ“Discontinuing Policy
            • ๐Ÿ’ปUser Guide
            • โš™๏ธAPIs related to Discontinuing Policy
              • Discontinue Policy
              • Migrate Policy Data
              • Migrate Policy Data Asynchronously
              • Get Policy Documents
          • ๐Ÿ“Live Project Data Migration
            • โžก๏ธLive Project Data Migration UI
            • โš™๏ธAPIs related to Live Project Data Migration
              • Getting Policy Data
              • Uploading Policy Data
              • Getting Policy Tag Block Map
              • Getting Policy Virtual Keys
              • Uploading Policy Virtual Keys
          • Roles & Permissions
            • Roles and Permissions User Guide
            • APIs related to Roles & Permissions
              • Returns list of all permissions
              • Returns list of all roles
              • Creates a New Role
              • Updates Role Configuration
              • Deletes Role
              • Setting Default Role
              • Returns list of all users for whom the current user can change the role
              • Retrieves information about the user (roles, permissions assigned policies)
              • Updates User Roles (only SR)
              • Returns list of all Policies
              • Assigns Policies to a User - Only SR
              • Updates user roles (for ordinary users)
              • Assigns policies to a user (for ordinary users)
          • ๐Ÿ“Import/Export from Excel
            • ๐Ÿ’ปImport and Export Excel file User Guide
            • โš™๏ธAPIs related to Import/Export Schemas from Excel
              • Import Schemas in Excel file format into local DB
              • Asynchronously Imports Schemas in Excel file format into a policy
              • Previews Schema from Excel file
              • Returns Schema in Excel file format
              • Returns list of Schemas
              • Exporting Policy to Excel
              • Import Schemas in Excel file format into a Policy
              • Policy Preview from Excel file
          • ๐Ÿ’ปDemo on Integrating external policies using UI
          • ๐Ÿ“Policy Labels
            • Policy Labels UI
            • APIs related to Policy Labels
              • Creating new Label definition
              • Retrieve the list of Label definitions
              • Retrieve a label definition configuration by ID
              • Update Label configuration by ID
              • Delete Label definition by ID
              • Publish Label definition by ID
              • Publish Label definition by ID asynchronously
              • Retrieve the list of components for Label configuration (schemas, policies, etc)
              • Import Label configuration from a file
              • Export Label configuration to a file
              • Preview of the imported file
              • Search for Labels and Statistics for importing into Label configuration
              • Retrieve the list of created tokens (VPs) for which a Label document can be created
              • Retrieve token (VP) and all its dependencies by document ID
              • Create a new Label document for token (VP)
              • Retrieve a list of created Label documents
              • Retrieve Label document by ID
              • Retrieve linked Label documents by ID
          • Formula Linked Definitions
            • Formula Linked Definitions using UI
            • APIs related to Formula Linked
              • Creating a new formula
              • Returns a list of formulas
              • Returns a formula by its ID
              • Update the formula by its ID
              • Delete the formula by its ID
              • Retrieve the list of all schemas and policies linked to a Formula
              • Create a new formula (import) from a file
              • Export selected formulas into a file
              • Loads (import) a file and return its preview
              • Publish a formula
              • Retrieve all data from documents that needed for displaying the formula
          • Decentralized Guardian
            • Remote Policy UI
            • โš™๏ธAPIs
              • Returns the list of requests for adding remote policies
              • Previews the policy from IPFS without loading it into the local DB
              • Policy Import from IPFS
              • Approves policy Asynchronously
              • Rejects policy Asynchronously
              • Approves Policy
              • Rejects policy
              • Return a list of all policies requests
              • Approves a request for an action from a remote Guardian
              • Rejects a request for an action from a remote Guardian
              • Return a count of policy requests
          • ๐Ÿ“”Artifacts
            • ๐Ÿ’ปImporting/Deleting Artifacts using UI
            • โš™๏ธArtifacts APIs
              • Returns all Artifacts
              • Upload Artifacts
              • Delete Artifact
          • ๐Ÿ””Notifications
            • ๐Ÿ’ปUser Guide
            • โš™๏ธAPIs related to Notifications
              • Get all Notifications
              • Get new Notifications
              • Get Progresses
              • Read All Notifications
              • Delete Notifications
        • ๐Ÿ› ๏ธStandard Registry Operations
          • โš™๏ธTask Status APIs
            • Returning Task Statuses
      • ๐Ÿ› ๏ธUser Operations
        • โœ–๏ธMulti Policy
          • ๐Ÿ’ปConfiguring Multi Policy using UI
        • ๐Ÿค–AI Search of Methodologies
          • ๐Ÿ’ปAI Search using UI
          • โš™๏ธAI Search APIs
            • Returns response
            • Rebuilds vector based on policy data
        • ๐Ÿ”ŽGuided Search of Methodologies
          • ๐Ÿ’ปSearch using UI
          • โš™๏ธSearch APIs
            • Retrieves list of all categories
            • List of policies that are best suited for given parameters
        • โš™๏ธAccount APIs
          • Display User List
          • User Balance
          • User Session
          • User Login
          • Registering new account
          • Returns all Standard Registries
          • Requests Password Reset
          • Sets New Password
          • Current version terms of use
          • Accept terms of use
          • Returns all Standard Registries with Policies and VC Documents
        • โš™๏ธProfile APIs
          • User Account Balance
          • User Account Information
          • Setting User Credentials
          • Setting User Credentials Asynchronously
          • Setup Vault for user secrets
        • โš™๏ธArtifacts APIs
          • Returns all Artifacts
          • Upload Artifacts
          • Delete Artifacts
        • Bottom Up Data Traceability
          • Bottom Up Data Traceability using UI
          • APIs related to Statistics Report
            • Create new Statistics Definition
            • Get the list of Statistics Definitions
            • Retrieve details of the Statistics Definition by ID
            • Update configuration of the Statistics Definition by ID
            • Delete the Statistics Definition by ID
            • Publish Statistics Definition by ID
            • Retrieve the list of linked schemas and policy
            • Retrieve the list of all documents conforming the rules of the Statistics Definition
            • Create a new Statistics Assessment based on the Statistics Definition
            • Retrieve the list of existing Statistics Assessment
            • Retrieve the Statistics Assessment by ID
            • Retrieve all VC documents related to the Statistics Assessment
            • Importing Statistic from zip file
            • Exporting statistic report to a file
            • Previews the statistic report imported from zip file
      • ๐Ÿ“Bring your own DIDs
        • ๐Ÿ’ปBring Your Own (BYO) DIDs UI
        • โš™๏ธBYO APIs
          • Validate DID Format
          • Validate DID Keys
      • Asynchronous Tasks Status
      • Show list of Hedera Transactions
        • Showing List of Hedera Transactions UI
        • APIs
          • Returning all transactions for Policy
          • Returning all transactions for Schema
          • Returning all transactions for Contract
          • Returning all transactions for Tokens
      • ๐Ÿ”MGS Vault
        • โ˜‘๏ธCompatible Vaults
        • ๐Ÿ”‘MGS Vault
          • ๐ŸŽ™๏ธIntroducing MGS Vault
          • โš™๏ธHashiCorp Vault Setup
          • โš™๏ธHashiCorp Vault Integration with MGS
        • ๐Ÿ”‘Microsoft Azure Key Vault
          • ๐ŸŽ™๏ธIntroducing Microsoft Azure Key Vault
          • โš™๏ธMicrosoft Azure Key Vault Setup
          • โš™๏ธMicrosoft Azure Key Vault Integration with MGS
        • ๐Ÿ”‘Google Cloud Platform Secret Manager
          • ๐ŸŽ™๏ธIntroducing Google Cloud Platform Secret Manager
            • โš™๏ธGCP Secret Manager Setup
            • โš™๏ธGCP Secret Manager Integration with MGS
    • ๐Ÿ•Obsolete Guardian Artifacts
    • ๐Ÿ“Project Comparison
      • โš™๏ธProject Comparison APIs
        • Comparing Documents
        • Retrieves all categories
        • Retrieves all Properties
        • Search Projects by filters
    • Global Indexer
      • Indexer User Guide
      • APIs related to Indexer
        • Full Text Indexer Search
        • Returns Standard Registries
        • Returns Registry as per MessageID
        • Returns Registry Users
        • Returns Registry User as per MessageID
        • Returns Policies
        • Returns policy as per MessageID
        • Returns Tools
        • Returns Tool as per MessageID
        • Returns Modules
        • Returns Module as per MessageID
        • Returns Schemas
        • Returns Schema as per MessageID
        • Returns Schema Tree
        • Returns Tokens
        • Returns Token as per TokenID
        • Returns Roles
        • Returns Role as per MessageID
        • Returns DIDs
        • Returns DID as per MessageID
        • Returns DID Relationships
        • Returns VP Documents
        • Returns VP Document as per MessageID
        • Returns VP Relationships
        • Returns VC Documents
        • Returns VC Document as per MessageID
        • Returns VC Relationships
        • Returns NFTs
        • Returns NFT as per Serial No.
        • Returns Topics
        • Returns Topic as per TopicID
        • Returns Contracts
        • Returns Contract as per MessageID
        • Returns Landing Page Analytics
        • Returns Project Coordinates
        • Returns Search Policy Results
        • Attempts to refresh linked files for the selected documents
        • Returns Hedera Network
        • Returns Hedera Network Explorer Settings
        • Returns Data Loading Progress Result
        • Returns Registry Relationships
        • Returns Policy Relationships
        • Retrieve the list of formulas
        • Retrieve the formula by message ID
        • Retrieve linked documents which are related to formula
        • Returning Topic Data Priority Loading Progress
        • Adding Topic Data Priority Loading
        • Adding Policy Data for Priority Loading
        • Adding Token Data for Priority Loading
        • Adding Document to Data Priority Loading
    • โš™๏ธAPI Guideline
    • ๐Ÿช™Tokens
      • ๐Ÿ’ปCreating Token using UI
      • ๐Ÿ“Token Template
        • ๐Ÿ’ปCreating Token Template using UI
        • ๐Ÿ’ปCreating Token through UI using Token Template
      • ๐Ÿ”ŽHow to establish Token Authenticity
      • ๐Ÿ› ๏ธToken Operations
        • โš™๏ธToken APIs
          • Token Listing
          • Creation of the token
          • User Info for selected token
          • Associates the user with token
          • Disassociates the user with token
          • Grants KYC for the user (Deprecated)
          • Grants KYC for the user
          • Revoke KYC of the user (Deprecated)
          • Revoke KYC of the user
          • Freeze tokens of a user
          • Unfreeze tokens of a user
      • ๐Ÿ“Token Retirement Contract
        • ๐Ÿ’ปCreating Contract using UI
        • TrustChain representation of token retirement
        • โš™๏ธRetirement APIs
          • Returning all contracts
          • Creating new Contract
          • Importing new Contract
          • Get Contract Permissions
          • Removing Contract
          • Returns a list of all Wipe requests
          • Enabling Wipe Requests
          • Disabling Wipe Requests
          • Approving Wipe Requests
          • Rejecting Wipe Requests
          • Clearing Wipe Requests
          • Adding Wipe Admin
          • Removing Wipe Admin
          • Adding Wipe Manager
          • Removing Wipe Manager
          • Adding Wipe Wiper
          • Removing Wipe Wiper
          • Syncing Retire Pools
          • Returning list of all Retire Requests
          • Returning list of all Retire Pools
          • Deleting Retire Requests
          • Deleting Retire Pools
          • Setting Retire Pools
          • Unsetting Retire Pool
          • Unsetting Retire Request
          • Retiring Tokens
          • Approving Retire Request
          • Cancelling Retire Request
          • Adding Retire Admin
          • Removing Retire Admin
          • Returning all Retired VCs
      • Dynamic Token Creation in Guardian Policies
    • โ›“๏ธTrust Chain
      • ๐Ÿ› ๏ธTrust Chain Operations
        • โš™๏ธTrust Chain APIs
          • Requesting
          • Building and Returning
    • ๐Ÿ”ฌOpen-Source Guardian Architecture
      • ๐Ÿ”ญHigh Level Architecture
      • ๐Ÿ”ฌDeep Dive Architecture
      • ๐Ÿ‘Policies,Projects and Topics mapping Architecture
      • โž—MRV Splitting Logic
      • ๐Ÿ”‘Internal (with Vault)Signing Sequence Diagram
      • ๐Ÿ”ฅFireBlocks Signing Sequence Diagram
    • ๐Ÿ“„Full API Documentation
    • ๐Ÿ“Library of Policy Examples
      • ๐Ÿ’ปCreating and using Roles
      • ๐Ÿ”ขData input via Forms, using Roles to partition user activities
      • ๐Ÿช™Token Operations
      • ๐Ÿ“ƒMRV Document Operations
      • โ›“๏ธTrustChain reports
      • โž—MRV aggregation and splitting for minting tokens
    • ๐Ÿ”Process for Testnet Resets
      • Deleting Tenants and Re-inviting Users
      • Setup of a User Account
  • ๐Ÿ—บ๏ธPreloaded Policy Guides
    • ๐ŸŒณCarbon Offsets
      • ๐ŸŒฒVerra Redd+ VM0007 Policy Guide
      • ๐Ÿ‘ฉโ€๐ŸŒพVM0017 Adoption of Sustainable Agricultural Land Management, v1.0
      • ๐Ÿ‘ฉโ€๐ŸŒพVM0042 Methodology for Improved Agricultural Land Management
      • ๐ŸŒฒVM0047 Afforestation, Reforestation, and Revegetation
      • ๐ŸŒฒGold Standard Afforestation and Reforestation (AR) v2.0
      • ๐Ÿ‘ทCarbon Reduction Measurement - GHG Corporate Standard Policy Guide
      • ๐Ÿ‘ฉโ€๐ŸŒพDovu Methodologies (Agre Calc & Cool Farm)
      • ๐Ÿš—Sustainable End-of-Life Vehicle Scrapping Program: Government Backed Voluntary Program
      • โ™จ๏ธImproved Cookstove
      • โ™จ๏ธGoldStandard - Metered Energy Cooking
      • ๐ŸญCDM AMS-II.G.: Energy Efficiency Measures in Thermal Applications of Non-Renewable Biomass
      • ๐ŸญCDM AMS-III.AR: Substituting fossil fuel based lighting with LED/CFL lighting systems
      • ๐ŸญCDM AMS-III.D.: Methane Recovery in Animal Manure Management Systems
      • ๐ŸญCDM AMS III.BB: Electrification of communities through grid extension
      • ๐ŸญCDM AR-ACM0003: Methodology for Afforestation and Reforestation of Lands Except Wetlands
      • ๐ŸญCDM ACM0001: Flaring or Use of Landfill Gas
      • ๐ŸจCDM ACM0002: Grid-Connected Electricity Generation from Renewable Sources
      • ๐ŸญCDM ACM0006: Electricity and Heat Generation from Biomass
      • ๐ŸญCDM ACM0007: Conversion from Single Cycle to Combined Cycle Power Generation
      • ๐ŸญCDM ACM0018: Electricity Generation from Biomass in Power-Only Plants
      • ๐ŸจCDM AMS-I.A.: Electricity Generation by the User
      • ๐ŸจCDM AMS-I.C.: Thermal Energy Production with or Without Electricity
      • ๐ŸจCDM AMS-I.F.: Renewable Electricity Generation for Captive Use and Mini-Grid
      • ๐Ÿ›๏ธCDM AMS-II.J.: Demand-Side Activities for Efficient Lighting Technologies
      • ๐ŸญCDM AMS-III.AV.: Low Greenhouse Gas Emitting Safe Drinking Water Production Systems
      • ๐ŸญCDM AMS-III.F.: Avoidance of Methane Emissions Through Composting
      • ๐ŸฆCDM AMS-III.H.: Methane Recovery in Wastewater Treatment
      • ๐ŸญPWRM0001 Plastic Waste Collection Methodology
      • ๐Ÿฅ‡Carbon Sequestration through Accelerated Carbonation of Concrete Aggregate
      • ๐ŸญVM0044 Methodology for Biochar Utilization in Soil and Non-Soil Applications
      • ๐ŸญVM0041 Methodology for the Reduction of Enteric Methane Emissions from Ruminants
      • ๐ŸญAMS-I.D: Grid Connected Renewable Electricity Generation โ€“ v.18.0
      • ๐ŸญPWRM0002 Plastic Waste Recycling Methodology
      • ๐ŸšMethane Emission Reduction by Adjusted Water Management Practice in Rice Cultivation
      • โ›ฝVerra VMR0006: Energy Efficiency and Fuel Switch Measures in Thermal Applications
      • AMS-I.E Switch from Non-Renewable Biomass for Thermal Applications by the User
      • GCCM001 v.4 Methodology for Renewable Energy Generation Projects Supplying Electricity to Grid
      • Climate Action Reserveโ€™s U.S. Landfill Protocol Version 6.0
      • Landfill Gas Destruction and Beneficial Use Projects, Version 2.0
      • VM0042 Improved Agricultural Land Management, v2.1
    • ๐Ÿ”‹Renewable Energy Credits
      • ๐Ÿ“กInternational Renewable Energy Credit Standard Policy guide
    • ๐ŸญCarbon Emissions
      • ๐Ÿ Remote Work GHG Policy Policy Guide
      • ๐ŸขCarbon Emissions Measurement - GHG Corporate Standard Policy Guide
      • ๐Ÿ™๏ธatma GHG Scope II Carbon Emission Policy
      • ๐ŸขAtma Scope 3 GHG Policy
      • ๐ŸขGHGP Corporate Standard
      • ๐ŸญGHGP Corporate Standard V2
Powered by GitBook
On this page
Export as PDF

Last updated 14 hours ago

  1. TECHNICAL INFORMATION
  2. ๐Ÿ‘จโ€๐Ÿ’ปUsers
  3. ๐ŸซStandard Registry Users, Schemas, and Policies
  4. ๐Ÿ› ๏ธPolicies
  5. Decentralized Guardian
  6. โš™๏ธAPIs

Rejects a request for an action from a remote Guardian

PreviousApproves a request for an action from a remote GuardianNextReturn a count of policy requests

Rejects a request for an action from a remote Guardian

put

Rejects a request for an action from a remote Guardian

Authorizations
Path parameters
messageIdstringRequired

Schema Rule Identifier

Example: 0000000000.000000001
Body
idstringRequiredExample: 000000000000000000000001
uuidstringRequiredExample: 00000000-0000-0000-0000-000000000000
namestringRequiredExample: Policy name
descriptionstringRequiredExample: Description
topicDescriptionstringRequiredExample: Description
policyTagstringRequiredExample: Tag
statusstring ยท enumRequiredExample: DRAFTPossible values:
creatorstringRequiredExample: #did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001
ownerstringRequiredExample: #did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001
topicIdstringRequiredExample: 0.0.1
messageIdstringRequiredExample: 0000000000.000000001
codeVersionstringRequiredExample: 1.0.0
createDatestringRequiredExample: 1900-01-01T00:00:00.000Z
versionstringRequiredExample: 1.0.0
userRolestringRequiredExample: Installer
userRolesstring[]RequiredExample: ["Installer"]
policyRolesstring[]RequiredExample: ["Registrant"]
categoriesstring[]Required
projectSchemastringRequiredExample: 00000000-0000-0000-0000-000000000000
Responses
200
Successful operation.
application/json
401
Unauthorized.
403
Forbidden.
500
Internal server error.
application/json
put
PUT /api/v1/external-policies/requests/{messageId}/reject HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1958

{
  "id": "000000000000000000000001",
  "uuid": "00000000-0000-0000-0000-000000000000",
  "name": "Policy name",
  "description": "Description",
  "topicDescription": "Description",
  "policyTag": "Tag",
  "status": "DRAFT",
  "creator": "#did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001",
  "owner": "#did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001",
  "topicId": "0.0.1",
  "messageId": "0000000000.000000001",
  "codeVersion": "1.0.0",
  "createDate": "1900-01-01T00:00:00.000Z",
  "version": "1.0.0",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "userRole": "Installer",
  "userRoles": [
    "Installer"
  ],
  "userGroup": {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "role": "Installer",
    "groupLabel": "Label",
    "groupName": "Name",
    "active": true
  },
  "userGroups": [
    {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "role": "Installer",
      "groupLabel": "Label",
      "groupName": "Name",
      "active": true
    }
  ],
  "policyRoles": [
    "Registrant"
  ],
  "policyNavigation": [
    {
      "role": "Registrant",
      "steps": [
        {
          "block": "Block tag",
          "level": 1,
          "name": "Step name"
        }
      ]
    }
  ],
  "policyTopics": [
    {
      "name": "Project",
      "description": "Project",
      "memoObj": "topic",
      "static": false,
      "type": "any"
    }
  ],
  "policyTokens": [
    {
      "tokenName": "Token name",
      "tokenSymbol": "Token symbol",
      "tokenType": "non-fungible",
      "decimals": "",
      "changeSupply": true,
      "enableAdmin": true,
      "enableFreeze": true,
      "enableKYC": true,
      "enableWipe": true,
      "templateTokenTag": "token_template_0"
    }
  ],
  "policyGroups": [
    {
      "name": "Group name",
      "creator": "Registrant",
      "groupAccessType": "Private",
      "groupRelationshipType": "Multiple",
      "members": [
        "Registrant"
      ]
    }
  ],
  "categories": [
    "text"
  ],
  "projectSchema": "00000000-0000-0000-0000-000000000000",
  "tests": [
    {
      "id": "000000000000000000000001",
      "uuid": "00000000-0000-0000-0000-000000000000",
      "name": "Test Name",
      "policyId": "000000000000000000000001",
      "owner": "#did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001",
      "status": "New",
      "date": "1900-01-01T00:00:00.000Z",
      "duration": 0,
      "progress": 0,
      "resultId": "00000000-0000-0000-0000-000000000000",
      "result": "text"
    }
  ]
}
{
  "id": "000000000000000000000001",
  "uuid": "00000000-0000-0000-0000-000000000000",
  "name": "Policy name",
  "description": "Description",
  "topicDescription": "Description",
  "policyTag": "Tag",
  "status": "DRAFT",
  "creator": "#did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001",
  "owner": "#did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001",
  "topicId": "0.0.1",
  "messageId": "0000000000.000000001",
  "codeVersion": "1.0.0",
  "createDate": "1900-01-01T00:00:00.000Z",
  "version": "1.0.0",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "userRole": "Installer",
  "userRoles": [
    "Installer"
  ],
  "userGroup": {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "role": "Installer",
    "groupLabel": "Label",
    "groupName": "Name",
    "active": true
  },
  "userGroups": [
    {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "role": "Installer",
      "groupLabel": "Label",
      "groupName": "Name",
      "active": true
    }
  ],
  "policyRoles": [
    "Registrant"
  ],
  "policyNavigation": [
    {
      "role": "Registrant",
      "steps": [
        {
          "block": "Block tag",
          "level": 1,
          "name": "Step name"
        }
      ]
    }
  ],
  "policyTopics": [
    {
      "name": "Project",
      "description": "Project",
      "memoObj": "topic",
      "static": false,
      "type": "any"
    }
  ],
  "policyTokens": [
    {
      "tokenName": "Token name",
      "tokenSymbol": "Token symbol",
      "tokenType": "non-fungible",
      "decimals": "",
      "changeSupply": true,
      "enableAdmin": true,
      "enableFreeze": true,
      "enableKYC": true,
      "enableWipe": true,
      "templateTokenTag": "token_template_0"
    }
  ],
  "policyGroups": [
    {
      "name": "Group name",
      "creator": "Registrant",
      "groupAccessType": "Private",
      "groupRelationshipType": "Multiple",
      "members": [
        "Registrant"
      ]
    }
  ],
  "categories": [
    "text"
  ],
  "projectSchema": "00000000-0000-0000-0000-000000000000",
  "tests": [
    {
      "id": "000000000000000000000001",
      "uuid": "00000000-0000-0000-0000-000000000000",
      "name": "Test Name",
      "policyId": "000000000000000000000001",
      "owner": "#did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001",
      "status": "New",
      "date": "1900-01-01T00:00:00.000Z",
      "duration": 0,
      "progress": 0,
      "resultId": "00000000-0000-0000-0000-000000000000",
      "result": "text"
    }
  ]
}