/api/users/:id

Loads details about user specified by ID.

Resource Information

Resource URL

https://service.belladati.com/api/users/:id

HTTP Method

GET

Request Parameters

Parameters

Detail

Example

id

ID of the user to fetch. You can find the ID in the response to /api/domains/:domain_id/users.

123
exclude(optional) removes information from Response Structureemail,lastLogin

Response Structure

JSON response contains one JSON object with following elements:

NameDescription
idUser identifier
usernameUsername
domain_idDomain identifier
firstNameUser first name
middleName
User middlename
lastNameUser last name
emailUser email address
activeBoolean flag indicating if user is active
infoUser detail information
firstLoginDate and time of user's first login
lastLoginDate and time of user's last login
phoneUser phone number
timeZoneUser time zone
localeUser locale - code of supported language
roles

Array containing all user roles where each role has following structure:

NameDescription
roleRole name - please see list of supported values
groups

Array containing all user groups where user belongs. Each group has following structure:

NameDescription
idUser group identifier
nameUser group name

Sample Request / Response

Using curl:

curl -H "Authorization: OAuth realm=\"https://service.belladati.com/\", oauth_consumer_key=\"myConsumer\", oauth_token=\"mh7an9dkrg59\", oauth_timestamp=\"135131231\", oauth_nonce=\"randomString\"" https://service.belladati.com/api/users/123

The JSON format response:

{
  "id": "123",
  "username": "myusername@example.com",
  "domain_id": "45",
  "firstName": "John",
  "middleName": "Middle", 
  "lastName": "Doe",
  "email": "myusername@example.com",
  "active": true,
  "info": "I'm pretty cool",
  "firstLogin": "Thu, 14 Jan 2012 15:33:28 GMT",
  "lastLogin": "Tue, 12 Apr 2016 11:40:58 GMT",
  "phone": "(555) 123 456 789",
  "timeZone": "Europe/Prague",
  "locale": "cs",
  "roles": [
    {
      "role": "WORKSPACE_ADMIN"
    }
  ],
  "groups": [
    {
      "id": "56",
      "name": "My User Group nr.1"
    }
  ]
}
  • No labels