Skip to main content
POST
/
identity
/
v1
/
users
Creates a new user in the specified organization.
curl --request POST \
  --url https://api.sandbox.tesouro.com/identity/v1/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "name": "<string>",
  "role": "ADMIN",
  "status": "<string>",
  "address1": "<string>",
  "address2": "<string>",
  "city": "<string>",
  "country": "<string>",
  "isExpenseApprover": true,
  "jobTitle": "<string>",
  "permissionIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "permissionKeys": [
    "acceptor:application:read"
  ],
  "phoneNumber": "<string>",
  "postalCode": "<string>",
  "redirectUri": "<string>",
  "reportingManagerUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "stateOrProvince": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "email": "<string>",
  "isExpenseApprover": true,
  "name": "<string>",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "role": "ADMIN",
  "status": "<string>",
  "jobTitle": "<string>",
  "reportingManagerUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Documentation Index

Fetch the complete documentation index at: https://docs.tesouro.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Application (M2M) OAuth2 access token (client credentials).

Headers

X-Organization-ID
string<uuid>

ID of the organization to scope this operation to. When omitted, the request creates the user in the caller's own organization. Must be a valid non-empty UUID. Present but empty or malformed values return 400.

Body

Cancellation token.

email
string
required
name
string
required
role
enum<string>
required
Available options:
ADMIN,
BOOKKEEPER,
EMPLOYEE,
TREASURY_MANAGER
status
string
required
address1
null | string
address2
null | string
city
null | string
country
null | string
isExpenseApprover
boolean
jobTitle
null | string
permissionIds
null | string<uuid>[]

Permission GUIDs to grant the user. Mutually exclusive with permissionKeys; exactly one must be supplied. Prefer permissionKeys for new integrations.

permissionKeys
null | enum<string>[]

Permission keys (e.g. "user:write") to grant the user. Resolved server-side to the underlying permission IDs. Mutually exclusive with permissionIds; exactly one must be supplied.

Available options:
acceptor:application:read,
acceptor:application:secondaryapproval,
acceptor:application:write,
accounting_tax_rate:create,
accounting_tax_rate:delete,
accounting_tax_rate:read,
accounting_tax_rate:update,
acquiring:report:read,
approval_policy:create,
approval_policy:delete,
approval_policy:read,
approval_policy:update,
approval_request:create,
approval_request:delete,
approval_request:read,
approval_request:update,
comment:create,
comment:delete,
comment:read,
comment:update,
cost_center:create,
cost_center:delete,
cost_center:read,
cost_center:update,
counterpart:create,
counterpart:delete,
counterpart:delete:own,
counterpart:read,
counterpart:read:own,
counterpart:update,
counterpart:update:own,
counterpart_vat_id:create,
counterpart_vat_id:delete,
counterpart_vat_id:read,
counterpart_vat_id:update,
delivery_note:create,
delivery_note:delete,
delivery_note:delete:own,
delivery_note:read,
delivery_note:read:own,
delivery_note:update,
delivery_note:update:own,
developer_portal,
dispute:read,
dispute:write,
embedded:bankaccount:read,
embedded:bankaccount:write,
embedded:bankaccountapplication:read,
embedded:bankaccountapplication:write,
embedded:beneficialowner:read,
embedded:creditcard:read,
embedded:creditcard:write,
embedded:creditcardapplication:read,
embedded:creditcardapplication:write,
embedded:creditcardcustomer:read,
embedded:creditcardcustomer:write,
embedded:externalbankaccount:micro-deposit,
embedded:externalbankaccount:read,
embedded:externalbankaccount:set-verification,
embedded:externalbankaccount:write,
embedded:transaction:read,
embedded:transfer:read,
embedded:transfer:write,
entity:create,
entity:delete,
entity:read,
entity:update,
entity_bank_account:create,
entity_bank_account:delete,
entity_bank_account:delete:own,
entity_bank_account:read,
entity_bank_account:read:own,
entity_bank_account:update,
entity_bank_account:update:own,
entity_user:create,
entity_user:delete,
entity_user:read,
entity_user:update,
entity_vat_ids:create,
entity_vat_ids:delete,
entity_vat_ids:read,
entity_vat_ids:update,
export:create,
export:delete,
export:read,
export:update,
ledger_account:create,
ledger_account:delete,
ledger_account:read,
ledger_account:update,
mailbox:create,
mailbox:delete,
mailbox:read,
mailbox:update,
notification:subscription:read,
notification:subscription:write,
ocr_task:create,
ocr_task:delete,
ocr_task:read,
ocr_task:update,
oidc:app:manage,
oidc:app:read,
oidc:app:write,
org:read:all,
org:write,
org:write:all,
overdue_reminder:create,
overdue_reminder:delete,
overdue_reminder:read,
overdue_reminder:update,
partner_portal,
payable:approve,
payable:approve:own,
payable:cancel,
payable:cancel:own,
payable:create,
payable:create_from_mail,
payable:delete,
payable:delete:own,
payable:pay,
payable:pay:own,
payable:read,
payable:read:own,
payable:reopen,
payable:reopen:own,
payable:submit,
payable:submit:own,
payable:update,
payable:update:own,
payables_purchase_order:create,
payables_purchase_order:delete,
payables_purchase_order:delete:own,
payables_purchase_order:read,
payables_purchase_order:read:own,
payables_purchase_order:update,
payables_purchase_order:update:own,
payment-link:write,
payment_rail:ach,
payment_rail:fednow,
payment_rail:rtp,
payment_record:create,
payment_record:delete,
payment_record:read,
payment_record:update,
payment_reminder:create,
payment_reminder:delete,
payment_reminder:read,
payment_reminder:update,
product:create,
product:delete,
product:read,
product:update,
project:create,
project:delete,
project:read,
project:update,
receipt:create,
receipt:delete,
receipt:delete:own,
receipt:read,
receipt:read:own,
receipt:update,
receipt:update:own,
receivable:create,
receivable:delete,
receivable:delete:own,
receivable:read,
receivable:read:own,
receivable:update,
receivable:update:own,
reconciliation:create,
reconciliation:delete,
reconciliation:read,
reconciliation:update,
role:create,
role:delete,
role:read,
role:update,
role:write,
tag:create,
tag:delete,
tag:read,
tag:update,
team:read,
team:write,
transaction:approve,
transaction:create,
transaction:delete,
transaction:delete:own,
transaction:read,
transaction:read:own,
transaction:update,
transaction:update:own,
transaction_validation:read,
transaction_validation:update,
underwriting:application:approval:escalation,
underwriting:application:approval:secondary,
underwriting:application:read,
underwriting:application:write,
user:profile:write,
user:profile:write:all,
user:read,
user:write,
user:write:all
phoneNumber
null | string
postalCode
null | string
redirectUri
null | string
reportingManagerUserId
null | string<uuid>
stateOrProvince
null | string

Response

User created successfully.

id
string<uuid>
required
createdAt
string<date-time>
required
email
string
required
isExpenseApprover
boolean
required
name
string
required
organizationId
string<uuid>
required
role
enum<string>
required
Available options:
ADMIN,
BOOKKEEPER,
EMPLOYEE,
TREASURY_MANAGER
status
string
required
jobTitle
null | string
reportingManagerUserId
null | string<uuid>