On this page:
   43.0    JSON Admin API
  • JSON Admin Endpoints
  • 43.0 JSON Admin API
  • 43.1 JSON Admin Home Endpoint
  • 43.2 MDM Endpoint
  • 43.3 Audit Log Endpoint
  • 43.4 Batch Job Endpoint
  • 43.5 Bulk Import Endpoint
  • 43.6 CDA Exchange Endpoint
  • 43.7 Config Diagnostics Endpoint
  • 43.8 Metrics Endpoint
  • 43.9 Module Config Endpoint
  • 43.10 OpenID Connect Clients Endpoint
  • 43.11 OpenID Connect Keystores Endpoint
  • 43.12 OpenID Connect Servers Endpoint
  • 43.13 OpenID Connect Sessions Endpoint
  • 43.14 Runtime Status Endpoint
  • 43.15 System Config Endpoint
  • 43.16 Transaction Log Endpoint
  • 43.17 Troubleshooting Log Endpoint
  • 43.18 User Management Endpoint
  • 43.19 Version Endpoint
    • 43.2    MDM Endpoint   
    Table of Contents

    JSON Admin Home Endpoint

    43.1.1JSON Admin Home Endpoint

     

    The JSON Admin Home endpoint serves as the root entry point for the JSON Admin API. It provides access to the Swagger UI interface for exploring and testing all available Admin JSON API endpoints.

    43.1.2Access Swagger UI

     
    This endpoint provides free access without authentication for compatibility purposes. No permissions are required.

    This method redirects users to the Swagger UI interface where they can explore the complete Admin JSON API documentation interactively.


    To invoke:

    GET http://localhost:9000/

    43.1.2.1Response Behavior

    The endpoint returns a redirect response to /swagger-ui.html, which displays the interactive Swagger UI interface. This interface provides:

    • Complete API documentation for all Admin JSON endpoints
    • Interactive testing capabilities for each endpoint
    • Request/response examples and schemas
    • Authentication requirements for each endpoint

    43.1.2.2Use Cases

    This endpoint is typically used for:

    1. API Discovery: Developers can explore all available Admin JSON endpoints 2. Interactive Testing: Test API endpoints directly from the browser interface 3. Documentation Reference: Access comprehensive API documentation with examples 4. Development and Integration: Understand request/response formats before implementing API calls

    43.1.2.3Security Considerations

    While this endpoint itself requires no authentication, the individual API endpoints accessible through the Swagger UI may require specific permissions. Always verify the permission requirements for each endpoint before use.

    This endpoint intentionally provides free access to ensure ease of API discovery. However, users will need appropriate permissions to successfully invoke the individual API endpoints documented in the Swagger UI.

    43.1.2.4Technical Implementation

    • HTTP Method: GET
    • URL: http://localhost:9000/
    • Authentication: None required
    • Response: HTTP redirect to /swagger-ui.html
    • Content-Type: HTML redirect response

    Note: This endpoint does not require the standard ACCESS_ADMIN_JSON permission that other Admin JSON endpoints require.

       43.0    JSON Admin API
  • JSON Admin Endpoints
  • 43.0 JSON Admin API
  • 43.1 JSON Admin Home Endpoint
  • 43.2 MDM Endpoint
  • 43.3 Audit Log Endpoint
  • 43.4 Batch Job Endpoint
  • 43.5 Bulk Import Endpoint
  • 43.6 CDA Exchange Endpoint
  • 43.7 Config Diagnostics Endpoint
  • 43.8 Metrics Endpoint
  • 43.9 Module Config Endpoint
  • 43.10 OpenID Connect Clients Endpoint
  • 43.11 OpenID Connect Keystores Endpoint
  • 43.12 OpenID Connect Servers Endpoint
  • 43.13 OpenID Connect Sessions Endpoint
  • 43.14 Runtime Status Endpoint
  • 43.15 System Config Endpoint
  • 43.16 Transaction Log Endpoint
  • 43.17 Troubleshooting Log Endpoint
  • 43.18 User Management Endpoint
  • 43.19 Version Endpoint
    • 43.2    MDM Endpoint