ForgeRock · Schema

User

A directory user entry mapped from LDAP to JSON via HDAP

Access ManagementAuthenticationAuthorizationIdentity GovernanceIdentity ManagementOAuthOpenID Connect

Properties

Name	Type	Description
_id	string	User identifier (mapped from LDAP uid)
_rev	string	Entry revision for MVCC
userName	string	Login username
givenName	string	First name
sn	string	Surname / last name
cn	string	Common name (full name)
mail	string	Email address
telephoneNumber	string	Phone number
description	string	User description
memberOf	array	Groups this user belongs to
userPassword	string	Password (write-only, stored hashed)

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/User",
  "title": "User",
  "type": "object",
  "description": "A directory user entry mapped from LDAP to JSON via HDAP",
  "properties": {
    "_id": {
      "type": "string",
      "description": "User identifier (mapped from LDAP uid)"
    },
    "_rev": {
      "type": "string",
      "description": "Entry revision for MVCC",
      "readOnly": true
    },
    "userName": {
      "type": "string",
      "description": "Login username"
    },
    "givenName": {
      "type": "string",
      "description": "First name"
    },
    "sn": {
      "type": "string",
      "description": "Surname / last name"
    },
    "cn": {
      "type": "string",
      "description": "Common name (full name)"
    },
    "mail": {
      "type": "string",
      "format": "email",
      "description": "Email address"
    },
    "telephoneNumber": {
      "type": "string",
      "description": "Phone number"
    },
    "description": {
      "type": "string",
      "description": "User description"
    },
    "memberOf": {
      "type": "array",
      "description": "Groups this user belongs to",
      "readOnly": true,
      "items": {
        "type": "string"
      }
    },
    "userPassword": {
      "type": "string",
      "format": "password",
      "description": "Password (write-only, stored hashed)",
      "writeOnly": true
    }
  }
}