Named users

Follow

Get named users

  • GET /named_users will return all named users.
[
  {
    "id": 605816632,
    "full_name": "Nicolas Raspal",
    "external_id": "60581D",
    "updated_at": "2012-03-23T13:55:43-05:00",
    "created_at": "2012-03-23T13:55:43-05:00",
    "access_token": "AZALPODP12332MLSDSDSLM",
    "named_user_group_id":5
  },
  {
   "id": 605816634,
   "full_name": "Yannick Chaze",
   "external_id": "60581D",
   "updated_at": "2012-03-23T13:55:43-05:00",
   "created_at": "2012-03-23T13:55:43-05:00",
   "access_token": "AZAL2P1DP12332MLSDSDSLM",
   "named_user_group_id":4
  }
]

external_id is an id assigned by the third party application (ie: the primary key of the user synchronized with the Bime named viewer). It has to be unique.

Get named user

  • GET /named_users/1 will return the specified named user.
{
   "id": 605816634,
   "full_name": "Yannick Chaze",
   "external_id": "60581D",
   "updated_at": "2012-03-23T13:55:43-05:00",
   "created_at": "2012-03-23T13:55:43-05:00",
   "access_token": "AZALPODP112332MLSDSDSLM",
   "named_user_group_id": 5
}

You can use an external parameter (?external=true) to tell us to perform the lookup on the external_id.

If the named user is not found you'll get an exception with record not found.

access_token is sent to dashboards to identify the users and apply data security.

Create named user

  • POST /named_users will create a new named user from the parameters passed.
{
  "login": "myemail@company.com",
  "external_id": "007",
  "named_user_group_id": 4
}

This will return 201 Created, with the current JSON representation of the named user if the creation was a success. See the Get named user endpoint for more info.

Update named user

  • PUT /named_users/1 will update the named user from the parameters passed.
{
  "login": "myemail@company.com",
  "external_id": "007",
  "named_user_group_id": 5,
  "renew_access_token":true
}

The renewaccesstoken parameter when set at true will expire the current one and create a new one.

This will return 200 OK if the update was a success along with the current JSON representation of the named user. See the Get named user endpoint for more info.

Delete named user

  • DELETE /named_users/1 will delete the named user specified and return 204 No Content if that was successful.
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk