Searching...

Matching results

User

/api/v1/users/rights

Returns a list of rights assigned to the authenticated user. User rights are calculated based on their context.

GET https://na.airvantage.net/api/v1/users/rights

HTTP/1.1 200 OK
Content-Type: application/json[][]
...
["entities.applications.view", "accountNetwork.users.createEdit"]

/api/v1/users

Returns a paginated list of users with their complete details.

It is possible to restrain the result list using criteria parameters.

The fields parameter has to be defined in order to specify the attributes of the user which will be returned.
If fields parameter is missing, only the following attributes of the user are returned: uid, name, email.

More information about paging, filtering, and sorting here

GET https://na.airvantage.net/api/v1/users?fields=uid,name,email,profile

HTTP/1.1 200 OK
Content-Type: application/json
{
   "items": [   {
      "uid": "1cb5e5fc9bc14fa584bfe417a91e7881",
      "name": "MyUser",
      "email": "myuser@airvantage.net",
      "profile": {
         "uid": "5a3e78ca0ea64d6a9bdaef5966e8b374",
         "name": "MyProfile"
      }
   }],
   "count": 1,
   "size": 1,
   "offset": 0
}

/api/v1/users/{uid}

Returns detailed information about the specified user.

GET https://na.airvantage.net/api/v1/users/1
...

HTTP/1.1 200 OK
Content-Type: application/json
...
{
   "company": {
      "uid": "1",
      "name": "Sierra Wireless"
   },
   "uid": "1",
   "email": "administrator@airvantage.net",
   "picture": {
      "normal": "/users/1/picture/normal",
      "small": "/users/1/picture/small",
      "icon": "/users/1/picture/icon"
   },
   "name": "The Administrator",
   "profile": null
}

/api/v1/users/current

Returns detailed information about the current user.

GET https://na.airvantage.net/api/v1/users/current
...

HTTP/1.1 200 OK
Content-Type: application/json
...
{
   "company": {
      "uid": "1",
      "name": "Sierra Wireless"
   },
   "uid": "1",
   "email": "administrator@airvantage.net",
   "picture": {
      "normal": "/users/1/picture/normal",
      "small": "/users/1/picture/small",
      "icon": "/users/1/picture/icon"
   },
   "name": "The Administrator",
   "profile": null
}

/api/v1/users

Creates a new user. Email, name, password, and profile are required fields. phoneNumber is optional.

POST https://na.airvantage.net/api/v1/users
Content-Type: application/json
...
// With content:
{
   "name":"Rodrigue",
   "email":"operator@airvantage.net",
   "password":"FCMM13r8m}pYu'E",
   "profile": {
     "uid":"ee81d84aec5b4d4397ead51b823b76a7"
   }
}

HTTP/1.1 200 OK
Content-Type: application/json
...
{
   "uid": "a86e9a3ff1df4a13b39c24f48f1967ed",
   "email": "operator@airvantage.net",
   "name": "Rodrigue",
   "phoneNumber" : null,
   "profile": {
      "uid": "ee81d84aec5b4d4397ead51b823b76a7",
      "name": "operator"
   },
   "company": {
      "uid": "6500ee29f8ed4e3991dff484b3ce3e73",
      "name": "Current Company Name"
   },
   "picture" : null
}

/api/v1/users/{uid}

Edits user details. User details can be edited by an administrator or by the user himself. However if the user is not an administrator, the profile cannot be changed.

PUT https://na.airvantage.net/api/v1/users/a86e9a3ff1df4a13b39c24f48f1967ed
Content-Type: application/json
...
// With content:
{
   "name" : "Rodrigue Dupont",
   "email" : "rodrigue@dupont.com",
   "password" : "xxxxxxx",
   "phoneNumber" : "+349854797415",
   "profile": {
     "uid":"63ee28685c8c4ad0a7e408f88abaffc4"
   }
}

...
{
   "uid": "a86e9a3ff1df4a13b39c24f48f1967ed",
   "email": "rodrigue@dupont.com",
   "name": "Rodrigue Dupont",
   "phoneNumber" : "+349854797415",
   "profile": {
      "uid": "63ee28685c8c4ad0a7e408f88abaffc4",
      "name": "user"
   },
   "company": {
      "uid": "6500ee29f8ed4e3991dff484b3ce3e73",
      "name": "Current Company Name"
   },
   "picture" : null
}

/api/v1/users/{uid}/picture

Uploads an image. The service creates 3 images in the fileStore for the uploaded one.

Uploaded images cannot be bigger than 750KB and dimensions have to be equals or less than 1024 px per side.

POST https://na.airvantage.net/api/v1/users/1/picture
Content-Type: image/jpeg

// with an attached jpeg file
...

HTTP/1.1 200 OK

/api/v1/users/{uid}/picture/{name}

Gets one of the user pictures.

GET https://na.airvantage.net/api/v1/users/1/picture/small

/api/v1/users/{uid}

Deletes a user. If the user is the unique administrator of a company, it can't be deleted.

DELETE https://na.airvantage.net/api/v1/users/a86e9a3ff1df4a13b39c24f48f1967ed

HTTP/1.1 200 OK

/api/v1/users/{uid}/clients

Gets the list of all API clients authorized by this user.

GET https://na.airvantage.net/api/v1/users/1/clients

HTTP/1.1 200 OK
Content-Type: application/json
...
[
    {
        "name": "Test",
        "description": "Api Client description",
        "uid": "ed5d212963d1487995758d7f3c2e4c5d",
        "pictureUrl": null
    }
]

/api/v1/users/{uid}/clients

Revokes an API client from the list of authorized clients authorized by this user. This method returns the remaining API clients.

DELETE https://na.airvantage.net/api/v1/users/a86e9a3ff1df4a13b39c24f48f1967ed/clients?apiClient=ed5d212963d1487995758d7f3c2e4c5d

HTTP/1.1 200 OK
Content-Type: application/json
...
[]