All URIs are relative to https://cdn.emnify.net
| Method | HTTP request | Description |
|---|---|---|
| user_by_id_delete | delete /api/v1/user/{user_id} | Delete User by ID |
| user_by_id_get | get /api/v1/user/{user_id} | Get User by ID or Username |
| user_by_id_patch | patch /api/v1/user/{user_id} | Update User by ID |
| user_event_page_per_page_sort_by_user_id_and_q_get | get /api/v1/user/{user_id}/event | List User Events |
| user_per_page_sort_by_q_and_page_get | get /api/v1/user | List User Accounts |
| user_per_page_sort_by_q_and_page_post | post /api/v1/user | Create User |
| user_role_by_id_and_role_id_delete | delete /api/v1/user/{user_id}/role/{role_id} | Delete User Role |
| user_role_by_id_and_role_id_put | put /api/v1/user/{user_id}/role/{role_id} | Assign Role to User |
| user_role_get | get /api/v1/user/role | List User Roles |
| user_role_permission_by_id_get | get /api/v1/user/{user_id}/role/permission | List User Role Permissions |
| user_status_get | get /api/v1/user/status | List User Statuses |
user_by_id_delete(user_id) Delete User by ID
Notes * A user can be deleted, if belonging to the same organisation as the requesting user, or to an organisation which is a direct child of the requesting user's organisation.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| user_id | f32 | User ID | [required] |
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::RetrievetheUserresponse user_by_id_get(user_id) Get User by ID or Username
Get a specific user by ID provided the user is within this requesting user's organisation or the organisation's immediate child organisations. id may be one of: * The numeric ID of the user, e.g. "123". This is the top-level id object returned by each item in GET /api/v1/user * Username (email), e.g. "exampleuser@org.de". This is the top-level username object returned by each item in GET /api/v1/user
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| user_id | f32 | User ID | [required] |
crate::models::RetrievetheUserresponse
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
user_by_id_patch(user_id, update_userrequest) Update User by ID
Provided fields * username (String optional) - has to be user's email * name (String optional) * status (Object optional) * organisation (Object optional) - must be the current organisation or not to be provided #### Notes * Password is not provided. Separate calls provide password management. * The organisation is not modifiable. A user can be updated, if belonging to the same organisation as the requesting user, or to an organisation which is a direct child of the requesting user's organisation. * Status can be changed between ACTIVE (id: 1) and SUSPENDED (id: 2), and from ACTIVATION_PENDING (id: 0) to SUSPENDED. > Modifying the username invalidates account and triggers the activation procedure.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| user_id | f32 | User ID | [required] | |
| update_userrequest | UpdateUserrequest | [required] |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Veccrate::models::RetrieveEventsresponse4 user_event_page_per_page_sort_by_user_id_and_q_get(user_id, page, per_page, sort, q) List User Events
Returns the list of events, filtered, sorted and paged according to query parameters. Only an administrator or observer may be allowed to see events of other users, provided they belong to an organisation he/she has access to. Any user can retrieve their own events at /api/v1/user/my/event. CAUTION This API endpoint deviates from the specified conventions and may not return the same HTTP Codes as the higher layer call (/api/v1/user/{user_id|my}). In case the requested {user_id} does not exist or is not accessible for the user, HTTP 200 will be returned with empty [] as long as the provided {user_id} is a number and all parameters are valid. Please take that into consideration when building automation on top of the error behaviour of this endpoint.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| user_id | f32 | User ID | [required] | |
| page | Option<f32> | Current page number | ||
| per_page | Option<f32> | Paging parameters defining the number of items per page | ||
| sort | Option<String> | Sort properties according to a comma separated list of accepted fields. Valid fields are: * id - (event id) * timestamp - (event timestamp) * source - (event source) * severity - (event severity) * alert - (alert status) * organisation - (organisation name) * user - (user id) * endpoint - (endpoint name) * tags - (endpoint tags) * ip_address - (endpoint ip_address) * iccid - (sim iccid) * imsi - (sim imsi) * type - (event type) |
||
| q | Option<String> | Filter parameter in <filter>:<value> format. Multiple filters must be in the format of a comma separated list of the following fields: * type (event_type, numerical) * source (event_type, numerical, e.g. 0 = Network), 1 = Policy Control, 2 = API) * severity (event_severity, numerical, e.g. 0 = Info, 1 = Warn), 2 = Critical) * alert (boolean, e.g. true, false) * description (event description, string) * organisation (organisation name, string) * user (user name, string) * endpoint (endpoint name, string) * tags (endpoint tags, string) * ip_address (endpoint IP address, valid IPv4/IPv6 address) * imei (endpoint imei, numerical string) * iccid (sim iccid, numerical string) * imsi (sim imsi, numerical string) * from (date, format YYYY-MM-DDTHH:mm:ssZ, only valid with until!) * until (date, format YYYY-MM-DDTHH:mm:ssZ, only valid with from!) * timestamp (date, format YYYY-MM-DDTHH:mm:ssZ, for querying events of 1 day, deprecated in future) |
Veccrate::models::RetrieveEventsresponse4
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Veccrate::models::User user_per_page_sort_by_q_and_page_get(page, q, per_page, sort) List User Accounts
Retrieves the collection of user accounts, filtered, sorted and paged accourding to query parameters.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| page | Option<f32> | Current page number | ||
| q | Option<String> | Filter parameter in <filter>:<value> format. Multiple filters must be in the format of a comma separated list of the following fields: * id * status * name * username * organisation |
||
| per_page | Option<f32> | Paging parameters defining the number of items per page | ||
| sort | Option<String> | Sort properties according to comma separated list out of the allowed fields * id * status * name * username * organisation * created |
Veccrate::models::User
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
user_per_page_sort_by_q_and_page_post(create_userrequest) Create User
Creates a user which is not active and has no password assigned. The URL to get the user details is provided as Location Header in the response. #### ACTIVATION Upon creation, the user account undergoes an activation process (see services below ) in which she receives an email with activation link. Following this link the user is asked to set the password and upon successful completion of this process, the account becomes active and operational. Provided fields: * username (String required) - has to be the email of this user * name (String required) * organisation (Object optional) - may be provided by regular user, but is required for master user. * roles (List of Objects optional) - List of one or more role Ids to be assigned at once. If missing, a default role is assigned #### Notes * Password is not provided. Separate calls provide password management. * When the organisation of the new user is not specified in the request, it is inherited from the user creating the account. A regular user is allowed to specify only organisations which are direct children of his/her own organisation, or his/her own organisation. * The status field is not user editable at account creation time - the default imposed by server is ACTIVATION_PENDING.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| create_userrequest | CreateUserrequest | [required] |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
user_role_by_id_and_role_id_delete(user_id, role_id) Delete User Role
Release a Role from association with this user. Note that a Role can only be removed, if it is not the last role of this user.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| user_id | f32 | User ID | [required] | |
| role_id | f32 | Role ID to be assigned | [required] |
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
user_role_by_id_and_role_id_put(user_id, role_id) Assign Role to User
Role is assigned to this user.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| user_id | f32 | User ID | [required] | |
| role_id | f32 | Role ID to be assigned | [required] |
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Vec<serde_json::Value> user_role_get() List User Roles
Retrieves the collection of available user roles
This endpoint does not need any parameter.
Vec<serde_json::Value>
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
serde_json::Value user_role_permission_by_id_get(user_id) List User Role Permissions
Role permissions available to this user. Only an administrator or observer is allowed to see the role permissions of other users, provided they belong to an organisation he/she has access to.
Any user can also retrieve one's own role permissions at: /api/v1/user/my/role/permission.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| user_id | f32 | User ID | [required] |
serde_json::Value
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Veccrate::models::RetrieveAvailableUserStatusesresponse user_status_get() List User Statuses
Provides the list of available user status (lookup).
This endpoint does not need any parameter.
Veccrate::models::RetrieveAvailableUserStatusesresponse
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]