# CData Users API

**Canonical:** https://apis.io/apis/cdata/cdata-users-api/  
**Provider:** CData — https://apis.io/providers/cdata/  
**Base URL:** https://cloud.cdata.com/api  
**Documentation:** https://cloud.cdata.com/docs/SQL-API.html

CData Users API is one of 14 APIs that [CData](https://apis.io/providers/cdata/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an API reference, and 6 JSON Schemas.

Lifecycle management for human users: create, update, deprovision, and manage direct role assignments, workspace-scoped roles, and direct resource permissions. SCIM handles group-based provisioning and user creation at scale; this API handles direct overrides and atomic deprovisioning.

## Operations (15)

| Method | Path | Summary |
|---|---|---|
| POST | `/users` | Create User |
| GET | `/users` | List Users |
| POST | `/users/batch` | Batch Create or Update Users |
| GET | `/users/{id}` | Get User |
| PATCH | `/users/{id}` | Update User |
| DELETE | `/users/{id}` | Delete User |
| POST | `/users/{id}/roles` | Assign User Role |
| GET | `/users/{id}/roles` | List User Roles |
| DELETE | `/users/{id}/roles/{role_id}` | Remove User Role |
| POST | `/users/{id}/permissions` | Assign User Permission |
| GET | `/users/{id}/permissions` | List User Permissions |
| DELETE | `/users/{id}/permissions/{permission_id}` | Remove User Permission |
| POST | `/users/{id}/workspaces/{workspace_id}/roles` | Assign User Workspace Role |
| GET | `/users/{id}/workspaces/{workspace_id}/roles` | List User Workspace Roles |
| DELETE | `/users/{id}/workspaces/{workspace_id}/roles/{role_id}` | Remove User Workspace Role |

## Machine-readable artifacts (23)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/cdata/refs/heads/main/openapi/cdata-users-api-openapi.yml
- **Documentation** — https://cloud.cdata.com/docs/SQL-API.html
- **Overview** — https://cloud.cdata.com/docs/API.html
- **Authentication** — https://cloud.cdata.com/docs/Authentication.html
- **APIReference** — https://docs.cloud.cdata.com/en/API/REST-API
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/cdata/refs/heads/main/errors/cdata-problem-types.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/cdata/refs/heads/main/conventions/cdata-conventions.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/cdata/refs/heads/main/data-model/cdata-data-model.yml
- **Documentation** — https://cloud.cdata.com/docs/Metadata-API.html
- **Documentation** — https://cloud.cdata.com/docs/Log-API.html
- **Documentation** — https://docs.cloud.cdata.com/en/API/Connection-API
- **Documentation** — https://docs.cloud.cdata.com/en/API/Job-API
- **Documentation** — https://docs.cloud.cdata.com/en/API/Account-API
- **Documentation** — https://cloud.cdata.com/docs/Audit-API.html
- **OAuthScopes** — https://raw.githubusercontent.com/api-evangelist/cdata/refs/heads/main/scopes/cdata-scopes.yml
- **Documentation** — https://docs.cloud.cdata.com/en/API/Management-API
- **Documentation** — https://docs.cloud.cdata.com/en/API/MCP-Embedded
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/cdata/refs/heads/main/json-schema/cdata-batch-create-users-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/cdata/refs/heads/main/json-schema/cdata-user-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/cdata/refs/heads/main/json-schema/cdata-user-workspace-role-assignment-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/cdata/refs/heads/main/json-schema/cdata-user-role-assignment-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/cdata/refs/heads/main/json-schema/cdata-user-permission-assignment-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/cdata/refs/heads/main/json-schema/cdata-create-user-request-schema.json

## Other CData APIs (12)

- [CData Connect AI MCP Server](https://apis.io/apis/cdata/mcp/)
- [CData Account API](https://apis.io/apis/cdata/cdata-account-api/)
- [CData Cache API](https://apis.io/apis/cdata/cdata-cache-api/)
- [CData Connection API](https://apis.io/apis/cdata/cdata-connection-api/)
- [CData Data Explorer API](https://apis.io/apis/cdata/cdata-data-explorer-api/)
- [CData Job API](https://apis.io/apis/cdata/cdata-job-api/)
- [CData Jobs API](https://apis.io/apis/cdata/cdata-jobs-api/)
- [CData Log API](https://apis.io/apis/cdata/cdata-log-api/)
- [CData Metadata API](https://apis.io/apis/cdata/cdata-metadata-api/)
- [CData Query API](https://apis.io/apis/cdata/cdata-query-api/)
- [CData Service Accounts API](https://apis.io/apis/cdata/cdata-service-accounts-api/)
- [CData O Data API](https://apis.io/apis/cdata/cdata-odata-api/)

## Tags

User

---

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