Adding a User

Requires FaxFinder 3.0.4 or higher.

HTTP Request Line

POST /ffws/v1/users HTTP/1.1

HTTP Response Status Codes

200 OK

Created user.

403 Forbidden

Authenticated user does not have permission to add users.

400 Bad Request

The provided XML is not valid.

Example

POST /ffws/v1/users HTTP/1.1
content-type: application/xml
authorization: Basic YWRtaW46YWRtaW4=
<?xml version=”1.0” encoding=”UTF-8”?>
<user>
	<name>New User 1</name>
	<username>user1</username>
	<password>user1</password>
	<email_address>admin@Example.com</email_address>
	<phone_number>218-555-3333</phone_number>
	<fax_number>218-555-3334</fax_number>
	<organization>Example Org</organization>
	<priority>1</priority>
	<max_attempts>2</max_attempts>
	<interval>600</interval>
	<receipt>never</receipt>
	<receipt_attachment>none</receipt_attachment>
</user>
-----------------------------------
<?xml version=”1.0” encoding=”UTF-8”?>
<response>
	<message>Created</message>
	<user>
		<user_url>https://172.16.0.3/ffws/v1/users/user1</user_url>
		<name>New User 1</name>
		<username>user1</username>
		<email_address>admin@Example.com</email_address>
		<phone_number>218-555-3333</phone_number>
		<fax_number>218-555-3334</fax_number>
		<organization>Example Org</organization>
		<default_cover_page_enabled>false</default_cover_page_enabled>
		<default_cover_page_name></default_cover_page_name>
		<priority>1</priority>
		<max_attempts>2</max_attempts>
		<interval>600</interval>
		<receipt>never</receipt>
		<receipt_attachment>none</receipt_attachment>
	</user>
</response>