Users API

A user effectively represents an individual identity usable in the Digital Vault.

Easiest way for a user to reset a password is to go to https://{{HOST}}/ums/Home#!/forgotPassword

User object

Property Type Description
Id String Friendly identifier. Identifies the username for locally authenticated users and a crafted representation of a username for externally authenticated users.
Subject String A consistent identifier that is usually a GUID. Useful when deleting and recreating an identical representation to distinguish between the previous one and the new one.
Username String A secondary ID property and required when updating the ID.
Credentials JSON Object Contains properties related to the user’s credentials, such as an encrypted password and a cryptography algorithm.
Identity JSON Object Contains properties related to the user’s identity, such as name, phone, email, and extra information retrieved from external identity providers.
Meta JSON Object Contains properties related to the user’s metadata, such as verification status, failed attempts, and various dates.
Privilege JSON Object Contains properties related to the user’s privilege, such as roles and permissions.

Example User Object

{
  "username": "SecurityAPI_TestUser1",
  "credentials": {
    "protectedPassword": "1.AINuvTfK2M2OE6yzaCmEYMz+OM6io/0fIB3rT39AtssypR39K8W7U0n8W0w7uLWGHA==",
    "crypto": "PBKDF2"
  },
  "identity": {
    "address": null,
    "email": "ckaveth@jci.com",
    "extraClaims": null,
    "familyName": "Delete",
    "givenName": "DoNot",
    "name": "SecurityAPI Test User1",
    "organization": "jci.com",
    "phone": null,
    "website": null
  },
  "meta": {
    "created": "2017-01-04T21:16:22.7430178Z",
    "emailVerified": false,
    "enabled": true,
    "failedLoginCount": 0,
    "failedPasswordResetCount": 0,
    "lastFailedLogin": "2017-01-04T22:51:16.3482433Z",
    "lastFailedPasswordReset": "0001-01-01T00:00:00",
    "lastLogin": "2017-01-17T23:35:22.2405056Z",
    "lastUpdated": "2017-01-17T23:35:54.3018335Z",
    "phoneVerified": false,
    "provider": null,
    "providerId": null
  },
  "privilege": {
    "roles": null
  },
  "id": "SecurityAPI_TestUser1",
  "subject": "9eabc9dc-a597-4373-b8fd-0e3e94fc2428"
}