This is the official registry of FORM_TYPEs and associated fields used in the context of the 'jabber:x:data' namespace (see XEP-0004: Data Forms and XEP-0068: Field Standardization for Data Forms), as registered with the XMPP Registrar.
Last Updated: 2009-04-06
XML: https://xmpp.org/registrar/formtypes.xml
1. http://jabber.org/network/serverinfo
2. http://jabber.org/protocol/admin
3. http://jabber.org/protocol/muc#register
4. http://jabber.org/protocol/muc#roomconfig
5. http://jabber.org/protocol/pubsub#subscribe_authorization
6. http://jabber.org/protocol/pubsub#subscribe_options
7. http://jabber.org/protocol/pubsub#meta-data
8. http://jabber.org/protocol/pubsub#node_config
9. http://jabber.org/protocol/pubsub#publish-options
10. http://jabber.org/protocol/rc
11. jabber:iq:register
12. jabber:iq:register:cancel
13. jabber:iq:register:changepassword
14. jabber:iq:search
15. urn:xmpp:captcha
16. urn:xmpp:ssn
Forms enabling the communication of contact addresses and other server information.
Defined in XEP-0157: Contact Addresses for XMPP Services.
| Field Name | Type | Description |
|---|---|---|
| abuse-addresses | list-multi | One or more addresses for communication related to abusive traffic |
| admin-addresses | list-multi | One or more addresses for communication with the service administrators |
| feedback-addresses | list-multi | One or more addresses for customer feedback |
| sales-addresses | list-multi | One or more addresses for communication related to sales and marketing |
| security-addresses | list-multi | One or more addresses for communication related to security concerns |
| support-addresses | list-multi | One or more addresses for customer support |
Forms used for administration of servers and components.
Defined in XEP-0133: Service Administration.
| Field Name | Type | Description |
|---|---|---|
| accountjid | jid-single | The Jabber ID of a single entity to which an operation applies |
| accountjids | jid-multi | The Jabber ID of one or more entities to which an operation applies |
| activeuserjids | jid-multi | The Jabber IDs associated with active sessions |
| activeusersnum | text-single | The number of online entities that are active |
| adminjids | jid-multi | A list of entities with administrative privileges |
| announcement | text-multi | The text of an announcement to be sent to active users or all users |
| blacklistjids | jid-multi | A list of entities with whom communication is blocked |
| delay | list-multi | The number of seconds to delay before applying a change |
| disableduserjids | jid-multi | The Jabber IDs that have been disabled |
| disabledusersnum | text-single | The number of disabled entities |
| text-single | The email address for a user | |
| given_name | text-single | The given (first) name of a user |
| idleusersnum | text-single | The number of online entities that are idle |
| ipaddresses | list-multi | The IP addresses of an account's online sessions |
| lastlogin | text-single | The last login time (per XEP-0082) of a user |
| loginsperminute | text-single | The number of logins per minute for an account |
| max_items | list-single | The maximum number of items associated with a search or list |
| motd | text-multi | The text of a message of the day |
| onlineresources | text-single | The names of an account's online sessions |
| onlineuserjids | jid-multi | The Jabber IDs associated with online users |
| onlineusersnum | text-single | The number of online entities |
| password | text-private | The password for an account |
| password-verify | text-private | Password verification |
| registereduserjids | jid-multi | A list of registered entities |
| registeredusersnum | text-single | The number of registered entities |
| rostersize | text-single | Number of roster items for an account |
| stanzaspersecond | text-single | The number of stanzas being sent per second by an account |
| surname | text-single | The family (last) name of a user |
| welcome | text-multi | The text of a welcome message |
| whitelistjids | jid-multi | A list of entities with whom communication is allowed |
Forms enabling user registration with a Multi-User Chat (MUC) room.
Defined in XEP-0045: Multi-User Chat.
| Field Name | Type | Description |
|---|---|---|
| muc#register_first | text-single | Given Name |
| muc#register_last | text-single | Family Name |
| muc#register_roomnick | text-single | Desired Nickname |
| muc#register_url | text-single | Your URL |
| muc#register_email | text-single | Email Address |
| muc#register_faqentry | text-multi | FAQ Entry |
Forms enabling creation and configuration of a Multi-User Chat (MUC) room.
Defined in XEP-0045: Multi-User Chat.
| Field Name | Type | Description |
|---|---|---|
| muc#roomconfig_allowinvites | boolean | Whether to Allow Occupants to Invite Others |
| muc#roomconfig_changesubject | boolean | Whether to Allow Occupants to Change Subject |
| muc#roomconfig_enablelogging | boolean | Whether to Enable Logging of Room Conversations |
| muc#roomconfig_lang | text-single | Natural Language for Room Discussions |
| muc#roomconfig_maxusers | list-single | Maximum Number of Room Occupants |
| muc#roomconfig_membersonly | boolean | Whether an Make Room Members-Only |
| muc#roomconfig_moderatedroom | boolean | Whether to Make Room Moderated |
| muc#roomconfig_passwordprotectedroom | boolean | Whether a Password is Required to Enter |
| muc#roomconfig_persistentroom | boolean | Whether to Make Room Persistent |
| muc#roomconfig_presencebroadcast | list-multi | Roles for which Presence is Broadcast |
| muc#roomconfig_publicroom | boolean | Whether to Allow Public Searching for Room |
| muc#roomconfig_roomadmins | jid-multi | Full List of Room Admins |
| muc#roomconfig_roomdesc | text-single | Short Description of Room |
| muc#roomconfig_roomname | text-single | Natural-Language Room Name |
| muc#roomconfig_roomowners | jid-multi | Full List of Room Owners |
| muc#roomconfig_roomsecret | text-private | The Room Password |
| muc#roomconfig_whois | list-single | Affiliations that May Discover Real JIDs of Occupants |
Forms enabling authorization of subscriptions to pubsub nodes
Defined in XEP-0060: Publish-Subscribe.
| Field Name | Type | Description |
|---|---|---|
| pubsub#allow | boolean | Whether to allow the subscription |
| pubsub#subid | text-single | The SubID of the subscription |
| pubsub#node | text-single | The NodeID of the relevant node |
| pubsub#subscriber_jid | jid-single | The address (JID) of the subscriber |
Forms enabling configuration of subscription options for pubsub nodes
Defined in XEP-0060: Publish-Subscribe.
| Field Name | Type | Description |
|---|---|---|
| pubsub#deliver | boolean | Whether an entity wants to receive or disable notifications |
| pubsub#digest | boolean | Whether an entity wants to receive digests (aggregations) of notifications or all notifications individually |
| pubsub#digest_frequency | text-single | The minimum number of milliseconds between sending any two notification digests |
| pubsub#expire | text-single | The DateTime at which a leased subscription will end or has ended |
| pubsub#include_body | boolean | Whether an entity wants to receive an XMPP message body in addition to the payload format |
| pubsub#show-values | list-multi | The presence states for which an entity wants to receive notifications |
| pubsub#subscription_type | list-single | |
| pubsub#subscription_depth | list-single |
Forms enabling setting of meta-data information about pubsub nodes
Defined in XEP-0060: Publish-Subscribe.
| Field Name | Type | Description |
|---|---|---|
| pubsub#contact | jid-multi | The JIDs of those to contact with questions |
| pubsub#creation_date | text-single | The datetime when the node was created |
| pubsub#creator | jid-single | The JID of the node creator |
| pubsub#description | text-single | A description of the node |
| pubsub#language | text-single | The default language of the node |
| pubsub#num_subscribers | text-single | The number of subscribers to the node |
| pubsub#owner | jid-multi | The JIDs of those with an affiliation of owner |
| pubsub#publisher | jid-multi | The JIDs of those with an affiliation of publisher |
| pubsub#title | text-single | The name of the node |
| pubsub#type | text-single | Payload type |
Forms enabling configuration of pubsub nodes
Defined in XEP-0060: Publish-Subscribe.
| Field Name | Type | Description |
|---|---|---|
| pubsub#access_model | list-single | Who may subscribe and retrieve items |
| pubsub#body_xslt | text-single | The URL of an XSL transformation which can be applied to payloads in order to generate an appropriate message body element. |
| pubsub#collection | text-single | The collection with which a node is affiliated |
| pubsub#contact | jid-multi | The JIDs of those to contact with questions |
| pubsub#dataform_xslt | text-single | The URL of an XSL transformation which can be applied to the payload format in order to generate a valid Data Forms result that the client could display using a generic Data Forms rendering engine |
| pubsub#deliver_notifications | boolean | Whether to deliver event notifications |
| pubsub#deliver_payloads | boolean | Whether to deliver payloads with event notifications; applies only to leaf nodes |
| pubsub#itemreply | list-single | Whether owners or publisher should receive replies to items |
| pubsub#children_association_policy | list-single | Who may associate leaf nodes with a collection |
| pubsub#children_association_whitelist | jid-multi | The list of JIDs that may associate leaf nodes with a collection |
| pubsub#children | text-multi | The child nodes (leaf or collection) associated with a collection |
| pubsub#children_max | text-single | The maximum number of child nodes that can be associated with a collection |
| pubsub#max_items | text-single | The maximum number of items to persist |
| pubsub#max_payload_size | text-single | The maximum payload size in bytes |
| pubsub#node_type | list-single | Whether the node is a leaf (default) or a collection |
| pubsub#notify_config | boolean | Whether to notify subscribers when the node configuration changes |
| pubsub#notify_delete | boolean | Whether to notify subscribers when the node is deleted |
| pubsub#notify_retract | boolean | Whether to notify subscribers when items are removed from the node |
| pubsub#notify_sub | boolean | Whether to notify owners about new subscribers and unsubscribes |
| pubsub#persist_items | boolean | Whether to persist items to storage |
| pubsub#presence_based_delivery | boolean | Whether to deliver notifications to available users only |
| pubsub#publish_model | list-single | The publisher model |
| pubsub#replyroom | jid-multi | The specific multi-user chat rooms to specify for replyroom |
| pubsub#replyto | jid-multi | The specific JID(s) to specify for replyto |
| pubsub#roster_groups_allowed | list-multi | The roster group(s) allowed to subscribe and retrieve items |
| pubsub#send_last_published_item | list-single | When to send the last published item |
| pubsub#subscribe | boolean | Whether to allow subscriptions |
| pubsub#title | text-single | A friendly name for the node |
| pubsub#type | text-single | The type of node data, usually specified by the namespace of the payload (if any); MAY be list-single rather than text-single |
Forms enabling publication with options; each field must specify whether it defines METADATA to be attached to the item, a per-item OVERRIDE of the node configuration, or a PRECONDITION to be checked against the node configuration.
Defined in XEP-0060: Publish-Subscribe.
| Field Name | Type | Description |
|---|---|---|
| pubsub#access_model | list-single | Precondition: node configuration with the specified access model |
Forms used for remote controlling clients
Defined in XEP-0146: Remote Controllling Clients.
| Field Name | Type | Description |
|---|---|---|
| auto-auth | boolean | Whether to automatically authorize subscription requests |
| auto-files | boolean | Whether to automatically accept file transfers |
| auto-msg | boolean | Whether to automatically open new messages |
| auto-offline | boolean | Whether to automatically go offline when idle |
| sounds | boolean | Whether to play sounds |
| files | list-multi | A list of pending file transfers |
| groupchats | list-multi | A list of joined groupchat rooms |
| status | list-single | A presence or availability status |
| status-message | text-multi | The status message text |
| status-priority | text-single | The new priority for the client |
Standardization of fields related to in-band registration.
Defined in XEP-0077: In-Band Registration.
| Field Name | Type | Description |
|---|---|---|
| address | text-single | Street portion of a physical or mailing address |
| answers | hidden | number of answers required |
| audio_recog | text-single | text associated with a sound |
| challenge | hidden | challenge ID |
| city | text-single | Locality portion of a physical or mailing address |
| text-single | Email address of the user | |
| first | text-single | Given name of the user |
| last | text-single | Family name of the user |
| name | text-single | Full name of the user |
| nick | text-single | Familiar name of the user |
| ocr | text-single | code appearing in an image |
| password | text-private | Password or secret for the user |
| picture_q | text-single | answer associated with a picture |
| picture_recog | text-single | text associated with a picture |
| qa | text-single | answer to a question |
| SHA-256 | text-single | least significant bits of SHA-256 hash of text should equal hexadecimal label |
| sid | hidden | stanza ID |
| speech_q | text-single | answer associated with speech |
| speech_recog | text-single | text associated with speech |
| state | text-single | Region portion of a physical or mailing address |
| username | text-single | Account name associated with the user |
| video_q | text-single | answer associated with a video |
| video_recog | text-single | text associated with a video |
| zip | text-single | Postal code portion of a physical or mailing address |
Standardization of fields related to cancellation use case.
Defined in XEP-0077.
| Field Name | Type | Description |
|---|---|---|
| password | text-private | Password or secret for the user |
| username | text-single | Account name associated with the user |
Standardization of fields related to change password use case.
Defined in XEP-0077.
| Field Name | Type | Description |
|---|---|---|
| old_password | text-private | Old password for the user |
| password | text-private | Desired password for the user |
| username | text-single | Account name associated with the user |
Forms enabling directory searches.
Defined in XEP-0055: Jabber Search.
| Field Name | Type | Description |
|---|---|---|
| first | text-single | Given Name |
| last | text-single | Family Name |
| nick | text-single | Nickname |
| text-single | Email Address |
Forms enabling the use of CAPTCHAs.
Defined in XEP-0158.
| Field Name | Type | Description |
|---|---|---|
| answers | hidden | number of answers required |
| audio_recog | text-single | text associated with a sound |
| challenge | hidden | challenge ID |
| from | hidden | to attribute of stanza that triggered challenge |
| ocr | text-single | code appearing in an image |
| picture_q | text-single | answer associated with a picture |
| picture_recog | text-single | text associated with a picture |
| qa | text-single | answer to a question |
| SHA-256 | text-single | least significant bits of SHA-256 hash of text should equal hexadecimal label |
| sid | hidden | stanza ID |
| speech_q | text-single | answer associated with speech |
| speech_recog | text-single | text associated with speech |
| video_q | text-single | answer associated with a video |
| video_recog | text-single | text associated with a video |
Forms enabling negotation of a one-to-one chat session between two entities.
Defined in XEP-0155: Stanza Session Negotiation.
| Field Name | Type | Description |
|---|---|---|
| accept | boolean | Whether to accept the invitation |
| continue | text-single | Another resource with which to continue the session |
| disclosure | list-single | Disclosure of content, decryption keys or identities |
| http://jabber.org/protocol/chatstates | list-single | Whether may send Chat State Notifications per XEP-0085 |
| http://jabber.org/protocol/xhtml-im | list-single | Whether allowed to use XHTML-IM formatting per XEP-0071 |
| language | list-single | Primary written language of the chat (each value appears in order of preference and conforms to RFC 4646 and the IANA registry) |
| logging | list-single | Whether allowed to log messages (i.e., whether Off-The-Record mode is required) |
| renegotiate | boolean | Whether to renegotiate the session |
| security | list-single | Minimum security level |
| terminate | boolean | Whether to terminate the session |
| urn:xmpp:receipts | boolean | Whether to enable Message Receipts per XEP-0184 |
2009-04-06 Added missing jabber:iq:register:cancel and jabber:iq:register:changepassword FORM_TYPEs from XEP-0077. (psa)
2008-09-03 Added CAPTCHA form type and CAPTCHA-related fields for registration form type. (psa)
2007-09-27 Added pubsub-options form type. (psa)
2007-01-31 Added server contact addresses registration from XEP-0157. (psa)
2007-01-17 Added chat session negotiation registration from XEP-0155. (psa)
2006-07-05 Corrected pubsub registration. (psa)
2006-03-23 Added registration from XEP-0146. (psa)
2004-01-18 Registrations from XEP-0055 and XEP-0060. (psa)
2003-12-31 Initial version (registrations from XEP-0045 and XEP-0077). (psa)