Page tree

Overview

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

The Update User API updates the profile details for a user. 

You can use the Get Users API to find the user ID (id).

You can use the Get Accounts API to find the account ID (id)

Sample request

PUT https://api.armor.com/users/2381

REQUEST:
{  
  "firstName":"John",
  "lastName":"Smith",
  "title":"",
  "status":"enabled",
  "isMfaEnabled":true,
  "phonePrimary":{  
     "countryCode":"1",
     "countryIsoCode":"US",
     "number":"8880000000"
  },
  "culture":"en-US",
  "timezone":"GMT Standard Time",
  "accountid":2093,
  "mfaMode":"VoiceCall",
  "mfaPinMode":"Standard",
  "mfaPin":null
}

Input

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

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

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

ParameterDescriptionFormatRequired or optionalExample
idID of the userIntegerRequired1
firstNameFirst name of the userStringRequiredJohn
lastNameLast name of the userStringRequiredSmith
statusThe status of the user account, either enabled or disabledStringRequiredenabled
isMfaEnabledThe status of MFA for the user account, either enabled or disabledBooleanRequiredtrue
phonePrimaryAn array for the phone number to be associated with the user account, especially for MFAStringRequired[ ]

Sample return

StatusResponse
200
{  
  "id":2381,
  "firstName":"John",
  "lastName":"Smith",
  "title":"",
  "status":"enabled",
  "isMfaEnabled":true,
  "phonePrimary":{  
     "countryCode":"1",
     "countryIsoCode":"US",
     "number":"8880000000"
  },
  "culture":"en-US",
  "timezone":"GMT Standard Time",
  "accountid":2093,
  "mfaMode":"VoiceCall",
  "mfaPinMode":"Standard",
  "mfaPin":null
}





In this topic



Have a suggestion for the Armor Knowledge Base? Send a message to kb@armor.com.