1. admin-workspaces
Docpier IDP API
  • IDP API
  • Webhook
  • Endpoints
    • agent
      • Upload a document
      • Retrieve structured data
      • Stream Document Content
      • Provide feedback
      • Get Document Feedback
    • admin-workspaces
      • Admin List Workspaces
        GET
      • Admin Create Workspace
        POST
      • Admin Get Workspace
        GET
      • Admin Patch Workspace
        PATCH
      • Admin Grant Workspace Access
        POST
      • Admin Revoke Workspace Access
        DELETE
      • Admin List Keycloak Agent Client Credentials
        GET
      • Admin Create Keycloak Agent Client
        POST
      • Admin Get Workspace Settings
        GET
      • Admin Merge Workspace Settings
        PATCH
      • Admin List Webhooks
        GET
      • Admin Create Webhook
        POST
      • Admin Patch Webhook
        PATCH
      • Admin Delete Webhook
        DELETE
      • Admin Meta Document Types
        GET
  1. admin-workspaces

Admin Create Keycloak Agent Client

POST
/admin/workspaces/{workspaceId}/keycloak/agent-client
Create a confidential Keycloak client (client credentials) using the Admin API.
Configure KEYCLOAK_ADMIN_CLIENT_ID / KEYCLOAK_ADMIN_CLIENT_SECRET (realm
defaults to KEYCLOAK_ADMIN_REALM or master). New clients are created in
KEYCLOAK_REALM. A matching CLIENT workspace access row is added so the
client appears in credential listing; revoke access if you need to detach without
deleting the Keycloak client.

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Path Params

Body Params application/json

Examples

Responses

🟢201
application/json
Successful Response
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://test.your-api-server.com/admin/workspaces//keycloak/agent-client' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "client_id": "string"
}'
Response Response Example
{
    "client_id": "string",
    "client_secret": "string"
}
Modified at 2026-05-16 21:22:56
Previous
Admin List Keycloak Agent Client Credentials
Next
Admin Get Workspace Settings
Built with