# Collate Users API

**Canonical:** https://apis.io/apis/collate/collate-users-api/  
**Provider:** Collate — https://apis.io/providers/collate/  
**Base URL:** https://sandbox.open-metadata.org/api/v1  
**Documentation:** https://docs.open-metadata.org/latest/api-reference

Collate Users API is one of 107 APIs that [Collate](https://apis.io/providers/collate/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

A `User` represents a user of OpenMetadata. A user can be part of 0 or more teams. A special type of user called Bot is used for automation. A user can be an owner of zero or more data assets. A user can also follow zero or more data assets.

## Operations (47)

| Method | Path | Summary |
|---|---|---|
| PUT | `/v1/users/changePassword` | Change Password For User |
| POST | `/v1/users/checkEmailVerified` | Check if a mail is verified |
| PUT | `/v1/users/registrationConfirmation` | Confirm User Email |
| GET | `/v1/users/security/token` | Get personal access token to User |
| PUT | `/v1/users/security/token` | Provide access token to User |
| GET | `/v1/users` | List users |
| PUT | `/v1/users` | Update user |
| POST | `/v1/users` | Create a user |
| GET | `/v1/users/name/{name}` | Get a user by name |
| DELETE | `/v1/users/name/{name}` | Delete a user |
| GET | `/v1/users/{id}` | Get a user |
| DELETE | `/v1/users/{id}` | Delete a user |
| PATCH | `/v1/users/{id}` | Update a user |
| DELETE | `/v1/users/async/{id}` | Asynchronously delete a user |
| PUT | `/v1/users/{userId}/preferences/{type}` | Create or replace a user preference |
| DELETE | `/v1/users/{userId}/preferences/{type}` | Delete a user preference |
| GET | `/v1/users/export` | Export users in a team in CSV format |
| GET | `/v1/users/exportAsync` | Export users in a team in CSV format |
| GET | `/v1/users/generateRandomPwd` | Generate a random password |
| POST | `/v1/users/generatePasswordResetLink` | Generate Password Reset Link |
| PUT | `/v1/users/generateToken/{id}` | Generate JWT Token for a Bot User |
| POST | `/v1/users/generateToken` | Generate JWT Token for a User |
| GET | `/v1/users/{id}/context` | Get the AI context for an entity by id |
| GET | `/v1/users/name/{fqn}/context` | Get the AI context for an entity by fully qualified name |
| GET | `/v1/users/auth-mechanism/{id}` | Get Authentication Mechanism for a Bot User |
| GET | `/v1/users/loggedInUser/groupTeams` | Get group type of teams for current logged in user |
| GET | `/v1/users/loggedInUser` | Get current logged in user |
| GET | `/v1/users/{userId}/preferences` | Get user preferences |
| GET | `/v1/users/token/{id}` | Get JWT Token for a Bot User |
| GET | `/v1/users/documentation/csv` | Get CSV documentation for user import/export |
| GET | `/v1/users/{id}/versions/{version}` | Get a version of the user |
| PUT | `/v1/users/import` | Import from CSV to create, and update teams |
| PUT | `/v1/users/importAsync` | Import from CSV to create, and update teams asynchronously |
| GET | `/v1/users/history` | List all entity versions within a time range |
| GET | `/v1/users/online` | List online users |
| GET | `/v1/users/{id}/assets` | List assets owned by this user or their teams |
| GET | `/v1/users/name/{name}/assets` | List assets owned by this user or their teams by name |
| GET | `/v1/users/{id}/versions` | List user versions |
| POST | `/v1/users/login` | Login User with email (plain-text) and Password (encoded in base 64) |
| POST | `/v1/users/logout` | Logout a User(Only called for saml and basic Auth) |
| POST | `/v1/users/refresh` | Provide access token to User with refresh token |
| POST | `/v1/users/signup` | Register User |
| PUT | `/v1/users/resendRegistrationToken` | Resend Registration Token |
| POST | `/v1/users/password/reset` | Reset Password For User |
| PUT | `/v1/users/restore` | Restore a soft deleted User |
| PUT | `/v1/users/security/token/revoke` | Revoke personal access token to User |
| PUT | `/v1/users/revokeToken` | Revoke JWT Token for a Bot User |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/collate/refs/heads/main/openapi/collate-users-api-openapi.yml
- **Documentation** — https://docs.open-metadata.org/latest/api-reference
- **APIReference** — https://docs.open-metadata.org/latest/api-reference

## Other Collate APIs (12)

- [Collate Activity Stream API](https://apis.io/apis/collate/collate-activity-stream-api/)
- [Collate Agent Executions API](https://apis.io/apis/collate/collate-agent-executions-api/)
- [Collate AI Applications API](https://apis.io/apis/collate/collate-ai-applications-api/)
- [Collate AI Audit Reports API](https://apis.io/apis/collate/collate-ai-audit-reports-api/)
- [Collate AI Context API](https://apis.io/apis/collate/collate-ai-context-api/)
- [Collate AI Framework Controls API](https://apis.io/apis/collate/collate-ai-framework-controls-api/)
- [Collate AI Governance API](https://apis.io/apis/collate/collate-ai-governance-api/)
- [Collate AI Governance Frameworks API](https://apis.io/apis/collate/collate-ai-governance-frameworks-api/)
- [Collate AI Governance Policies API](https://apis.io/apis/collate/collate-ai-governance-policies-api/)
- [Collate Announcements API](https://apis.io/apis/collate/collate-announcements-api/)
- [Collate API Collections API](https://apis.io/apis/collate/collate-api-collections-api/)
- [Collate API Endpoint API](https://apis.io/apis/collate/collate-api-endpoint-api/)

## Tags

User

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/collate/collate-users-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/collate/.