User

What can you do with User?


Properties

Property Details
id
"id": 903
Type: Number
This is the unique numeric identifier for the User
roleId
"roleId": 110
Type: Number
Unique identifier for the associated Role object.
cultureId
"cultureId": 687
Type: Number
Unique identifier for the associated Culture object.
languageId
"languageId": 954
Type: Number
Unique identifier for the associated Language object.
ownerId
"ownerId": 781
Type: Number
Unique identifier for the associated Owner object.
userStatusTypeId
"userStatusTypeId": 988
Type: Number
Unique identifier for the associated UserStatusType object.
name
"name": "Hello World"
Type: String
created
"created": "2005-04-11T14:56:24"
Type: Date
expire
"expire": "2005-04-11T14:56:24"
Type: Date
isInteractive
"isInteractive": true
Type: Boolean
salt
"salt": "Hello World"
Type: String
firstName
"firstName": "Hello World"
Type: String
lastName
"lastName": "Hello World"
Type: String
email
"email": "Hello World"
Type: String
forcePasswordReset
"forcePasswordReset": true
Type: Boolean
timeZone
"timeZone": "Hello World"
Type: String
failedLoginCount
"failedLoginCount": 65
Type: Number
displayName
"displayName": "Hello World"
Type: String


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • roleId
  • cultureId
  • languageId
  • userStatusTypeId
  • name
  • created
  • expire
  • isInteractive
  • firstName
  • lastName
  • email
  • forcePasswordReset
  • timeZone
  • failedLoginCount
  • displayName

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the User object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v1/User/{id:int}
Delete an instance of the User object.
GETapi/v1/User
Retrieve all of the User objects.
GETapi/v1/User/Metadata
Retrieve all of the meta data details of the User object.
GETapi/v1/User/Metadata/{option}
Retrieve all the meta data details of the User object based on provided options.
{option}Metadata options for the User object.
GETapi/v1/User/Paged
Retreive all of the User objects in a paged fashion.
GETapi/v1/User/Paged/Detail
Retreive all of the User objects in a paged fashion with all object details.
GETapi/v1/User/{id:int}
Retrieve an instance of the User object by it's ID.
{id:int}Unique identifier for the User object.
GETapi/v1/User/{id:int}/Access/Recent
Retreive all of the Access/Recent objects for the specified User.
{id:int}Unique identifier for the User object.
GETapi/v1/User/{id:int}/Detail
Retreive all of the Detail objects for the specified User.
{id:int}Unique identifier for the User object.
PATCHapi/v1/User/{id:int}
Update the User object and optionally make changes to any child objects.
POSTapi/v1/User
Create a new instance of the User object.
PUTapi/v1/User/{id:int}
Update an existing instance of the User object.