User

Summary

The API Manager user is a member of organizations.

Description

API Manager user information. User objects support custom properties which will appear as field members of the user object.

Fields

Field Name Type Since Version Description
id String The unique identifier for the user
organizationId String The unique identifier for the organization to which the user belongs
name String The user's name
description String A description of the user
loginName String 1.2 A unique login name for the user
email String An email address for the user
phone String The user's phone number
mobile String The user's mobile number
role String The user's role, one of: user, oadmin, or admin
image String The user's photo. To update the image, please refer to the API.
enabled Boolean Indicates whether or not the user account is enabled or not
createdOn Long Epoch/Unix time stamp when the organization was created
state String The current state of the account, one of: approved, pending
type String Indicates the type of user. Possible values: internal, external

Example JSON

{
  "id" : "2be9fc6e-1110-474f-8029-bf1577ec3801",
  "organizationId" : "6fb4bd38-199a-4e9f-8c11-43233f530d82",
  "name" : "New User",
  "description" : "Created by admin",
  "loginName" : "jbloggs",
  "email" : "jbloggs@acmecorp.com",
  "phone" : "+353 (1) 6742000",
  "mobile" : "+353 (89) 6742087",
  "role" : "user",
  "image" : "resources/photo.jpg",
  "enabled" : true,
  "createdOn" : 1367337125476,
  "state" : "approved",
  "type" : "internal",
  "authAttrs" : null,
  "surname" : "User",
  "dn" : null
}