Create a Proofing User

Creates a Proofing User account. Must be a Story Orchestration customer and have available user licenses.

SecurityApiKeyAuth or BasicAuth
Request
header Parameters
X-API-Key
required
string

Customer-specific API key required to invoke API.

Authorization
required
string

Provided by Authentication Token creation operation

AccessToken
required
string

JWT token provided by Authentication Token creation operation.

Request Body schema: application/json
required

The Request Body must be a JSON object

first_name
string
last_name
string
email
string

Email address for the user

roles
Array of strings (ProofUserRoles)

List of string for each account type assigned to the user

Items Enum: "manager" "user" "guest"
phone
string

Phone number for the user

timezone
string

Timezone for the user

company
string

The company associated with the user account

verified
boolean

Indicates whether or not the user has confirmed their account via the email notification sent. Only available when the role is not guest. If set to true, user will not receive an email notification and will be able to login without confirming email address.

password
string

The password the user will use to login. For Tenovos federated users, this can be any password that is at least 8 characters with 1 number and 1 captial letter, and user will not use this password when accessing proofs via Tenovos federation.

object
Responses
200

Successful Operation

400

Error occurred

401

Unauthorized. Missing Authorization or AccessToken or Access Token expired

403

Forbidden. Missing X-API-key

post/proofing/user
Request samples
application/json
{
  • "first_name": "Tony",
  • "last_name": "Stark",
  • "email": "tony.stark@tenovos.com",
  • "roles": [
    ],
  • "phone": "4412345678911",
  • "timezone": "account_owner_timezone",
  • "company": "Tenovos",
  • "verified": false,
  • "password": "string",
  • "proofing_defaults": {
    }
}
Response samples
application/json
{
  • "id": "a4fdc859-6d9e-4885-8df0-a5d315827703",
  • "first_name": "Tony",
  • "last_name": "Stark",
  • "account_owner": false,
  • "timezone": "Europe/London",
  • "email": "tony.stark@tenovos.com",
  • "roles": [
    ],
  • "phone": "4412345678911",
  • "company": "Tenovos",
  • "verified": "false"
}