# Acceldata Administration API

**Canonical:** https://apis.io/apis/acceldata/acceldata-administration-api/  
**Provider:** Acceldata — https://apis.io/providers/acceldata/  
**Base URL:** https://{adoc-host}  
**Documentation:** https://documentation.acceldata.io/docs/acceldata/api/administration

Acceldata Administration API is one of 10 APIs that [Acceldata](https://apis.io/providers/acceldata/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Administration, Identity, RBAC, and SCIM. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

Tenant administration for ADOC: user and service-user lifecycle (create, update, disable), user group management, client role assignment, and API key issuance and revocation. SCIM-managed users and groups carry restricted edit and delete operations. 31 published operations.

## Operations (31)

| Method | Path | Summary |
|---|---|---|
| GET | `/admin/api/users/list` | List all users (paginated with metadata) |
| GET | `/admin/api/users/count` | Get user count |
| PUT | `/admin/api/users/{userId}` | Update a user |
| GET | `/admin/api/users/{userId}` | Get a user by ID |
| DELETE | `/admin/api/users/{userId}/remove-user` | Remove a user |
| PUT | `/admin/api/users/{userId}/assign-groups` | Assign groups to a user |
| PUT | `/admin/api/users/{userId}/remove-groups` | Remove groups from a user |
| GET | `/admin/api/users/{userId}/groups` | Get groups for a user |
| GET | `/admin/api/users/{userId}/api-keys` | List API keys for a user |
| GET | `/admin/api/users/api-keys/all` | List all API keys in the realm |
| DELETE | `/admin/api/users/api-keys/{accessKey}` | Delete an API key |
| GET | `/admin/api/groups/list` | List groups (summary view) |
| POST | `/admin/api/groups/metadata` | Get metadata for groups |
| POST | `/admin/api/groups` | Create a group |
| GET | `/admin/api/groups` | List all groups |
| PUT | `/admin/api/groups/{groupId}` | Update a group |
| DELETE | `/admin/api/groups/{groupId}` | Delete a group |
| GET | `/admin/api/groups/{groupId}` | Get a group by ID |
| GET | `/admin/api/groups/{groupId}/available-roles` | Get available roles for a group |
| PUT | `/admin/api/assign-client-roles` | Assign client roles to a user |
| PUT | `/admin/api/remove-assigned-client-roles` | Remove assigned client roles from a user |
| GET | `/admin/api/assigned-client-roles/{userId}` | Get assigned client roles for a user |
| POST | `/admin/api/profile-update/forgot-password` | Trigger forgot-password email |
| POST | `/admin/api/v1/service-users` | Create a service user |
| GET | `/admin/api/v1/service-users/list` | List service users |
| PUT | `/admin/api/v1/service-users/{serviceUserId}` | Update a service user |
| GET | `/admin/api/v1/service-users/{serviceUserId}` | Get a service user |
| PUT | `/admin/api/v1/service-users/{serviceUserId}/add-roles` | Add roles to a service user |
| PUT | `/admin/api/v1/service-users/{serviceUserId}/remove-roles` | Remove roles from a service user |
| POST | `/admin/api/v1/service-users/{serviceUserId}/api-key` | Create an API key for a service user |
| DELETE | `/admin/api/v1/service-users/{serviceUserId}/api-key/{accessKey}` | Delete a service user API key |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/acceldata/refs/heads/main/openapi/_original/acceldata-administration-api-openapi.json
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/acceldata/refs/heads/main/overlays/acceldata-administration-overlay.yaml
- **Documentation** — https://docs.acceldata.io/documentation/roles-and-permissions
- **APIReference** — https://documentation.acceldata.io/docs/acceldata/api/administration
- **Authentication** — https://docs.acceldata.io/documentation/api-keys
- **AgentSkill** — https://raw.githubusercontent.com/api-evangelist/acceldata/refs/heads/main/skills/acceldata-provision-service-user-and-api-key.md
- **OAuthScopes** — https://raw.githubusercontent.com/api-evangelist/acceldata/refs/heads/main/scopes/acceldata-scopes.yml

## Other Acceldata APIs (9)

- [Acceldata Alerts API](https://apis.io/apis/acceldata/acceldata-alerts-api/)
- [Acceldata Data Quality Rules API](https://apis.io/apis/acceldata/acceldata-data-quality-rules-api/)
- [Acceldata Datasets API](https://apis.io/apis/acceldata/acceldata-datasets-api/)
- [Acceldata Lineage API](https://apis.io/apis/acceldata/acceldata-lineage-api/)
- [Acceldata Pipeline Jobs API](https://apis.io/apis/acceldata/acceldata-pipeline-jobs-api/)
- [Acceldata Roles API](https://apis.io/apis/acceldata/acceldata-roles-api/)
- [Acceldata Users API](https://apis.io/apis/acceldata/acceldata-users-api/)
- [Acceldata Catalog API](https://apis.io/apis/acceldata/acceldata-catalog-api/)
- [Acceldata Tag Services API](https://apis.io/apis/acceldata/acceldata-tags-api/)

## Tags

Administration, Identity, RBAC, SCIM

---

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