APappdirect
User

Read a user

Changed on

Retrieves a marketplace user by ID or external ID. If you use the ID, you can omit a prefix or use 'id:' as the prefix. If you use the external ID, you must always specify the 'externalId:' prefix.

get/account/v2/users/{userUuid}

Request

Path parameters

userUuidstring required

Unique identifier (ID or external ID) of the user

Query parameters

includeCustomAttributesboolean

Optional. Default is true. When set to true, user custom attributes are included in the API response. When set to false, user custom attributes are not included.

Response

Success

activatedboolean

Is this user activated

creationDatenumber

User creation date in UNIX Epoch milliseconds

emailstring

Email address

externalIdstring

External identifier of user

firstNamestring nullable

First name

lastNamestring nullable

Last name

allowLoginboolean

The user is able to log into a marketplace. By default allowLogin=true

lastSuccessfulLoginnumber

User last successful login date in UNIX Epoch milliseconds

ldapIdstring nullable

Ldap integration

idpUuidstring nullable

The external identity provider's ID for the user

localestring

User locale in the standard ISO 639-1 language code + ISO 3166-1 country code format. For example: 'en_US', 'fr_CA', and so on.

metadataobject
openidstring

OpenID URL

picturestring nullable

Profile picture URL

rolesstring[]

User roles. All responses include ROLE_USER (end-user access). If the user has the Network Manager role, this array also includes ROLE_CORPORATE_ADMIN. For company membership roles, see UserCompanyMembershipAccountV2.

userIdnumber

ID

usernamestring nullable

User name. If not provided, use the user's email address

uuidstring

Unique identifier of the user assigned by the AppDirect platform

Example response

{
  "uuid": "8d237de5-9710-4d55-a5cc-3e8dc918c216",
  "email": "jude.doe@company8578572384.com",
  "username": "jude.doe",
  "firstName": "Jude",
  "lastName": "Doe",
  "picture": "http://localhost:8080/profilePics/img2147417701652580695.png?184b58e358f087154d94329f9000b28a",
  "activated": true,
  "allowLogin": true,
  "currency": "USD",
  "creationDate": 1398896238000,
  "lastSuccessfulLogin": 1543259363000,
  "openId": "http://localhost:8080/openid/id/2f93cb24-f7b9-433f-875e-bb0dd9b0f1c1",
  "externalId": "b34974b2-f5d6-4326-9859-5247dc42ee60",
  "idpUuid": "1d37bace-f4cf-11e6-af80-22000a9513f7",
  "locale": "en_US",
  "customAttributes": [
    {
      "name": "C5125859",
      "attributeType": "TEXT",
      "label": "Commission_Payout_ID",
      "hint": "commission_hint",
      "value": "value"
    }
  ],
  "ldapId": "1",
  "boostUser": {
    "apsUid": "murnu8w"
  },
  "roles": [
    "ROLE_USER"
  ],
  "metadata": {
    "apsUid": null
  },
  "links": [
    {
      "rel": "self",
      "href": "http://appdirect/api/account/v2/users/8d237de5-9710-4d55-a5cc-3e8dc918c216"
    },
    {
      "rel": "memberships",
      "href": "http://appdirect/api/account/v2/users/8d237de5-9710-4d55-a5cc-3e8dc918c216/memberships"
    }
  ]
}

Changes

  • 1fc240f06971Revision changes
    • breaking

      removed the media type */* for the response with the status

    • breaking

      removed the media type */* for the response with the status