# identity

Source: https://zotonic.com/docs/1285/identity

URI: https://zotonic.com/id/1285

Language: en



The m\_identity model manages usernames and other user identities. <a href="/id/doc_module_mod_authentication" class="doc-reference doc-reference-module"><code>module#mod_authentication</code></a> uses it to store and check salted passwords, but also provides a safe storage for user tokens of any kind, as used by <a href="/id/doc_module_mod_facebook" class="doc-reference doc-reference-module"><code>module#mod_facebook</code></a>.

Note that a user does not have to be of the person category per se, in Zotonic anything can have identities attached to it.

The following m\_identity model properties are available in templates:

| Property | Description                                                                      | Example value |
| -------- | -------------------------------------------------------------------------------- | ------------- |
| is\_user | Check if a page id is a user. Return a bool. Usage: m.identity\[page\_id\].is\_user | `true`        |
| username | Fetch the username, if any, of a user. Returns a binary or undefined. Usage: m.identity\[page\_id\].username | `<<"admin">>` |

Available Model API Paths
-------------------------

| Method | Path pattern                     | Description                                                                      |
| ------ | -------------------------------- | -------------------------------------------------------------------------------- |
| `get`  | `/lookup/+type/+key/...`         | Return all filtered identity records matching normalized identity key `+key` for identity type `+type` (`propb` and secret fields are stripped; admin only). |
| `get`  | `/generate_password/...`         | Return a newly generated random password string (`z_ids:password/0`).            |
| `get`  | `/is_email_verified`             | Return whether the current user’s primary `email_raw` has a matching verified `email` identity record. No further lookups. |
| `get`  | `/is_email_verified/+userid/...` | Return whether user `+userid` has a verified identity record for its primary `email_raw` address (editable by caller). |
| `get`  | `/+id/is_user/...`               | Return whether resource `+id` has at least one identity of a user-defining type (`auth_identity_types`, default includes `username_pw`; requires visibility). |
| `get`  | `/+id/username/...`              | Return the current username identity key for resource `+id` (requires edit permission on `+id`). |
| `get`  | `/+id/user_info/...`             | Return user info map for `+id` with `user_id`, `username`, `visited`, `modified`, and `is_expired`; returns empty/default values when no `username_pw` identity exists (requires edit permission). |
| `get`  | `/+id/logon_history/...`         | Return login history rows (`user_agent`, `ip_address`, `created`) ordered by newest first for user `+id` (self or admin). |
| `get`  | `/+id/all_types/...`             | Return all identity `type` values present for user/resource `+id`; returns `[]` when caller cannot edit `+id`. |
| `get`  | `/+id/all`                       | Return all identities for user/resource `+id` as filtered identity records (admin only). No further lookups. |
| `get`  | `/+id/all/email/...`             | Return all filtered `email` identities for user `+id`; ensures the resource primary email is represented as an identity when valid (requires edit permission). |
| `get`  | `/+id/all/+type/...`             | Return filtered identity records of type `+type` for user/resource `+id` (admin only). |
| `get`  | `/get/+idnid/...`                | Return one filtered identity record by identity id `+idnid` (admin only).        |
| `get`  | `/verify/+idnid/+verifykey/...`  | Return identity record `+idnid` only when `+verifykey` matches the stored `verify_key` using constant-time comparison; otherwise return `undefined`. |
| `get`  | `/+id/+type/...`                 | Return identity record for type `+type` on user/resource `+id` (admin only; `enoent` when missing). |

`/+name` marks a variable path segment. A trailing `/...` means extra path segments are accepted for further lookups.

License: 

Attribution: 

Related resources: https://zotonic.com/api/agent/related/1285?language=en


## API access

- [API help](<https://zotonic.com/api-help>)
- [OpenAPI specification](<https://zotonic.com/openapi.json>)
- [This resource as JSON](<https://zotonic.com/api/agent/resource/1285?language=en>)
