Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

emnify subpackage_userManagement API

The subpackage_userManagement API from emnify — 8 operation(s) for subpackage_usermanagement.

emnify subpackage_userManagement API is one of 29 APIs that emnify publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 5 JSON Schema definitions.

Tagged areas include subpackage_userManagement. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 5 JSON Schemas.

This API exposes 12 operations across 8 paths, and defines 34 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://cdn.emnify.net.

12 operations 8 paths 34 schemas 2 DELETE6 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Server
https://cdn.emnify.net
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

emnify subpackage_userManagement API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Retrieve a JWT via POST /api/v1/authenticate using an applicationtoken or user credentials, then send it as Authorization: Bearer .

Paths & Operations 12

Across 8 paths, the API surfaces 12 operations — 2 DELETE, 6 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

subpackage_userManagement 12
GET
/api/v1/user
List user accounts
user-per-page-sort-by-q-and-page-get 5 params → 200
POST
/api/v1/user
Create user
user-per-page-sort-by-q-and-page-post 1 param body → 201404422
GET
/api/v1/user/role
List user roles
user-role-get 1 param → 200
GET
/api/v1/user/status
List user statuses
user-status-get 1 param → 200
GET
/api/v1/user/{user_id}
Get user by ID or username
user-by-id-get 2 params → 200404
DELETE
/api/v1/user/{user_id}
Delete user by ID
user-by-id-delete 2 params → 204404
PATCH
/api/v1/user/{user_id}
Update user by ID
user-by-id-patch 2 params body → 204422
GET
/api/v1/user/{user_id}/event
List user events
user-event-page-per-page-sort-by-user-id-and-q-get 6 params → 200400403422
GET
/api/v1/user/{user_id}/role/permission
List user role permissions
user-role-permission-by-id-get 2 params → 200
PUT
/api/v1/user/{user_id}/role/{role_id}
Assign role to user
user-role-by-id-and-role-id-put 3 params → 204404409
DELETE
/api/v1/user/{user_id}/role/{role_id}
Delete user role
user-role-by-id-and-role-id-delete 3 params → 204404409
POST
/api/v2/user/{user_id}/support_token
Create support access token for given user
user-by-id-v-2-create-support-token 2 params body → 201403404

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are ApiV1UserUserIdEventGetResponsesContentApplicationJsonSchemaItems (9 properties), User Management_UserByIdGet_Response_200 (8 properties), ApiV1UserGetResponsesContentApplicationJsonSchemaItems (6 properties), UserByIdPatchRequestUnprocessableEntityError (4 properties). Each schema is shown below with its type and property counts.

ApiV1UserUserIdEventGetResponsesContentApplicationJsonSchemaItemsEventSource
object
ApiV1UserUserIdPatchResponsesContentApplicationJsonSchemaErrorsItems
object
User Management_UserPerPageSortByQAndPagePost_Response_201
object
Empty response body
ApiV1UserUserIdPatchRequestBodyContentApplicationJsonSchemaStatus
object
ApiV1UserUserIdGetResponsesContentApplicationJsonSchemaRolesItems
object
ApiV2UserUserIdSupportTokenPostRequestBodyContentApplicationJsonSchemaRole
string
UserRoleByIdAndRoleIdDeleteRequestNotFoundError
object
3 properties
ApiV1UserPostResponsesContentApplicationJsonSchemaErrorsItems
object
ApiV1UserGetResponsesContentApplicationJsonSchemaItemsStatus
object
2 properties
ApiV1UserStatusGetResponsesContentApplicationJsonSchemaItems
object
2 properties
ApiV1UserUserIdGetResponsesContentApplicationJsonSchemaMfaItems
object
UserRoleByIdAndRoleIdPutRequestNotFoundError
object
3 properties
ApiV1UserRoleGetResponsesContentApplicationJsonSchemaItems
object
2 properties
ApiV1UserGetResponsesContentApplicationJsonSchemaItems
object
6 properties
ApiV1UserPostRequestBodyContentApplicationJsonSchemaRolesItems
object
User Management_UserByIdV2CreateSupportToken_Response_201
object
1 property
ApiV1UserUserIdEventGetResponsesContentApplicationJsonSchemaItemsUser
object
UserRoleByIdAndRoleIdDeleteRequestConflictError
object
3 properties
UserByIdPatchRequestUnprocessableEntityError
object
4 properties
UserPerPageSortByQAndPagePostRequestNotFoundError
object
3 properties
UserPerPageSortByQAndPagePostRequestUnprocessableEntityError
object
4 properties
UserRoleByIdAndRoleIdPutRequestConflictError
object
3 properties
ApiV1UserUserIdEventGetResponsesContentApplicationJsonSchemaItemsOrganisation
object
ApiV1UserPostRequestBodyContentApplicationJsonSchemaOrganisation
object
ApiV1UserUserIdEventGetResponsesContentApplicationJsonSchemaItems
object
9 properties 9 required
ApiV1UserUserIdEventGetResponsesContentApplicationJsonSchemaItemsEventSeverity
object
ApiV1UserGetResponsesContentApplicationJsonSchemaItemsOrganisation
object
2 properties
UserByIdDeleteRequestNotFoundError
object
3 properties
User Management_UserByIdGet_Response_200
object
8 properties
ApiV1UserUserIdGetResponsesContentApplicationJsonSchemaOrganisation
object
ApiV1UserUserIdGetResponsesContentApplicationJsonSchemaStatus
object
UserByIdGetRequestNotFoundError
object
3 properties
ApiV1UserUserIdEventGetResponsesContentApplicationJsonSchemaItemsEventType
object
User Management_UserRolePermissionByIdGet_Response_200
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

emnify-subpackage-usermanagement-api-openapi.yml Raw ↑

Other APIs emnify publishes across the network.

emnify GraphQL API
emnify Data Streamer
emnify Documentation MCP Server
emnify subpackage_applicationTokens API
emnify subpackage_authentication API
emnify subpackage_automations API
emnify subpackage_cloudConnect API
emnify subpackage_customEvents API
emnify subpackage_endpoint API
emnify subpackage_euicc API
emnify subpackage_euiccOperation API
emnify subpackage_events API