Post apiauthcreate api only user

POST /api/auth/create_api_only_user

Try it

cURL

cURL

curl --request POST \
  --url https://api.trieve.ai/api/auth/create_api_only_user \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "user_email": "<string>",
  "user_name": "<string>"
}'

200

{
  "api_key": "<string>",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user": {
    "email": "[email protected]",
    "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
    "name": "Trieve",
    "orgs": [
      {
        "created_at": "2021-01-01 00:00:00.000",
        "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
        "name": "Trieve",
        "registerable": true,
        "updated_at": "2021-01-01 00:00:00.000"
      }
    ],
    "user_orgs": [
      {
        "created_at": "2021-01-01 00:00:00.000",
        "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
        "org_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
        "role": 0,
        "updated_at": "2021-01-01 00:00:00.000",
        "user_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3"
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Body

application/json

user_email · string · required

user_name · string · required

Response

200

application/json

The user id

api_key · string · required

organization_id · string<uuid> · required

user · object · required

Show child attributes

user. created_at · string<date-time> · required

user. email · string · required

user. id · string<uuid> · required

user. orgs · object[] · required

Show child attributes

user.orgs. created_at · string<date-time> · required

Timestamp of the creation of the dataset

user.orgs. deleted · integer<int32> · required

Flag to indicate if the organization has been deleted. Deletes are handled async after the flag is set so as to avoid expensive search index compaction.

user.orgs. id · string<uuid> · required

Unique identifier of the dataset, auto-generated uuid created by Trieve

user.orgs. name · string · required

Name of the organization

user.orgs. partner_configuration · any · required

Configuration of the organization for the Trieve partner program. Contact [email protected] for more details.

user.orgs. updated_at · string<date-time> · required

Timestamp of the last update of the dataset

user.orgs. registerable · boolean | null

Flag to indicate whether or not new users may join the organization. Default is true.

user. user_orgs · object[] · required

Show child attributes

user.user_orgs. created_at · string<date-time> · required

user.user_orgs. id · string<uuid> · required

user.user_orgs. organization_id · string<uuid> · required

user.user_orgs. role · integer<int32> · required

user.user_orgs. updated_at · string<date-time> · required

user.user_orgs. user_id · string<uuid> · required

user.user_orgs. scopes · (string | null)[] | null

user. name · string | null

Example:

{
  "email": "[email protected]",
  "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
  "name": "Trieve",
  "orgs": [
    {
      "created_at": "2021-01-01 00:00:00.000",
      "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
      "name": "Trieve",
      "registerable": true,
      "updated_at": "2021-01-01 00:00:00.000"
    }
  ],
  "user_orgs": [
    {
      "created_at": "2021-01-01 00:00:00.000",
      "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
      "org_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
      "role": 0,
      "updated_at": "2021-01-01 00:00:00.000",
      "user_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3"
    }
  ]
}