Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• Quick Start
• Learn More
  • Work with your REST Client
  • Manage Collections
  • Perform Batch Actions
  • Set the REST Framework Version
  • Configure for CORS
  • Access Metadata
• Reference
  • Access Roles for Resources
  • Resource Types
  • Status Codes
  • Supported Data Types
  • Supported HTTP Methods
  • Supported Media Types
  • Terminology
  • REST API Versions and URL Paths
• Change History

Tasks

• Administration
  • API Annexes
    • Create an API annex
    • Delete an API annex
    • Get all API annexes
    • Get an API annex
    • Replace an API annex
    • Update an API annex
  • APIs
    • Create an API
    • Delete an API
    • Get all APIs
    • Get an API
    • Replace an API
    • Update an API
  • Connection Descriptors
    • Create a connection descriptor
    • Delete a connection descriptor
    • Get a connection descriptor
    • Get all connection descriptors
    • Replace a connection descriptor
    • Update a connection descriptor
  • Endpoint Rules
    • Create an endpoint rule
    • Delete an endpoint rule
    • Get all endpoint rules
    • Get an endpoint rule
    • Replace an endpoint rule
    • Update an endpoint rule
  • Export
    • Export all configurations
    • Export an individual configuration
  • Extensibility Secrets
    • Create an extensibility secret
    • Get all extensibility secrets
    • Replace an extensibility secret
  • Feature Flags
    • Enable/Disable a feature flag
    • Get a feature flag
    • Get all feature flags
  • Gatekeeping Rule Annexes
    • Create a gatekeeping rule annex
    • Delete a gatekeeping rule annex
    • Get a gatekeeping rule annex
    • Get all gatekeeping rule annexes
    • Replace a gatekeeping rule annex
    • Update a gatekeeping rule annex
  • Gatekeeping Rules
    • Get a gatekeeping rule
    • Get all gatekeeping rules
    • Replace a gatekeeping rule
  • Import
    • Import all configurations
  • Interaction Context Enrichments
    • Create an interaction context enrichment
    • Delete an interaction context enrichment
    • Get all interaction context enrichments
    • Get an interaction context enrichment
    • Replace an interaction context enrichment
    • Update an interaction context enrichment
  • Listener Registrations
    • Create a listener registration
    • Delete a listener registration
    • Get a listener registration
    • Get all listener registrations
    • Replace a listener registration
    • Update a listener registration
  • OIDC Servers
    • Create an OIDC server
    • Delete an OIDC server
    • Get all OIDC servers
    • Get an OIDC server
    • Replace an OIDC server
    • Update an OIDC server
  • Routing Criteria
    • Create a routing criteria
    • Delete a routing criteria
    • Get a routing criteria
    • Get all routing criteria
    • Replace a routing criteria
    • Update a routing criteria
  • SCIM Configurations
    • Create a SCIM configuration
    • Get a SCIM configuration
    • Get all SCIM configurations
    • Replace a SCIM configuration
    • Update a SCIM configuration
  • Stock Responses
    • Create a stock response
    • Delete a stock response
    • Get a stock response
    • Get all stock responses
    • Replace a stock response
    • Update a stock response
  • System Descriptors
    • Create a system descriptor
    • Delete a system descriptor
    • Get a system descriptor
    • Get all system descriptors
    • Replace a system descriptor
    • Update a system descriptor
  • Tenant Configurations
    • Get all tenant configurations
    • Replace a tenant configuration
  • Utility Configurations
    • Get all utility configurations
    • Replace an utility configuration
  • Workspace Clients
    • Create a workspace client
    • Delete a workspace client
    • Get a workspace client
    • Get all workspace clients
    • Replace a workspace client
    • Update a workspace client
  • Workspaces
    • Get a workspace
    • Get all workspaces
    • Replace a workspace
    • Update a workspace
• After-Market Extensibility
  • Create a generation rule
  • Create a JSON Schema
  • Get all extensible resources
  • Get all extensions
  • Get an extension status
  • Update a generation rule
  • Update a JSON Schema
• Business Logical Extensions
  • Create a processing information for business logical extension
  • Delete a business logical extension
  • Get the audit details for business logical extension process
  • Update a business logical extension
• Document Management
  • Documents
    • Delete document
    • Download document
    • Get document metadata
    • Upload document
    • Upload multiple files
    • Upload new version of document
  • Folders
    • Create folder
    • Delete folder
    • Rename folder
• Extensibility
  • Generation Rules
    • Create a generation rule
    • Delete a generation rule
    • Get a generation rule
    • Get all generation rules
    • Update a generation rule
  • JSON Schemas
    • Create a JSON Schema
    • Delete a JSON Schema
    • Get a JSON Schema
    • Get all JSON Schemas
    • Update a JSON Schema
  • Open APIs
    • Get all OpenAPIs
    • Get an OpenAPI
  • Processing Information
    • Create processing information
    • Delete a processing information
    • Get a processing information
    • Get all processing information
    • Replace a processing information
• Routing Status
  • Get spoke system registration information
• TMF 632 Party Management
  • Event Subscriptions
    • Register a listener
    • Unregister a listener
  • Individuals
    • Create an individual
    • Delete an individual
    • Get all individuals
    • Get an individual
    • Update an individual
  • Notification Listeners
    • Sample listener for Create Individual event
    • Sample listener for Create Organization event
    • Sample listener for Individual Delete event
    • Sample listener for Organization Delete event
    • Sample listener for Update Individual event
    • Sample listener for Update Organization event
  • Organizations
    • Create an organization
    • Delete an organization
    • Get all organizations
    • Get an organization
    • Update an organization
• User Management
  • Create user in the target IDM
  • Get users by user name
  • Replace user attribute values in the target IDM
  • Update user in the target IDM