Add User

This endpoint allows you to add users for either a group or specific workflows.

Information Circle

User Creation: New users can be assigned directly to groups or workflows. If token_expire is specified, a login token and QR code will be generated for the user.

POST Parameters

ParameterRequiredValueDescription
api_key{key}An API key that has access to the resource you want to query for
name{string}Full name of the user
email_address{string}Email address of the user
password{string}User's password (if not provided, user will need to set password on first login)
group_id{integer}The ID of a specific group to assign user to
workflow_ids{integer}Comma-separated list of workflow IDs to assign user to
token_expire{integer}Time in seconds for login token expiry (returns token and QR code). Maximum: 86400

Response Information

ElementDescription
<status>A status code in response to the operation.
<message>Additional information about the operation – human readable.
<user_id>The users id.
<name>Name of the user.
<email_address>Email address of the user
<primary_group_id>The users assigned primary group.
<assigned_workflows>A list of workflows the user has been assigned to.
<<password>>The user password

Example

Sample Request

POST https://api-app.xtracta.com/v1/user/add HTTP/1.1
api_key=123&name=John&email_address=john@xtracta.com&password=12345678&group_id=12345

Sample Response

<?xml version="1.0" encoding="UTF-8"?>
<user_response>
	<status>200</status>
	<message>The request has been successfully processed</message>
	<user>
		<user_id>4092</user_id>
		<name>John</name>
		<email_address>John@example.com</email_address>
		<primary_group_id>130</primary_group_id>
		<assigned_workflows/>
		<password>John1234</password>
	</user>
</user_response>

Schema Definition

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">

  <xs:simpleType name="ConfidenceType">
    <xs:union>
      <xs:simpleType>
        <xs:restriction base="xs:integer">
          <xs:minInclusive value="0"/>
          <xs:maxInclusive value="100"/>
        </xs:restriction>
      </xs:simpleType>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value=""/>
        </xs:restriction>
      </xs:simpleType>
    </xs:union>
  </xs:simpleType>

  <xs:complexType name="UserresponseType">
    <xs:sequence>
      <xs:element name="status" type="xs:positiveInteger"/>
      <xs:element name="message" type="xs:string"/>
      <xs:element name="user" type="UserType"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="UserType">
    <xs:sequence>
      <xs:element name="user_id" type="xs:nonNegativeInteger"/>
      <xs:element name="name" type="xs:string"/>
      <xs:element name="email_address" type="xs:string"/>
      <xs:element name="primary_group_id" type="xs:nonNegativeInteger"/>
      <xs:element name="assigned_workflows" type="xs:string" nillable="true"/>
    </xs:sequence>
  </xs:complexType>

  <xs:element name="user_response">
    <xs:complexType>
      <xs:sequence>
      <xs:element name="status" type="xs:positiveInteger"/>
      <xs:element name="message" type="xs:string"/>
      <xs:element name="user" type="UserType"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

</xs:schema>