Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Overview

This API call applies to both Armor Complete and Armor Anywhere users.

The Get User API retrieves details for a specific user.  


Sample request

GET https://api.armor.com/users/1

Input

The following table describes the different parts of this API call: 

API Call / URLMethod / Type
/users/{id}GET

The following table describes the parameter (or parameters) for this API call:

ParameterDescriptionFormatRequired or optionalExample
id (Route)ID of the userIntegerRequired1

Sample return

StatusResponse
200
{  
  "id":2402,
  "isMfaEnabled":true,
  "status":"enabled",
  "title":"",
  "firstName":"John",
  "lastName":"Smith",
  "email":"john.smith@example.com",
  "phonePrimary":{  
     "countryCode":1,
     "countryIsoCode":"US",
     "number":"8880000000"
  },
  "timezone":"GMT Standard Time",
  "culture":"en-US",
  "permissions":[  
     1
  ],
  "lastModified":"2015-09-22T15:28:06.89",
  "passwordLastSet":"0001-01-01T00:00:00",
  "mustChangePassword":false,
  "lastLogin":"2015-10-26T20:23:58.067",
  "mfaMode":"VoiceCall",
  "mfaPinMode":"Standard"
}

Output

The following table describes the expected results for specific outputs that may not be clear enough within the sample output.

ReturnTypeDescriptionPossible valuesExample