Skip to content
docstack-ocr

Invite User

POST
/v1/admin/users
 
curl --request POST \
  --url http://localhost:8080/v1/admin/users \
  --header 'Content-Type: application/json' \
  --data '{ "email": "hello@example.com", "role": "example", "display_name": "example" }'

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
tenant_id
Any of:
string

Request Body required

Section titled “Request Body required ”
Media type application/json
InvitePayload
object
email
required
Email
string format: email
role
required
Role
string
/^(tenant_admin|tenant_user)$/
display_name
Any of:
string
<= 128 characters
Example generated
{
  "email": "hello@example.com",
  "role": "example",
  "display_name": "example"
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Successful Response

Media type application/json
Response Invite User V1 Admin Users Post
object
key
additional properties
any
Example generated
{}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}