# Instaclustr Service User Management API

**Canonical:** https://apis.io/apis/instaclustr/instaclustr-service-user-management-api-api/  
**Provider:** Instaclustr — https://apis.io/providers/instaclustr/  
**Base URL:** https://api.instaclustr.com  
**Documentation:** https://instaclustr.redoc.ly/Current/

Instaclustr Service User Management API is one of 93 APIs that [Instaclustr](https://apis.io/providers/instaclustr/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 12 JSON Schema definitions. Tagged areas include Service User Management API. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 12 JSON Schemas.

Operations related to service user management.<br>Service Users are API-only users. Service Users are created in, and have access to, a single account. This account is the account associated with the API key that was used to create the Service User via the API. Owner and Cluster Admin level users in an account can create Service Users. The user who creates a Service User automatically becomes an Administrator of that Service User. Administrators of a Service User may invite additional Cluster Admin users to be Controllers of that user. Owner users in an account automatically have Administrator-level access to all Service Users in that account.<br>A Service User may not have multiple API keys of the same type, however an account can create multiple Service Users.

## Operations (9)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/service-users` | Get service users |
| POST | `/v1/service-users` | Create a service user |
| GET | `/v1/service-users/{username}` | Get a service user |
| PUT | `/v1/service-users/{username}` | Update a service user |
| DELETE | `/v1/service-users/{username}` | Deactivate a service user |
| POST | `/v1/service-users/{username}/apikey` | Generate a service user's API key |
| DELETE | `/v1/service-users/{username}/apikey` | Revoke a service user's API key |
| PUT | `/v1/service-users/{username}/apikey/{apiKeyType}` | Update API key's IP restrictions for the service user |
| POST | `/v1/service-users/{username}/apikey/{apiKeyType}` | Rotate service user's API key |

## Machine-readable artifacts (14)

- **OpenAPI** — https://artifacts.apis.io/instaclustr/openapi/instaclustr-service-user-management-api-api-openapi.yml
- **Documentation** — https://www.instaclustr.com/support/documentation/
- **JSONSchema** — https://artifacts.apis.io/instaclustr/json-schema/instaclustr-open-search-cluster-v2-schema.json
- **JSONSchema** — https://artifacts.apis.io/instaclustr/json-schema/instaclustr-kafka-cluster-v3-schema.json
- **JSONSchema** — https://artifacts.apis.io/instaclustr/json-schema/instaclustr-cadence-cluster-v2-schema.json
- **JSONSchema** — https://artifacts.apis.io/instaclustr/json-schema/instaclustr-cassandra-cluster-v2-schema.json
- **JSONSchema** — https://artifacts.apis.io/instaclustr/json-schema/instaclustr-postgresql-cluster-v2-schema.json
- **JSONSchema** — https://artifacts.apis.io/instaclustr/json-schema/instaclustr-click-house-integration-s3-fsxn-schema.json
- **JSONSchema** — https://artifacts.apis.io/instaclustr/json-schema/instaclustr-cluster-provisioning-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/instaclustr/json-schema/instaclustr-data-centre-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/instaclustr/json-schema/instaclustr-kafka-cluster-v2-schema.json
- **JSONSchema** — https://artifacts.apis.io/instaclustr/json-schema/instaclustr-cluster-details-response-for-terraform-import-schema.json
- **JSONSchema** — https://artifacts.apis.io/instaclustr/json-schema/instaclustr-bundle-compatibility-response-schema-schema.json
- **JSONSchema** — https://artifacts.apis.io/instaclustr/json-schema/instaclustr-kafka-topic-v2-schema.json

## Other Instaclustr APIs (12)

- [Instaclustr Account Cluster List V2 API](https://apis.io/apis/instaclustr/instaclustr-account-cluster-list-v2-api/)
- [Instaclustr Apache Cassandra Provisioning V2 API](https://apis.io/apis/instaclustr/instaclustr-apache-cassandra-provisioning-v2-api/)
- [Instaclustr Apache Kafka ACL V2 API](https://apis.io/apis/instaclustr/instaclustr-apache-kafka-acl-v2-api/)
- [Instaclustr Apache Kafka ACL V3 API](https://apis.io/apis/instaclustr/instaclustr-apache-kafka-acl-v3-api/)
- [Instaclustr Apache Kafka Connect Mirror V2 API](https://apis.io/apis/instaclustr/instaclustr-apache-kafka-connect-mirror-v2-api/)
- [Instaclustr Apache Kafka Connect Provisioning V2 API](https://apis.io/apis/instaclustr/instaclustr-apache-kafka-connect-provisioning-v2-api/)
- [Instaclustr Apache Kafka Provisioning V2 API](https://apis.io/apis/instaclustr/instaclustr-apache-kafka-provisioning-v2-api/)
- [Instaclustr Apache Kafka Provisioning V3 API](https://apis.io/apis/instaclustr/instaclustr-apache-kafka-provisioning-v3-api/)
- [Instaclustr Apache Kafka Rest Proxy User API](https://apis.io/apis/instaclustr/instaclustr-apache-kafka-rest-proxy-user-api/)
- [Instaclustr Apache Kafka Schema Registry User API](https://apis.io/apis/instaclustr/instaclustr-apache-kafka-schema-registry-user-api/)
- [Instaclustr Apache Kafka Tiered Storage API](https://apis.io/apis/instaclustr/instaclustr-apache-kafka-tiered-storage-api/)
- [Instaclustr Apache Kafka Topic V2 API](https://apis.io/apis/instaclustr/instaclustr-apache-kafka-topic-v2-api/)

## Tags

Service User Management API

---

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