> For the complete documentation index, see [llms.txt](https://docs.toolkit.equs.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.toolkit.equs.ai/api/identity-manager-api/holders.md).

# Holders

## Create a holder user

> Creates a Keycloak user account for a holder, tagged with the tenant's slug and the external identity provider user id, links a federated identity for that user under the tenant's identity provider, and registers the user in the Web Custodial Wallet.

```json
{"openapi":"3.0.0","info":{"title":"EqusDTK Identity Manager Documentation","version":"0.1.2"},"tags":[{"name":"Holders","description":""}],"security":[{"sp":[]},{"tenant":[]},{"sp":[]}],"components":{"securitySchemes":{"sp":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Service Provider. Token of the Service Provider client in the `agents` realm, with no `tenantId` claim. Authorize one bearer scheme at a time."},"tenant":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Tenant. Token of a Tenant machine client or of a Tenant portal user, carrying the `tenantId` claim. Authorize one bearer scheme at a time."}},"schemas":{"CreateUserRequest":{"type":"object","properties":{"extUserId":{"type":"string","description":"External IdP user unique ID"}},"required":["extUserId"]},"CreateUserResponse":{"type":"object","properties":{"id":{"type":"string","description":"Internal Idp user unique ID"}},"required":["id"]}}},"paths":{"/api/v1/holders/users":{"post":{"description":"Creates a Keycloak user account for a holder, tagged with the tenant's slug and the external identity provider user id, links a federated identity for that user under the tenant's identity provider, and registers the user in the Web Custodial Wallet.","operationId":"HoldersController_createUser_api/v1","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserRequest"}}}},"responses":{"201":{"description":"When the user is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserResponse"}}}},"400":{"description":"- When the tenant slug and subject identifier together exceed the username length limit.\n- When the request names no tenant: the token carries no tenantId claim and the Service Provider sent no x-tenant-id header."},"401":{"description":"When the operator-portal-ui token is missing or invalid, or when it carries no tenantId claim and belongs to a client other than the Service Provider."},"409":{"description":"When a holder with this subject identifier already exists for this tenant."}},"summary":"Create a holder user","tags":["Holders"]}}}}
```

## Create a holder agent

> Creates a placeholder, disabled Keycloak user account for a holder agent, tagged with the tenant's slug, and registers the agent in the Web Custodial Wallet under the given userId and name.

```json
{"openapi":"3.0.0","info":{"title":"EqusDTK Identity Manager Documentation","version":"0.1.2"},"tags":[{"name":"Holders","description":""}],"security":[{"sp":[]},{"tenant":[]},{"sp":[]}],"components":{"securitySchemes":{"sp":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Service Provider. Token of the Service Provider client in the `agents` realm, with no `tenantId` claim. Authorize one bearer scheme at a time."},"tenant":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Tenant. Token of a Tenant machine client or of a Tenant portal user, carrying the `tenantId` claim. Authorize one bearer scheme at a time."}},"schemas":{"CreateAgentRequest":{"type":"object","properties":{"userId":{"type":"string","description":"User unique ID this agent is associated with"},"name":{"type":"string","description":"The agent's own name"}},"required":["userId","name"]},"CreateAgentResponse":{"type":"object","properties":{"id":{"type":"string","description":"Agent unique ID"}},"required":["id"]}}},"paths":{"/api/v1/holders/agents":{"post":{"description":"Creates a placeholder, disabled Keycloak user account for a holder agent, tagged with the tenant's slug, and registers the agent in the Web Custodial Wallet under the given userId and name.","operationId":"HoldersController_createAgent_api/v1","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAgentRequest"}}}},"responses":{"201":{"description":"When the agent is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAgentResponse"}}}},"400":{"description":"When the request names no tenant: the token carries no tenantId claim and the Service Provider sent no x-tenant-id header."},"401":{"description":"When the operator-portal-ui token is missing or invalid, or when it carries no tenantId claim and belongs to a client other than the Service Provider."},"409":{"description":"When the user already has an agent with the given name."}},"summary":"Create a holder agent","tags":["Holders"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.toolkit.equs.ai/api/identity-manager-api/holders.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.