User Login Info

GET /api/v1/mngt/user_login_info/

Retrieve login profile of a user (of any type) that the authenticated user can manage. This API is classically used by an Admin to get the url ids of a user he manages.

Note: This API is not yet 100% finalized.

Example request:

GET /api/v1/mngt/user_login_info/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "username": "PieGroupAdmin1",
}

Request JSON Object:

• username (optional) (string) – the username of the user. Mutually exclusive with phoneNumber. If none is provided it will be the info of the authenticated user.

• phoneNumber (optional) (string) – the phone number of the user. Mutually exclusive with username If none is provided it will be the info of the authenticated user.

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"
Set-Cookie: sessionid=0123456780

{
   "ids": {
      "tenant_id": "Pie",
      "group_id": "PieGroup"
   }
   "profile" : {
      "user_level": 8,
   },
   "username" : "PieGroupAdmin1@sip.netaxis.be
}

Response JSON Object:

• ids (object) – The list of ids of the requested user defined as Ids attributes, to be used by the client to build further API urls. Of course only ids relevant for the type of user retrieved are returned

• profile (object) – Some properties of the profile as defined in Login profile attributes. The optional parameters are only present if relevant. The “is_first_login” is never provided as it is not a login.

• username (string) – The full username (including domain if any) if the user requested.

Status Codes:

• 200 OK – no error, successfully logged

• 404 Not Found – user not found or not allowed to be managed by the authenticated user (to avoid user enumeration)