Auth Templates

Get a random auth template

GET random auth template

Endpoint

GET /api/v1/auth_templates/random

Parameters

Name Description In
by_usage required Usage of the auth template ["create_account", "create_password", "company_details", "login"]

Request

Route

GET /api/v1/auth_templates/random?by_usage=create_account

Headers

Accept: application/json
Content-Type: application/json
Host: example.org
Cookie:

Query Parameters

by_usage=create_account

Body

{
}

Response

Simulated Response

Status

200

Headers

x-frame-options: SAMEORIGIN
x-xss-protection: 0
x-content-type-options: nosniff
x-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
content-type: application/json; charset=utf-8
vary: Accept, Origin
etag: W/"1f10f65f6a4054247dcee46f1cb17809"
cache-control: max-age=0, private, must-revalidate
x-request-id: 87aa224a-09d5-40ba-934b-789a16ab8afc
x-runtime: 0.007180
content-length: 889

Body

{
  "auth_template": {
    "id": 7,
    "content": "Et repellat quia. Ab asperiores laborum. Cupiditate architecto voluptas.",
    "image": {
      "id": 8,
      "signed_id": "eyJfcmFpbHMiOnsiZGF0YSI6OCwicHVyIjoiYmxvYl9pZCJ9fQ==--c1ea555d59fd509dc04891bc2509126a912b59cf",
      "byte_size": 596,
      "filename": "test_image.png",
      "url": "http://localhost:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6OCwicHVyIjoiYmxvYl9pZCJ9fQ==--c1ea555d59fd509dc04891bc2509126a912b59cf/test_image.png"
    },
    "operator_full_name": "Winfred DuBuque",
    "operator_image": {
      "id": 9,
      "signed_id": "eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--3b91776aad290a8238f9f4bd84db3cd3abc2c2a3",
      "byte_size": 596,
      "filename": "test_image.png",
      "url": "http://localhost:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--3b91776aad290a8238f9f4bd84db3cd3abc2c2a3/test_image.png"
    },
    "operator_position": "Forward Officer"
  }
}